babylon.module.d.ts 6.5 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. get observers(): Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Check if the document object exists
  290. * @returns true if the document object exists
  291. */
  292. static IsDocumentAvailable(): boolean;
  293. /**
  294. * Extracts text content from a DOM element hierarchy
  295. * @param element defines the root element
  296. * @returns a string
  297. */
  298. static GetDOMTextContent(element: HTMLElement): string;
  299. }
  300. }
  301. declare module "babylonjs/Misc/logger" {
  302. /**
  303. * Logger used througouht the application to allow configuration of
  304. * the log level required for the messages.
  305. */
  306. export class Logger {
  307. /**
  308. * No log
  309. */
  310. static readonly NoneLogLevel: number;
  311. /**
  312. * Only message logs
  313. */
  314. static readonly MessageLogLevel: number;
  315. /**
  316. * Only warning logs
  317. */
  318. static readonly WarningLogLevel: number;
  319. /**
  320. * Only error logs
  321. */
  322. static readonly ErrorLogLevel: number;
  323. /**
  324. * All logs
  325. */
  326. static readonly AllLogLevel: number;
  327. private static _LogCache;
  328. /**
  329. * Gets a value indicating the number of loading errors
  330. * @ignorenaming
  331. */
  332. static errorsCount: number;
  333. /**
  334. * Callback called when a new log is added
  335. */
  336. static OnNewCacheEntry: (entry: string) => void;
  337. private static _AddLogEntry;
  338. private static _FormatMessage;
  339. private static _LogDisabled;
  340. private static _LogEnabled;
  341. private static _WarnDisabled;
  342. private static _WarnEnabled;
  343. private static _ErrorDisabled;
  344. private static _ErrorEnabled;
  345. /**
  346. * Log a message to the console
  347. */
  348. static Log: (message: string) => void;
  349. /**
  350. * Write a warning message to the console
  351. */
  352. static Warn: (message: string) => void;
  353. /**
  354. * Write an error message to the console
  355. */
  356. static Error: (message: string) => void;
  357. /**
  358. * Gets current log cache (list of logs)
  359. */
  360. static get LogCache(): string;
  361. /**
  362. * Clears the log cache
  363. */
  364. static ClearLogCache(): void;
  365. /**
  366. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  367. */
  368. static set LogLevels(level: number);
  369. }
  370. }
  371. declare module "babylonjs/Misc/typeStore" {
  372. /** @hidden */
  373. export class _TypeStore {
  374. /** @hidden */
  375. static RegisteredTypes: {
  376. [key: string]: Object;
  377. };
  378. /** @hidden */
  379. static GetClass(fqdn: string): any;
  380. }
  381. }
  382. declare module "babylonjs/Misc/stringTools" {
  383. /**
  384. * Helper to manipulate strings
  385. */
  386. export class StringTools {
  387. /**
  388. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  389. * @param str Source string
  390. * @param suffix Suffix to search for in the source string
  391. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  392. */
  393. static EndsWith(str: string, suffix: string): boolean;
  394. /**
  395. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  396. * @param str Source string
  397. * @param suffix Suffix to search for in the source string
  398. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  399. */
  400. static StartsWith(str: string, suffix: string): boolean;
  401. /**
  402. * Decodes a buffer into a string
  403. * @param buffer The buffer to decode
  404. * @returns The decoded string
  405. */
  406. static Decode(buffer: Uint8Array | Uint16Array): string;
  407. /**
  408. * Encode a buffer to a base64 string
  409. * @param buffer defines the buffer to encode
  410. * @returns the encoded string
  411. */
  412. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  413. /**
  414. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  415. * @param num the number to convert and pad
  416. * @param length the expected length of the string
  417. * @returns the padded string
  418. */
  419. static PadNumber(num: number, length: number): string;
  420. }
  421. }
  422. declare module "babylonjs/Misc/deepCopier" {
  423. /**
  424. * Class containing a set of static utilities functions for deep copy.
  425. */
  426. export class DeepCopier {
  427. /**
  428. * Tries to copy an object by duplicating every property
  429. * @param source defines the source object
  430. * @param destination defines the target object
  431. * @param doNotCopyList defines a list of properties to avoid
  432. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  433. */
  434. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  435. }
  436. }
  437. declare module "babylonjs/Misc/precisionDate" {
  438. /**
  439. * Class containing a set of static utilities functions for precision date
  440. */
  441. export class PrecisionDate {
  442. /**
  443. * Gets either window.performance.now() if supported or Date.now() else
  444. */
  445. static get Now(): number;
  446. }
  447. }
  448. declare module "babylonjs/Misc/devTools" {
  449. /** @hidden */
  450. export class _DevTools {
  451. static WarnImport(name: string): string;
  452. }
  453. }
  454. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  455. /**
  456. * Interface used to define the mechanism to get data from the network
  457. */
  458. export interface IWebRequest {
  459. /**
  460. * Returns client's response url
  461. */
  462. responseURL: string;
  463. /**
  464. * Returns client's status
  465. */
  466. status: number;
  467. /**
  468. * Returns client's status as a text
  469. */
  470. statusText: string;
  471. }
  472. }
  473. declare module "babylonjs/Misc/webRequest" {
  474. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  475. import { Nullable } from "babylonjs/types";
  476. /**
  477. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  478. */
  479. export class WebRequest implements IWebRequest {
  480. private _xhr;
  481. /**
  482. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  483. * i.e. when loading files, where the server/service expects an Authorization header
  484. */
  485. static CustomRequestHeaders: {
  486. [key: string]: string;
  487. };
  488. /**
  489. * Add callback functions in this array to update all the requests before they get sent to the network
  490. */
  491. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  492. private _injectCustomRequestHeaders;
  493. /**
  494. * Gets or sets a function to be called when loading progress changes
  495. */
  496. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  497. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  498. /**
  499. * Returns client's state
  500. */
  501. get readyState(): number;
  502. /**
  503. * Returns client's status
  504. */
  505. get status(): number;
  506. /**
  507. * Returns client's status as a text
  508. */
  509. get statusText(): string;
  510. /**
  511. * Returns client's response
  512. */
  513. get response(): any;
  514. /**
  515. * Returns client's response url
  516. */
  517. get responseURL(): string;
  518. /**
  519. * Returns client's response as text
  520. */
  521. get responseText(): string;
  522. /**
  523. * Gets or sets the expected response type
  524. */
  525. get responseType(): XMLHttpRequestResponseType;
  526. set responseType(value: XMLHttpRequestResponseType);
  527. /** @hidden */
  528. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  529. /** @hidden */
  530. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  531. /**
  532. * Cancels any network activity
  533. */
  534. abort(): void;
  535. /**
  536. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  537. * @param body defines an optional request body
  538. */
  539. send(body?: Document | BodyInit | null): void;
  540. /**
  541. * Sets the request method, request URL
  542. * @param method defines the method to use (GET, POST, etc..)
  543. * @param url defines the url to connect with
  544. */
  545. open(method: string, url: string): void;
  546. /**
  547. * Sets the value of a request header.
  548. * @param name The name of the header whose value is to be set
  549. * @param value The value to set as the body of the header
  550. */
  551. setRequestHeader(name: string, value: string): void;
  552. /**
  553. * Get the string containing the text of a particular header's value.
  554. * @param name The name of the header
  555. * @returns The string containing the text of the given header name
  556. */
  557. getResponseHeader(name: string): Nullable<string>;
  558. }
  559. }
  560. declare module "babylonjs/Misc/fileRequest" {
  561. import { Observable } from "babylonjs/Misc/observable";
  562. /**
  563. * File request interface
  564. */
  565. export interface IFileRequest {
  566. /**
  567. * Raised when the request is complete (success or error).
  568. */
  569. onCompleteObservable: Observable<IFileRequest>;
  570. /**
  571. * Aborts the request for a file.
  572. */
  573. abort: () => void;
  574. }
  575. }
  576. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  577. /**
  578. * Define options used to create a render target texture
  579. */
  580. export class RenderTargetCreationOptions {
  581. /**
  582. * Specifies is mipmaps must be generated
  583. */
  584. generateMipMaps?: boolean;
  585. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  586. generateDepthBuffer?: boolean;
  587. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  588. generateStencilBuffer?: boolean;
  589. /** Defines texture type (int by default) */
  590. type?: number;
  591. /** Defines sampling mode (trilinear by default) */
  592. samplingMode?: number;
  593. /** Defines format (RGBA by default) */
  594. format?: number;
  595. }
  596. }
  597. declare module "babylonjs/Engines/constants" {
  598. /** Defines the cross module used constants to avoid circular dependncies */
  599. export class Constants {
  600. /** Defines that alpha blending is disabled */
  601. static readonly ALPHA_DISABLE: number;
  602. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  603. static readonly ALPHA_ADD: number;
  604. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  605. static readonly ALPHA_COMBINE: number;
  606. /** Defines that alpha blending is DEST - SRC * DEST */
  607. static readonly ALPHA_SUBTRACT: number;
  608. /** Defines that alpha blending is SRC * DEST */
  609. static readonly ALPHA_MULTIPLY: number;
  610. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  611. static readonly ALPHA_MAXIMIZED: number;
  612. /** Defines that alpha blending is SRC + DEST */
  613. static readonly ALPHA_ONEONE: number;
  614. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  615. static readonly ALPHA_PREMULTIPLIED: number;
  616. /**
  617. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  618. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  619. */
  620. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  621. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  622. static readonly ALPHA_INTERPOLATE: number;
  623. /**
  624. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  625. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  626. */
  627. static readonly ALPHA_SCREENMODE: number;
  628. /**
  629. * Defines that alpha blending is SRC + DST
  630. * Alpha will be set to SRC ALPHA + DST ALPHA
  631. */
  632. static readonly ALPHA_ONEONE_ONEONE: number;
  633. /**
  634. * Defines that alpha blending is SRC * DST ALPHA + DST
  635. * Alpha will be set to 0
  636. */
  637. static readonly ALPHA_ALPHATOCOLOR: number;
  638. /**
  639. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  640. */
  641. static readonly ALPHA_REVERSEONEMINUS: number;
  642. /**
  643. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  644. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  645. */
  646. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  647. /**
  648. * Defines that alpha blending is SRC + DST
  649. * Alpha will be set to SRC ALPHA
  650. */
  651. static readonly ALPHA_ONEONE_ONEZERO: number;
  652. /**
  653. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  654. * Alpha will be set to DST ALPHA
  655. */
  656. static readonly ALPHA_EXCLUSION: number;
  657. /** Defines that alpha blending equation a SUM */
  658. static readonly ALPHA_EQUATION_ADD: number;
  659. /** Defines that alpha blending equation a SUBSTRACTION */
  660. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  661. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  662. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  663. /** Defines that alpha blending equation a MAX operation */
  664. static readonly ALPHA_EQUATION_MAX: number;
  665. /** Defines that alpha blending equation a MIN operation */
  666. static readonly ALPHA_EQUATION_MIN: number;
  667. /**
  668. * Defines that alpha blending equation a DARKEN operation:
  669. * It takes the min of the src and sums the alpha channels.
  670. */
  671. static readonly ALPHA_EQUATION_DARKEN: number;
  672. /** Defines that the ressource is not delayed*/
  673. static readonly DELAYLOADSTATE_NONE: number;
  674. /** Defines that the ressource was successfully delay loaded */
  675. static readonly DELAYLOADSTATE_LOADED: number;
  676. /** Defines that the ressource is currently delay loading */
  677. static readonly DELAYLOADSTATE_LOADING: number;
  678. /** Defines that the ressource is delayed and has not started loading */
  679. static readonly DELAYLOADSTATE_NOTLOADED: number;
  680. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  681. static readonly NEVER: number;
  682. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  683. static readonly ALWAYS: number;
  684. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  685. static readonly LESS: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  687. static readonly EQUAL: number;
  688. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  689. static readonly LEQUAL: number;
  690. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  691. static readonly GREATER: number;
  692. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  693. static readonly GEQUAL: number;
  694. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  695. static readonly NOTEQUAL: number;
  696. /** Passed to stencilOperation to specify that stencil value must be kept */
  697. static readonly KEEP: number;
  698. /** Passed to stencilOperation to specify that stencil value must be replaced */
  699. static readonly REPLACE: number;
  700. /** Passed to stencilOperation to specify that stencil value must be incremented */
  701. static readonly INCR: number;
  702. /** Passed to stencilOperation to specify that stencil value must be decremented */
  703. static readonly DECR: number;
  704. /** Passed to stencilOperation to specify that stencil value must be inverted */
  705. static readonly INVERT: number;
  706. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  707. static readonly INCR_WRAP: number;
  708. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  709. static readonly DECR_WRAP: number;
  710. /** Texture is not repeating outside of 0..1 UVs */
  711. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  712. /** Texture is repeating outside of 0..1 UVs */
  713. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  714. /** Texture is repeating and mirrored */
  715. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  716. /** ALPHA */
  717. static readonly TEXTUREFORMAT_ALPHA: number;
  718. /** LUMINANCE */
  719. static readonly TEXTUREFORMAT_LUMINANCE: number;
  720. /** LUMINANCE_ALPHA */
  721. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  722. /** RGB */
  723. static readonly TEXTUREFORMAT_RGB: number;
  724. /** RGBA */
  725. static readonly TEXTUREFORMAT_RGBA: number;
  726. /** RED */
  727. static readonly TEXTUREFORMAT_RED: number;
  728. /** RED (2nd reference) */
  729. static readonly TEXTUREFORMAT_R: number;
  730. /** RG */
  731. static readonly TEXTUREFORMAT_RG: number;
  732. /** RED_INTEGER */
  733. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  734. /** RED_INTEGER (2nd reference) */
  735. static readonly TEXTUREFORMAT_R_INTEGER: number;
  736. /** RG_INTEGER */
  737. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  738. /** RGB_INTEGER */
  739. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  740. /** RGBA_INTEGER */
  741. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  742. /** UNSIGNED_BYTE */
  743. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  744. /** UNSIGNED_BYTE (2nd reference) */
  745. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  746. /** FLOAT */
  747. static readonly TEXTURETYPE_FLOAT: number;
  748. /** HALF_FLOAT */
  749. static readonly TEXTURETYPE_HALF_FLOAT: number;
  750. /** BYTE */
  751. static readonly TEXTURETYPE_BYTE: number;
  752. /** SHORT */
  753. static readonly TEXTURETYPE_SHORT: number;
  754. /** UNSIGNED_SHORT */
  755. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  756. /** INT */
  757. static readonly TEXTURETYPE_INT: number;
  758. /** UNSIGNED_INT */
  759. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  760. /** UNSIGNED_SHORT_4_4_4_4 */
  761. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  762. /** UNSIGNED_SHORT_5_5_5_1 */
  763. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  764. /** UNSIGNED_SHORT_5_6_5 */
  765. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  766. /** UNSIGNED_INT_2_10_10_10_REV */
  767. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  768. /** UNSIGNED_INT_24_8 */
  769. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  770. /** UNSIGNED_INT_10F_11F_11F_REV */
  771. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  772. /** UNSIGNED_INT_5_9_9_9_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  774. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  775. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  776. /** nearest is mag = nearest and min = nearest and no mip */
  777. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  778. /** mag = nearest and min = nearest and mip = none */
  779. static readonly TEXTURE_NEAREST_NEAREST: number;
  780. /** Bilinear is mag = linear and min = linear and no mip */
  781. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  782. /** mag = linear and min = linear and mip = none */
  783. static readonly TEXTURE_LINEAR_LINEAR: number;
  784. /** Trilinear is mag = linear and min = linear and mip = linear */
  785. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  786. /** Trilinear is mag = linear and min = linear and mip = linear */
  787. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  788. /** mag = nearest and min = nearest and mip = nearest */
  789. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  790. /** mag = nearest and min = linear and mip = nearest */
  791. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  792. /** mag = nearest and min = linear and mip = linear */
  793. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  794. /** mag = nearest and min = linear and mip = none */
  795. static readonly TEXTURE_NEAREST_LINEAR: number;
  796. /** nearest is mag = nearest and min = nearest and mip = linear */
  797. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  798. /** mag = linear and min = nearest and mip = nearest */
  799. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  800. /** mag = linear and min = nearest and mip = linear */
  801. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  802. /** Bilinear is mag = linear and min = linear and mip = nearest */
  803. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  804. /** mag = linear and min = nearest and mip = none */
  805. static readonly TEXTURE_LINEAR_NEAREST: number;
  806. /** Explicit coordinates mode */
  807. static readonly TEXTURE_EXPLICIT_MODE: number;
  808. /** Spherical coordinates mode */
  809. static readonly TEXTURE_SPHERICAL_MODE: number;
  810. /** Planar coordinates mode */
  811. static readonly TEXTURE_PLANAR_MODE: number;
  812. /** Cubic coordinates mode */
  813. static readonly TEXTURE_CUBIC_MODE: number;
  814. /** Projection coordinates mode */
  815. static readonly TEXTURE_PROJECTION_MODE: number;
  816. /** Skybox coordinates mode */
  817. static readonly TEXTURE_SKYBOX_MODE: number;
  818. /** Inverse Cubic coordinates mode */
  819. static readonly TEXTURE_INVCUBIC_MODE: number;
  820. /** Equirectangular coordinates mode */
  821. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  822. /** Equirectangular Fixed coordinates mode */
  823. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  824. /** Equirectangular Fixed Mirrored coordinates mode */
  825. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  826. /** Offline (baking) quality for texture filtering */
  827. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  828. /** High quality for texture filtering */
  829. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  830. /** Medium quality for texture filtering */
  831. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  832. /** Low quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  834. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  835. static readonly SCALEMODE_FLOOR: number;
  836. /** Defines that texture rescaling will look for the nearest power of 2 size */
  837. static readonly SCALEMODE_NEAREST: number;
  838. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  839. static readonly SCALEMODE_CEILING: number;
  840. /**
  841. * The dirty texture flag value
  842. */
  843. static readonly MATERIAL_TextureDirtyFlag: number;
  844. /**
  845. * The dirty light flag value
  846. */
  847. static readonly MATERIAL_LightDirtyFlag: number;
  848. /**
  849. * The dirty fresnel flag value
  850. */
  851. static readonly MATERIAL_FresnelDirtyFlag: number;
  852. /**
  853. * The dirty attribute flag value
  854. */
  855. static readonly MATERIAL_AttributesDirtyFlag: number;
  856. /**
  857. * The dirty misc flag value
  858. */
  859. static readonly MATERIAL_MiscDirtyFlag: number;
  860. /**
  861. * The all dirty flag value
  862. */
  863. static readonly MATERIAL_AllDirtyFlag: number;
  864. /**
  865. * Returns the triangle fill mode
  866. */
  867. static readonly MATERIAL_TriangleFillMode: number;
  868. /**
  869. * Returns the wireframe mode
  870. */
  871. static readonly MATERIAL_WireFrameFillMode: number;
  872. /**
  873. * Returns the point fill mode
  874. */
  875. static readonly MATERIAL_PointFillMode: number;
  876. /**
  877. * Returns the point list draw mode
  878. */
  879. static readonly MATERIAL_PointListDrawMode: number;
  880. /**
  881. * Returns the line list draw mode
  882. */
  883. static readonly MATERIAL_LineListDrawMode: number;
  884. /**
  885. * Returns the line loop draw mode
  886. */
  887. static readonly MATERIAL_LineLoopDrawMode: number;
  888. /**
  889. * Returns the line strip draw mode
  890. */
  891. static readonly MATERIAL_LineStripDrawMode: number;
  892. /**
  893. * Returns the triangle strip draw mode
  894. */
  895. static readonly MATERIAL_TriangleStripDrawMode: number;
  896. /**
  897. * Returns the triangle fan draw mode
  898. */
  899. static readonly MATERIAL_TriangleFanDrawMode: number;
  900. /**
  901. * Stores the clock-wise side orientation
  902. */
  903. static readonly MATERIAL_ClockWiseSideOrientation: number;
  904. /**
  905. * Stores the counter clock-wise side orientation
  906. */
  907. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  908. /**
  909. * Nothing
  910. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_NothingTrigger: number;
  913. /**
  914. * On pick
  915. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnPickTrigger: number;
  918. /**
  919. * On left pick
  920. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnLeftPickTrigger: number;
  923. /**
  924. * On right pick
  925. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnRightPickTrigger: number;
  928. /**
  929. * On center pick
  930. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnCenterPickTrigger: number;
  933. /**
  934. * On pick down
  935. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  936. */
  937. static readonly ACTION_OnPickDownTrigger: number;
  938. /**
  939. * On double pick
  940. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  941. */
  942. static readonly ACTION_OnDoublePickTrigger: number;
  943. /**
  944. * On pick up
  945. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  946. */
  947. static readonly ACTION_OnPickUpTrigger: number;
  948. /**
  949. * On pick out.
  950. * This trigger will only be raised if you also declared a OnPickDown
  951. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPickOutTrigger: number;
  954. /**
  955. * On long press
  956. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnLongPressTrigger: number;
  959. /**
  960. * On pointer over
  961. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnPointerOverTrigger: number;
  964. /**
  965. * On pointer out
  966. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnPointerOutTrigger: number;
  969. /**
  970. * On every frame
  971. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnEveryFrameTrigger: number;
  974. /**
  975. * On intersection enter
  976. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnIntersectionEnterTrigger: number;
  979. /**
  980. * On intersection exit
  981. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  982. */
  983. static readonly ACTION_OnIntersectionExitTrigger: number;
  984. /**
  985. * On key down
  986. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  987. */
  988. static readonly ACTION_OnKeyDownTrigger: number;
  989. /**
  990. * On key up
  991. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  992. */
  993. static readonly ACTION_OnKeyUpTrigger: number;
  994. /**
  995. * Billboard mode will only apply to Y axis
  996. */
  997. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  998. /**
  999. * Billboard mode will apply to all axes
  1000. */
  1001. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1002. /**
  1003. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1004. */
  1005. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1006. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1007. * Test order :
  1008. * Is the bounding sphere outside the frustum ?
  1009. * If not, are the bounding box vertices outside the frustum ?
  1010. * It not, then the cullable object is in the frustum.
  1011. */
  1012. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1013. /** Culling strategy : Bounding Sphere Only.
  1014. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1015. * It's also less accurate than the standard because some not visible objects can still be selected.
  1016. * Test : is the bounding sphere outside the frustum ?
  1017. * If not, then the cullable object is in the frustum.
  1018. */
  1019. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1020. /** Culling strategy : Optimistic Inclusion.
  1021. * This in an inclusion test first, then the standard exclusion test.
  1022. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1023. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1024. * Anyway, it's as accurate as the standard strategy.
  1025. * Test :
  1026. * Is the cullable object bounding sphere center in the frustum ?
  1027. * If not, apply the default culling strategy.
  1028. */
  1029. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1030. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1031. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1032. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1033. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1034. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1035. * Test :
  1036. * Is the cullable object bounding sphere center in the frustum ?
  1037. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1038. */
  1039. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1040. /**
  1041. * No logging while loading
  1042. */
  1043. static readonly SCENELOADER_NO_LOGGING: number;
  1044. /**
  1045. * Minimal logging while loading
  1046. */
  1047. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1048. /**
  1049. * Summary logging while loading
  1050. */
  1051. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1052. /**
  1053. * Detailled logging while loading
  1054. */
  1055. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1056. }
  1057. }
  1058. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1059. import { Nullable } from "babylonjs/types";
  1060. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1061. /**
  1062. * This represents the required contract to create a new type of texture loader.
  1063. */
  1064. export interface IInternalTextureLoader {
  1065. /**
  1066. * Defines wether the loader supports cascade loading the different faces.
  1067. */
  1068. supportCascades: boolean;
  1069. /**
  1070. * This returns if the loader support the current file information.
  1071. * @param extension defines the file extension of the file being loaded
  1072. * @returns true if the loader can load the specified file
  1073. */
  1074. canLoad(extension: string): boolean;
  1075. /**
  1076. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1077. * @param data contains the texture data
  1078. * @param texture defines the BabylonJS internal texture
  1079. * @param createPolynomials will be true if polynomials have been requested
  1080. * @param onLoad defines the callback to trigger once the texture is ready
  1081. * @param onError defines the callback to trigger in case of error
  1082. */
  1083. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1084. /**
  1085. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1086. * @param data contains the texture data
  1087. * @param texture defines the BabylonJS internal texture
  1088. * @param callback defines the method to call once ready to upload
  1089. */
  1090. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1091. }
  1092. }
  1093. declare module "babylonjs/Engines/IPipelineContext" {
  1094. /**
  1095. * Class used to store and describe the pipeline context associated with an effect
  1096. */
  1097. export interface IPipelineContext {
  1098. /**
  1099. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1100. */
  1101. isAsync: boolean;
  1102. /**
  1103. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1104. */
  1105. isReady: boolean;
  1106. /** @hidden */
  1107. _getVertexShaderCode(): string | null;
  1108. /** @hidden */
  1109. _getFragmentShaderCode(): string | null;
  1110. /** @hidden */
  1111. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1112. }
  1113. }
  1114. declare module "babylonjs/Meshes/dataBuffer" {
  1115. /**
  1116. * Class used to store gfx data (like WebGLBuffer)
  1117. */
  1118. export class DataBuffer {
  1119. /**
  1120. * Gets or sets the number of objects referencing this buffer
  1121. */
  1122. references: number;
  1123. /** Gets or sets the size of the underlying buffer */
  1124. capacity: number;
  1125. /**
  1126. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1127. */
  1128. is32Bits: boolean;
  1129. /**
  1130. * Gets the underlying buffer
  1131. */
  1132. get underlyingResource(): any;
  1133. }
  1134. }
  1135. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1136. /** @hidden */
  1137. export interface IShaderProcessor {
  1138. attributeProcessor?: (attribute: string) => string;
  1139. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1140. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1141. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1142. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1143. lineProcessor?: (line: string, isFragment: boolean) => string;
  1144. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1145. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1146. }
  1147. }
  1148. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1149. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1150. /** @hidden */
  1151. export interface ProcessingOptions {
  1152. defines: string[];
  1153. indexParameters: any;
  1154. isFragment: boolean;
  1155. shouldUseHighPrecisionShader: boolean;
  1156. supportsUniformBuffers: boolean;
  1157. shadersRepository: string;
  1158. includesShadersStore: {
  1159. [key: string]: string;
  1160. };
  1161. processor?: IShaderProcessor;
  1162. version: string;
  1163. platformName: string;
  1164. lookForClosingBracketForUniformBuffer?: boolean;
  1165. }
  1166. }
  1167. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1168. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1169. /** @hidden */
  1170. export class ShaderCodeNode {
  1171. line: string;
  1172. children: ShaderCodeNode[];
  1173. additionalDefineKey?: string;
  1174. additionalDefineValue?: string;
  1175. isValid(preprocessors: {
  1176. [key: string]: string;
  1177. }): boolean;
  1178. process(preprocessors: {
  1179. [key: string]: string;
  1180. }, options: ProcessingOptions): string;
  1181. }
  1182. }
  1183. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1184. /** @hidden */
  1185. export class ShaderCodeCursor {
  1186. private _lines;
  1187. lineIndex: number;
  1188. get currentLine(): string;
  1189. get canRead(): boolean;
  1190. set lines(value: string[]);
  1191. }
  1192. }
  1193. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1194. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1195. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1196. /** @hidden */
  1197. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1198. process(preprocessors: {
  1199. [key: string]: string;
  1200. }, options: ProcessingOptions): string;
  1201. }
  1202. }
  1203. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1204. /** @hidden */
  1205. export class ShaderDefineExpression {
  1206. isTrue(preprocessors: {
  1207. [key: string]: string;
  1208. }): boolean;
  1209. private static _OperatorPriority;
  1210. private static _Stack;
  1211. static postfixToInfix(postfix: string[]): string;
  1212. static infixToPostfix(infix: string): string[];
  1213. }
  1214. }
  1215. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1216. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1217. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1218. /** @hidden */
  1219. export class ShaderCodeTestNode extends ShaderCodeNode {
  1220. testExpression: ShaderDefineExpression;
  1221. isValid(preprocessors: {
  1222. [key: string]: string;
  1223. }): boolean;
  1224. }
  1225. }
  1226. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1227. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1228. /** @hidden */
  1229. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1230. define: string;
  1231. not: boolean;
  1232. constructor(define: string, not?: boolean);
  1233. isTrue(preprocessors: {
  1234. [key: string]: string;
  1235. }): boolean;
  1236. }
  1237. }
  1238. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1239. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1240. /** @hidden */
  1241. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1242. leftOperand: ShaderDefineExpression;
  1243. rightOperand: ShaderDefineExpression;
  1244. isTrue(preprocessors: {
  1245. [key: string]: string;
  1246. }): boolean;
  1247. }
  1248. }
  1249. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1250. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1251. /** @hidden */
  1252. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1253. leftOperand: ShaderDefineExpression;
  1254. rightOperand: ShaderDefineExpression;
  1255. isTrue(preprocessors: {
  1256. [key: string]: string;
  1257. }): boolean;
  1258. }
  1259. }
  1260. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1261. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1262. /** @hidden */
  1263. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1264. define: string;
  1265. operand: string;
  1266. testValue: string;
  1267. constructor(define: string, operand: string, testValue: string);
  1268. isTrue(preprocessors: {
  1269. [key: string]: string;
  1270. }): boolean;
  1271. }
  1272. }
  1273. declare module "babylonjs/Offline/IOfflineProvider" {
  1274. /**
  1275. * Class used to enable access to offline support
  1276. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1277. */
  1278. export interface IOfflineProvider {
  1279. /**
  1280. * Gets a boolean indicating if scene must be saved in the database
  1281. */
  1282. enableSceneOffline: boolean;
  1283. /**
  1284. * Gets a boolean indicating if textures must be saved in the database
  1285. */
  1286. enableTexturesOffline: boolean;
  1287. /**
  1288. * Open the offline support and make it available
  1289. * @param successCallback defines the callback to call on success
  1290. * @param errorCallback defines the callback to call on error
  1291. */
  1292. open(successCallback: () => void, errorCallback: () => void): void;
  1293. /**
  1294. * Loads an image from the offline support
  1295. * @param url defines the url to load from
  1296. * @param image defines the target DOM image
  1297. */
  1298. loadImage(url: string, image: HTMLImageElement): void;
  1299. /**
  1300. * Loads a file from offline support
  1301. * @param url defines the URL to load from
  1302. * @param sceneLoaded defines a callback to call on success
  1303. * @param progressCallBack defines a callback to call when progress changed
  1304. * @param errorCallback defines a callback to call on error
  1305. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1306. */
  1307. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1308. }
  1309. }
  1310. declare module "babylonjs/Misc/filesInputStore" {
  1311. /**
  1312. * Class used to help managing file picking and drag'n'drop
  1313. * File Storage
  1314. */
  1315. export class FilesInputStore {
  1316. /**
  1317. * List of files ready to be loaded
  1318. */
  1319. static FilesToLoad: {
  1320. [key: string]: File;
  1321. };
  1322. }
  1323. }
  1324. declare module "babylonjs/Misc/retryStrategy" {
  1325. import { WebRequest } from "babylonjs/Misc/webRequest";
  1326. /**
  1327. * Class used to define a retry strategy when error happens while loading assets
  1328. */
  1329. export class RetryStrategy {
  1330. /**
  1331. * Function used to defines an exponential back off strategy
  1332. * @param maxRetries defines the maximum number of retries (3 by default)
  1333. * @param baseInterval defines the interval between retries
  1334. * @returns the strategy function to use
  1335. */
  1336. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1337. }
  1338. }
  1339. declare module "babylonjs/Misc/baseError" {
  1340. /**
  1341. * @ignore
  1342. * Application error to support additional information when loading a file
  1343. */
  1344. export abstract class BaseError extends Error {
  1345. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1346. }
  1347. }
  1348. declare module "babylonjs/Misc/fileTools" {
  1349. import { WebRequest } from "babylonjs/Misc/webRequest";
  1350. import { Nullable } from "babylonjs/types";
  1351. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1352. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1353. import { BaseError } from "babylonjs/Misc/baseError";
  1354. /** @ignore */
  1355. export class LoadFileError extends BaseError {
  1356. request?: WebRequest;
  1357. file?: File;
  1358. /**
  1359. * Creates a new LoadFileError
  1360. * @param message defines the message of the error
  1361. * @param request defines the optional web request
  1362. * @param file defines the optional file
  1363. */
  1364. constructor(message: string, object?: WebRequest | File);
  1365. }
  1366. /** @ignore */
  1367. export class RequestFileError extends BaseError {
  1368. request: WebRequest;
  1369. /**
  1370. * Creates a new LoadFileError
  1371. * @param message defines the message of the error
  1372. * @param request defines the optional web request
  1373. */
  1374. constructor(message: string, request: WebRequest);
  1375. }
  1376. /** @ignore */
  1377. export class ReadFileError extends BaseError {
  1378. file: File;
  1379. /**
  1380. * Creates a new ReadFileError
  1381. * @param message defines the message of the error
  1382. * @param file defines the optional file
  1383. */
  1384. constructor(message: string, file: File);
  1385. }
  1386. /**
  1387. * @hidden
  1388. */
  1389. export class FileTools {
  1390. /**
  1391. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1392. */
  1393. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1394. /**
  1395. * Gets or sets the base URL to use to load assets
  1396. */
  1397. static BaseUrl: string;
  1398. /**
  1399. * Default behaviour for cors in the application.
  1400. * It can be a string if the expected behavior is identical in the entire app.
  1401. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1402. */
  1403. static CorsBehavior: string | ((url: string | string[]) => string);
  1404. /**
  1405. * Gets or sets a function used to pre-process url before using them to load assets
  1406. */
  1407. static PreprocessUrl: (url: string) => string;
  1408. /**
  1409. * Removes unwanted characters from an url
  1410. * @param url defines the url to clean
  1411. * @returns the cleaned url
  1412. */
  1413. private static _CleanUrl;
  1414. /**
  1415. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1416. * @param url define the url we are trying
  1417. * @param element define the dom element where to configure the cors policy
  1418. */
  1419. static SetCorsBehavior(url: string | string[], element: {
  1420. crossOrigin: string | null;
  1421. }): void;
  1422. /**
  1423. * Loads an image as an HTMLImageElement.
  1424. * @param input url string, ArrayBuffer, or Blob to load
  1425. * @param onLoad callback called when the image successfully loads
  1426. * @param onError callback called when the image fails to load
  1427. * @param offlineProvider offline provider for caching
  1428. * @param mimeType optional mime type
  1429. * @returns the HTMLImageElement of the loaded image
  1430. */
  1431. 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>;
  1432. /**
  1433. * Reads a file from a File object
  1434. * @param file defines the file to load
  1435. * @param onSuccess defines the callback to call when data is loaded
  1436. * @param onProgress defines the callback to call during loading process
  1437. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1438. * @param onError defines the callback to call when an error occurs
  1439. * @returns a file request object
  1440. */
  1441. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1442. /**
  1443. * Loads a file from a url
  1444. * @param url url to load
  1445. * @param onSuccess callback called when the file successfully loads
  1446. * @param onProgress callback called while file is loading (if the server supports this mode)
  1447. * @param offlineProvider defines the offline provider for caching
  1448. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1449. * @param onError callback called when the file fails to load
  1450. * @returns a file request object
  1451. */
  1452. 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;
  1453. /**
  1454. * Loads a file
  1455. * @param url url to load
  1456. * @param onSuccess callback called when the file successfully loads
  1457. * @param onProgress callback called while file is loading (if the server supports this mode)
  1458. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1459. * @param onError callback called when the file fails to load
  1460. * @param onOpened callback called when the web request is opened
  1461. * @returns a file request object
  1462. */
  1463. 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;
  1464. /**
  1465. * Checks if the loaded document was accessed via `file:`-Protocol.
  1466. * @returns boolean
  1467. */
  1468. static IsFileURL(): boolean;
  1469. }
  1470. }
  1471. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1472. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1473. import { WebRequest } from "babylonjs/Misc/webRequest";
  1474. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1475. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1476. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1477. /** @hidden */
  1478. export class ShaderProcessor {
  1479. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1480. private static _ProcessPrecision;
  1481. private static _ExtractOperation;
  1482. private static _BuildSubExpression;
  1483. private static _BuildExpression;
  1484. private static _MoveCursorWithinIf;
  1485. private static _MoveCursor;
  1486. private static _EvaluatePreProcessors;
  1487. private static _PreparePreProcessors;
  1488. private static _ProcessShaderConversion;
  1489. private static _ProcessIncludes;
  1490. /**
  1491. * Loads a file from a url
  1492. * @param url url to load
  1493. * @param onSuccess callback called when the file successfully loads
  1494. * @param onProgress callback called while file is loading (if the server supports this mode)
  1495. * @param offlineProvider defines the offline provider for caching
  1496. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1497. * @param onError callback called when the file fails to load
  1498. * @returns a file request object
  1499. * @hidden
  1500. */
  1501. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1502. }
  1503. }
  1504. declare module "babylonjs/Maths/math.like" {
  1505. import { float, int, DeepImmutable } from "babylonjs/types";
  1506. /**
  1507. * @hidden
  1508. */
  1509. export interface IColor4Like {
  1510. r: float;
  1511. g: float;
  1512. b: float;
  1513. a: float;
  1514. }
  1515. /**
  1516. * @hidden
  1517. */
  1518. export interface IColor3Like {
  1519. r: float;
  1520. g: float;
  1521. b: float;
  1522. }
  1523. /**
  1524. * @hidden
  1525. */
  1526. export interface IVector4Like {
  1527. x: float;
  1528. y: float;
  1529. z: float;
  1530. w: float;
  1531. }
  1532. /**
  1533. * @hidden
  1534. */
  1535. export interface IVector3Like {
  1536. x: float;
  1537. y: float;
  1538. z: float;
  1539. }
  1540. /**
  1541. * @hidden
  1542. */
  1543. export interface IVector2Like {
  1544. x: float;
  1545. y: float;
  1546. }
  1547. /**
  1548. * @hidden
  1549. */
  1550. export interface IMatrixLike {
  1551. toArray(): DeepImmutable<Float32Array>;
  1552. updateFlag: int;
  1553. }
  1554. /**
  1555. * @hidden
  1556. */
  1557. export interface IViewportLike {
  1558. x: float;
  1559. y: float;
  1560. width: float;
  1561. height: float;
  1562. }
  1563. /**
  1564. * @hidden
  1565. */
  1566. export interface IPlaneLike {
  1567. normal: IVector3Like;
  1568. d: float;
  1569. normalize(): void;
  1570. }
  1571. }
  1572. declare module "babylonjs/Materials/iEffectFallbacks" {
  1573. import { Effect } from "babylonjs/Materials/effect";
  1574. /**
  1575. * Interface used to define common properties for effect fallbacks
  1576. */
  1577. export interface IEffectFallbacks {
  1578. /**
  1579. * Removes the defines that should be removed when falling back.
  1580. * @param currentDefines defines the current define statements for the shader.
  1581. * @param effect defines the current effect we try to compile
  1582. * @returns The resulting defines with defines of the current rank removed.
  1583. */
  1584. reduce(currentDefines: string, effect: Effect): string;
  1585. /**
  1586. * Removes the fallback from the bound mesh.
  1587. */
  1588. unBindMesh(): void;
  1589. /**
  1590. * Checks to see if more fallbacks are still availible.
  1591. */
  1592. hasMoreFallbacks: boolean;
  1593. }
  1594. }
  1595. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1596. /**
  1597. * Class used to evalaute queries containing `and` and `or` operators
  1598. */
  1599. export class AndOrNotEvaluator {
  1600. /**
  1601. * Evaluate a query
  1602. * @param query defines the query to evaluate
  1603. * @param evaluateCallback defines the callback used to filter result
  1604. * @returns true if the query matches
  1605. */
  1606. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1607. private static _HandleParenthesisContent;
  1608. private static _SimplifyNegation;
  1609. }
  1610. }
  1611. declare module "babylonjs/Misc/tags" {
  1612. /**
  1613. * Class used to store custom tags
  1614. */
  1615. export class Tags {
  1616. /**
  1617. * Adds support for tags on the given object
  1618. * @param obj defines the object to use
  1619. */
  1620. static EnableFor(obj: any): void;
  1621. /**
  1622. * Removes tags support
  1623. * @param obj defines the object to use
  1624. */
  1625. static DisableFor(obj: any): void;
  1626. /**
  1627. * Gets a boolean indicating if the given object has tags
  1628. * @param obj defines the object to use
  1629. * @returns a boolean
  1630. */
  1631. static HasTags(obj: any): boolean;
  1632. /**
  1633. * Gets the tags available on a given object
  1634. * @param obj defines the object to use
  1635. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1636. * @returns the tags
  1637. */
  1638. static GetTags(obj: any, asString?: boolean): any;
  1639. /**
  1640. * Adds tags to an object
  1641. * @param obj defines the object to use
  1642. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1643. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1644. */
  1645. static AddTagsTo(obj: any, tagsString: string): void;
  1646. /**
  1647. * @hidden
  1648. */
  1649. static _AddTagTo(obj: any, tag: string): void;
  1650. /**
  1651. * Removes specific tags from a specific object
  1652. * @param obj defines the object to use
  1653. * @param tagsString defines the tags to remove
  1654. */
  1655. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1656. /**
  1657. * @hidden
  1658. */
  1659. static _RemoveTagFrom(obj: any, tag: string): void;
  1660. /**
  1661. * Defines if tags hosted on an object match a given query
  1662. * @param obj defines the object to use
  1663. * @param tagsQuery defines the tag query
  1664. * @returns a boolean
  1665. */
  1666. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1667. }
  1668. }
  1669. declare module "babylonjs/Maths/math.scalar" {
  1670. /**
  1671. * Scalar computation library
  1672. */
  1673. export class Scalar {
  1674. /**
  1675. * Two pi constants convenient for computation.
  1676. */
  1677. static TwoPi: number;
  1678. /**
  1679. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1680. * @param a number
  1681. * @param b number
  1682. * @param epsilon (default = 1.401298E-45)
  1683. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1684. */
  1685. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1686. /**
  1687. * Returns a string : the upper case translation of the number i to hexadecimal.
  1688. * @param i number
  1689. * @returns the upper case translation of the number i to hexadecimal.
  1690. */
  1691. static ToHex(i: number): string;
  1692. /**
  1693. * Returns -1 if value is negative and +1 is value is positive.
  1694. * @param value the value
  1695. * @returns the value itself if it's equal to zero.
  1696. */
  1697. static Sign(value: number): number;
  1698. /**
  1699. * Returns the value itself if it's between min and max.
  1700. * Returns min if the value is lower than min.
  1701. * Returns max if the value is greater than max.
  1702. * @param value the value to clmap
  1703. * @param min the min value to clamp to (default: 0)
  1704. * @param max the max value to clamp to (default: 1)
  1705. * @returns the clamped value
  1706. */
  1707. static Clamp(value: number, min?: number, max?: number): number;
  1708. /**
  1709. * the log2 of value.
  1710. * @param value the value to compute log2 of
  1711. * @returns the log2 of value.
  1712. */
  1713. static Log2(value: number): number;
  1714. /**
  1715. * Loops the value, so that it is never larger than length and never smaller than 0.
  1716. *
  1717. * This is similar to the modulo operator but it works with floating point numbers.
  1718. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1719. * With t = 5 and length = 2.5, the result would be 0.0.
  1720. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1721. * @param value the value
  1722. * @param length the length
  1723. * @returns the looped value
  1724. */
  1725. static Repeat(value: number, length: number): number;
  1726. /**
  1727. * Normalize the value between 0.0 and 1.0 using min and max values
  1728. * @param value value to normalize
  1729. * @param min max to normalize between
  1730. * @param max min to normalize between
  1731. * @returns the normalized value
  1732. */
  1733. static Normalize(value: number, min: number, max: number): number;
  1734. /**
  1735. * Denormalize the value from 0.0 and 1.0 using min and max values
  1736. * @param normalized value to denormalize
  1737. * @param min max to denormalize between
  1738. * @param max min to denormalize between
  1739. * @returns the denormalized value
  1740. */
  1741. static Denormalize(normalized: number, min: number, max: number): number;
  1742. /**
  1743. * Calculates the shortest difference between two given angles given in degrees.
  1744. * @param current current angle in degrees
  1745. * @param target target angle in degrees
  1746. * @returns the delta
  1747. */
  1748. static DeltaAngle(current: number, target: number): number;
  1749. /**
  1750. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1751. * @param tx value
  1752. * @param length length
  1753. * @returns The returned value will move back and forth between 0 and length
  1754. */
  1755. static PingPong(tx: number, length: number): number;
  1756. /**
  1757. * Interpolates between min and max with smoothing at the limits.
  1758. *
  1759. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1760. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1761. * @param from from
  1762. * @param to to
  1763. * @param tx value
  1764. * @returns the smooth stepped value
  1765. */
  1766. static SmoothStep(from: number, to: number, tx: number): number;
  1767. /**
  1768. * Moves a value current towards target.
  1769. *
  1770. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1771. * Negative values of maxDelta pushes the value away from target.
  1772. * @param current current value
  1773. * @param target target value
  1774. * @param maxDelta max distance to move
  1775. * @returns resulting value
  1776. */
  1777. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1778. /**
  1779. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1780. *
  1781. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1782. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1783. * @param current current value
  1784. * @param target target value
  1785. * @param maxDelta max distance to move
  1786. * @returns resulting angle
  1787. */
  1788. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1789. /**
  1790. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1791. * @param start start value
  1792. * @param end target value
  1793. * @param amount amount to lerp between
  1794. * @returns the lerped value
  1795. */
  1796. static Lerp(start: number, end: number, amount: number): number;
  1797. /**
  1798. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1799. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1800. * @param start start value
  1801. * @param end target value
  1802. * @param amount amount to lerp between
  1803. * @returns the lerped value
  1804. */
  1805. static LerpAngle(start: number, end: number, amount: number): number;
  1806. /**
  1807. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1808. * @param a start value
  1809. * @param b target value
  1810. * @param value value between a and b
  1811. * @returns the inverseLerp value
  1812. */
  1813. static InverseLerp(a: number, b: number, value: number): number;
  1814. /**
  1815. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1816. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1817. * @param value1 spline value
  1818. * @param tangent1 spline value
  1819. * @param value2 spline value
  1820. * @param tangent2 spline value
  1821. * @param amount input value
  1822. * @returns hermite result
  1823. */
  1824. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1825. /**
  1826. * Returns a random float number between and min and max values
  1827. * @param min min value of random
  1828. * @param max max value of random
  1829. * @returns random value
  1830. */
  1831. static RandomRange(min: number, max: number): number;
  1832. /**
  1833. * This function returns percentage of a number in a given range.
  1834. *
  1835. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1836. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1837. * @param number to convert to percentage
  1838. * @param min min range
  1839. * @param max max range
  1840. * @returns the percentage
  1841. */
  1842. static RangeToPercent(number: number, min: number, max: number): number;
  1843. /**
  1844. * This function returns number that corresponds to the percentage in a given range.
  1845. *
  1846. * PercentToRange(0.34,0,100) will return 34.
  1847. * @param percent to convert to number
  1848. * @param min min range
  1849. * @param max max range
  1850. * @returns the number
  1851. */
  1852. static PercentToRange(percent: number, min: number, max: number): number;
  1853. /**
  1854. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1855. * @param angle The angle to normalize in radian.
  1856. * @return The converted angle.
  1857. */
  1858. static NormalizeRadians(angle: number): number;
  1859. }
  1860. }
  1861. declare module "babylonjs/Maths/math.constants" {
  1862. /**
  1863. * Constant used to convert a value to gamma space
  1864. * @ignorenaming
  1865. */
  1866. export const ToGammaSpace: number;
  1867. /**
  1868. * Constant used to convert a value to linear space
  1869. * @ignorenaming
  1870. */
  1871. export const ToLinearSpace = 2.2;
  1872. /**
  1873. * Constant used to define the minimal number value in Babylon.js
  1874. * @ignorenaming
  1875. */
  1876. let Epsilon: number;
  1877. export { Epsilon };
  1878. }
  1879. declare module "babylonjs/Maths/math.viewport" {
  1880. /**
  1881. * Class used to represent a viewport on screen
  1882. */
  1883. export class Viewport {
  1884. /** viewport left coordinate */
  1885. x: number;
  1886. /** viewport top coordinate */
  1887. y: number;
  1888. /**viewport width */
  1889. width: number;
  1890. /** viewport height */
  1891. height: number;
  1892. /**
  1893. * Creates a Viewport object located at (x, y) and sized (width, height)
  1894. * @param x defines viewport left coordinate
  1895. * @param y defines viewport top coordinate
  1896. * @param width defines the viewport width
  1897. * @param height defines the viewport height
  1898. */
  1899. constructor(
  1900. /** viewport left coordinate */
  1901. x: number,
  1902. /** viewport top coordinate */
  1903. y: number,
  1904. /**viewport width */
  1905. width: number,
  1906. /** viewport height */
  1907. height: number);
  1908. /**
  1909. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1910. * @param renderWidth defines the rendering width
  1911. * @param renderHeight defines the rendering height
  1912. * @returns a new Viewport
  1913. */
  1914. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1915. /**
  1916. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1917. * @param renderWidth defines the rendering width
  1918. * @param renderHeight defines the rendering height
  1919. * @param ref defines the target viewport
  1920. * @returns the current viewport
  1921. */
  1922. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1923. /**
  1924. * Returns a new Viewport copied from the current one
  1925. * @returns a new Viewport
  1926. */
  1927. clone(): Viewport;
  1928. }
  1929. }
  1930. declare module "babylonjs/Misc/arrayTools" {
  1931. /**
  1932. * Class containing a set of static utilities functions for arrays.
  1933. */
  1934. export class ArrayTools {
  1935. /**
  1936. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1937. * @param size the number of element to construct and put in the array
  1938. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1939. * @returns a new array filled with new objects
  1940. */
  1941. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1942. }
  1943. }
  1944. declare module "babylonjs/Maths/math.plane" {
  1945. import { DeepImmutable } from "babylonjs/types";
  1946. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1947. /**
  1948. * Represents a plane by the equation ax + by + cz + d = 0
  1949. */
  1950. export class Plane {
  1951. private static _TmpMatrix;
  1952. /**
  1953. * Normal of the plane (a,b,c)
  1954. */
  1955. normal: Vector3;
  1956. /**
  1957. * d component of the plane
  1958. */
  1959. d: number;
  1960. /**
  1961. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  1962. * @param a a component of the plane
  1963. * @param b b component of the plane
  1964. * @param c c component of the plane
  1965. * @param d d component of the plane
  1966. */
  1967. constructor(a: number, b: number, c: number, d: number);
  1968. /**
  1969. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  1970. */
  1971. asArray(): number[];
  1972. /**
  1973. * @returns a new plane copied from the current Plane.
  1974. */
  1975. clone(): Plane;
  1976. /**
  1977. * @returns the string "Plane".
  1978. */
  1979. getClassName(): string;
  1980. /**
  1981. * @returns the Plane hash code.
  1982. */
  1983. getHashCode(): number;
  1984. /**
  1985. * Normalize the current Plane in place.
  1986. * @returns the updated Plane.
  1987. */
  1988. normalize(): Plane;
  1989. /**
  1990. * Applies a transformation the plane and returns the result
  1991. * @param transformation the transformation matrix to be applied to the plane
  1992. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  1993. */
  1994. transform(transformation: DeepImmutable<Matrix>): Plane;
  1995. /**
  1996. * Compute the dot product between the point and the plane normal
  1997. * @param point point to calculate the dot product with
  1998. * @returns the dot product (float) of the point coordinates and the plane normal.
  1999. */
  2000. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2001. /**
  2002. * Updates the current Plane from the plane defined by the three given points.
  2003. * @param point1 one of the points used to contruct the plane
  2004. * @param point2 one of the points used to contruct the plane
  2005. * @param point3 one of the points used to contruct the plane
  2006. * @returns the updated Plane.
  2007. */
  2008. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2009. /**
  2010. * Checks if the plane is facing a given direction
  2011. * @param direction the direction to check if the plane is facing
  2012. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2013. * @returns True is the vector "direction" is the same side than the plane normal.
  2014. */
  2015. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2016. /**
  2017. * Calculates the distance to a point
  2018. * @param point point to calculate distance to
  2019. * @returns the signed distance (float) from the given point to the Plane.
  2020. */
  2021. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2022. /**
  2023. * Creates a plane from an array
  2024. * @param array the array to create a plane from
  2025. * @returns a new Plane from the given array.
  2026. */
  2027. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2028. /**
  2029. * Creates a plane from three points
  2030. * @param point1 point used to create the plane
  2031. * @param point2 point used to create the plane
  2032. * @param point3 point used to create the plane
  2033. * @returns a new Plane defined by the three given points.
  2034. */
  2035. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2036. /**
  2037. * Creates a plane from an origin point and a normal
  2038. * @param origin origin of the plane to be constructed
  2039. * @param normal normal of the plane to be constructed
  2040. * @returns a new Plane the normal vector to this plane at the given origin point.
  2041. * Note : the vector "normal" is updated because normalized.
  2042. */
  2043. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2044. /**
  2045. * Calculates the distance from a plane and a point
  2046. * @param origin origin of the plane to be constructed
  2047. * @param normal normal of the plane to be constructed
  2048. * @param point point to calculate distance to
  2049. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2050. */
  2051. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2052. }
  2053. }
  2054. declare module "babylonjs/Maths/math.vector" {
  2055. import { Viewport } from "babylonjs/Maths/math.viewport";
  2056. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2057. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2058. import { Plane } from "babylonjs/Maths/math.plane";
  2059. /**
  2060. * Class representing a vector containing 2 coordinates
  2061. */
  2062. export class Vector2 {
  2063. /** defines the first coordinate */
  2064. x: number;
  2065. /** defines the second coordinate */
  2066. y: number;
  2067. /**
  2068. * Creates a new Vector2 from the given x and y coordinates
  2069. * @param x defines the first coordinate
  2070. * @param y defines the second coordinate
  2071. */
  2072. constructor(
  2073. /** defines the first coordinate */
  2074. x?: number,
  2075. /** defines the second coordinate */
  2076. y?: number);
  2077. /**
  2078. * Gets a string with the Vector2 coordinates
  2079. * @returns a string with the Vector2 coordinates
  2080. */
  2081. toString(): string;
  2082. /**
  2083. * Gets class name
  2084. * @returns the string "Vector2"
  2085. */
  2086. getClassName(): string;
  2087. /**
  2088. * Gets current vector hash code
  2089. * @returns the Vector2 hash code as a number
  2090. */
  2091. getHashCode(): number;
  2092. /**
  2093. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2094. * @param array defines the source array
  2095. * @param index defines the offset in source array
  2096. * @returns the current Vector2
  2097. */
  2098. toArray(array: FloatArray, index?: number): Vector2;
  2099. /**
  2100. * Copy the current vector to an array
  2101. * @returns a new array with 2 elements: the Vector2 coordinates.
  2102. */
  2103. asArray(): number[];
  2104. /**
  2105. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2106. * @param source defines the source Vector2
  2107. * @returns the current updated Vector2
  2108. */
  2109. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2110. /**
  2111. * Sets the Vector2 coordinates with the given floats
  2112. * @param x defines the first coordinate
  2113. * @param y defines the second coordinate
  2114. * @returns the current updated Vector2
  2115. */
  2116. copyFromFloats(x: number, y: number): Vector2;
  2117. /**
  2118. * Sets the Vector2 coordinates with the given floats
  2119. * @param x defines the first coordinate
  2120. * @param y defines the second coordinate
  2121. * @returns the current updated Vector2
  2122. */
  2123. set(x: number, y: number): Vector2;
  2124. /**
  2125. * Add another vector with the current one
  2126. * @param otherVector defines the other vector
  2127. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2128. */
  2129. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2130. /**
  2131. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2132. * @param otherVector defines the other vector
  2133. * @param result defines the target vector
  2134. * @returns the unmodified current Vector2
  2135. */
  2136. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2137. /**
  2138. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2139. * @param otherVector defines the other vector
  2140. * @returns the current updated Vector2
  2141. */
  2142. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2143. /**
  2144. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2145. * @param otherVector defines the other vector
  2146. * @returns a new Vector2
  2147. */
  2148. addVector3(otherVector: Vector3): Vector2;
  2149. /**
  2150. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2151. * @param otherVector defines the other vector
  2152. * @returns a new Vector2
  2153. */
  2154. subtract(otherVector: Vector2): Vector2;
  2155. /**
  2156. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2157. * @param otherVector defines the other vector
  2158. * @param result defines the target vector
  2159. * @returns the unmodified current Vector2
  2160. */
  2161. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2162. /**
  2163. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2164. * @param otherVector defines the other vector
  2165. * @returns the current updated Vector2
  2166. */
  2167. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2168. /**
  2169. * Multiplies in place the current Vector2 coordinates by the given ones
  2170. * @param otherVector defines the other vector
  2171. * @returns the current updated Vector2
  2172. */
  2173. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2174. /**
  2175. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2176. * @param otherVector defines the other vector
  2177. * @returns a new Vector2
  2178. */
  2179. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2180. /**
  2181. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2182. * @param otherVector defines the other vector
  2183. * @param result defines the target vector
  2184. * @returns the unmodified current Vector2
  2185. */
  2186. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2187. /**
  2188. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2189. * @param x defines the first coordinate
  2190. * @param y defines the second coordinate
  2191. * @returns a new Vector2
  2192. */
  2193. multiplyByFloats(x: number, y: number): Vector2;
  2194. /**
  2195. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2196. * @param otherVector defines the other vector
  2197. * @returns a new Vector2
  2198. */
  2199. divide(otherVector: Vector2): Vector2;
  2200. /**
  2201. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2202. * @param otherVector defines the other vector
  2203. * @param result defines the target vector
  2204. * @returns the unmodified current Vector2
  2205. */
  2206. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2207. /**
  2208. * Divides the current Vector2 coordinates by the given ones
  2209. * @param otherVector defines the other vector
  2210. * @returns the current updated Vector2
  2211. */
  2212. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2213. /**
  2214. * Gets a new Vector2 with current Vector2 negated coordinates
  2215. * @returns a new Vector2
  2216. */
  2217. negate(): Vector2;
  2218. /**
  2219. * Negate this vector in place
  2220. * @returns this
  2221. */
  2222. negateInPlace(): Vector2;
  2223. /**
  2224. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2225. * @param result defines the Vector3 object where to store the result
  2226. * @returns the current Vector2
  2227. */
  2228. negateToRef(result: Vector2): Vector2;
  2229. /**
  2230. * Multiply the Vector2 coordinates by scale
  2231. * @param scale defines the scaling factor
  2232. * @returns the current updated Vector2
  2233. */
  2234. scaleInPlace(scale: number): Vector2;
  2235. /**
  2236. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2237. * @param scale defines the scaling factor
  2238. * @returns a new Vector2
  2239. */
  2240. scale(scale: number): Vector2;
  2241. /**
  2242. * Scale the current Vector2 values by a factor to a given Vector2
  2243. * @param scale defines the scale factor
  2244. * @param result defines the Vector2 object where to store the result
  2245. * @returns the unmodified current Vector2
  2246. */
  2247. scaleToRef(scale: number, result: Vector2): Vector2;
  2248. /**
  2249. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2250. * @param scale defines the scale factor
  2251. * @param result defines the Vector2 object where to store the result
  2252. * @returns the unmodified current Vector2
  2253. */
  2254. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2255. /**
  2256. * Gets a boolean if two vectors are equals
  2257. * @param otherVector defines the other vector
  2258. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2259. */
  2260. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2261. /**
  2262. * Gets a boolean if two vectors are equals (using an epsilon value)
  2263. * @param otherVector defines the other vector
  2264. * @param epsilon defines the minimal distance to consider equality
  2265. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2266. */
  2267. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2268. /**
  2269. * Gets a new Vector2 from current Vector2 floored values
  2270. * @returns a new Vector2
  2271. */
  2272. floor(): Vector2;
  2273. /**
  2274. * Gets a new Vector2 from current Vector2 floored values
  2275. * @returns a new Vector2
  2276. */
  2277. fract(): Vector2;
  2278. /**
  2279. * Gets the length of the vector
  2280. * @returns the vector length (float)
  2281. */
  2282. length(): number;
  2283. /**
  2284. * Gets the vector squared length
  2285. * @returns the vector squared length (float)
  2286. */
  2287. lengthSquared(): number;
  2288. /**
  2289. * Normalize the vector
  2290. * @returns the current updated Vector2
  2291. */
  2292. normalize(): Vector2;
  2293. /**
  2294. * Gets a new Vector2 copied from the Vector2
  2295. * @returns a new Vector2
  2296. */
  2297. clone(): Vector2;
  2298. /**
  2299. * Gets a new Vector2(0, 0)
  2300. * @returns a new Vector2
  2301. */
  2302. static Zero(): Vector2;
  2303. /**
  2304. * Gets a new Vector2(1, 1)
  2305. * @returns a new Vector2
  2306. */
  2307. static One(): Vector2;
  2308. /**
  2309. * Gets a new Vector2 set from the given index element of the given array
  2310. * @param array defines the data source
  2311. * @param offset defines the offset in the data source
  2312. * @returns a new Vector2
  2313. */
  2314. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2315. /**
  2316. * Sets "result" from the given index element of the given array
  2317. * @param array defines the data source
  2318. * @param offset defines the offset in the data source
  2319. * @param result defines the target vector
  2320. */
  2321. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2322. /**
  2323. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2324. * @param value1 defines 1st point of control
  2325. * @param value2 defines 2nd point of control
  2326. * @param value3 defines 3rd point of control
  2327. * @param value4 defines 4th point of control
  2328. * @param amount defines the interpolation factor
  2329. * @returns a new Vector2
  2330. */
  2331. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2332. /**
  2333. * 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".
  2334. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2335. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2336. * @param value defines the value to clamp
  2337. * @param min defines the lower limit
  2338. * @param max defines the upper limit
  2339. * @returns a new Vector2
  2340. */
  2341. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2342. /**
  2343. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2344. * @param value1 defines the 1st control point
  2345. * @param tangent1 defines the outgoing tangent
  2346. * @param value2 defines the 2nd control point
  2347. * @param tangent2 defines the incoming tangent
  2348. * @param amount defines the interpolation factor
  2349. * @returns a new Vector2
  2350. */
  2351. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2352. /**
  2353. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2354. * @param start defines the start vector
  2355. * @param end defines the end vector
  2356. * @param amount defines the interpolation factor
  2357. * @returns a new Vector2
  2358. */
  2359. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2360. /**
  2361. * Gets the dot product of the vector "left" and the vector "right"
  2362. * @param left defines first vector
  2363. * @param right defines second vector
  2364. * @returns the dot product (float)
  2365. */
  2366. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2367. /**
  2368. * Returns a new Vector2 equal to the normalized given vector
  2369. * @param vector defines the vector to normalize
  2370. * @returns a new Vector2
  2371. */
  2372. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2373. /**
  2374. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2375. * @param left defines 1st vector
  2376. * @param right defines 2nd vector
  2377. * @returns a new Vector2
  2378. */
  2379. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2380. /**
  2381. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2382. * @param left defines 1st vector
  2383. * @param right defines 2nd vector
  2384. * @returns a new Vector2
  2385. */
  2386. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2387. /**
  2388. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2389. * @param vector defines the vector to transform
  2390. * @param transformation defines the matrix to apply
  2391. * @returns a new Vector2
  2392. */
  2393. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2394. /**
  2395. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2396. * @param vector defines the vector to transform
  2397. * @param transformation defines the matrix to apply
  2398. * @param result defines the target vector
  2399. */
  2400. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2401. /**
  2402. * Determines if a given vector is included in a triangle
  2403. * @param p defines the vector to test
  2404. * @param p0 defines 1st triangle point
  2405. * @param p1 defines 2nd triangle point
  2406. * @param p2 defines 3rd triangle point
  2407. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2408. */
  2409. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2410. /**
  2411. * Gets the distance between the vectors "value1" and "value2"
  2412. * @param value1 defines first vector
  2413. * @param value2 defines second vector
  2414. * @returns the distance between vectors
  2415. */
  2416. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2417. /**
  2418. * Returns the squared distance between the vectors "value1" and "value2"
  2419. * @param value1 defines first vector
  2420. * @param value2 defines second vector
  2421. * @returns the squared distance between vectors
  2422. */
  2423. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2424. /**
  2425. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2426. * @param value1 defines first vector
  2427. * @param value2 defines second vector
  2428. * @returns a new Vector2
  2429. */
  2430. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2431. /**
  2432. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2433. * @param p defines the middle point
  2434. * @param segA defines one point of the segment
  2435. * @param segB defines the other point of the segment
  2436. * @returns the shortest distance
  2437. */
  2438. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2439. }
  2440. /**
  2441. * Class used to store (x,y,z) vector representation
  2442. * A Vector3 is the main object used in 3D geometry
  2443. * It can represent etiher the coordinates of a point the space, either a direction
  2444. * Reminder: js uses a left handed forward facing system
  2445. */
  2446. export class Vector3 {
  2447. private static _UpReadOnly;
  2448. private static _ZeroReadOnly;
  2449. /** @hidden */
  2450. _x: number;
  2451. /** @hidden */
  2452. _y: number;
  2453. /** @hidden */
  2454. _z: number;
  2455. /** @hidden */
  2456. _isDirty: boolean;
  2457. /** Gets or sets the x coordinate */
  2458. get x(): number;
  2459. set x(value: number);
  2460. /** Gets or sets the y coordinate */
  2461. get y(): number;
  2462. set y(value: number);
  2463. /** Gets or sets the z coordinate */
  2464. get z(): number;
  2465. set z(value: number);
  2466. /**
  2467. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2468. * @param x defines the first coordinates (on X axis)
  2469. * @param y defines the second coordinates (on Y axis)
  2470. * @param z defines the third coordinates (on Z axis)
  2471. */
  2472. constructor(x?: number, y?: number, z?: number);
  2473. /**
  2474. * Creates a string representation of the Vector3
  2475. * @returns a string with the Vector3 coordinates.
  2476. */
  2477. toString(): string;
  2478. /**
  2479. * Gets the class name
  2480. * @returns the string "Vector3"
  2481. */
  2482. getClassName(): string;
  2483. /**
  2484. * Creates the Vector3 hash code
  2485. * @returns a number which tends to be unique between Vector3 instances
  2486. */
  2487. getHashCode(): number;
  2488. /**
  2489. * Creates an array containing three elements : the coordinates of the Vector3
  2490. * @returns a new array of numbers
  2491. */
  2492. asArray(): number[];
  2493. /**
  2494. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2495. * @param array defines the destination array
  2496. * @param index defines the offset in the destination array
  2497. * @returns the current Vector3
  2498. */
  2499. toArray(array: FloatArray, index?: number): Vector3;
  2500. /**
  2501. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2502. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2503. */
  2504. toQuaternion(): Quaternion;
  2505. /**
  2506. * Adds the given vector to the current Vector3
  2507. * @param otherVector defines the second operand
  2508. * @returns the current updated Vector3
  2509. */
  2510. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2511. /**
  2512. * Adds the given coordinates to the current Vector3
  2513. * @param x defines the x coordinate of the operand
  2514. * @param y defines the y coordinate of the operand
  2515. * @param z defines the z coordinate of the operand
  2516. * @returns the current updated Vector3
  2517. */
  2518. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2519. /**
  2520. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2521. * @param otherVector defines the second operand
  2522. * @returns the resulting Vector3
  2523. */
  2524. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2525. /**
  2526. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2527. * @param otherVector defines the second operand
  2528. * @param result defines the Vector3 object where to store the result
  2529. * @returns the current Vector3
  2530. */
  2531. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2532. /**
  2533. * Subtract the given vector from the current Vector3
  2534. * @param otherVector defines the second operand
  2535. * @returns the current updated Vector3
  2536. */
  2537. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2538. /**
  2539. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2540. * @param otherVector defines the second operand
  2541. * @returns the resulting Vector3
  2542. */
  2543. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2544. /**
  2545. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2546. * @param otherVector defines the second operand
  2547. * @param result defines the Vector3 object where to store the result
  2548. * @returns the current Vector3
  2549. */
  2550. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2551. /**
  2552. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2553. * @param x defines the x coordinate of the operand
  2554. * @param y defines the y coordinate of the operand
  2555. * @param z defines the z coordinate of the operand
  2556. * @returns the resulting Vector3
  2557. */
  2558. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2559. /**
  2560. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2561. * @param x defines the x coordinate of the operand
  2562. * @param y defines the y coordinate of the operand
  2563. * @param z defines the z coordinate of the operand
  2564. * @param result defines the Vector3 object where to store the result
  2565. * @returns the current Vector3
  2566. */
  2567. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2568. /**
  2569. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2570. * @returns a new Vector3
  2571. */
  2572. negate(): Vector3;
  2573. /**
  2574. * Negate this vector in place
  2575. * @returns this
  2576. */
  2577. negateInPlace(): Vector3;
  2578. /**
  2579. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2580. * @param result defines the Vector3 object where to store the result
  2581. * @returns the current Vector3
  2582. */
  2583. negateToRef(result: Vector3): Vector3;
  2584. /**
  2585. * Multiplies the Vector3 coordinates by the float "scale"
  2586. * @param scale defines the multiplier factor
  2587. * @returns the current updated Vector3
  2588. */
  2589. scaleInPlace(scale: number): Vector3;
  2590. /**
  2591. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2592. * @param scale defines the multiplier factor
  2593. * @returns a new Vector3
  2594. */
  2595. scale(scale: number): Vector3;
  2596. /**
  2597. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2598. * @param scale defines the multiplier factor
  2599. * @param result defines the Vector3 object where to store the result
  2600. * @returns the current Vector3
  2601. */
  2602. scaleToRef(scale: number, result: Vector3): Vector3;
  2603. /**
  2604. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2605. * @param scale defines the scale factor
  2606. * @param result defines the Vector3 object where to store the result
  2607. * @returns the unmodified current Vector3
  2608. */
  2609. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2610. /**
  2611. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2612. * @param origin defines the origin of the projection ray
  2613. * @param plane defines the plane to project to
  2614. * @returns the projected vector3
  2615. */
  2616. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2617. /**
  2618. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2619. * @param origin defines the origin of the projection ray
  2620. * @param plane defines the plane to project to
  2621. * @param result defines the Vector3 where to store the result
  2622. */
  2623. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2624. /**
  2625. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2626. * @param otherVector defines the second operand
  2627. * @returns true if both vectors are equals
  2628. */
  2629. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2630. /**
  2631. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2632. * @param otherVector defines the second operand
  2633. * @param epsilon defines the minimal distance to define values as equals
  2634. * @returns true if both vectors are distant less than epsilon
  2635. */
  2636. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2637. /**
  2638. * Returns true if the current Vector3 coordinates equals the given floats
  2639. * @param x defines the x coordinate of the operand
  2640. * @param y defines the y coordinate of the operand
  2641. * @param z defines the z coordinate of the operand
  2642. * @returns true if both vectors are equals
  2643. */
  2644. equalsToFloats(x: number, y: number, z: number): boolean;
  2645. /**
  2646. * Multiplies the current Vector3 coordinates by the given ones
  2647. * @param otherVector defines the second operand
  2648. * @returns the current updated Vector3
  2649. */
  2650. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2651. /**
  2652. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2653. * @param otherVector defines the second operand
  2654. * @returns the new Vector3
  2655. */
  2656. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2657. /**
  2658. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2659. * @param otherVector defines the second operand
  2660. * @param result defines the Vector3 object where to store the result
  2661. * @returns the current Vector3
  2662. */
  2663. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2664. /**
  2665. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2666. * @param x defines the x coordinate of the operand
  2667. * @param y defines the y coordinate of the operand
  2668. * @param z defines the z coordinate of the operand
  2669. * @returns the new Vector3
  2670. */
  2671. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2672. /**
  2673. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2674. * @param otherVector defines the second operand
  2675. * @returns the new Vector3
  2676. */
  2677. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2678. /**
  2679. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2680. * @param otherVector defines the second operand
  2681. * @param result defines the Vector3 object where to store the result
  2682. * @returns the current Vector3
  2683. */
  2684. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2685. /**
  2686. * Divides the current Vector3 coordinates by the given ones.
  2687. * @param otherVector defines the second operand
  2688. * @returns the current updated Vector3
  2689. */
  2690. divideInPlace(otherVector: Vector3): Vector3;
  2691. /**
  2692. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2693. * @param other defines the second operand
  2694. * @returns the current updated Vector3
  2695. */
  2696. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2697. /**
  2698. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2699. * @param other defines the second operand
  2700. * @returns the current updated Vector3
  2701. */
  2702. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2703. /**
  2704. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2705. * @param x defines the x coordinate of the operand
  2706. * @param y defines the y coordinate of the operand
  2707. * @param z defines the z coordinate of the operand
  2708. * @returns the current updated Vector3
  2709. */
  2710. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2711. /**
  2712. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2713. * @param x defines the x coordinate of the operand
  2714. * @param y defines the y coordinate of the operand
  2715. * @param z defines the z coordinate of the operand
  2716. * @returns the current updated Vector3
  2717. */
  2718. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2719. /**
  2720. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2721. * Check if is non uniform within a certain amount of decimal places to account for this
  2722. * @param epsilon the amount the values can differ
  2723. * @returns if the the vector is non uniform to a certain number of decimal places
  2724. */
  2725. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2726. /**
  2727. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2728. */
  2729. get isNonUniform(): boolean;
  2730. /**
  2731. * Gets a new Vector3 from current Vector3 floored values
  2732. * @returns a new Vector3
  2733. */
  2734. floor(): Vector3;
  2735. /**
  2736. * Gets a new Vector3 from current Vector3 floored values
  2737. * @returns a new Vector3
  2738. */
  2739. fract(): Vector3;
  2740. /**
  2741. * Gets the length of the Vector3
  2742. * @returns the length of the Vector3
  2743. */
  2744. length(): number;
  2745. /**
  2746. * Gets the squared length of the Vector3
  2747. * @returns squared length of the Vector3
  2748. */
  2749. lengthSquared(): number;
  2750. /**
  2751. * Normalize the current Vector3.
  2752. * Please note that this is an in place operation.
  2753. * @returns the current updated Vector3
  2754. */
  2755. normalize(): Vector3;
  2756. /**
  2757. * Reorders the x y z properties of the vector in place
  2758. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2759. * @returns the current updated vector
  2760. */
  2761. reorderInPlace(order: string): this;
  2762. /**
  2763. * Rotates the vector around 0,0,0 by a quaternion
  2764. * @param quaternion the rotation quaternion
  2765. * @param result vector to store the result
  2766. * @returns the resulting vector
  2767. */
  2768. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2769. /**
  2770. * Rotates a vector around a given point
  2771. * @param quaternion the rotation quaternion
  2772. * @param point the point to rotate around
  2773. * @param result vector to store the result
  2774. * @returns the resulting vector
  2775. */
  2776. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2777. /**
  2778. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2779. * The cross product is then orthogonal to both current and "other"
  2780. * @param other defines the right operand
  2781. * @returns the cross product
  2782. */
  2783. cross(other: Vector3): Vector3;
  2784. /**
  2785. * Normalize the current Vector3 with the given input length.
  2786. * Please note that this is an in place operation.
  2787. * @param len the length of the vector
  2788. * @returns the current updated Vector3
  2789. */
  2790. normalizeFromLength(len: number): Vector3;
  2791. /**
  2792. * Normalize the current Vector3 to a new vector
  2793. * @returns the new Vector3
  2794. */
  2795. normalizeToNew(): Vector3;
  2796. /**
  2797. * Normalize the current Vector3 to the reference
  2798. * @param reference define the Vector3 to update
  2799. * @returns the updated Vector3
  2800. */
  2801. normalizeToRef(reference: Vector3): Vector3;
  2802. /**
  2803. * Creates a new Vector3 copied from the current Vector3
  2804. * @returns the new Vector3
  2805. */
  2806. clone(): Vector3;
  2807. /**
  2808. * Copies the given vector coordinates to the current Vector3 ones
  2809. * @param source defines the source Vector3
  2810. * @returns the current updated Vector3
  2811. */
  2812. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2813. /**
  2814. * Copies the given floats to the current Vector3 coordinates
  2815. * @param x defines the x coordinate of the operand
  2816. * @param y defines the y coordinate of the operand
  2817. * @param z defines the z coordinate of the operand
  2818. * @returns the current updated Vector3
  2819. */
  2820. copyFromFloats(x: number, y: number, z: number): Vector3;
  2821. /**
  2822. * Copies the given floats to the current Vector3 coordinates
  2823. * @param x defines the x coordinate of the operand
  2824. * @param y defines the y coordinate of the operand
  2825. * @param z defines the z coordinate of the operand
  2826. * @returns the current updated Vector3
  2827. */
  2828. set(x: number, y: number, z: number): Vector3;
  2829. /**
  2830. * Copies the given float to the current Vector3 coordinates
  2831. * @param v defines the x, y and z coordinates of the operand
  2832. * @returns the current updated Vector3
  2833. */
  2834. setAll(v: number): Vector3;
  2835. /**
  2836. * Get the clip factor between two vectors
  2837. * @param vector0 defines the first operand
  2838. * @param vector1 defines the second operand
  2839. * @param axis defines the axis to use
  2840. * @param size defines the size along the axis
  2841. * @returns the clip factor
  2842. */
  2843. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2844. /**
  2845. * Get angle between two vectors
  2846. * @param vector0 angle between vector0 and vector1
  2847. * @param vector1 angle between vector0 and vector1
  2848. * @param normal direction of the normal
  2849. * @return the angle between vector0 and vector1
  2850. */
  2851. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2852. /**
  2853. * Returns a new Vector3 set from the index "offset" of the given array
  2854. * @param array defines the source array
  2855. * @param offset defines the offset in the source array
  2856. * @returns the new Vector3
  2857. */
  2858. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2859. /**
  2860. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2861. * @param array defines the source array
  2862. * @param offset defines the offset in the source array
  2863. * @returns the new Vector3
  2864. * @deprecated Please use FromArray instead.
  2865. */
  2866. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2867. /**
  2868. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2869. * @param array defines the source array
  2870. * @param offset defines the offset in the source array
  2871. * @param result defines the Vector3 where to store the result
  2872. */
  2873. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2874. /**
  2875. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2876. * @param array defines the source array
  2877. * @param offset defines the offset in the source array
  2878. * @param result defines the Vector3 where to store the result
  2879. * @deprecated Please use FromArrayToRef instead.
  2880. */
  2881. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2882. /**
  2883. * Sets the given vector "result" with the given floats.
  2884. * @param x defines the x coordinate of the source
  2885. * @param y defines the y coordinate of the source
  2886. * @param z defines the z coordinate of the source
  2887. * @param result defines the Vector3 where to store the result
  2888. */
  2889. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2890. /**
  2891. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2892. * @returns a new empty Vector3
  2893. */
  2894. static Zero(): Vector3;
  2895. /**
  2896. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2897. * @returns a new unit Vector3
  2898. */
  2899. static One(): Vector3;
  2900. /**
  2901. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2902. * @returns a new up Vector3
  2903. */
  2904. static Up(): Vector3;
  2905. /**
  2906. * Gets a up Vector3 that must not be updated
  2907. */
  2908. static get UpReadOnly(): DeepImmutable<Vector3>;
  2909. /**
  2910. * Gets a zero Vector3 that must not be updated
  2911. */
  2912. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2913. /**
  2914. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2915. * @returns a new down Vector3
  2916. */
  2917. static Down(): Vector3;
  2918. /**
  2919. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2920. * @param rightHandedSystem is the scene right-handed (negative z)
  2921. * @returns a new forward Vector3
  2922. */
  2923. static Forward(rightHandedSystem?: boolean): Vector3;
  2924. /**
  2925. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2926. * @param rightHandedSystem is the scene right-handed (negative-z)
  2927. * @returns a new forward Vector3
  2928. */
  2929. static Backward(rightHandedSystem?: boolean): Vector3;
  2930. /**
  2931. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2932. * @returns a new right Vector3
  2933. */
  2934. static Right(): Vector3;
  2935. /**
  2936. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2937. * @returns a new left Vector3
  2938. */
  2939. static Left(): Vector3;
  2940. /**
  2941. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2942. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2943. * @param vector defines the Vector3 to transform
  2944. * @param transformation defines the transformation matrix
  2945. * @returns the transformed Vector3
  2946. */
  2947. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2948. /**
  2949. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2950. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2951. * @param vector defines the Vector3 to transform
  2952. * @param transformation defines the transformation matrix
  2953. * @param result defines the Vector3 where to store the result
  2954. */
  2955. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2956. /**
  2957. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  2958. * This method computes tranformed coordinates only, not transformed direction vectors
  2959. * @param x define the x coordinate of the source vector
  2960. * @param y define the y coordinate of the source vector
  2961. * @param z define the z coordinate of the source vector
  2962. * @param transformation defines the transformation matrix
  2963. * @param result defines the Vector3 where to store the result
  2964. */
  2965. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2966. /**
  2967. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  2968. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2969. * @param vector defines the Vector3 to transform
  2970. * @param transformation defines the transformation matrix
  2971. * @returns the new Vector3
  2972. */
  2973. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2974. /**
  2975. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  2976. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2977. * @param vector defines the Vector3 to transform
  2978. * @param transformation defines the transformation matrix
  2979. * @param result defines the Vector3 where to store the result
  2980. */
  2981. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2982. /**
  2983. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  2984. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2985. * @param x define the x coordinate of the source vector
  2986. * @param y define the y coordinate of the source vector
  2987. * @param z define the z coordinate of the source vector
  2988. * @param transformation defines the transformation matrix
  2989. * @param result defines the Vector3 where to store the result
  2990. */
  2991. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2992. /**
  2993. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  2994. * @param value1 defines the first control point
  2995. * @param value2 defines the second control point
  2996. * @param value3 defines the third control point
  2997. * @param value4 defines the fourth control point
  2998. * @param amount defines the amount on the spline to use
  2999. * @returns the new Vector3
  3000. */
  3001. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3002. /**
  3003. * 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"
  3004. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3005. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3006. * @param value defines the current value
  3007. * @param min defines the lower range value
  3008. * @param max defines the upper range value
  3009. * @returns the new Vector3
  3010. */
  3011. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3012. /**
  3013. * 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"
  3014. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3015. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3016. * @param value defines the current value
  3017. * @param min defines the lower range value
  3018. * @param max defines the upper range value
  3019. * @param result defines the Vector3 where to store the result
  3020. */
  3021. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3022. /**
  3023. * Checks if a given vector is inside a specific range
  3024. * @param v defines the vector to test
  3025. * @param min defines the minimum range
  3026. * @param max defines the maximum range
  3027. */
  3028. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3029. /**
  3030. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3031. * @param value1 defines the first control point
  3032. * @param tangent1 defines the first tangent vector
  3033. * @param value2 defines the second control point
  3034. * @param tangent2 defines the second tangent vector
  3035. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3036. * @returns the new Vector3
  3037. */
  3038. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3039. /**
  3040. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3041. * @param start defines the start value
  3042. * @param end defines the end value
  3043. * @param amount max defines amount between both (between 0 and 1)
  3044. * @returns the new Vector3
  3045. */
  3046. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3047. /**
  3048. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3049. * @param start defines the start value
  3050. * @param end defines the end value
  3051. * @param amount max defines amount between both (between 0 and 1)
  3052. * @param result defines the Vector3 where to store the result
  3053. */
  3054. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3055. /**
  3056. * Returns the dot product (float) between the vectors "left" and "right"
  3057. * @param left defines the left operand
  3058. * @param right defines the right operand
  3059. * @returns the dot product
  3060. */
  3061. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3062. /**
  3063. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3064. * The cross product is then orthogonal to both "left" and "right"
  3065. * @param left defines the left operand
  3066. * @param right defines the right operand
  3067. * @returns the cross product
  3068. */
  3069. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3070. /**
  3071. * Sets the given vector "result" with the cross product of "left" and "right"
  3072. * The cross product is then orthogonal to both "left" and "right"
  3073. * @param left defines the left operand
  3074. * @param right defines the right operand
  3075. * @param result defines the Vector3 where to store the result
  3076. */
  3077. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3078. /**
  3079. * Returns a new Vector3 as the normalization of the given vector
  3080. * @param vector defines the Vector3 to normalize
  3081. * @returns the new Vector3
  3082. */
  3083. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3084. /**
  3085. * Sets the given vector "result" with the normalization of the given first vector
  3086. * @param vector defines the Vector3 to normalize
  3087. * @param result defines the Vector3 where to store the result
  3088. */
  3089. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3090. /**
  3091. * Project a Vector3 onto screen space
  3092. * @param vector defines the Vector3 to project
  3093. * @param world defines the world matrix to use
  3094. * @param transform defines the transform (view x projection) matrix to use
  3095. * @param viewport defines the screen viewport to use
  3096. * @returns the new Vector3
  3097. */
  3098. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3099. /** @hidden */
  3100. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3101. /**
  3102. * Unproject from screen space to object space
  3103. * @param source defines the screen space Vector3 to use
  3104. * @param viewportWidth defines the current width of the viewport
  3105. * @param viewportHeight defines the current height of the viewport
  3106. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3107. * @param transform defines the transform (view x projection) matrix to use
  3108. * @returns the new Vector3
  3109. */
  3110. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3111. /**
  3112. * Unproject from screen space to object space
  3113. * @param source defines the screen space Vector3 to use
  3114. * @param viewportWidth defines the current width of the viewport
  3115. * @param viewportHeight defines the current height of the viewport
  3116. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3117. * @param view defines the view matrix to use
  3118. * @param projection defines the projection matrix to use
  3119. * @returns the new Vector3
  3120. */
  3121. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3122. /**
  3123. * Unproject from screen space to object space
  3124. * @param source defines the screen space Vector3 to use
  3125. * @param viewportWidth defines the current width of the viewport
  3126. * @param viewportHeight defines the current height of the viewport
  3127. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3128. * @param view defines the view matrix to use
  3129. * @param projection defines the projection matrix to use
  3130. * @param result defines the Vector3 where to store the result
  3131. */
  3132. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3133. /**
  3134. * Unproject from screen space to object space
  3135. * @param sourceX defines the screen space x coordinate to use
  3136. * @param sourceY defines the screen space y coordinate to use
  3137. * @param sourceZ defines the screen space z coordinate to use
  3138. * @param viewportWidth defines the current width of the viewport
  3139. * @param viewportHeight defines the current height of the viewport
  3140. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3141. * @param view defines the view matrix to use
  3142. * @param projection defines the projection matrix to use
  3143. * @param result defines the Vector3 where to store the result
  3144. */
  3145. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3146. /**
  3147. * Gets the minimal coordinate values between two Vector3
  3148. * @param left defines the first operand
  3149. * @param right defines the second operand
  3150. * @returns the new Vector3
  3151. */
  3152. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3153. /**
  3154. * Gets the maximal coordinate values between two Vector3
  3155. * @param left defines the first operand
  3156. * @param right defines the second operand
  3157. * @returns the new Vector3
  3158. */
  3159. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3160. /**
  3161. * Returns the distance between the vectors "value1" and "value2"
  3162. * @param value1 defines the first operand
  3163. * @param value2 defines the second operand
  3164. * @returns the distance
  3165. */
  3166. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3167. /**
  3168. * Returns the squared distance between the vectors "value1" and "value2"
  3169. * @param value1 defines the first operand
  3170. * @param value2 defines the second operand
  3171. * @returns the squared distance
  3172. */
  3173. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3174. /**
  3175. * Returns a new Vector3 located at the center between "value1" and "value2"
  3176. * @param value1 defines the first operand
  3177. * @param value2 defines the second operand
  3178. * @returns the new Vector3
  3179. */
  3180. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3181. /**
  3182. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3183. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3184. * to something in order to rotate it from its local system to the given target system
  3185. * Note: axis1, axis2 and axis3 are normalized during this operation
  3186. * @param axis1 defines the first axis
  3187. * @param axis2 defines the second axis
  3188. * @param axis3 defines the third axis
  3189. * @returns a new Vector3
  3190. */
  3191. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3192. /**
  3193. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3194. * @param axis1 defines the first axis
  3195. * @param axis2 defines the second axis
  3196. * @param axis3 defines the third axis
  3197. * @param ref defines the Vector3 where to store the result
  3198. */
  3199. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3200. }
  3201. /**
  3202. * Vector4 class created for EulerAngle class conversion to Quaternion
  3203. */
  3204. export class Vector4 {
  3205. /** x value of the vector */
  3206. x: number;
  3207. /** y value of the vector */
  3208. y: number;
  3209. /** z value of the vector */
  3210. z: number;
  3211. /** w value of the vector */
  3212. w: number;
  3213. /**
  3214. * Creates a Vector4 object from the given floats.
  3215. * @param x x value of the vector
  3216. * @param y y value of the vector
  3217. * @param z z value of the vector
  3218. * @param w w value of the vector
  3219. */
  3220. constructor(
  3221. /** x value of the vector */
  3222. x: number,
  3223. /** y value of the vector */
  3224. y: number,
  3225. /** z value of the vector */
  3226. z: number,
  3227. /** w value of the vector */
  3228. w: number);
  3229. /**
  3230. * Returns the string with the Vector4 coordinates.
  3231. * @returns a string containing all the vector values
  3232. */
  3233. toString(): string;
  3234. /**
  3235. * Returns the string "Vector4".
  3236. * @returns "Vector4"
  3237. */
  3238. getClassName(): string;
  3239. /**
  3240. * Returns the Vector4 hash code.
  3241. * @returns a unique hash code
  3242. */
  3243. getHashCode(): number;
  3244. /**
  3245. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3246. * @returns the resulting array
  3247. */
  3248. asArray(): number[];
  3249. /**
  3250. * Populates the given array from the given index with the Vector4 coordinates.
  3251. * @param array array to populate
  3252. * @param index index of the array to start at (default: 0)
  3253. * @returns the Vector4.
  3254. */
  3255. toArray(array: FloatArray, index?: number): Vector4;
  3256. /**
  3257. * Adds the given vector to the current Vector4.
  3258. * @param otherVector the vector to add
  3259. * @returns the updated Vector4.
  3260. */
  3261. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3262. /**
  3263. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3264. * @param otherVector the vector to add
  3265. * @returns the resulting vector
  3266. */
  3267. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3268. /**
  3269. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3270. * @param otherVector the vector to add
  3271. * @param result the vector to store the result
  3272. * @returns the current Vector4.
  3273. */
  3274. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3275. /**
  3276. * Subtract in place the given vector from the current Vector4.
  3277. * @param otherVector the vector to subtract
  3278. * @returns the updated Vector4.
  3279. */
  3280. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3281. /**
  3282. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3283. * @param otherVector the vector to add
  3284. * @returns the new vector with the result
  3285. */
  3286. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3287. /**
  3288. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3289. * @param otherVector the vector to subtract
  3290. * @param result the vector to store the result
  3291. * @returns the current Vector4.
  3292. */
  3293. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3294. /**
  3295. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3296. */
  3297. /**
  3298. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3299. * @param x value to subtract
  3300. * @param y value to subtract
  3301. * @param z value to subtract
  3302. * @param w value to subtract
  3303. * @returns new vector containing the result
  3304. */
  3305. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3306. /**
  3307. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3308. * @param x value to subtract
  3309. * @param y value to subtract
  3310. * @param z value to subtract
  3311. * @param w value to subtract
  3312. * @param result the vector to store the result in
  3313. * @returns the current Vector4.
  3314. */
  3315. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3316. /**
  3317. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3318. * @returns a new vector with the negated values
  3319. */
  3320. negate(): Vector4;
  3321. /**
  3322. * Negate this vector in place
  3323. * @returns this
  3324. */
  3325. negateInPlace(): Vector4;
  3326. /**
  3327. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3328. * @param result defines the Vector3 object where to store the result
  3329. * @returns the current Vector4
  3330. */
  3331. negateToRef(result: Vector4): Vector4;
  3332. /**
  3333. * Multiplies the current Vector4 coordinates by scale (float).
  3334. * @param scale the number to scale with
  3335. * @returns the updated Vector4.
  3336. */
  3337. scaleInPlace(scale: number): Vector4;
  3338. /**
  3339. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3340. * @param scale the number to scale with
  3341. * @returns a new vector with the result
  3342. */
  3343. scale(scale: number): Vector4;
  3344. /**
  3345. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3346. * @param scale the number to scale with
  3347. * @param result a vector to store the result in
  3348. * @returns the current Vector4.
  3349. */
  3350. scaleToRef(scale: number, result: Vector4): Vector4;
  3351. /**
  3352. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3353. * @param scale defines the scale factor
  3354. * @param result defines the Vector4 object where to store the result
  3355. * @returns the unmodified current Vector4
  3356. */
  3357. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3358. /**
  3359. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3360. * @param otherVector the vector to compare against
  3361. * @returns true if they are equal
  3362. */
  3363. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3364. /**
  3365. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3366. * @param otherVector vector to compare against
  3367. * @param epsilon (Default: very small number)
  3368. * @returns true if they are equal
  3369. */
  3370. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3371. /**
  3372. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3373. * @param x x value to compare against
  3374. * @param y y value to compare against
  3375. * @param z z value to compare against
  3376. * @param w w value to compare against
  3377. * @returns true if equal
  3378. */
  3379. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3380. /**
  3381. * Multiplies in place the current Vector4 by the given one.
  3382. * @param otherVector vector to multiple with
  3383. * @returns the updated Vector4.
  3384. */
  3385. multiplyInPlace(otherVector: Vector4): Vector4;
  3386. /**
  3387. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3388. * @param otherVector vector to multiple with
  3389. * @returns resulting new vector
  3390. */
  3391. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3392. /**
  3393. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3394. * @param otherVector vector to multiple with
  3395. * @param result vector to store the result
  3396. * @returns the current Vector4.
  3397. */
  3398. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3399. /**
  3400. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3401. * @param x x value multiply with
  3402. * @param y y value multiply with
  3403. * @param z z value multiply with
  3404. * @param w w value multiply with
  3405. * @returns resulting new vector
  3406. */
  3407. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3408. /**
  3409. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3410. * @param otherVector vector to devide with
  3411. * @returns resulting new vector
  3412. */
  3413. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3414. /**
  3415. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3416. * @param otherVector vector to devide with
  3417. * @param result vector to store the result
  3418. * @returns the current Vector4.
  3419. */
  3420. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3421. /**
  3422. * Divides the current Vector3 coordinates by the given ones.
  3423. * @param otherVector vector to devide with
  3424. * @returns the updated Vector3.
  3425. */
  3426. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3427. /**
  3428. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3429. * @param other defines the second operand
  3430. * @returns the current updated Vector4
  3431. */
  3432. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3433. /**
  3434. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3435. * @param other defines the second operand
  3436. * @returns the current updated Vector4
  3437. */
  3438. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3439. /**
  3440. * Gets a new Vector4 from current Vector4 floored values
  3441. * @returns a new Vector4
  3442. */
  3443. floor(): Vector4;
  3444. /**
  3445. * Gets a new Vector4 from current Vector3 floored values
  3446. * @returns a new Vector4
  3447. */
  3448. fract(): Vector4;
  3449. /**
  3450. * Returns the Vector4 length (float).
  3451. * @returns the length
  3452. */
  3453. length(): number;
  3454. /**
  3455. * Returns the Vector4 squared length (float).
  3456. * @returns the length squared
  3457. */
  3458. lengthSquared(): number;
  3459. /**
  3460. * Normalizes in place the Vector4.
  3461. * @returns the updated Vector4.
  3462. */
  3463. normalize(): Vector4;
  3464. /**
  3465. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3466. * @returns this converted to a new vector3
  3467. */
  3468. toVector3(): Vector3;
  3469. /**
  3470. * Returns a new Vector4 copied from the current one.
  3471. * @returns the new cloned vector
  3472. */
  3473. clone(): Vector4;
  3474. /**
  3475. * Updates the current Vector4 with the given one coordinates.
  3476. * @param source the source vector to copy from
  3477. * @returns the updated Vector4.
  3478. */
  3479. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3480. /**
  3481. * Updates the current Vector4 coordinates with the given floats.
  3482. * @param x float to copy from
  3483. * @param y float to copy from
  3484. * @param z float to copy from
  3485. * @param w float to copy from
  3486. * @returns the updated Vector4.
  3487. */
  3488. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3489. /**
  3490. * Updates the current Vector4 coordinates with the given floats.
  3491. * @param x float to set from
  3492. * @param y float to set from
  3493. * @param z float to set from
  3494. * @param w float to set from
  3495. * @returns the updated Vector4.
  3496. */
  3497. set(x: number, y: number, z: number, w: number): Vector4;
  3498. /**
  3499. * Copies the given float to the current Vector3 coordinates
  3500. * @param v defines the x, y, z and w coordinates of the operand
  3501. * @returns the current updated Vector3
  3502. */
  3503. setAll(v: number): Vector4;
  3504. /**
  3505. * Returns a new Vector4 set from the starting index of the given array.
  3506. * @param array the array to pull values from
  3507. * @param offset the offset into the array to start at
  3508. * @returns the new vector
  3509. */
  3510. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3511. /**
  3512. * Updates the given vector "result" from the starting index of the given array.
  3513. * @param array the array to pull values from
  3514. * @param offset the offset into the array to start at
  3515. * @param result the vector to store the result in
  3516. */
  3517. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3518. /**
  3519. * Updates the given vector "result" from the starting index of the given Float32Array.
  3520. * @param array the array to pull values from
  3521. * @param offset the offset into the array to start at
  3522. * @param result the vector to store the result in
  3523. */
  3524. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3525. /**
  3526. * Updates the given vector "result" coordinates from the given floats.
  3527. * @param x float to set from
  3528. * @param y float to set from
  3529. * @param z float to set from
  3530. * @param w float to set from
  3531. * @param result the vector to the floats in
  3532. */
  3533. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3534. /**
  3535. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3536. * @returns the new vector
  3537. */
  3538. static Zero(): Vector4;
  3539. /**
  3540. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3541. * @returns the new vector
  3542. */
  3543. static One(): Vector4;
  3544. /**
  3545. * Returns a new normalized Vector4 from the given one.
  3546. * @param vector the vector to normalize
  3547. * @returns the vector
  3548. */
  3549. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3550. /**
  3551. * Updates the given vector "result" from the normalization of the given one.
  3552. * @param vector the vector to normalize
  3553. * @param result the vector to store the result in
  3554. */
  3555. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3556. /**
  3557. * Returns a vector with the minimum values from the left and right vectors
  3558. * @param left left vector to minimize
  3559. * @param right right vector to minimize
  3560. * @returns a new vector with the minimum of the left and right vector values
  3561. */
  3562. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3563. /**
  3564. * Returns a vector with the maximum values from the left and right vectors
  3565. * @param left left vector to maximize
  3566. * @param right right vector to maximize
  3567. * @returns a new vector with the maximum of the left and right vector values
  3568. */
  3569. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3570. /**
  3571. * Returns the distance (float) between the vectors "value1" and "value2".
  3572. * @param value1 value to calulate the distance between
  3573. * @param value2 value to calulate the distance between
  3574. * @return the distance between the two vectors
  3575. */
  3576. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3577. /**
  3578. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3579. * @param value1 value to calulate the distance between
  3580. * @param value2 value to calulate the distance between
  3581. * @return the distance between the two vectors squared
  3582. */
  3583. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3584. /**
  3585. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3586. * @param value1 value to calulate the center between
  3587. * @param value2 value to calulate the center between
  3588. * @return the center between the two vectors
  3589. */
  3590. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3591. /**
  3592. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3593. * This methods computes transformed normalized direction vectors only.
  3594. * @param vector the vector to transform
  3595. * @param transformation the transformation matrix to apply
  3596. * @returns the new vector
  3597. */
  3598. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3599. /**
  3600. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3601. * This methods computes transformed normalized direction vectors only.
  3602. * @param vector the vector to transform
  3603. * @param transformation the transformation matrix to apply
  3604. * @param result the vector to store the result in
  3605. */
  3606. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3607. /**
  3608. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3609. * This methods computes transformed normalized direction vectors only.
  3610. * @param x value to transform
  3611. * @param y value to transform
  3612. * @param z value to transform
  3613. * @param w value to transform
  3614. * @param transformation the transformation matrix to apply
  3615. * @param result the vector to store the results in
  3616. */
  3617. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3618. /**
  3619. * Creates a new Vector4 from a Vector3
  3620. * @param source defines the source data
  3621. * @param w defines the 4th component (default is 0)
  3622. * @returns a new Vector4
  3623. */
  3624. static FromVector3(source: Vector3, w?: number): Vector4;
  3625. }
  3626. /**
  3627. * Class used to store quaternion data
  3628. * @see https://en.wikipedia.org/wiki/Quaternion
  3629. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  3630. */
  3631. export class Quaternion {
  3632. /** @hidden */
  3633. _x: number;
  3634. /** @hidden */
  3635. _y: number;
  3636. /** @hidden */
  3637. _z: number;
  3638. /** @hidden */
  3639. _w: number;
  3640. /** @hidden */
  3641. _isDirty: boolean;
  3642. /** Gets or sets the x coordinate */
  3643. get x(): number;
  3644. set x(value: number);
  3645. /** Gets or sets the y coordinate */
  3646. get y(): number;
  3647. set y(value: number);
  3648. /** Gets or sets the z coordinate */
  3649. get z(): number;
  3650. set z(value: number);
  3651. /** Gets or sets the w coordinate */
  3652. get w(): number;
  3653. set w(value: number);
  3654. /**
  3655. * Creates a new Quaternion from the given floats
  3656. * @param x defines the first component (0 by default)
  3657. * @param y defines the second component (0 by default)
  3658. * @param z defines the third component (0 by default)
  3659. * @param w defines the fourth component (1.0 by default)
  3660. */
  3661. constructor(x?: number, y?: number, z?: number, w?: number);
  3662. /**
  3663. * Gets a string representation for the current quaternion
  3664. * @returns a string with the Quaternion coordinates
  3665. */
  3666. toString(): string;
  3667. /**
  3668. * Gets the class name of the quaternion
  3669. * @returns the string "Quaternion"
  3670. */
  3671. getClassName(): string;
  3672. /**
  3673. * Gets a hash code for this quaternion
  3674. * @returns the quaternion hash code
  3675. */
  3676. getHashCode(): number;
  3677. /**
  3678. * Copy the quaternion to an array
  3679. * @returns a new array populated with 4 elements from the quaternion coordinates
  3680. */
  3681. asArray(): number[];
  3682. /**
  3683. * Check if two quaternions are equals
  3684. * @param otherQuaternion defines the second operand
  3685. * @return true if the current quaternion and the given one coordinates are strictly equals
  3686. */
  3687. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3688. /**
  3689. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3690. * @param otherQuaternion defines the other quaternion
  3691. * @param epsilon defines the minimal distance to consider equality
  3692. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3693. */
  3694. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3695. /**
  3696. * Clone the current quaternion
  3697. * @returns a new quaternion copied from the current one
  3698. */
  3699. clone(): Quaternion;
  3700. /**
  3701. * Copy a quaternion to the current one
  3702. * @param other defines the other quaternion
  3703. * @returns the updated current quaternion
  3704. */
  3705. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3706. /**
  3707. * Updates the current quaternion with the given float coordinates
  3708. * @param x defines the x coordinate
  3709. * @param y defines the y coordinate
  3710. * @param z defines the z coordinate
  3711. * @param w defines the w coordinate
  3712. * @returns the updated current quaternion
  3713. */
  3714. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3715. /**
  3716. * Updates the current quaternion from the given float coordinates
  3717. * @param x defines the x coordinate
  3718. * @param y defines the y coordinate
  3719. * @param z defines the z coordinate
  3720. * @param w defines the w coordinate
  3721. * @returns the updated current quaternion
  3722. */
  3723. set(x: number, y: number, z: number, w: number): Quaternion;
  3724. /**
  3725. * Adds two quaternions
  3726. * @param other defines the second operand
  3727. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3728. */
  3729. add(other: DeepImmutable<Quaternion>): Quaternion;
  3730. /**
  3731. * Add a quaternion to the current one
  3732. * @param other defines the quaternion to add
  3733. * @returns the current quaternion
  3734. */
  3735. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3736. /**
  3737. * Subtract two quaternions
  3738. * @param other defines the second operand
  3739. * @returns a new quaternion as the subtraction result of the given one from the current one
  3740. */
  3741. subtract(other: Quaternion): Quaternion;
  3742. /**
  3743. * Multiplies the current quaternion by a scale factor
  3744. * @param value defines the scale factor
  3745. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3746. */
  3747. scale(value: number): Quaternion;
  3748. /**
  3749. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3750. * @param scale defines the scale factor
  3751. * @param result defines the Quaternion object where to store the result
  3752. * @returns the unmodified current quaternion
  3753. */
  3754. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3755. /**
  3756. * Multiplies in place the current quaternion by a scale factor
  3757. * @param value defines the scale factor
  3758. * @returns the current modified quaternion
  3759. */
  3760. scaleInPlace(value: number): Quaternion;
  3761. /**
  3762. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3763. * @param scale defines the scale factor
  3764. * @param result defines the Quaternion object where to store the result
  3765. * @returns the unmodified current quaternion
  3766. */
  3767. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3768. /**
  3769. * Multiplies two quaternions
  3770. * @param q1 defines the second operand
  3771. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3772. */
  3773. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3774. /**
  3775. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3776. * @param q1 defines the second operand
  3777. * @param result defines the target quaternion
  3778. * @returns the current quaternion
  3779. */
  3780. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3781. /**
  3782. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3783. * @param q1 defines the second operand
  3784. * @returns the currentupdated quaternion
  3785. */
  3786. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3787. /**
  3788. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3789. * @param ref defines the target quaternion
  3790. * @returns the current quaternion
  3791. */
  3792. conjugateToRef(ref: Quaternion): Quaternion;
  3793. /**
  3794. * Conjugates in place (1-q) the current quaternion
  3795. * @returns the current updated quaternion
  3796. */
  3797. conjugateInPlace(): Quaternion;
  3798. /**
  3799. * Conjugates in place (1-q) the current quaternion
  3800. * @returns a new quaternion
  3801. */
  3802. conjugate(): Quaternion;
  3803. /**
  3804. * Gets length of current quaternion
  3805. * @returns the quaternion length (float)
  3806. */
  3807. length(): number;
  3808. /**
  3809. * Normalize in place the current quaternion
  3810. * @returns the current updated quaternion
  3811. */
  3812. normalize(): Quaternion;
  3813. /**
  3814. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3815. * @param order is a reserved parameter and is ignore for now
  3816. * @returns a new Vector3 containing the Euler angles
  3817. */
  3818. toEulerAngles(order?: string): Vector3;
  3819. /**
  3820. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3821. * @param result defines the vector which will be filled with the Euler angles
  3822. * @param order is a reserved parameter and is ignore for now
  3823. * @returns the current unchanged quaternion
  3824. */
  3825. toEulerAnglesToRef(result: Vector3): Quaternion;
  3826. /**
  3827. * Updates the given rotation matrix with the current quaternion values
  3828. * @param result defines the target matrix
  3829. * @returns the current unchanged quaternion
  3830. */
  3831. toRotationMatrix(result: Matrix): Quaternion;
  3832. /**
  3833. * Updates the current quaternion from the given rotation matrix values
  3834. * @param matrix defines the source matrix
  3835. * @returns the current updated quaternion
  3836. */
  3837. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3838. /**
  3839. * Creates a new quaternion from a rotation matrix
  3840. * @param matrix defines the source matrix
  3841. * @returns a new quaternion created from the given rotation matrix values
  3842. */
  3843. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3844. /**
  3845. * Updates the given quaternion with the given rotation matrix values
  3846. * @param matrix defines the source matrix
  3847. * @param result defines the target quaternion
  3848. */
  3849. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3850. /**
  3851. * Returns the dot product (float) between the quaternions "left" and "right"
  3852. * @param left defines the left operand
  3853. * @param right defines the right operand
  3854. * @returns the dot product
  3855. */
  3856. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3857. /**
  3858. * Checks if the two quaternions are close to each other
  3859. * @param quat0 defines the first quaternion to check
  3860. * @param quat1 defines the second quaternion to check
  3861. * @returns true if the two quaternions are close to each other
  3862. */
  3863. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3864. /**
  3865. * Creates an empty quaternion
  3866. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3867. */
  3868. static Zero(): Quaternion;
  3869. /**
  3870. * Inverse a given quaternion
  3871. * @param q defines the source quaternion
  3872. * @returns a new quaternion as the inverted current quaternion
  3873. */
  3874. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3875. /**
  3876. * Inverse a given quaternion
  3877. * @param q defines the source quaternion
  3878. * @param result the quaternion the result will be stored in
  3879. * @returns the result quaternion
  3880. */
  3881. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3882. /**
  3883. * Creates an identity quaternion
  3884. * @returns the identity quaternion
  3885. */
  3886. static Identity(): Quaternion;
  3887. /**
  3888. * Gets a boolean indicating if the given quaternion is identity
  3889. * @param quaternion defines the quaternion to check
  3890. * @returns true if the quaternion is identity
  3891. */
  3892. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3893. /**
  3894. * Creates a quaternion from a rotation around an axis
  3895. * @param axis defines the axis to use
  3896. * @param angle defines the angle to use
  3897. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3898. */
  3899. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3900. /**
  3901. * Creates a rotation around an axis and stores it into the given quaternion
  3902. * @param axis defines the axis to use
  3903. * @param angle defines the angle to use
  3904. * @param result defines the target quaternion
  3905. * @returns the target quaternion
  3906. */
  3907. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3908. /**
  3909. * Creates a new quaternion from data stored into an array
  3910. * @param array defines the data source
  3911. * @param offset defines the offset in the source array where the data starts
  3912. * @returns a new quaternion
  3913. */
  3914. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3915. /**
  3916. * Updates the given quaternion "result" from the starting index of the given array.
  3917. * @param array the array to pull values from
  3918. * @param offset the offset into the array to start at
  3919. * @param result the quaternion to store the result in
  3920. */
  3921. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3922. /**
  3923. * Create a quaternion from Euler rotation angles
  3924. * @param x Pitch
  3925. * @param y Yaw
  3926. * @param z Roll
  3927. * @returns the new Quaternion
  3928. */
  3929. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3930. /**
  3931. * Updates a quaternion from Euler rotation angles
  3932. * @param x Pitch
  3933. * @param y Yaw
  3934. * @param z Roll
  3935. * @param result the quaternion to store the result
  3936. * @returns the updated quaternion
  3937. */
  3938. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3939. /**
  3940. * Create a quaternion from Euler rotation vector
  3941. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3942. * @returns the new Quaternion
  3943. */
  3944. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3945. /**
  3946. * Updates a quaternion from Euler rotation vector
  3947. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3948. * @param result the quaternion to store the result
  3949. * @returns the updated quaternion
  3950. */
  3951. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  3952. /**
  3953. * Creates a new quaternion from the given Euler float angles (y, x, z)
  3954. * @param yaw defines the rotation around Y axis
  3955. * @param pitch defines the rotation around X axis
  3956. * @param roll defines the rotation around Z axis
  3957. * @returns the new quaternion
  3958. */
  3959. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  3960. /**
  3961. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  3962. * @param yaw defines the rotation around Y axis
  3963. * @param pitch defines the rotation around X axis
  3964. * @param roll defines the rotation around Z axis
  3965. * @param result defines the target quaternion
  3966. */
  3967. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  3968. /**
  3969. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  3970. * @param alpha defines the rotation around first axis
  3971. * @param beta defines the rotation around second axis
  3972. * @param gamma defines the rotation around third axis
  3973. * @returns the new quaternion
  3974. */
  3975. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  3976. /**
  3977. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  3978. * @param alpha defines the rotation around first axis
  3979. * @param beta defines the rotation around second axis
  3980. * @param gamma defines the rotation around third axis
  3981. * @param result defines the target quaternion
  3982. */
  3983. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  3984. /**
  3985. * 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)
  3986. * @param axis1 defines the first axis
  3987. * @param axis2 defines the second axis
  3988. * @param axis3 defines the third axis
  3989. * @returns the new quaternion
  3990. */
  3991. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  3992. /**
  3993. * 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
  3994. * @param axis1 defines the first axis
  3995. * @param axis2 defines the second axis
  3996. * @param axis3 defines the third axis
  3997. * @param ref defines the target quaternion
  3998. */
  3999. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4000. /**
  4001. * Interpolates between two quaternions
  4002. * @param left defines first quaternion
  4003. * @param right defines second quaternion
  4004. * @param amount defines the gradient to use
  4005. * @returns the new interpolated quaternion
  4006. */
  4007. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4008. /**
  4009. * Interpolates between two quaternions and stores it into a target quaternion
  4010. * @param left defines first quaternion
  4011. * @param right defines second quaternion
  4012. * @param amount defines the gradient to use
  4013. * @param result defines the target quaternion
  4014. */
  4015. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4016. /**
  4017. * Interpolate between two quaternions using Hermite interpolation
  4018. * @param value1 defines first quaternion
  4019. * @param tangent1 defines the incoming tangent
  4020. * @param value2 defines second quaternion
  4021. * @param tangent2 defines the outgoing tangent
  4022. * @param amount defines the target quaternion
  4023. * @returns the new interpolated quaternion
  4024. */
  4025. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4026. }
  4027. /**
  4028. * Class used to store matrix data (4x4)
  4029. */
  4030. export class Matrix {
  4031. private static _updateFlagSeed;
  4032. private static _identityReadOnly;
  4033. private _isIdentity;
  4034. private _isIdentityDirty;
  4035. private _isIdentity3x2;
  4036. private _isIdentity3x2Dirty;
  4037. /**
  4038. * Gets the update flag of the matrix which is an unique number for the matrix.
  4039. * It will be incremented every time the matrix data change.
  4040. * You can use it to speed the comparison between two versions of the same matrix.
  4041. */
  4042. updateFlag: number;
  4043. private readonly _m;
  4044. /**
  4045. * Gets the internal data of the matrix
  4046. */
  4047. get m(): DeepImmutable<Float32Array>;
  4048. /** @hidden */
  4049. _markAsUpdated(): void;
  4050. /** @hidden */
  4051. private _updateIdentityStatus;
  4052. /**
  4053. * Creates an empty matrix (filled with zeros)
  4054. */
  4055. constructor();
  4056. /**
  4057. * Check if the current matrix is identity
  4058. * @returns true is the matrix is the identity matrix
  4059. */
  4060. isIdentity(): boolean;
  4061. /**
  4062. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4063. * @returns true is the matrix is the identity matrix
  4064. */
  4065. isIdentityAs3x2(): boolean;
  4066. /**
  4067. * Gets the determinant of the matrix
  4068. * @returns the matrix determinant
  4069. */
  4070. determinant(): number;
  4071. /**
  4072. * Returns the matrix as a Float32Array
  4073. * @returns the matrix underlying array
  4074. */
  4075. toArray(): DeepImmutable<Float32Array>;
  4076. /**
  4077. * Returns the matrix as a Float32Array
  4078. * @returns the matrix underlying array.
  4079. */
  4080. asArray(): DeepImmutable<Float32Array>;
  4081. /**
  4082. * Inverts the current matrix in place
  4083. * @returns the current inverted matrix
  4084. */
  4085. invert(): Matrix;
  4086. /**
  4087. * Sets all the matrix elements to zero
  4088. * @returns the current matrix
  4089. */
  4090. reset(): Matrix;
  4091. /**
  4092. * Adds the current matrix with a second one
  4093. * @param other defines the matrix to add
  4094. * @returns a new matrix as the addition of the current matrix and the given one
  4095. */
  4096. add(other: DeepImmutable<Matrix>): Matrix;
  4097. /**
  4098. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4099. * @param other defines the matrix to add
  4100. * @param result defines the target matrix
  4101. * @returns the current matrix
  4102. */
  4103. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4104. /**
  4105. * Adds in place the given matrix to the current matrix
  4106. * @param other defines the second operand
  4107. * @returns the current updated matrix
  4108. */
  4109. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4110. /**
  4111. * Sets the given matrix to the current inverted Matrix
  4112. * @param other defines the target matrix
  4113. * @returns the unmodified current matrix
  4114. */
  4115. invertToRef(other: Matrix): Matrix;
  4116. /**
  4117. * add a value at the specified position in the current Matrix
  4118. * @param index the index of the value within the matrix. between 0 and 15.
  4119. * @param value the value to be added
  4120. * @returns the current updated matrix
  4121. */
  4122. addAtIndex(index: number, value: number): Matrix;
  4123. /**
  4124. * mutiply the specified position in the current Matrix by a value
  4125. * @param index the index of the value within the matrix. between 0 and 15.
  4126. * @param value the value to be added
  4127. * @returns the current updated matrix
  4128. */
  4129. multiplyAtIndex(index: number, value: number): Matrix;
  4130. /**
  4131. * Inserts the translation vector (using 3 floats) in the current matrix
  4132. * @param x defines the 1st component of the translation
  4133. * @param y defines the 2nd component of the translation
  4134. * @param z defines the 3rd component of the translation
  4135. * @returns the current updated matrix
  4136. */
  4137. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4138. /**
  4139. * Adds the translation vector (using 3 floats) in the current matrix
  4140. * @param x defines the 1st component of the translation
  4141. * @param y defines the 2nd component of the translation
  4142. * @param z defines the 3rd component of the translation
  4143. * @returns the current updated matrix
  4144. */
  4145. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4146. /**
  4147. * Inserts the translation vector in the current matrix
  4148. * @param vector3 defines the translation to insert
  4149. * @returns the current updated matrix
  4150. */
  4151. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4152. /**
  4153. * Gets the translation value of the current matrix
  4154. * @returns a new Vector3 as the extracted translation from the matrix
  4155. */
  4156. getTranslation(): Vector3;
  4157. /**
  4158. * Fill a Vector3 with the extracted translation from the matrix
  4159. * @param result defines the Vector3 where to store the translation
  4160. * @returns the current matrix
  4161. */
  4162. getTranslationToRef(result: Vector3): Matrix;
  4163. /**
  4164. * Remove rotation and scaling part from the matrix
  4165. * @returns the updated matrix
  4166. */
  4167. removeRotationAndScaling(): Matrix;
  4168. /**
  4169. * Multiply two matrices
  4170. * @param other defines the second operand
  4171. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4172. */
  4173. multiply(other: DeepImmutable<Matrix>): Matrix;
  4174. /**
  4175. * Copy the current matrix from the given one
  4176. * @param other defines the source matrix
  4177. * @returns the current updated matrix
  4178. */
  4179. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4180. /**
  4181. * Populates the given array from the starting index with the current matrix values
  4182. * @param array defines the target array
  4183. * @param offset defines the offset in the target array where to start storing values
  4184. * @returns the current matrix
  4185. */
  4186. copyToArray(array: Float32Array, offset?: number): Matrix;
  4187. /**
  4188. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4189. * @param other defines the second operand
  4190. * @param result defines the matrix where to store the multiplication
  4191. * @returns the current matrix
  4192. */
  4193. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4194. /**
  4195. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4196. * @param other defines the second operand
  4197. * @param result defines the array where to store the multiplication
  4198. * @param offset defines the offset in the target array where to start storing values
  4199. * @returns the current matrix
  4200. */
  4201. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  4202. /**
  4203. * Check equality between this matrix and a second one
  4204. * @param value defines the second matrix to compare
  4205. * @returns true is the current matrix and the given one values are strictly equal
  4206. */
  4207. equals(value: DeepImmutable<Matrix>): boolean;
  4208. /**
  4209. * Clone the current matrix
  4210. * @returns a new matrix from the current matrix
  4211. */
  4212. clone(): Matrix;
  4213. /**
  4214. * Returns the name of the current matrix class
  4215. * @returns the string "Matrix"
  4216. */
  4217. getClassName(): string;
  4218. /**
  4219. * Gets the hash code of the current matrix
  4220. * @returns the hash code
  4221. */
  4222. getHashCode(): number;
  4223. /**
  4224. * Decomposes the current Matrix into a translation, rotation and scaling components
  4225. * @param scale defines the scale vector3 given as a reference to update
  4226. * @param rotation defines the rotation quaternion given as a reference to update
  4227. * @param translation defines the translation vector3 given as a reference to update
  4228. * @returns true if operation was successful
  4229. */
  4230. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4231. /**
  4232. * Gets specific row of the matrix
  4233. * @param index defines the number of the row to get
  4234. * @returns the index-th row of the current matrix as a new Vector4
  4235. */
  4236. getRow(index: number): Nullable<Vector4>;
  4237. /**
  4238. * Sets the index-th row of the current matrix to the vector4 values
  4239. * @param index defines the number of the row to set
  4240. * @param row defines the target vector4
  4241. * @returns the updated current matrix
  4242. */
  4243. setRow(index: number, row: Vector4): Matrix;
  4244. /**
  4245. * Compute the transpose of the matrix
  4246. * @returns the new transposed matrix
  4247. */
  4248. transpose(): Matrix;
  4249. /**
  4250. * Compute the transpose of the matrix and store it in a given matrix
  4251. * @param result defines the target matrix
  4252. * @returns the current matrix
  4253. */
  4254. transposeToRef(result: Matrix): Matrix;
  4255. /**
  4256. * Sets the index-th row of the current matrix with the given 4 x float values
  4257. * @param index defines the row index
  4258. * @param x defines the x component to set
  4259. * @param y defines the y component to set
  4260. * @param z defines the z component to set
  4261. * @param w defines the w component to set
  4262. * @returns the updated current matrix
  4263. */
  4264. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4265. /**
  4266. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4267. * @param scale defines the scale factor
  4268. * @returns a new matrix
  4269. */
  4270. scale(scale: number): Matrix;
  4271. /**
  4272. * Scale the current matrix values by a factor to a given result matrix
  4273. * @param scale defines the scale factor
  4274. * @param result defines the matrix to store the result
  4275. * @returns the current matrix
  4276. */
  4277. scaleToRef(scale: number, result: Matrix): Matrix;
  4278. /**
  4279. * Scale the current matrix values by a factor and add the result to a given matrix
  4280. * @param scale defines the scale factor
  4281. * @param result defines the Matrix to store the result
  4282. * @returns the current matrix
  4283. */
  4284. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4285. /**
  4286. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4287. * @param ref matrix to store the result
  4288. */
  4289. toNormalMatrix(ref: Matrix): void;
  4290. /**
  4291. * Gets only rotation part of the current matrix
  4292. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4293. */
  4294. getRotationMatrix(): Matrix;
  4295. /**
  4296. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4297. * @param result defines the target matrix to store data to
  4298. * @returns the current matrix
  4299. */
  4300. getRotationMatrixToRef(result: Matrix): Matrix;
  4301. /**
  4302. * Toggles model matrix from being right handed to left handed in place and vice versa
  4303. */
  4304. toggleModelMatrixHandInPlace(): void;
  4305. /**
  4306. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4307. */
  4308. toggleProjectionMatrixHandInPlace(): void;
  4309. /**
  4310. * Creates a matrix from an array
  4311. * @param array defines the source array
  4312. * @param offset defines an offset in the source array
  4313. * @returns a new Matrix set from the starting index of the given array
  4314. */
  4315. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4316. /**
  4317. * Copy the content of an array into a given matrix
  4318. * @param array defines the source array
  4319. * @param offset defines an offset in the source array
  4320. * @param result defines the target matrix
  4321. */
  4322. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4323. /**
  4324. * Stores an array into a matrix after having multiplied each component by a given factor
  4325. * @param array defines the source array
  4326. * @param offset defines the offset in the source array
  4327. * @param scale defines the scaling factor
  4328. * @param result defines the target matrix
  4329. */
  4330. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  4331. /**
  4332. * Gets an identity matrix that must not be updated
  4333. */
  4334. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4335. /**
  4336. * Stores a list of values (16) inside a given matrix
  4337. * @param initialM11 defines 1st value of 1st row
  4338. * @param initialM12 defines 2nd value of 1st row
  4339. * @param initialM13 defines 3rd value of 1st row
  4340. * @param initialM14 defines 4th value of 1st row
  4341. * @param initialM21 defines 1st value of 2nd row
  4342. * @param initialM22 defines 2nd value of 2nd row
  4343. * @param initialM23 defines 3rd value of 2nd row
  4344. * @param initialM24 defines 4th value of 2nd row
  4345. * @param initialM31 defines 1st value of 3rd row
  4346. * @param initialM32 defines 2nd value of 3rd row
  4347. * @param initialM33 defines 3rd value of 3rd row
  4348. * @param initialM34 defines 4th value of 3rd row
  4349. * @param initialM41 defines 1st value of 4th row
  4350. * @param initialM42 defines 2nd value of 4th row
  4351. * @param initialM43 defines 3rd value of 4th row
  4352. * @param initialM44 defines 4th value of 4th row
  4353. * @param result defines the target matrix
  4354. */
  4355. 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;
  4356. /**
  4357. * Creates new matrix from a list of values (16)
  4358. * @param initialM11 defines 1st value of 1st row
  4359. * @param initialM12 defines 2nd value of 1st row
  4360. * @param initialM13 defines 3rd value of 1st row
  4361. * @param initialM14 defines 4th value of 1st row
  4362. * @param initialM21 defines 1st value of 2nd row
  4363. * @param initialM22 defines 2nd value of 2nd row
  4364. * @param initialM23 defines 3rd value of 2nd row
  4365. * @param initialM24 defines 4th value of 2nd row
  4366. * @param initialM31 defines 1st value of 3rd row
  4367. * @param initialM32 defines 2nd value of 3rd row
  4368. * @param initialM33 defines 3rd value of 3rd row
  4369. * @param initialM34 defines 4th value of 3rd row
  4370. * @param initialM41 defines 1st value of 4th row
  4371. * @param initialM42 defines 2nd value of 4th row
  4372. * @param initialM43 defines 3rd value of 4th row
  4373. * @param initialM44 defines 4th value of 4th row
  4374. * @returns the new matrix
  4375. */
  4376. 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;
  4377. /**
  4378. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4379. * @param scale defines the scale vector3
  4380. * @param rotation defines the rotation quaternion
  4381. * @param translation defines the translation vector3
  4382. * @returns a new matrix
  4383. */
  4384. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4385. /**
  4386. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4387. * @param scale defines the scale vector3
  4388. * @param rotation defines the rotation quaternion
  4389. * @param translation defines the translation vector3
  4390. * @param result defines the target matrix
  4391. */
  4392. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4393. /**
  4394. * Creates a new identity matrix
  4395. * @returns a new identity matrix
  4396. */
  4397. static Identity(): Matrix;
  4398. /**
  4399. * Creates a new identity matrix and stores the result in a given matrix
  4400. * @param result defines the target matrix
  4401. */
  4402. static IdentityToRef(result: Matrix): void;
  4403. /**
  4404. * Creates a new zero matrix
  4405. * @returns a new zero matrix
  4406. */
  4407. static Zero(): Matrix;
  4408. /**
  4409. * Creates a new rotation matrix for "angle" radians around the X axis
  4410. * @param angle defines the angle (in radians) to use
  4411. * @return the new matrix
  4412. */
  4413. static RotationX(angle: number): Matrix;
  4414. /**
  4415. * Creates a new matrix as the invert of a given matrix
  4416. * @param source defines the source matrix
  4417. * @returns the new matrix
  4418. */
  4419. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4420. /**
  4421. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4422. * @param angle defines the angle (in radians) to use
  4423. * @param result defines the target matrix
  4424. */
  4425. static RotationXToRef(angle: number, result: Matrix): void;
  4426. /**
  4427. * Creates a new rotation matrix for "angle" radians around the Y axis
  4428. * @param angle defines the angle (in radians) to use
  4429. * @return the new matrix
  4430. */
  4431. static RotationY(angle: number): Matrix;
  4432. /**
  4433. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4434. * @param angle defines the angle (in radians) to use
  4435. * @param result defines the target matrix
  4436. */
  4437. static RotationYToRef(angle: number, result: Matrix): void;
  4438. /**
  4439. * Creates a new rotation matrix for "angle" radians around the Z axis
  4440. * @param angle defines the angle (in radians) to use
  4441. * @return the new matrix
  4442. */
  4443. static RotationZ(angle: number): Matrix;
  4444. /**
  4445. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4446. * @param angle defines the angle (in radians) to use
  4447. * @param result defines the target matrix
  4448. */
  4449. static RotationZToRef(angle: number, result: Matrix): void;
  4450. /**
  4451. * Creates a new rotation matrix for "angle" radians around the given axis
  4452. * @param axis defines the axis to use
  4453. * @param angle defines the angle (in radians) to use
  4454. * @return the new matrix
  4455. */
  4456. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4457. /**
  4458. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4459. * @param axis defines the axis to use
  4460. * @param angle defines the angle (in radians) to use
  4461. * @param result defines the target matrix
  4462. */
  4463. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4464. /**
  4465. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4466. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4467. * @param from defines the vector to align
  4468. * @param to defines the vector to align to
  4469. * @param result defines the target matrix
  4470. */
  4471. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4472. /**
  4473. * Creates a rotation matrix
  4474. * @param yaw defines the yaw angle in radians (Y axis)
  4475. * @param pitch defines the pitch angle in radians (X axis)
  4476. * @param roll defines the roll angle in radians (X axis)
  4477. * @returns the new rotation matrix
  4478. */
  4479. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4480. /**
  4481. * Creates a rotation matrix and stores it in a given matrix
  4482. * @param yaw defines the yaw angle in radians (Y axis)
  4483. * @param pitch defines the pitch angle in radians (X axis)
  4484. * @param roll defines the roll angle in radians (X axis)
  4485. * @param result defines the target matrix
  4486. */
  4487. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4488. /**
  4489. * Creates a scaling matrix
  4490. * @param x defines the scale factor on X axis
  4491. * @param y defines the scale factor on Y axis
  4492. * @param z defines the scale factor on Z axis
  4493. * @returns the new matrix
  4494. */
  4495. static Scaling(x: number, y: number, z: number): Matrix;
  4496. /**
  4497. * Creates a scaling matrix and stores it in a given matrix
  4498. * @param x defines the scale factor on X axis
  4499. * @param y defines the scale factor on Y axis
  4500. * @param z defines the scale factor on Z axis
  4501. * @param result defines the target matrix
  4502. */
  4503. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4504. /**
  4505. * Creates a translation matrix
  4506. * @param x defines the translation on X axis
  4507. * @param y defines the translation on Y axis
  4508. * @param z defines the translationon Z axis
  4509. * @returns the new matrix
  4510. */
  4511. static Translation(x: number, y: number, z: number): Matrix;
  4512. /**
  4513. * Creates a translation matrix and stores it in a given matrix
  4514. * @param x defines the translation on X axis
  4515. * @param y defines the translation on Y axis
  4516. * @param z defines the translationon Z axis
  4517. * @param result defines the target matrix
  4518. */
  4519. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4520. /**
  4521. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4522. * @param startValue defines the start value
  4523. * @param endValue defines the end value
  4524. * @param gradient defines the gradient factor
  4525. * @returns the new matrix
  4526. */
  4527. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4528. /**
  4529. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4530. * @param startValue defines the start value
  4531. * @param endValue defines the end value
  4532. * @param gradient defines the gradient factor
  4533. * @param result defines the Matrix object where to store data
  4534. */
  4535. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4536. /**
  4537. * Builds a new matrix whose values are computed by:
  4538. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4539. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4540. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4541. * @param startValue defines the first matrix
  4542. * @param endValue defines the second matrix
  4543. * @param gradient defines the gradient between the two matrices
  4544. * @returns the new matrix
  4545. */
  4546. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4547. /**
  4548. * Update a matrix to values which are computed by:
  4549. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4550. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4551. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4552. * @param startValue defines the first matrix
  4553. * @param endValue defines the second matrix
  4554. * @param gradient defines the gradient between the two matrices
  4555. * @param result defines the target matrix
  4556. */
  4557. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4558. /**
  4559. * 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"
  4560. * This function works in left handed mode
  4561. * @param eye defines the final position of the entity
  4562. * @param target defines where the entity should look at
  4563. * @param up defines the up vector for the entity
  4564. * @returns the new matrix
  4565. */
  4566. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4567. /**
  4568. * 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".
  4569. * This function works in left handed mode
  4570. * @param eye defines the final position of the entity
  4571. * @param target defines where the entity should look at
  4572. * @param up defines the up vector for the entity
  4573. * @param result defines the target matrix
  4574. */
  4575. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4576. /**
  4577. * 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"
  4578. * This function works in right handed mode
  4579. * @param eye defines the final position of the entity
  4580. * @param target defines where the entity should look at
  4581. * @param up defines the up vector for the entity
  4582. * @returns the new matrix
  4583. */
  4584. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4585. /**
  4586. * 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".
  4587. * This function works in right handed mode
  4588. * @param eye defines the final position of the entity
  4589. * @param target defines where the entity should look at
  4590. * @param up defines the up vector for the entity
  4591. * @param result defines the target matrix
  4592. */
  4593. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4594. /**
  4595. * Create a left-handed orthographic projection matrix
  4596. * @param width defines the viewport width
  4597. * @param height defines the viewport height
  4598. * @param znear defines the near clip plane
  4599. * @param zfar defines the far clip plane
  4600. * @returns a new matrix as a left-handed orthographic projection matrix
  4601. */
  4602. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4603. /**
  4604. * Store a left-handed orthographic projection to a given matrix
  4605. * @param width defines the viewport width
  4606. * @param height defines the viewport height
  4607. * @param znear defines the near clip plane
  4608. * @param zfar defines the far clip plane
  4609. * @param result defines the target matrix
  4610. */
  4611. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4612. /**
  4613. * Create a left-handed orthographic projection matrix
  4614. * @param left defines the viewport left coordinate
  4615. * @param right defines the viewport right coordinate
  4616. * @param bottom defines the viewport bottom coordinate
  4617. * @param top defines the viewport top coordinate
  4618. * @param znear defines the near clip plane
  4619. * @param zfar defines the far clip plane
  4620. * @returns a new matrix as a left-handed orthographic projection matrix
  4621. */
  4622. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4623. /**
  4624. * Stores a left-handed orthographic projection into a given matrix
  4625. * @param left defines the viewport left coordinate
  4626. * @param right defines the viewport right coordinate
  4627. * @param bottom defines the viewport bottom coordinate
  4628. * @param top defines the viewport top coordinate
  4629. * @param znear defines the near clip plane
  4630. * @param zfar defines the far clip plane
  4631. * @param result defines the target matrix
  4632. */
  4633. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4634. /**
  4635. * Creates a right-handed orthographic projection matrix
  4636. * @param left defines the viewport left coordinate
  4637. * @param right defines the viewport right coordinate
  4638. * @param bottom defines the viewport bottom coordinate
  4639. * @param top defines the viewport top coordinate
  4640. * @param znear defines the near clip plane
  4641. * @param zfar defines the far clip plane
  4642. * @returns a new matrix as a right-handed orthographic projection matrix
  4643. */
  4644. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4645. /**
  4646. * Stores a right-handed orthographic projection into a given matrix
  4647. * @param left defines the viewport left coordinate
  4648. * @param right defines the viewport right coordinate
  4649. * @param bottom defines the viewport bottom coordinate
  4650. * @param top defines the viewport top coordinate
  4651. * @param znear defines the near clip plane
  4652. * @param zfar defines the far clip plane
  4653. * @param result defines the target matrix
  4654. */
  4655. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4656. /**
  4657. * Creates a left-handed perspective projection matrix
  4658. * @param width defines the viewport width
  4659. * @param height defines the viewport height
  4660. * @param znear defines the near clip plane
  4661. * @param zfar defines the far clip plane
  4662. * @returns a new matrix as a left-handed perspective projection matrix
  4663. */
  4664. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4665. /**
  4666. * Creates a left-handed perspective projection matrix
  4667. * @param fov defines the horizontal field of view
  4668. * @param aspect defines the aspect ratio
  4669. * @param znear defines the near clip plane
  4670. * @param zfar defines the far clip plane
  4671. * @returns a new matrix as a left-handed perspective projection matrix
  4672. */
  4673. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4674. /**
  4675. * Stores a left-handed perspective projection into a given matrix
  4676. * @param fov defines the horizontal field of view
  4677. * @param aspect defines the aspect ratio
  4678. * @param znear defines the near clip plane
  4679. * @param zfar defines the far clip plane
  4680. * @param result defines the target matrix
  4681. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4682. */
  4683. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4684. /**
  4685. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4686. * @param fov defines the horizontal field of view
  4687. * @param aspect defines the aspect ratio
  4688. * @param znear defines the near clip plane
  4689. * @param zfar not used as infinity is used as far clip
  4690. * @param result defines the target matrix
  4691. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4692. */
  4693. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4694. /**
  4695. * Creates a right-handed perspective projection matrix
  4696. * @param fov defines the horizontal field of view
  4697. * @param aspect defines the aspect ratio
  4698. * @param znear defines the near clip plane
  4699. * @param zfar defines the far clip plane
  4700. * @returns a new matrix as a right-handed perspective projection matrix
  4701. */
  4702. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4703. /**
  4704. * Stores a right-handed perspective projection into a given matrix
  4705. * @param fov defines the horizontal field of view
  4706. * @param aspect defines the aspect ratio
  4707. * @param znear defines the near clip plane
  4708. * @param zfar defines the far clip plane
  4709. * @param result defines the target matrix
  4710. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4711. */
  4712. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4713. /**
  4714. * Stores a right-handed perspective projection into a given matrix
  4715. * @param fov defines the horizontal field of view
  4716. * @param aspect defines the aspect ratio
  4717. * @param znear defines the near clip plane
  4718. * @param zfar not used as infinity is used as far clip
  4719. * @param result defines the target matrix
  4720. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4721. */
  4722. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4723. /**
  4724. * Stores a perspective projection for WebVR info a given matrix
  4725. * @param fov defines the field of view
  4726. * @param znear defines the near clip plane
  4727. * @param zfar defines the far clip plane
  4728. * @param result defines the target matrix
  4729. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4730. */
  4731. static PerspectiveFovWebVRToRef(fov: {
  4732. upDegrees: number;
  4733. downDegrees: number;
  4734. leftDegrees: number;
  4735. rightDegrees: number;
  4736. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4737. /**
  4738. * Computes a complete transformation matrix
  4739. * @param viewport defines the viewport to use
  4740. * @param world defines the world matrix
  4741. * @param view defines the view matrix
  4742. * @param projection defines the projection matrix
  4743. * @param zmin defines the near clip plane
  4744. * @param zmax defines the far clip plane
  4745. * @returns the transformation matrix
  4746. */
  4747. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4748. /**
  4749. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4750. * @param matrix defines the matrix to use
  4751. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4752. */
  4753. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  4754. /**
  4755. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4756. * @param matrix defines the matrix to use
  4757. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4758. */
  4759. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  4760. /**
  4761. * Compute the transpose of a given matrix
  4762. * @param matrix defines the matrix to transpose
  4763. * @returns the new matrix
  4764. */
  4765. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4766. /**
  4767. * Compute the transpose of a matrix and store it in a target matrix
  4768. * @param matrix defines the matrix to transpose
  4769. * @param result defines the target matrix
  4770. */
  4771. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4772. /**
  4773. * Computes a reflection matrix from a plane
  4774. * @param plane defines the reflection plane
  4775. * @returns a new matrix
  4776. */
  4777. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4778. /**
  4779. * Computes a reflection matrix from a plane
  4780. * @param plane defines the reflection plane
  4781. * @param result defines the target matrix
  4782. */
  4783. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4784. /**
  4785. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4786. * @param xaxis defines the value of the 1st axis
  4787. * @param yaxis defines the value of the 2nd axis
  4788. * @param zaxis defines the value of the 3rd axis
  4789. * @param result defines the target matrix
  4790. */
  4791. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4792. /**
  4793. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4794. * @param quat defines the quaternion to use
  4795. * @param result defines the target matrix
  4796. */
  4797. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4798. }
  4799. /**
  4800. * @hidden
  4801. */
  4802. export class TmpVectors {
  4803. static Vector2: Vector2[];
  4804. static Vector3: Vector3[];
  4805. static Vector4: Vector4[];
  4806. static Quaternion: Quaternion[];
  4807. static Matrix: Matrix[];
  4808. }
  4809. }
  4810. declare module "babylonjs/Maths/math.path" {
  4811. import { DeepImmutable, Nullable } from "babylonjs/types";
  4812. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4813. /**
  4814. * Defines potential orientation for back face culling
  4815. */
  4816. export enum Orientation {
  4817. /**
  4818. * Clockwise
  4819. */
  4820. CW = 0,
  4821. /** Counter clockwise */
  4822. CCW = 1
  4823. }
  4824. /** Class used to represent a Bezier curve */
  4825. export class BezierCurve {
  4826. /**
  4827. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4828. * @param t defines the time
  4829. * @param x1 defines the left coordinate on X axis
  4830. * @param y1 defines the left coordinate on Y axis
  4831. * @param x2 defines the right coordinate on X axis
  4832. * @param y2 defines the right coordinate on Y axis
  4833. * @returns the interpolated value
  4834. */
  4835. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4836. }
  4837. /**
  4838. * Defines angle representation
  4839. */
  4840. export class Angle {
  4841. private _radians;
  4842. /**
  4843. * Creates an Angle object of "radians" radians (float).
  4844. * @param radians the angle in radians
  4845. */
  4846. constructor(radians: number);
  4847. /**
  4848. * Get value in degrees
  4849. * @returns the Angle value in degrees (float)
  4850. */
  4851. degrees(): number;
  4852. /**
  4853. * Get value in radians
  4854. * @returns the Angle value in radians (float)
  4855. */
  4856. radians(): number;
  4857. /**
  4858. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  4859. * @param a defines first vector
  4860. * @param b defines second vector
  4861. * @returns a new Angle
  4862. */
  4863. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4864. /**
  4865. * Gets a new Angle object from the given float in radians
  4866. * @param radians defines the angle value in radians
  4867. * @returns a new Angle
  4868. */
  4869. static FromRadians(radians: number): Angle;
  4870. /**
  4871. * Gets a new Angle object from the given float in degrees
  4872. * @param degrees defines the angle value in degrees
  4873. * @returns a new Angle
  4874. */
  4875. static FromDegrees(degrees: number): Angle;
  4876. }
  4877. /**
  4878. * This represents an arc in a 2d space.
  4879. */
  4880. export class Arc2 {
  4881. /** Defines the start point of the arc */
  4882. startPoint: Vector2;
  4883. /** Defines the mid point of the arc */
  4884. midPoint: Vector2;
  4885. /** Defines the end point of the arc */
  4886. endPoint: Vector2;
  4887. /**
  4888. * Defines the center point of the arc.
  4889. */
  4890. centerPoint: Vector2;
  4891. /**
  4892. * Defines the radius of the arc.
  4893. */
  4894. radius: number;
  4895. /**
  4896. * Defines the angle of the arc (from mid point to end point).
  4897. */
  4898. angle: Angle;
  4899. /**
  4900. * Defines the start angle of the arc (from start point to middle point).
  4901. */
  4902. startAngle: Angle;
  4903. /**
  4904. * Defines the orientation of the arc (clock wise/counter clock wise).
  4905. */
  4906. orientation: Orientation;
  4907. /**
  4908. * Creates an Arc object from the three given points : start, middle and end.
  4909. * @param startPoint Defines the start point of the arc
  4910. * @param midPoint Defines the midlle point of the arc
  4911. * @param endPoint Defines the end point of the arc
  4912. */
  4913. constructor(
  4914. /** Defines the start point of the arc */
  4915. startPoint: Vector2,
  4916. /** Defines the mid point of the arc */
  4917. midPoint: Vector2,
  4918. /** Defines the end point of the arc */
  4919. endPoint: Vector2);
  4920. }
  4921. /**
  4922. * Represents a 2D path made up of multiple 2D points
  4923. */
  4924. export class Path2 {
  4925. private _points;
  4926. private _length;
  4927. /**
  4928. * If the path start and end point are the same
  4929. */
  4930. closed: boolean;
  4931. /**
  4932. * Creates a Path2 object from the starting 2D coordinates x and y.
  4933. * @param x the starting points x value
  4934. * @param y the starting points y value
  4935. */
  4936. constructor(x: number, y: number);
  4937. /**
  4938. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4939. * @param x the added points x value
  4940. * @param y the added points y value
  4941. * @returns the updated Path2.
  4942. */
  4943. addLineTo(x: number, y: number): Path2;
  4944. /**
  4945. * 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.
  4946. * @param midX middle point x value
  4947. * @param midY middle point y value
  4948. * @param endX end point x value
  4949. * @param endY end point y value
  4950. * @param numberOfSegments (default: 36)
  4951. * @returns the updated Path2.
  4952. */
  4953. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  4954. /**
  4955. * Closes the Path2.
  4956. * @returns the Path2.
  4957. */
  4958. close(): Path2;
  4959. /**
  4960. * Gets the sum of the distance between each sequential point in the path
  4961. * @returns the Path2 total length (float).
  4962. */
  4963. length(): number;
  4964. /**
  4965. * Gets the points which construct the path
  4966. * @returns the Path2 internal array of points.
  4967. */
  4968. getPoints(): Vector2[];
  4969. /**
  4970. * Retreives the point at the distance aways from the starting point
  4971. * @param normalizedLengthPosition the length along the path to retreive the point from
  4972. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  4973. */
  4974. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  4975. /**
  4976. * Creates a new path starting from an x and y position
  4977. * @param x starting x value
  4978. * @param y starting y value
  4979. * @returns a new Path2 starting at the coordinates (x, y).
  4980. */
  4981. static StartingAt(x: number, y: number): Path2;
  4982. }
  4983. /**
  4984. * Represents a 3D path made up of multiple 3D points
  4985. */
  4986. export class Path3D {
  4987. /**
  4988. * an array of Vector3, the curve axis of the Path3D
  4989. */
  4990. path: Vector3[];
  4991. private _curve;
  4992. private _distances;
  4993. private _tangents;
  4994. private _normals;
  4995. private _binormals;
  4996. private _raw;
  4997. private _alignTangentsWithPath;
  4998. private readonly _pointAtData;
  4999. /**
  5000. * new Path3D(path, normal, raw)
  5001. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5002. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5003. * @param path an array of Vector3, the curve axis of the Path3D
  5004. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5005. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5006. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5007. */
  5008. constructor(
  5009. /**
  5010. * an array of Vector3, the curve axis of the Path3D
  5011. */
  5012. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5013. /**
  5014. * Returns the Path3D array of successive Vector3 designing its curve.
  5015. * @returns the Path3D array of successive Vector3 designing its curve.
  5016. */
  5017. getCurve(): Vector3[];
  5018. /**
  5019. * Returns the Path3D array of successive Vector3 designing its curve.
  5020. * @returns the Path3D array of successive Vector3 designing its curve.
  5021. */
  5022. getPoints(): Vector3[];
  5023. /**
  5024. * @returns the computed length (float) of the path.
  5025. */
  5026. length(): number;
  5027. /**
  5028. * Returns an array populated with tangent vectors on each Path3D curve point.
  5029. * @returns an array populated with tangent vectors on each Path3D curve point.
  5030. */
  5031. getTangents(): Vector3[];
  5032. /**
  5033. * Returns an array populated with normal vectors on each Path3D curve point.
  5034. * @returns an array populated with normal vectors on each Path3D curve point.
  5035. */
  5036. getNormals(): Vector3[];
  5037. /**
  5038. * Returns an array populated with binormal vectors on each Path3D curve point.
  5039. * @returns an array populated with binormal vectors on each Path3D curve point.
  5040. */
  5041. getBinormals(): Vector3[];
  5042. /**
  5043. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5044. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5045. */
  5046. getDistances(): number[];
  5047. /**
  5048. * Returns an interpolated point along this path
  5049. * @param position the position of the point along this path, from 0.0 to 1.0
  5050. * @returns a new Vector3 as the point
  5051. */
  5052. getPointAt(position: number): Vector3;
  5053. /**
  5054. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5055. * @param position the position of the point along this path, from 0.0 to 1.0
  5056. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5057. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5058. */
  5059. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5060. /**
  5061. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5062. * @param position the position of the point along this path, from 0.0 to 1.0
  5063. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5064. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5065. */
  5066. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5067. /**
  5068. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5069. * @param position the position of the point along this path, from 0.0 to 1.0
  5070. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5071. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5072. */
  5073. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5074. /**
  5075. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5076. * @param position the position of the point along this path, from 0.0 to 1.0
  5077. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5078. */
  5079. getDistanceAt(position: number): number;
  5080. /**
  5081. * Returns the array index of the previous point of an interpolated point along this path
  5082. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5083. * @returns the array index
  5084. */
  5085. getPreviousPointIndexAt(position: number): number;
  5086. /**
  5087. * 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)
  5088. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5089. * @returns the sub position
  5090. */
  5091. getSubPositionAt(position: number): number;
  5092. /**
  5093. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5094. * @param target the vector of which to get the closest position to
  5095. * @returns the position of the closest virtual point on this path to the target vector
  5096. */
  5097. getClosestPositionTo(target: Vector3): number;
  5098. /**
  5099. * Returns a sub path (slice) of this path
  5100. * @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
  5101. * @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
  5102. * @returns a sub path (slice) of this path
  5103. */
  5104. slice(start?: number, end?: number): Path3D;
  5105. /**
  5106. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5107. * @param path path which all values are copied into the curves points
  5108. * @param firstNormal which should be projected onto the curve
  5109. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5110. * @returns the same object updated.
  5111. */
  5112. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5113. private _compute;
  5114. private _getFirstNonNullVector;
  5115. private _getLastNonNullVector;
  5116. private _normalVector;
  5117. /**
  5118. * Updates the point at data for an interpolated point along this curve
  5119. * @param position the position of the point along this curve, from 0.0 to 1.0
  5120. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5121. * @returns the (updated) point at data
  5122. */
  5123. private _updatePointAtData;
  5124. /**
  5125. * Updates the point at data from the specified parameters
  5126. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5127. * @param point the interpolated point
  5128. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5129. */
  5130. private _setPointAtData;
  5131. /**
  5132. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5133. */
  5134. private _updateInterpolationMatrix;
  5135. }
  5136. /**
  5137. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5138. * A Curve3 is designed from a series of successive Vector3.
  5139. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5140. */
  5141. export class Curve3 {
  5142. private _points;
  5143. private _length;
  5144. /**
  5145. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5146. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5147. * @param v1 (Vector3) the control point
  5148. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5149. * @param nbPoints (integer) the wanted number of points in the curve
  5150. * @returns the created Curve3
  5151. */
  5152. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5153. /**
  5154. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5155. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5156. * @param v1 (Vector3) the first control point
  5157. * @param v2 (Vector3) the second control point
  5158. * @param v3 (Vector3) the end point of the Cubic Bezier
  5159. * @param nbPoints (integer) the wanted number of points in the curve
  5160. * @returns the created Curve3
  5161. */
  5162. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5163. /**
  5164. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5165. * @param p1 (Vector3) the origin point of the Hermite Spline
  5166. * @param t1 (Vector3) the tangent vector at the origin point
  5167. * @param p2 (Vector3) the end point of the Hermite Spline
  5168. * @param t2 (Vector3) the tangent vector at the end point
  5169. * @param nbPoints (integer) the wanted number of points in the curve
  5170. * @returns the created Curve3
  5171. */
  5172. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5173. /**
  5174. * Returns a Curve3 object along a CatmullRom Spline curve :
  5175. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5176. * @param nbPoints (integer) the wanted number of points between each curve control points
  5177. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5178. * @returns the created Curve3
  5179. */
  5180. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5181. /**
  5182. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5183. * A Curve3 is designed from a series of successive Vector3.
  5184. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5185. * @param points points which make up the curve
  5186. */
  5187. constructor(points: Vector3[]);
  5188. /**
  5189. * @returns the Curve3 stored array of successive Vector3
  5190. */
  5191. getPoints(): Vector3[];
  5192. /**
  5193. * @returns the computed length (float) of the curve.
  5194. */
  5195. length(): number;
  5196. /**
  5197. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5198. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5199. * curveA and curveB keep unchanged.
  5200. * @param curve the curve to continue from this curve
  5201. * @returns the newly constructed curve
  5202. */
  5203. continue(curve: DeepImmutable<Curve3>): Curve3;
  5204. private _computeLength;
  5205. }
  5206. }
  5207. declare module "babylonjs/Animations/easing" {
  5208. /**
  5209. * This represents the main contract an easing function should follow.
  5210. * Easing functions are used throughout the animation system.
  5211. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5212. */
  5213. export interface IEasingFunction {
  5214. /**
  5215. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5216. * of the easing function.
  5217. * The link below provides some of the most common examples of easing functions.
  5218. * @see https://easings.net/
  5219. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5220. * @returns the corresponding value on the curve defined by the easing function
  5221. */
  5222. ease(gradient: number): number;
  5223. }
  5224. /**
  5225. * Base class used for every default easing function.
  5226. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5227. */
  5228. export class EasingFunction implements IEasingFunction {
  5229. /**
  5230. * Interpolation follows the mathematical formula associated with the easing function.
  5231. */
  5232. static readonly EASINGMODE_EASEIN: number;
  5233. /**
  5234. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5235. */
  5236. static readonly EASINGMODE_EASEOUT: number;
  5237. /**
  5238. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5239. */
  5240. static readonly EASINGMODE_EASEINOUT: number;
  5241. private _easingMode;
  5242. /**
  5243. * Sets the easing mode of the current function.
  5244. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5245. */
  5246. setEasingMode(easingMode: number): void;
  5247. /**
  5248. * Gets the current easing mode.
  5249. * @returns the easing mode
  5250. */
  5251. getEasingMode(): number;
  5252. /**
  5253. * @hidden
  5254. */
  5255. easeInCore(gradient: number): number;
  5256. /**
  5257. * Given an input gradient between 0 and 1, this returns the corresponding value
  5258. * of the easing function.
  5259. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5260. * @returns the corresponding value on the curve defined by the easing function
  5261. */
  5262. ease(gradient: number): number;
  5263. }
  5264. /**
  5265. * Easing function with a circle shape (see link below).
  5266. * @see https://easings.net/#easeInCirc
  5267. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5268. */
  5269. export class CircleEase extends EasingFunction implements IEasingFunction {
  5270. /** @hidden */
  5271. easeInCore(gradient: number): number;
  5272. }
  5273. /**
  5274. * Easing function with a ease back shape (see link below).
  5275. * @see https://easings.net/#easeInBack
  5276. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5277. */
  5278. export class BackEase extends EasingFunction implements IEasingFunction {
  5279. /** Defines the amplitude of the function */
  5280. amplitude: number;
  5281. /**
  5282. * Instantiates a back ease easing
  5283. * @see https://easings.net/#easeInBack
  5284. * @param amplitude Defines the amplitude of the function
  5285. */
  5286. constructor(
  5287. /** Defines the amplitude of the function */
  5288. amplitude?: number);
  5289. /** @hidden */
  5290. easeInCore(gradient: number): number;
  5291. }
  5292. /**
  5293. * Easing function with a bouncing shape (see link below).
  5294. * @see https://easings.net/#easeInBounce
  5295. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5296. */
  5297. export class BounceEase extends EasingFunction implements IEasingFunction {
  5298. /** Defines the number of bounces */
  5299. bounces: number;
  5300. /** Defines the amplitude of the bounce */
  5301. bounciness: number;
  5302. /**
  5303. * Instantiates a bounce easing
  5304. * @see https://easings.net/#easeInBounce
  5305. * @param bounces Defines the number of bounces
  5306. * @param bounciness Defines the amplitude of the bounce
  5307. */
  5308. constructor(
  5309. /** Defines the number of bounces */
  5310. bounces?: number,
  5311. /** Defines the amplitude of the bounce */
  5312. bounciness?: number);
  5313. /** @hidden */
  5314. easeInCore(gradient: number): number;
  5315. }
  5316. /**
  5317. * Easing function with a power of 3 shape (see link below).
  5318. * @see https://easings.net/#easeInCubic
  5319. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5320. */
  5321. export class CubicEase extends EasingFunction implements IEasingFunction {
  5322. /** @hidden */
  5323. easeInCore(gradient: number): number;
  5324. }
  5325. /**
  5326. * Easing function with an elastic shape (see link below).
  5327. * @see https://easings.net/#easeInElastic
  5328. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5329. */
  5330. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5331. /** Defines the number of oscillations*/
  5332. oscillations: number;
  5333. /** Defines the amplitude of the oscillations*/
  5334. springiness: number;
  5335. /**
  5336. * Instantiates an elastic easing function
  5337. * @see https://easings.net/#easeInElastic
  5338. * @param oscillations Defines the number of oscillations
  5339. * @param springiness Defines the amplitude of the oscillations
  5340. */
  5341. constructor(
  5342. /** Defines the number of oscillations*/
  5343. oscillations?: number,
  5344. /** Defines the amplitude of the oscillations*/
  5345. springiness?: number);
  5346. /** @hidden */
  5347. easeInCore(gradient: number): number;
  5348. }
  5349. /**
  5350. * Easing function with an exponential shape (see link below).
  5351. * @see https://easings.net/#easeInExpo
  5352. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5353. */
  5354. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5355. /** Defines the exponent of the function */
  5356. exponent: number;
  5357. /**
  5358. * Instantiates an exponential easing function
  5359. * @see https://easings.net/#easeInExpo
  5360. * @param exponent Defines the exponent of the function
  5361. */
  5362. constructor(
  5363. /** Defines the exponent of the function */
  5364. exponent?: number);
  5365. /** @hidden */
  5366. easeInCore(gradient: number): number;
  5367. }
  5368. /**
  5369. * Easing function with a power shape (see link below).
  5370. * @see https://easings.net/#easeInQuad
  5371. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5372. */
  5373. export class PowerEase extends EasingFunction implements IEasingFunction {
  5374. /** Defines the power of the function */
  5375. power: number;
  5376. /**
  5377. * Instantiates an power base easing function
  5378. * @see https://easings.net/#easeInQuad
  5379. * @param power Defines the power of the function
  5380. */
  5381. constructor(
  5382. /** Defines the power of the function */
  5383. power?: number);
  5384. /** @hidden */
  5385. easeInCore(gradient: number): number;
  5386. }
  5387. /**
  5388. * Easing function with a power of 2 shape (see link below).
  5389. * @see https://easings.net/#easeInQuad
  5390. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5391. */
  5392. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5393. /** @hidden */
  5394. easeInCore(gradient: number): number;
  5395. }
  5396. /**
  5397. * Easing function with a power of 4 shape (see link below).
  5398. * @see https://easings.net/#easeInQuart
  5399. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5400. */
  5401. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5402. /** @hidden */
  5403. easeInCore(gradient: number): number;
  5404. }
  5405. /**
  5406. * Easing function with a power of 5 shape (see link below).
  5407. * @see https://easings.net/#easeInQuint
  5408. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5409. */
  5410. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5411. /** @hidden */
  5412. easeInCore(gradient: number): number;
  5413. }
  5414. /**
  5415. * Easing function with a sin shape (see link below).
  5416. * @see https://easings.net/#easeInSine
  5417. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5418. */
  5419. export class SineEase extends EasingFunction implements IEasingFunction {
  5420. /** @hidden */
  5421. easeInCore(gradient: number): number;
  5422. }
  5423. /**
  5424. * Easing function with a bezier shape (see link below).
  5425. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5426. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5427. */
  5428. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5429. /** Defines the x component of the start tangent in the bezier curve */
  5430. x1: number;
  5431. /** Defines the y component of the start tangent in the bezier curve */
  5432. y1: number;
  5433. /** Defines the x component of the end tangent in the bezier curve */
  5434. x2: number;
  5435. /** Defines the y component of the end tangent in the bezier curve */
  5436. y2: number;
  5437. /**
  5438. * Instantiates a bezier function
  5439. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5440. * @param x1 Defines the x component of the start tangent in the bezier curve
  5441. * @param y1 Defines the y component of the start tangent in the bezier curve
  5442. * @param x2 Defines the x component of the end tangent in the bezier curve
  5443. * @param y2 Defines the y component of the end tangent in the bezier curve
  5444. */
  5445. constructor(
  5446. /** Defines the x component of the start tangent in the bezier curve */
  5447. x1?: number,
  5448. /** Defines the y component of the start tangent in the bezier curve */
  5449. y1?: number,
  5450. /** Defines the x component of the end tangent in the bezier curve */
  5451. x2?: number,
  5452. /** Defines the y component of the end tangent in the bezier curve */
  5453. y2?: number);
  5454. /** @hidden */
  5455. easeInCore(gradient: number): number;
  5456. }
  5457. }
  5458. declare module "babylonjs/Maths/math.color" {
  5459. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5460. /**
  5461. * Class used to hold a RBG color
  5462. */
  5463. export class Color3 {
  5464. /**
  5465. * Defines the red component (between 0 and 1, default is 0)
  5466. */
  5467. r: number;
  5468. /**
  5469. * Defines the green component (between 0 and 1, default is 0)
  5470. */
  5471. g: number;
  5472. /**
  5473. * Defines the blue component (between 0 and 1, default is 0)
  5474. */
  5475. b: number;
  5476. /**
  5477. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5478. * @param r defines the red component (between 0 and 1, default is 0)
  5479. * @param g defines the green component (between 0 and 1, default is 0)
  5480. * @param b defines the blue component (between 0 and 1, default is 0)
  5481. */
  5482. constructor(
  5483. /**
  5484. * Defines the red component (between 0 and 1, default is 0)
  5485. */
  5486. r?: number,
  5487. /**
  5488. * Defines the green component (between 0 and 1, default is 0)
  5489. */
  5490. g?: number,
  5491. /**
  5492. * Defines the blue component (between 0 and 1, default is 0)
  5493. */
  5494. b?: number);
  5495. /**
  5496. * Creates a string with the Color3 current values
  5497. * @returns the string representation of the Color3 object
  5498. */
  5499. toString(): string;
  5500. /**
  5501. * Returns the string "Color3"
  5502. * @returns "Color3"
  5503. */
  5504. getClassName(): string;
  5505. /**
  5506. * Compute the Color3 hash code
  5507. * @returns an unique number that can be used to hash Color3 objects
  5508. */
  5509. getHashCode(): number;
  5510. /**
  5511. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5512. * @param array defines the array where to store the r,g,b components
  5513. * @param index defines an optional index in the target array to define where to start storing values
  5514. * @returns the current Color3 object
  5515. */
  5516. toArray(array: FloatArray, index?: number): Color3;
  5517. /**
  5518. * Returns a new Color4 object from the current Color3 and the given alpha
  5519. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5520. * @returns a new Color4 object
  5521. */
  5522. toColor4(alpha?: number): Color4;
  5523. /**
  5524. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5525. * @returns the new array
  5526. */
  5527. asArray(): number[];
  5528. /**
  5529. * Returns the luminance value
  5530. * @returns a float value
  5531. */
  5532. toLuminance(): number;
  5533. /**
  5534. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5535. * @param otherColor defines the second operand
  5536. * @returns the new Color3 object
  5537. */
  5538. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5539. /**
  5540. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5541. * @param otherColor defines the second operand
  5542. * @param result defines the Color3 object where to store the result
  5543. * @returns the current Color3
  5544. */
  5545. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5546. /**
  5547. * Determines equality between Color3 objects
  5548. * @param otherColor defines the second operand
  5549. * @returns true if the rgb values are equal to the given ones
  5550. */
  5551. equals(otherColor: DeepImmutable<Color3>): boolean;
  5552. /**
  5553. * Determines equality between the current Color3 object and a set of r,b,g values
  5554. * @param r defines the red component to check
  5555. * @param g defines the green component to check
  5556. * @param b defines the blue component to check
  5557. * @returns true if the rgb values are equal to the given ones
  5558. */
  5559. equalsFloats(r: number, g: number, b: number): boolean;
  5560. /**
  5561. * Multiplies in place each rgb value by scale
  5562. * @param scale defines the scaling factor
  5563. * @returns the updated Color3
  5564. */
  5565. scale(scale: number): Color3;
  5566. /**
  5567. * Multiplies the rgb values by scale and stores the result into "result"
  5568. * @param scale defines the scaling factor
  5569. * @param result defines the Color3 object where to store the result
  5570. * @returns the unmodified current Color3
  5571. */
  5572. scaleToRef(scale: number, result: Color3): Color3;
  5573. /**
  5574. * Scale the current Color3 values by a factor and add the result to a given Color3
  5575. * @param scale defines the scale factor
  5576. * @param result defines color to store the result into
  5577. * @returns the unmodified current Color3
  5578. */
  5579. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5580. /**
  5581. * Clamps the rgb values by the min and max values and stores the result into "result"
  5582. * @param min defines minimum clamping value (default is 0)
  5583. * @param max defines maximum clamping value (default is 1)
  5584. * @param result defines color to store the result into
  5585. * @returns the original Color3
  5586. */
  5587. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5588. /**
  5589. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5590. * @param otherColor defines the second operand
  5591. * @returns the new Color3
  5592. */
  5593. add(otherColor: DeepImmutable<Color3>): Color3;
  5594. /**
  5595. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5596. * @param otherColor defines the second operand
  5597. * @param result defines Color3 object to store the result into
  5598. * @returns the unmodified current Color3
  5599. */
  5600. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5601. /**
  5602. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5603. * @param otherColor defines the second operand
  5604. * @returns the new Color3
  5605. */
  5606. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5607. /**
  5608. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5609. * @param otherColor defines the second operand
  5610. * @param result defines Color3 object to store the result into
  5611. * @returns the unmodified current Color3
  5612. */
  5613. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5614. /**
  5615. * Copy the current object
  5616. * @returns a new Color3 copied the current one
  5617. */
  5618. clone(): Color3;
  5619. /**
  5620. * Copies the rgb values from the source in the current Color3
  5621. * @param source defines the source Color3 object
  5622. * @returns the updated Color3 object
  5623. */
  5624. copyFrom(source: DeepImmutable<Color3>): Color3;
  5625. /**
  5626. * Updates the Color3 rgb values from the given floats
  5627. * @param r defines the red component to read from
  5628. * @param g defines the green component to read from
  5629. * @param b defines the blue component to read from
  5630. * @returns the current Color3 object
  5631. */
  5632. copyFromFloats(r: number, g: number, b: number): Color3;
  5633. /**
  5634. * Updates the Color3 rgb values from the given floats
  5635. * @param r defines the red component to read from
  5636. * @param g defines the green component to read from
  5637. * @param b defines the blue component to read from
  5638. * @returns the current Color3 object
  5639. */
  5640. set(r: number, g: number, b: number): Color3;
  5641. /**
  5642. * Compute the Color3 hexadecimal code as a string
  5643. * @returns a string containing the hexadecimal representation of the Color3 object
  5644. */
  5645. toHexString(): string;
  5646. /**
  5647. * Computes a new Color3 converted from the current one to linear space
  5648. * @returns a new Color3 object
  5649. */
  5650. toLinearSpace(): Color3;
  5651. /**
  5652. * Converts current color in rgb space to HSV values
  5653. * @returns a new color3 representing the HSV values
  5654. */
  5655. toHSV(): Color3;
  5656. /**
  5657. * Converts current color in rgb space to HSV values
  5658. * @param result defines the Color3 where to store the HSV values
  5659. */
  5660. toHSVToRef(result: Color3): void;
  5661. /**
  5662. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5663. * @param convertedColor defines the Color3 object where to store the linear space version
  5664. * @returns the unmodified Color3
  5665. */
  5666. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5667. /**
  5668. * Computes a new Color3 converted from the current one to gamma space
  5669. * @returns a new Color3 object
  5670. */
  5671. toGammaSpace(): Color3;
  5672. /**
  5673. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5674. * @param convertedColor defines the Color3 object where to store the gamma space version
  5675. * @returns the unmodified Color3
  5676. */
  5677. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5678. private static _BlackReadOnly;
  5679. /**
  5680. * Convert Hue, saturation and value to a Color3 (RGB)
  5681. * @param hue defines the hue
  5682. * @param saturation defines the saturation
  5683. * @param value defines the value
  5684. * @param result defines the Color3 where to store the RGB values
  5685. */
  5686. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5687. /**
  5688. * Creates a new Color3 from the string containing valid hexadecimal values
  5689. * @param hex defines a string containing valid hexadecimal values
  5690. * @returns a new Color3 object
  5691. */
  5692. static FromHexString(hex: string): Color3;
  5693. /**
  5694. * Creates a new Color3 from the starting index of the given array
  5695. * @param array defines the source array
  5696. * @param offset defines an offset in the source array
  5697. * @returns a new Color3 object
  5698. */
  5699. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5700. /**
  5701. * Creates a new Color3 from integer values (< 256)
  5702. * @param r defines the red component to read from (value between 0 and 255)
  5703. * @param g defines the green component to read from (value between 0 and 255)
  5704. * @param b defines the blue component to read from (value between 0 and 255)
  5705. * @returns a new Color3 object
  5706. */
  5707. static FromInts(r: number, g: number, b: number): Color3;
  5708. /**
  5709. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5710. * @param start defines the start Color3 value
  5711. * @param end defines the end Color3 value
  5712. * @param amount defines the gradient value between start and end
  5713. * @returns a new Color3 object
  5714. */
  5715. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5716. /**
  5717. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5718. * @param left defines the start value
  5719. * @param right defines the end value
  5720. * @param amount defines the gradient factor
  5721. * @param result defines the Color3 object where to store the result
  5722. */
  5723. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5724. /**
  5725. * Returns a Color3 value containing a red color
  5726. * @returns a new Color3 object
  5727. */
  5728. static Red(): Color3;
  5729. /**
  5730. * Returns a Color3 value containing a green color
  5731. * @returns a new Color3 object
  5732. */
  5733. static Green(): Color3;
  5734. /**
  5735. * Returns a Color3 value containing a blue color
  5736. * @returns a new Color3 object
  5737. */
  5738. static Blue(): Color3;
  5739. /**
  5740. * Returns a Color3 value containing a black color
  5741. * @returns a new Color3 object
  5742. */
  5743. static Black(): Color3;
  5744. /**
  5745. * Gets a Color3 value containing a black color that must not be updated
  5746. */
  5747. static get BlackReadOnly(): DeepImmutable<Color3>;
  5748. /**
  5749. * Returns a Color3 value containing a white color
  5750. * @returns a new Color3 object
  5751. */
  5752. static White(): Color3;
  5753. /**
  5754. * Returns a Color3 value containing a purple color
  5755. * @returns a new Color3 object
  5756. */
  5757. static Purple(): Color3;
  5758. /**
  5759. * Returns a Color3 value containing a magenta color
  5760. * @returns a new Color3 object
  5761. */
  5762. static Magenta(): Color3;
  5763. /**
  5764. * Returns a Color3 value containing a yellow color
  5765. * @returns a new Color3 object
  5766. */
  5767. static Yellow(): Color3;
  5768. /**
  5769. * Returns a Color3 value containing a gray color
  5770. * @returns a new Color3 object
  5771. */
  5772. static Gray(): Color3;
  5773. /**
  5774. * Returns a Color3 value containing a teal color
  5775. * @returns a new Color3 object
  5776. */
  5777. static Teal(): Color3;
  5778. /**
  5779. * Returns a Color3 value containing a random color
  5780. * @returns a new Color3 object
  5781. */
  5782. static Random(): Color3;
  5783. }
  5784. /**
  5785. * Class used to hold a RBGA color
  5786. */
  5787. export class Color4 {
  5788. /**
  5789. * Defines the red component (between 0 and 1, default is 0)
  5790. */
  5791. r: number;
  5792. /**
  5793. * Defines the green component (between 0 and 1, default is 0)
  5794. */
  5795. g: number;
  5796. /**
  5797. * Defines the blue component (between 0 and 1, default is 0)
  5798. */
  5799. b: number;
  5800. /**
  5801. * Defines the alpha component (between 0 and 1, default is 1)
  5802. */
  5803. a: number;
  5804. /**
  5805. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5806. * @param r defines the red component (between 0 and 1, default is 0)
  5807. * @param g defines the green component (between 0 and 1, default is 0)
  5808. * @param b defines the blue component (between 0 and 1, default is 0)
  5809. * @param a defines the alpha component (between 0 and 1, default is 1)
  5810. */
  5811. constructor(
  5812. /**
  5813. * Defines the red component (between 0 and 1, default is 0)
  5814. */
  5815. r?: number,
  5816. /**
  5817. * Defines the green component (between 0 and 1, default is 0)
  5818. */
  5819. g?: number,
  5820. /**
  5821. * Defines the blue component (between 0 and 1, default is 0)
  5822. */
  5823. b?: number,
  5824. /**
  5825. * Defines the alpha component (between 0 and 1, default is 1)
  5826. */
  5827. a?: number);
  5828. /**
  5829. * Adds in place the given Color4 values to the current Color4 object
  5830. * @param right defines the second operand
  5831. * @returns the current updated Color4 object
  5832. */
  5833. addInPlace(right: DeepImmutable<Color4>): Color4;
  5834. /**
  5835. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5836. * @returns the new array
  5837. */
  5838. asArray(): number[];
  5839. /**
  5840. * Stores from the starting index in the given array the Color4 successive values
  5841. * @param array defines the array where to store the r,g,b components
  5842. * @param index defines an optional index in the target array to define where to start storing values
  5843. * @returns the current Color4 object
  5844. */
  5845. toArray(array: number[], index?: number): Color4;
  5846. /**
  5847. * Determines equality between Color4 objects
  5848. * @param otherColor defines the second operand
  5849. * @returns true if the rgba values are equal to the given ones
  5850. */
  5851. equals(otherColor: DeepImmutable<Color4>): boolean;
  5852. /**
  5853. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5854. * @param right defines the second operand
  5855. * @returns a new Color4 object
  5856. */
  5857. add(right: DeepImmutable<Color4>): Color4;
  5858. /**
  5859. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5860. * @param right defines the second operand
  5861. * @returns a new Color4 object
  5862. */
  5863. subtract(right: DeepImmutable<Color4>): Color4;
  5864. /**
  5865. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5866. * @param right defines the second operand
  5867. * @param result defines the Color4 object where to store the result
  5868. * @returns the current Color4 object
  5869. */
  5870. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5871. /**
  5872. * Creates a new Color4 with the current Color4 values multiplied by scale
  5873. * @param scale defines the scaling factor to apply
  5874. * @returns a new Color4 object
  5875. */
  5876. scale(scale: number): Color4;
  5877. /**
  5878. * Multiplies the current Color4 values by scale and stores the result in "result"
  5879. * @param scale defines the scaling factor to apply
  5880. * @param result defines the Color4 object where to store the result
  5881. * @returns the current unmodified Color4
  5882. */
  5883. scaleToRef(scale: number, result: Color4): Color4;
  5884. /**
  5885. * Scale the current Color4 values by a factor and add the result to a given Color4
  5886. * @param scale defines the scale factor
  5887. * @param result defines the Color4 object where to store the result
  5888. * @returns the unmodified current Color4
  5889. */
  5890. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5891. /**
  5892. * Clamps the rgb values by the min and max values and stores the result into "result"
  5893. * @param min defines minimum clamping value (default is 0)
  5894. * @param max defines maximum clamping value (default is 1)
  5895. * @param result defines color to store the result into.
  5896. * @returns the cuurent Color4
  5897. */
  5898. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5899. /**
  5900. * Multipy an Color4 value by another and return a new Color4 object
  5901. * @param color defines the Color4 value to multiply by
  5902. * @returns a new Color4 object
  5903. */
  5904. multiply(color: Color4): Color4;
  5905. /**
  5906. * Multipy a Color4 value by another and push the result in a reference value
  5907. * @param color defines the Color4 value to multiply by
  5908. * @param result defines the Color4 to fill the result in
  5909. * @returns the result Color4
  5910. */
  5911. multiplyToRef(color: Color4, result: Color4): Color4;
  5912. /**
  5913. * Creates a string with the Color4 current values
  5914. * @returns the string representation of the Color4 object
  5915. */
  5916. toString(): string;
  5917. /**
  5918. * Returns the string "Color4"
  5919. * @returns "Color4"
  5920. */
  5921. getClassName(): string;
  5922. /**
  5923. * Compute the Color4 hash code
  5924. * @returns an unique number that can be used to hash Color4 objects
  5925. */
  5926. getHashCode(): number;
  5927. /**
  5928. * Creates a new Color4 copied from the current one
  5929. * @returns a new Color4 object
  5930. */
  5931. clone(): Color4;
  5932. /**
  5933. * Copies the given Color4 values into the current one
  5934. * @param source defines the source Color4 object
  5935. * @returns the current updated Color4 object
  5936. */
  5937. copyFrom(source: Color4): Color4;
  5938. /**
  5939. * Copies the given float values into the current one
  5940. * @param r defines the red component to read from
  5941. * @param g defines the green component to read from
  5942. * @param b defines the blue component to read from
  5943. * @param a defines the alpha component to read from
  5944. * @returns the current updated Color4 object
  5945. */
  5946. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  5947. /**
  5948. * Copies the given float values into the current one
  5949. * @param r defines the red component to read from
  5950. * @param g defines the green component to read from
  5951. * @param b defines the blue component to read from
  5952. * @param a defines the alpha component to read from
  5953. * @returns the current updated Color4 object
  5954. */
  5955. set(r: number, g: number, b: number, a: number): Color4;
  5956. /**
  5957. * Compute the Color4 hexadecimal code as a string
  5958. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  5959. * @returns a string containing the hexadecimal representation of the Color4 object
  5960. */
  5961. toHexString(returnAsColor3?: boolean): string;
  5962. /**
  5963. * Computes a new Color4 converted from the current one to linear space
  5964. * @returns a new Color4 object
  5965. */
  5966. toLinearSpace(): Color4;
  5967. /**
  5968. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  5969. * @param convertedColor defines the Color4 object where to store the linear space version
  5970. * @returns the unmodified Color4
  5971. */
  5972. toLinearSpaceToRef(convertedColor: Color4): Color4;
  5973. /**
  5974. * Computes a new Color4 converted from the current one to gamma space
  5975. * @returns a new Color4 object
  5976. */
  5977. toGammaSpace(): Color4;
  5978. /**
  5979. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  5980. * @param convertedColor defines the Color4 object where to store the gamma space version
  5981. * @returns the unmodified Color4
  5982. */
  5983. toGammaSpaceToRef(convertedColor: Color4): Color4;
  5984. /**
  5985. * Creates a new Color4 from the string containing valid hexadecimal values
  5986. * @param hex defines a string containing valid hexadecimal values
  5987. * @returns a new Color4 object
  5988. */
  5989. static FromHexString(hex: string): Color4;
  5990. /**
  5991. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5992. * @param left defines the start value
  5993. * @param right defines the end value
  5994. * @param amount defines the gradient factor
  5995. * @returns a new Color4 object
  5996. */
  5997. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  5998. /**
  5999. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6000. * @param left defines the start value
  6001. * @param right defines the end value
  6002. * @param amount defines the gradient factor
  6003. * @param result defines the Color4 object where to store data
  6004. */
  6005. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6006. /**
  6007. * Creates a new Color4 from a Color3 and an alpha value
  6008. * @param color3 defines the source Color3 to read from
  6009. * @param alpha defines the alpha component (1.0 by default)
  6010. * @returns a new Color4 object
  6011. */
  6012. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6013. /**
  6014. * Creates a new Color4 from the starting index element of the given array
  6015. * @param array defines the source array to read from
  6016. * @param offset defines the offset in the source array
  6017. * @returns a new Color4 object
  6018. */
  6019. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6020. /**
  6021. * Creates a new Color3 from integer values (< 256)
  6022. * @param r defines the red component to read from (value between 0 and 255)
  6023. * @param g defines the green component to read from (value between 0 and 255)
  6024. * @param b defines the blue component to read from (value between 0 and 255)
  6025. * @param a defines the alpha component to read from (value between 0 and 255)
  6026. * @returns a new Color3 object
  6027. */
  6028. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6029. /**
  6030. * Check the content of a given array and convert it to an array containing RGBA data
  6031. * If the original array was already containing count * 4 values then it is returned directly
  6032. * @param colors defines the array to check
  6033. * @param count defines the number of RGBA data to expect
  6034. * @returns an array containing count * 4 values (RGBA)
  6035. */
  6036. static CheckColors4(colors: number[], count: number): number[];
  6037. }
  6038. /**
  6039. * @hidden
  6040. */
  6041. export class TmpColors {
  6042. static Color3: Color3[];
  6043. static Color4: Color4[];
  6044. }
  6045. }
  6046. declare module "babylonjs/Animations/animationKey" {
  6047. /**
  6048. * Defines an interface which represents an animation key frame
  6049. */
  6050. export interface IAnimationKey {
  6051. /**
  6052. * Frame of the key frame
  6053. */
  6054. frame: number;
  6055. /**
  6056. * Value at the specifies key frame
  6057. */
  6058. value: any;
  6059. /**
  6060. * The input tangent for the cubic hermite spline
  6061. */
  6062. inTangent?: any;
  6063. /**
  6064. * The output tangent for the cubic hermite spline
  6065. */
  6066. outTangent?: any;
  6067. /**
  6068. * The animation interpolation type
  6069. */
  6070. interpolation?: AnimationKeyInterpolation;
  6071. }
  6072. /**
  6073. * Enum for the animation key frame interpolation type
  6074. */
  6075. export enum AnimationKeyInterpolation {
  6076. /**
  6077. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6078. */
  6079. STEP = 1
  6080. }
  6081. }
  6082. declare module "babylonjs/Animations/animationRange" {
  6083. /**
  6084. * Represents the range of an animation
  6085. */
  6086. export class AnimationRange {
  6087. /**The name of the animation range**/
  6088. name: string;
  6089. /**The starting frame of the animation */
  6090. from: number;
  6091. /**The ending frame of the animation*/
  6092. to: number;
  6093. /**
  6094. * Initializes the range of an animation
  6095. * @param name The name of the animation range
  6096. * @param from The starting frame of the animation
  6097. * @param to The ending frame of the animation
  6098. */
  6099. constructor(
  6100. /**The name of the animation range**/
  6101. name: string,
  6102. /**The starting frame of the animation */
  6103. from: number,
  6104. /**The ending frame of the animation*/
  6105. to: number);
  6106. /**
  6107. * Makes a copy of the animation range
  6108. * @returns A copy of the animation range
  6109. */
  6110. clone(): AnimationRange;
  6111. }
  6112. }
  6113. declare module "babylonjs/Animations/animationEvent" {
  6114. /**
  6115. * Composed of a frame, and an action function
  6116. */
  6117. export class AnimationEvent {
  6118. /** The frame for which the event is triggered **/
  6119. frame: number;
  6120. /** The event to perform when triggered **/
  6121. action: (currentFrame: number) => void;
  6122. /** Specifies if the event should be triggered only once**/
  6123. onlyOnce?: boolean | undefined;
  6124. /**
  6125. * Specifies if the animation event is done
  6126. */
  6127. isDone: boolean;
  6128. /**
  6129. * Initializes the animation event
  6130. * @param frame The frame for which the event is triggered
  6131. * @param action The event to perform when triggered
  6132. * @param onlyOnce Specifies if the event should be triggered only once
  6133. */
  6134. constructor(
  6135. /** The frame for which the event is triggered **/
  6136. frame: number,
  6137. /** The event to perform when triggered **/
  6138. action: (currentFrame: number) => void,
  6139. /** Specifies if the event should be triggered only once**/
  6140. onlyOnce?: boolean | undefined);
  6141. /** @hidden */
  6142. _clone(): AnimationEvent;
  6143. }
  6144. }
  6145. declare module "babylonjs/Behaviors/behavior" {
  6146. import { Nullable } from "babylonjs/types";
  6147. /**
  6148. * Interface used to define a behavior
  6149. */
  6150. export interface Behavior<T> {
  6151. /** gets or sets behavior's name */
  6152. name: string;
  6153. /**
  6154. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6155. */
  6156. init(): void;
  6157. /**
  6158. * Called when the behavior is attached to a target
  6159. * @param target defines the target where the behavior is attached to
  6160. */
  6161. attach(target: T): void;
  6162. /**
  6163. * Called when the behavior is detached from its target
  6164. */
  6165. detach(): void;
  6166. }
  6167. /**
  6168. * Interface implemented by classes supporting behaviors
  6169. */
  6170. export interface IBehaviorAware<T> {
  6171. /**
  6172. * Attach a behavior
  6173. * @param behavior defines the behavior to attach
  6174. * @returns the current host
  6175. */
  6176. addBehavior(behavior: Behavior<T>): T;
  6177. /**
  6178. * Remove a behavior from the current object
  6179. * @param behavior defines the behavior to detach
  6180. * @returns the current host
  6181. */
  6182. removeBehavior(behavior: Behavior<T>): T;
  6183. /**
  6184. * Gets a behavior using its name to search
  6185. * @param name defines the name to search
  6186. * @returns the behavior or null if not found
  6187. */
  6188. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6189. }
  6190. }
  6191. declare module "babylonjs/Misc/smartArray" {
  6192. /**
  6193. * Defines an array and its length.
  6194. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6195. */
  6196. export interface ISmartArrayLike<T> {
  6197. /**
  6198. * The data of the array.
  6199. */
  6200. data: Array<T>;
  6201. /**
  6202. * The active length of the array.
  6203. */
  6204. length: number;
  6205. }
  6206. /**
  6207. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6208. */
  6209. export class SmartArray<T> implements ISmartArrayLike<T> {
  6210. /**
  6211. * The full set of data from the array.
  6212. */
  6213. data: Array<T>;
  6214. /**
  6215. * The active length of the array.
  6216. */
  6217. length: number;
  6218. protected _id: number;
  6219. /**
  6220. * Instantiates a Smart Array.
  6221. * @param capacity defines the default capacity of the array.
  6222. */
  6223. constructor(capacity: number);
  6224. /**
  6225. * Pushes a value at the end of the active data.
  6226. * @param value defines the object to push in the array.
  6227. */
  6228. push(value: T): void;
  6229. /**
  6230. * Iterates over the active data and apply the lambda to them.
  6231. * @param func defines the action to apply on each value.
  6232. */
  6233. forEach(func: (content: T) => void): void;
  6234. /**
  6235. * Sorts the full sets of data.
  6236. * @param compareFn defines the comparison function to apply.
  6237. */
  6238. sort(compareFn: (a: T, b: T) => number): void;
  6239. /**
  6240. * Resets the active data to an empty array.
  6241. */
  6242. reset(): void;
  6243. /**
  6244. * Releases all the data from the array as well as the array.
  6245. */
  6246. dispose(): void;
  6247. /**
  6248. * Concats the active data with a given array.
  6249. * @param array defines the data to concatenate with.
  6250. */
  6251. concat(array: any): void;
  6252. /**
  6253. * Returns the position of a value in the active data.
  6254. * @param value defines the value to find the index for
  6255. * @returns the index if found in the active data otherwise -1
  6256. */
  6257. indexOf(value: T): number;
  6258. /**
  6259. * Returns whether an element is part of the active data.
  6260. * @param value defines the value to look for
  6261. * @returns true if found in the active data otherwise false
  6262. */
  6263. contains(value: T): boolean;
  6264. private static _GlobalId;
  6265. }
  6266. /**
  6267. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6268. * The data in this array can only be present once
  6269. */
  6270. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6271. private _duplicateId;
  6272. /**
  6273. * Pushes a value at the end of the active data.
  6274. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6275. * @param value defines the object to push in the array.
  6276. */
  6277. push(value: T): void;
  6278. /**
  6279. * Pushes a value at the end of the active data.
  6280. * If the data is already present, it won t be added again
  6281. * @param value defines the object to push in the array.
  6282. * @returns true if added false if it was already present
  6283. */
  6284. pushNoDuplicate(value: T): boolean;
  6285. /**
  6286. * Resets the active data to an empty array.
  6287. */
  6288. reset(): void;
  6289. /**
  6290. * Concats the active data with a given array.
  6291. * This ensures no dupplicate will be present in the result.
  6292. * @param array defines the data to concatenate with.
  6293. */
  6294. concatWithNoDuplicate(array: any): void;
  6295. }
  6296. }
  6297. declare module "babylonjs/Cameras/cameraInputsManager" {
  6298. import { Nullable } from "babylonjs/types";
  6299. import { Camera } from "babylonjs/Cameras/camera";
  6300. /**
  6301. * @ignore
  6302. * This is a list of all the different input types that are available in the application.
  6303. * Fo instance: ArcRotateCameraGamepadInput...
  6304. */
  6305. export var CameraInputTypes: {};
  6306. /**
  6307. * This is the contract to implement in order to create a new input class.
  6308. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6309. */
  6310. export interface ICameraInput<TCamera extends Camera> {
  6311. /**
  6312. * Defines the camera the input is attached to.
  6313. */
  6314. camera: Nullable<TCamera>;
  6315. /**
  6316. * Gets the class name of the current intput.
  6317. * @returns the class name
  6318. */
  6319. getClassName(): string;
  6320. /**
  6321. * Get the friendly name associated with the input class.
  6322. * @returns the input friendly name
  6323. */
  6324. getSimpleName(): string;
  6325. /**
  6326. * Attach the input controls to a specific dom element to get the input from.
  6327. * @param element Defines the element the controls should be listened from
  6328. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6329. */
  6330. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6331. /**
  6332. * Detach the current controls from the specified dom element.
  6333. * @param element Defines the element to stop listening the inputs from
  6334. */
  6335. detachControl(element: Nullable<HTMLElement>): void;
  6336. /**
  6337. * Update the current camera state depending on the inputs that have been used this frame.
  6338. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6339. */
  6340. checkInputs?: () => void;
  6341. }
  6342. /**
  6343. * Represents a map of input types to input instance or input index to input instance.
  6344. */
  6345. export interface CameraInputsMap<TCamera extends Camera> {
  6346. /**
  6347. * Accessor to the input by input type.
  6348. */
  6349. [name: string]: ICameraInput<TCamera>;
  6350. /**
  6351. * Accessor to the input by input index.
  6352. */
  6353. [idx: number]: ICameraInput<TCamera>;
  6354. }
  6355. /**
  6356. * This represents the input manager used within a camera.
  6357. * It helps dealing with all the different kind of input attached to a camera.
  6358. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6359. */
  6360. export class CameraInputsManager<TCamera extends Camera> {
  6361. /**
  6362. * Defines the list of inputs attahed to the camera.
  6363. */
  6364. attached: CameraInputsMap<TCamera>;
  6365. /**
  6366. * Defines the dom element the camera is collecting inputs from.
  6367. * This is null if the controls have not been attached.
  6368. */
  6369. attachedElement: Nullable<HTMLElement>;
  6370. /**
  6371. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6372. */
  6373. noPreventDefault: boolean;
  6374. /**
  6375. * Defined the camera the input manager belongs to.
  6376. */
  6377. camera: TCamera;
  6378. /**
  6379. * Update the current camera state depending on the inputs that have been used this frame.
  6380. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6381. */
  6382. checkInputs: () => void;
  6383. /**
  6384. * Instantiate a new Camera Input Manager.
  6385. * @param camera Defines the camera the input manager blongs to
  6386. */
  6387. constructor(camera: TCamera);
  6388. /**
  6389. * Add an input method to a camera
  6390. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6391. * @param input camera input method
  6392. */
  6393. add(input: ICameraInput<TCamera>): void;
  6394. /**
  6395. * Remove a specific input method from a camera
  6396. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6397. * @param inputToRemove camera input method
  6398. */
  6399. remove(inputToRemove: ICameraInput<TCamera>): void;
  6400. /**
  6401. * Remove a specific input type from a camera
  6402. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6403. * @param inputType the type of the input to remove
  6404. */
  6405. removeByType(inputType: string): void;
  6406. private _addCheckInputs;
  6407. /**
  6408. * Attach the input controls to the currently attached dom element to listen the events from.
  6409. * @param input Defines the input to attach
  6410. */
  6411. attachInput(input: ICameraInput<TCamera>): void;
  6412. /**
  6413. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6414. * @param element Defines the dom element to collect the events from
  6415. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6416. */
  6417. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6418. /**
  6419. * Detach the current manager inputs controls from a specific dom element.
  6420. * @param element Defines the dom element to collect the events from
  6421. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6422. */
  6423. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6424. /**
  6425. * Rebuild the dynamic inputCheck function from the current list of
  6426. * defined inputs in the manager.
  6427. */
  6428. rebuildInputCheck(): void;
  6429. /**
  6430. * Remove all attached input methods from a camera
  6431. */
  6432. clear(): void;
  6433. /**
  6434. * Serialize the current input manager attached to a camera.
  6435. * This ensures than once parsed,
  6436. * the input associated to the camera will be identical to the current ones
  6437. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6438. */
  6439. serialize(serializedCamera: any): void;
  6440. /**
  6441. * Parses an input manager serialized JSON to restore the previous list of inputs
  6442. * and states associated to a camera.
  6443. * @param parsedCamera Defines the JSON to parse
  6444. */
  6445. parse(parsedCamera: any): void;
  6446. }
  6447. }
  6448. declare module "babylonjs/Meshes/buffer" {
  6449. import { Nullable, DataArray } from "babylonjs/types";
  6450. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6451. /**
  6452. * Class used to store data that will be store in GPU memory
  6453. */
  6454. export class Buffer {
  6455. private _engine;
  6456. private _buffer;
  6457. /** @hidden */
  6458. _data: Nullable<DataArray>;
  6459. private _updatable;
  6460. private _instanced;
  6461. private _divisor;
  6462. /**
  6463. * Gets the byte stride.
  6464. */
  6465. readonly byteStride: number;
  6466. /**
  6467. * Constructor
  6468. * @param engine the engine
  6469. * @param data the data to use for this buffer
  6470. * @param updatable whether the data is updatable
  6471. * @param stride the stride (optional)
  6472. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6473. * @param instanced whether the buffer is instanced (optional)
  6474. * @param useBytes set to true if the stride in in bytes (optional)
  6475. * @param divisor sets an optional divisor for instances (1 by default)
  6476. */
  6477. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6478. /**
  6479. * Create a new VertexBuffer based on the current buffer
  6480. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6481. * @param offset defines offset in the buffer (0 by default)
  6482. * @param size defines the size in floats of attributes (position is 3 for instance)
  6483. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6484. * @param instanced defines if the vertex buffer contains indexed data
  6485. * @param useBytes defines if the offset and stride are in bytes *
  6486. * @param divisor sets an optional divisor for instances (1 by default)
  6487. * @returns the new vertex buffer
  6488. */
  6489. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6490. /**
  6491. * Gets a boolean indicating if the Buffer is updatable?
  6492. * @returns true if the buffer is updatable
  6493. */
  6494. isUpdatable(): boolean;
  6495. /**
  6496. * Gets current buffer's data
  6497. * @returns a DataArray or null
  6498. */
  6499. getData(): Nullable<DataArray>;
  6500. /**
  6501. * Gets underlying native buffer
  6502. * @returns underlying native buffer
  6503. */
  6504. getBuffer(): Nullable<DataBuffer>;
  6505. /**
  6506. * Gets the stride in float32 units (i.e. byte stride / 4).
  6507. * May not be an integer if the byte stride is not divisible by 4.
  6508. * @returns the stride in float32 units
  6509. * @deprecated Please use byteStride instead.
  6510. */
  6511. getStrideSize(): number;
  6512. /**
  6513. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6514. * @param data defines the data to store
  6515. */
  6516. create(data?: Nullable<DataArray>): void;
  6517. /** @hidden */
  6518. _rebuild(): void;
  6519. /**
  6520. * Update current buffer data
  6521. * @param data defines the data to store
  6522. */
  6523. update(data: DataArray): void;
  6524. /**
  6525. * Updates the data directly.
  6526. * @param data the new data
  6527. * @param offset the new offset
  6528. * @param vertexCount the vertex count (optional)
  6529. * @param useBytes set to true if the offset is in bytes
  6530. */
  6531. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6532. /**
  6533. * Release all resources
  6534. */
  6535. dispose(): void;
  6536. }
  6537. /**
  6538. * Specialized buffer used to store vertex data
  6539. */
  6540. export class VertexBuffer {
  6541. /** @hidden */
  6542. _buffer: Buffer;
  6543. private _kind;
  6544. private _size;
  6545. private _ownsBuffer;
  6546. private _instanced;
  6547. private _instanceDivisor;
  6548. /**
  6549. * The byte type.
  6550. */
  6551. static readonly BYTE: number;
  6552. /**
  6553. * The unsigned byte type.
  6554. */
  6555. static readonly UNSIGNED_BYTE: number;
  6556. /**
  6557. * The short type.
  6558. */
  6559. static readonly SHORT: number;
  6560. /**
  6561. * The unsigned short type.
  6562. */
  6563. static readonly UNSIGNED_SHORT: number;
  6564. /**
  6565. * The integer type.
  6566. */
  6567. static readonly INT: number;
  6568. /**
  6569. * The unsigned integer type.
  6570. */
  6571. static readonly UNSIGNED_INT: number;
  6572. /**
  6573. * The float type.
  6574. */
  6575. static readonly FLOAT: number;
  6576. /**
  6577. * Gets or sets the instance divisor when in instanced mode
  6578. */
  6579. get instanceDivisor(): number;
  6580. set instanceDivisor(value: number);
  6581. /**
  6582. * Gets the byte stride.
  6583. */
  6584. readonly byteStride: number;
  6585. /**
  6586. * Gets the byte offset.
  6587. */
  6588. readonly byteOffset: number;
  6589. /**
  6590. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6591. */
  6592. readonly normalized: boolean;
  6593. /**
  6594. * Gets the data type of each component in the array.
  6595. */
  6596. readonly type: number;
  6597. /**
  6598. * Constructor
  6599. * @param engine the engine
  6600. * @param data the data to use for this vertex buffer
  6601. * @param kind the vertex buffer kind
  6602. * @param updatable whether the data is updatable
  6603. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6604. * @param stride the stride (optional)
  6605. * @param instanced whether the buffer is instanced (optional)
  6606. * @param offset the offset of the data (optional)
  6607. * @param size the number of components (optional)
  6608. * @param type the type of the component (optional)
  6609. * @param normalized whether the data contains normalized data (optional)
  6610. * @param useBytes set to true if stride and offset are in bytes (optional)
  6611. * @param divisor defines the instance divisor to use (1 by default)
  6612. */
  6613. 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);
  6614. /** @hidden */
  6615. _rebuild(): void;
  6616. /**
  6617. * Returns the kind of the VertexBuffer (string)
  6618. * @returns a string
  6619. */
  6620. getKind(): string;
  6621. /**
  6622. * Gets a boolean indicating if the VertexBuffer is updatable?
  6623. * @returns true if the buffer is updatable
  6624. */
  6625. isUpdatable(): boolean;
  6626. /**
  6627. * Gets current buffer's data
  6628. * @returns a DataArray or null
  6629. */
  6630. getData(): Nullable<DataArray>;
  6631. /**
  6632. * Gets underlying native buffer
  6633. * @returns underlying native buffer
  6634. */
  6635. getBuffer(): Nullable<DataBuffer>;
  6636. /**
  6637. * Gets the stride in float32 units (i.e. byte stride / 4).
  6638. * May not be an integer if the byte stride is not divisible by 4.
  6639. * @returns the stride in float32 units
  6640. * @deprecated Please use byteStride instead.
  6641. */
  6642. getStrideSize(): number;
  6643. /**
  6644. * Returns the offset as a multiple of the type byte length.
  6645. * @returns the offset in bytes
  6646. * @deprecated Please use byteOffset instead.
  6647. */
  6648. getOffset(): number;
  6649. /**
  6650. * Returns the number of components per vertex attribute (integer)
  6651. * @returns the size in float
  6652. */
  6653. getSize(): number;
  6654. /**
  6655. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6656. * @returns true if this buffer is instanced
  6657. */
  6658. getIsInstanced(): boolean;
  6659. /**
  6660. * Returns the instancing divisor, zero for non-instanced (integer).
  6661. * @returns a number
  6662. */
  6663. getInstanceDivisor(): number;
  6664. /**
  6665. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6666. * @param data defines the data to store
  6667. */
  6668. create(data?: DataArray): void;
  6669. /**
  6670. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6671. * This function will create a new buffer if the current one is not updatable
  6672. * @param data defines the data to store
  6673. */
  6674. update(data: DataArray): void;
  6675. /**
  6676. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6677. * Returns the directly updated WebGLBuffer.
  6678. * @param data the new data
  6679. * @param offset the new offset
  6680. * @param useBytes set to true if the offset is in bytes
  6681. */
  6682. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6683. /**
  6684. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6685. */
  6686. dispose(): void;
  6687. /**
  6688. * Enumerates each value of this vertex buffer as numbers.
  6689. * @param count the number of values to enumerate
  6690. * @param callback the callback function called for each value
  6691. */
  6692. forEach(count: number, callback: (value: number, index: number) => void): void;
  6693. /**
  6694. * Positions
  6695. */
  6696. static readonly PositionKind: string;
  6697. /**
  6698. * Normals
  6699. */
  6700. static readonly NormalKind: string;
  6701. /**
  6702. * Tangents
  6703. */
  6704. static readonly TangentKind: string;
  6705. /**
  6706. * Texture coordinates
  6707. */
  6708. static readonly UVKind: string;
  6709. /**
  6710. * Texture coordinates 2
  6711. */
  6712. static readonly UV2Kind: string;
  6713. /**
  6714. * Texture coordinates 3
  6715. */
  6716. static readonly UV3Kind: string;
  6717. /**
  6718. * Texture coordinates 4
  6719. */
  6720. static readonly UV4Kind: string;
  6721. /**
  6722. * Texture coordinates 5
  6723. */
  6724. static readonly UV5Kind: string;
  6725. /**
  6726. * Texture coordinates 6
  6727. */
  6728. static readonly UV6Kind: string;
  6729. /**
  6730. * Colors
  6731. */
  6732. static readonly ColorKind: string;
  6733. /**
  6734. * Matrix indices (for bones)
  6735. */
  6736. static readonly MatricesIndicesKind: string;
  6737. /**
  6738. * Matrix weights (for bones)
  6739. */
  6740. static readonly MatricesWeightsKind: string;
  6741. /**
  6742. * Additional matrix indices (for bones)
  6743. */
  6744. static readonly MatricesIndicesExtraKind: string;
  6745. /**
  6746. * Additional matrix weights (for bones)
  6747. */
  6748. static readonly MatricesWeightsExtraKind: string;
  6749. /**
  6750. * Deduces the stride given a kind.
  6751. * @param kind The kind string to deduce
  6752. * @returns The deduced stride
  6753. */
  6754. static DeduceStride(kind: string): number;
  6755. /**
  6756. * Gets the byte length of the given type.
  6757. * @param type the type
  6758. * @returns the number of bytes
  6759. */
  6760. static GetTypeByteLength(type: number): number;
  6761. /**
  6762. * Enumerates each value of the given parameters as numbers.
  6763. * @param data the data to enumerate
  6764. * @param byteOffset the byte offset of the data
  6765. * @param byteStride the byte stride of the data
  6766. * @param componentCount the number of components per element
  6767. * @param componentType the type of the component
  6768. * @param count the number of values to enumerate
  6769. * @param normalized whether the data is normalized
  6770. * @param callback the callback function called for each value
  6771. */
  6772. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6773. private static _GetFloatValue;
  6774. }
  6775. }
  6776. declare module "babylonjs/Collisions/intersectionInfo" {
  6777. import { Nullable } from "babylonjs/types";
  6778. /**
  6779. * @hidden
  6780. */
  6781. export class IntersectionInfo {
  6782. bu: Nullable<number>;
  6783. bv: Nullable<number>;
  6784. distance: number;
  6785. faceId: number;
  6786. subMeshId: number;
  6787. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6788. }
  6789. }
  6790. declare module "babylonjs/Culling/boundingSphere" {
  6791. import { DeepImmutable } from "babylonjs/types";
  6792. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6793. import { Plane } from "babylonjs/Maths/math.plane";
  6794. /**
  6795. * Class used to store bounding sphere information
  6796. */
  6797. export class BoundingSphere {
  6798. /**
  6799. * Gets the center of the bounding sphere in local space
  6800. */
  6801. readonly center: Vector3;
  6802. /**
  6803. * Radius of the bounding sphere in local space
  6804. */
  6805. radius: number;
  6806. /**
  6807. * Gets the center of the bounding sphere in world space
  6808. */
  6809. readonly centerWorld: Vector3;
  6810. /**
  6811. * Radius of the bounding sphere in world space
  6812. */
  6813. radiusWorld: number;
  6814. /**
  6815. * Gets the minimum vector in local space
  6816. */
  6817. readonly minimum: Vector3;
  6818. /**
  6819. * Gets the maximum vector in local space
  6820. */
  6821. readonly maximum: Vector3;
  6822. private _worldMatrix;
  6823. private static readonly TmpVector3;
  6824. /**
  6825. * Creates a new bounding sphere
  6826. * @param min defines the minimum vector (in local space)
  6827. * @param max defines the maximum vector (in local space)
  6828. * @param worldMatrix defines the new world matrix
  6829. */
  6830. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6831. /**
  6832. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6833. * @param min defines the new minimum vector (in local space)
  6834. * @param max defines the new maximum vector (in local space)
  6835. * @param worldMatrix defines the new world matrix
  6836. */
  6837. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6838. /**
  6839. * Scale the current bounding sphere by applying a scale factor
  6840. * @param factor defines the scale factor to apply
  6841. * @returns the current bounding box
  6842. */
  6843. scale(factor: number): BoundingSphere;
  6844. /**
  6845. * Gets the world matrix of the bounding box
  6846. * @returns a matrix
  6847. */
  6848. getWorldMatrix(): DeepImmutable<Matrix>;
  6849. /** @hidden */
  6850. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6851. /**
  6852. * Tests if the bounding sphere is intersecting the frustum planes
  6853. * @param frustumPlanes defines the frustum planes to test
  6854. * @returns true if there is an intersection
  6855. */
  6856. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6857. /**
  6858. * Tests if the bounding sphere center is in between the frustum planes.
  6859. * Used for optimistic fast inclusion.
  6860. * @param frustumPlanes defines the frustum planes to test
  6861. * @returns true if the sphere center is in between the frustum planes
  6862. */
  6863. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6864. /**
  6865. * Tests if a point is inside the bounding sphere
  6866. * @param point defines the point to test
  6867. * @returns true if the point is inside the bounding sphere
  6868. */
  6869. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6870. /**
  6871. * Checks if two sphere intersct
  6872. * @param sphere0 sphere 0
  6873. * @param sphere1 sphere 1
  6874. * @returns true if the speres intersect
  6875. */
  6876. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6877. }
  6878. }
  6879. declare module "babylonjs/Culling/boundingBox" {
  6880. import { DeepImmutable } from "babylonjs/types";
  6881. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6882. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6883. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6884. import { Plane } from "babylonjs/Maths/math.plane";
  6885. /**
  6886. * Class used to store bounding box information
  6887. */
  6888. export class BoundingBox implements ICullable {
  6889. /**
  6890. * Gets the 8 vectors representing the bounding box in local space
  6891. */
  6892. readonly vectors: Vector3[];
  6893. /**
  6894. * Gets the center of the bounding box in local space
  6895. */
  6896. readonly center: Vector3;
  6897. /**
  6898. * Gets the center of the bounding box in world space
  6899. */
  6900. readonly centerWorld: Vector3;
  6901. /**
  6902. * Gets the extend size in local space
  6903. */
  6904. readonly extendSize: Vector3;
  6905. /**
  6906. * Gets the extend size in world space
  6907. */
  6908. readonly extendSizeWorld: Vector3;
  6909. /**
  6910. * Gets the OBB (object bounding box) directions
  6911. */
  6912. readonly directions: Vector3[];
  6913. /**
  6914. * Gets the 8 vectors representing the bounding box in world space
  6915. */
  6916. readonly vectorsWorld: Vector3[];
  6917. /**
  6918. * Gets the minimum vector in world space
  6919. */
  6920. readonly minimumWorld: Vector3;
  6921. /**
  6922. * Gets the maximum vector in world space
  6923. */
  6924. readonly maximumWorld: Vector3;
  6925. /**
  6926. * Gets the minimum vector in local space
  6927. */
  6928. readonly minimum: Vector3;
  6929. /**
  6930. * Gets the maximum vector in local space
  6931. */
  6932. readonly maximum: Vector3;
  6933. private _worldMatrix;
  6934. private static readonly TmpVector3;
  6935. /**
  6936. * @hidden
  6937. */
  6938. _tag: number;
  6939. /**
  6940. * Creates a new bounding box
  6941. * @param min defines the minimum vector (in local space)
  6942. * @param max defines the maximum vector (in local space)
  6943. * @param worldMatrix defines the new world matrix
  6944. */
  6945. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6946. /**
  6947. * Recreates the entire bounding box from scratch as if we call the constructor in place
  6948. * @param min defines the new minimum vector (in local space)
  6949. * @param max defines the new maximum vector (in local space)
  6950. * @param worldMatrix defines the new world matrix
  6951. */
  6952. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6953. /**
  6954. * Scale the current bounding box by applying a scale factor
  6955. * @param factor defines the scale factor to apply
  6956. * @returns the current bounding box
  6957. */
  6958. scale(factor: number): BoundingBox;
  6959. /**
  6960. * Gets the world matrix of the bounding box
  6961. * @returns a matrix
  6962. */
  6963. getWorldMatrix(): DeepImmutable<Matrix>;
  6964. /** @hidden */
  6965. _update(world: DeepImmutable<Matrix>): void;
  6966. /**
  6967. * Tests if the bounding box is intersecting the frustum planes
  6968. * @param frustumPlanes defines the frustum planes to test
  6969. * @returns true if there is an intersection
  6970. */
  6971. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6972. /**
  6973. * Tests if the bounding box is entirely inside the frustum planes
  6974. * @param frustumPlanes defines the frustum planes to test
  6975. * @returns true if there is an inclusion
  6976. */
  6977. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6978. /**
  6979. * Tests if a point is inside the bounding box
  6980. * @param point defines the point to test
  6981. * @returns true if the point is inside the bounding box
  6982. */
  6983. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6984. /**
  6985. * Tests if the bounding box intersects with a bounding sphere
  6986. * @param sphere defines the sphere to test
  6987. * @returns true if there is an intersection
  6988. */
  6989. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  6990. /**
  6991. * Tests if the bounding box intersects with a box defined by a min and max vectors
  6992. * @param min defines the min vector to use
  6993. * @param max defines the max vector to use
  6994. * @returns true if there is an intersection
  6995. */
  6996. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  6997. /**
  6998. * Tests if two bounding boxes are intersections
  6999. * @param box0 defines the first box to test
  7000. * @param box1 defines the second box to test
  7001. * @returns true if there is an intersection
  7002. */
  7003. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7004. /**
  7005. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7006. * @param minPoint defines the minimum vector of the bounding box
  7007. * @param maxPoint defines the maximum vector of the bounding box
  7008. * @param sphereCenter defines the sphere center
  7009. * @param sphereRadius defines the sphere radius
  7010. * @returns true if there is an intersection
  7011. */
  7012. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7013. /**
  7014. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7015. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7016. * @param frustumPlanes defines the frustum planes to test
  7017. * @return true if there is an inclusion
  7018. */
  7019. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7020. /**
  7021. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7022. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7023. * @param frustumPlanes defines the frustum planes to test
  7024. * @return true if there is an intersection
  7025. */
  7026. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7027. }
  7028. }
  7029. declare module "babylonjs/Collisions/collider" {
  7030. import { Nullable, IndicesArray } from "babylonjs/types";
  7031. import { Vector3 } from "babylonjs/Maths/math.vector";
  7032. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7033. import { Plane } from "babylonjs/Maths/math.plane";
  7034. /** @hidden */
  7035. export class Collider {
  7036. /** Define if a collision was found */
  7037. collisionFound: boolean;
  7038. /**
  7039. * Define last intersection point in local space
  7040. */
  7041. intersectionPoint: Vector3;
  7042. /**
  7043. * Define last collided mesh
  7044. */
  7045. collidedMesh: Nullable<AbstractMesh>;
  7046. private _collisionPoint;
  7047. private _planeIntersectionPoint;
  7048. private _tempVector;
  7049. private _tempVector2;
  7050. private _tempVector3;
  7051. private _tempVector4;
  7052. private _edge;
  7053. private _baseToVertex;
  7054. private _destinationPoint;
  7055. private _slidePlaneNormal;
  7056. private _displacementVector;
  7057. /** @hidden */
  7058. _radius: Vector3;
  7059. /** @hidden */
  7060. _retry: number;
  7061. private _velocity;
  7062. private _basePoint;
  7063. private _epsilon;
  7064. /** @hidden */
  7065. _velocityWorldLength: number;
  7066. /** @hidden */
  7067. _basePointWorld: Vector3;
  7068. private _velocityWorld;
  7069. private _normalizedVelocity;
  7070. /** @hidden */
  7071. _initialVelocity: Vector3;
  7072. /** @hidden */
  7073. _initialPosition: Vector3;
  7074. private _nearestDistance;
  7075. private _collisionMask;
  7076. get collisionMask(): number;
  7077. set collisionMask(mask: number);
  7078. /**
  7079. * Gets the plane normal used to compute the sliding response (in local space)
  7080. */
  7081. get slidePlaneNormal(): Vector3;
  7082. /** @hidden */
  7083. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7084. /** @hidden */
  7085. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7086. /** @hidden */
  7087. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7088. /** @hidden */
  7089. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7090. /** @hidden */
  7091. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7092. /** @hidden */
  7093. _getResponse(pos: Vector3, vel: Vector3): void;
  7094. }
  7095. }
  7096. declare module "babylonjs/Culling/boundingInfo" {
  7097. import { DeepImmutable } from "babylonjs/types";
  7098. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7099. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7100. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7101. import { Plane } from "babylonjs/Maths/math.plane";
  7102. import { Collider } from "babylonjs/Collisions/collider";
  7103. /**
  7104. * Interface for cullable objects
  7105. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7106. */
  7107. export interface ICullable {
  7108. /**
  7109. * Checks if the object or part of the object is in the frustum
  7110. * @param frustumPlanes Camera near/planes
  7111. * @returns true if the object is in frustum otherwise false
  7112. */
  7113. isInFrustum(frustumPlanes: Plane[]): boolean;
  7114. /**
  7115. * Checks if a cullable object (mesh...) is in the camera frustum
  7116. * Unlike isInFrustum this cheks the full bounding box
  7117. * @param frustumPlanes Camera near/planes
  7118. * @returns true if the object is in frustum otherwise false
  7119. */
  7120. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7121. }
  7122. /**
  7123. * Info for a bounding data of a mesh
  7124. */
  7125. export class BoundingInfo implements ICullable {
  7126. /**
  7127. * Bounding box for the mesh
  7128. */
  7129. readonly boundingBox: BoundingBox;
  7130. /**
  7131. * Bounding sphere for the mesh
  7132. */
  7133. readonly boundingSphere: BoundingSphere;
  7134. private _isLocked;
  7135. private static readonly TmpVector3;
  7136. /**
  7137. * Constructs bounding info
  7138. * @param minimum min vector of the bounding box/sphere
  7139. * @param maximum max vector of the bounding box/sphere
  7140. * @param worldMatrix defines the new world matrix
  7141. */
  7142. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7143. /**
  7144. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7145. * @param min defines the new minimum vector (in local space)
  7146. * @param max defines the new maximum vector (in local space)
  7147. * @param worldMatrix defines the new world matrix
  7148. */
  7149. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7150. /**
  7151. * min vector of the bounding box/sphere
  7152. */
  7153. get minimum(): Vector3;
  7154. /**
  7155. * max vector of the bounding box/sphere
  7156. */
  7157. get maximum(): Vector3;
  7158. /**
  7159. * If the info is locked and won't be updated to avoid perf overhead
  7160. */
  7161. get isLocked(): boolean;
  7162. set isLocked(value: boolean);
  7163. /**
  7164. * Updates the bounding sphere and box
  7165. * @param world world matrix to be used to update
  7166. */
  7167. update(world: DeepImmutable<Matrix>): void;
  7168. /**
  7169. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7170. * @param center New center of the bounding info
  7171. * @param extend New extend of the bounding info
  7172. * @returns the current bounding info
  7173. */
  7174. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7175. /**
  7176. * Scale the current bounding info by applying a scale factor
  7177. * @param factor defines the scale factor to apply
  7178. * @returns the current bounding info
  7179. */
  7180. scale(factor: number): BoundingInfo;
  7181. /**
  7182. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7183. * @param frustumPlanes defines the frustum to test
  7184. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7185. * @returns true if the bounding info is in the frustum planes
  7186. */
  7187. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7188. /**
  7189. * Gets the world distance between the min and max points of the bounding box
  7190. */
  7191. get diagonalLength(): number;
  7192. /**
  7193. * Checks if a cullable object (mesh...) is in the camera frustum
  7194. * Unlike isInFrustum this cheks the full bounding box
  7195. * @param frustumPlanes Camera near/planes
  7196. * @returns true if the object is in frustum otherwise false
  7197. */
  7198. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7199. /** @hidden */
  7200. _checkCollision(collider: Collider): boolean;
  7201. /**
  7202. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7203. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7204. * @param point the point to check intersection with
  7205. * @returns if the point intersects
  7206. */
  7207. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7208. /**
  7209. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7210. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7211. * @param boundingInfo the bounding info to check intersection with
  7212. * @param precise if the intersection should be done using OBB
  7213. * @returns if the bounding info intersects
  7214. */
  7215. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7216. }
  7217. }
  7218. declare module "babylonjs/Maths/math.functions" {
  7219. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7220. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7221. /**
  7222. * Extracts minimum and maximum values from a list of indexed positions
  7223. * @param positions defines the positions to use
  7224. * @param indices defines the indices to the positions
  7225. * @param indexStart defines the start index
  7226. * @param indexCount defines the end index
  7227. * @param bias defines bias value to add to the result
  7228. * @return minimum and maximum values
  7229. */
  7230. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7231. minimum: Vector3;
  7232. maximum: Vector3;
  7233. };
  7234. /**
  7235. * Extracts minimum and maximum values from a list of positions
  7236. * @param positions defines the positions to use
  7237. * @param start defines the start index in the positions array
  7238. * @param count defines the number of positions to handle
  7239. * @param bias defines bias value to add to the result
  7240. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7241. * @return minimum and maximum values
  7242. */
  7243. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7244. minimum: Vector3;
  7245. maximum: Vector3;
  7246. };
  7247. }
  7248. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7249. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7250. /** @hidden */
  7251. export class WebGLDataBuffer extends DataBuffer {
  7252. private _buffer;
  7253. constructor(resource: WebGLBuffer);
  7254. get underlyingResource(): any;
  7255. }
  7256. }
  7257. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7258. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7259. import { Nullable } from "babylonjs/types";
  7260. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7261. /** @hidden */
  7262. export class WebGLPipelineContext implements IPipelineContext {
  7263. engine: ThinEngine;
  7264. program: Nullable<WebGLProgram>;
  7265. context?: WebGLRenderingContext;
  7266. vertexShader?: WebGLShader;
  7267. fragmentShader?: WebGLShader;
  7268. isParallelCompiled: boolean;
  7269. onCompiled?: () => void;
  7270. transformFeedback?: WebGLTransformFeedback | null;
  7271. vertexCompilationError: Nullable<string>;
  7272. fragmentCompilationError: Nullable<string>;
  7273. programLinkError: Nullable<string>;
  7274. programValidationError: Nullable<string>;
  7275. get isAsync(): boolean;
  7276. get isReady(): boolean;
  7277. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7278. _getVertexShaderCode(): string | null;
  7279. _getFragmentShaderCode(): string | null;
  7280. }
  7281. }
  7282. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7283. import { FloatArray, Nullable } from "babylonjs/types";
  7284. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7285. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7286. module "babylonjs/Engines/thinEngine" {
  7287. interface ThinEngine {
  7288. /**
  7289. * Create an uniform buffer
  7290. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7291. * @param elements defines the content of the uniform buffer
  7292. * @returns the webGL uniform buffer
  7293. */
  7294. createUniformBuffer(elements: FloatArray): DataBuffer;
  7295. /**
  7296. * Create a dynamic uniform buffer
  7297. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7298. * @param elements defines the content of the uniform buffer
  7299. * @returns the webGL uniform buffer
  7300. */
  7301. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7302. /**
  7303. * Update an existing uniform buffer
  7304. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7305. * @param uniformBuffer defines the target uniform buffer
  7306. * @param elements defines the content to update
  7307. * @param offset defines the offset in the uniform buffer where update should start
  7308. * @param count defines the size of the data to update
  7309. */
  7310. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7311. /**
  7312. * Bind an uniform buffer to the current webGL context
  7313. * @param buffer defines the buffer to bind
  7314. */
  7315. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7316. /**
  7317. * Bind a buffer to the current webGL context at a given location
  7318. * @param buffer defines the buffer to bind
  7319. * @param location defines the index where to bind the buffer
  7320. */
  7321. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7322. /**
  7323. * Bind a specific block at a given index in a specific shader program
  7324. * @param pipelineContext defines the pipeline context to use
  7325. * @param blockName defines the block name
  7326. * @param index defines the index where to bind the block
  7327. */
  7328. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7329. }
  7330. }
  7331. }
  7332. declare module "babylonjs/Materials/uniformBuffer" {
  7333. import { Nullable, FloatArray } from "babylonjs/types";
  7334. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7335. import { Engine } from "babylonjs/Engines/engine";
  7336. import { Effect } from "babylonjs/Materials/effect";
  7337. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7338. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7339. import { Color3 } from "babylonjs/Maths/math.color";
  7340. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7341. /**
  7342. * Uniform buffer objects.
  7343. *
  7344. * Handles blocks of uniform on the GPU.
  7345. *
  7346. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7347. *
  7348. * For more information, please refer to :
  7349. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7350. */
  7351. export class UniformBuffer {
  7352. private _engine;
  7353. private _buffer;
  7354. private _data;
  7355. private _bufferData;
  7356. private _dynamic?;
  7357. private _uniformLocations;
  7358. private _uniformSizes;
  7359. private _uniformLocationPointer;
  7360. private _needSync;
  7361. private _noUBO;
  7362. private _currentEffect;
  7363. /** @hidden */
  7364. _alreadyBound: boolean;
  7365. private static _MAX_UNIFORM_SIZE;
  7366. private static _tempBuffer;
  7367. /**
  7368. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7369. * This is dynamic to allow compat with webgl 1 and 2.
  7370. * You will need to pass the name of the uniform as well as the value.
  7371. */
  7372. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7373. /**
  7374. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7375. * This is dynamic to allow compat with webgl 1 and 2.
  7376. * You will need to pass the name of the uniform as well as the value.
  7377. */
  7378. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7379. /**
  7380. * Lambda to Update a single float in a uniform buffer.
  7381. * This is dynamic to allow compat with webgl 1 and 2.
  7382. * You will need to pass the name of the uniform as well as the value.
  7383. */
  7384. updateFloat: (name: string, x: number) => void;
  7385. /**
  7386. * Lambda to Update a vec2 of float in a uniform buffer.
  7387. * This is dynamic to allow compat with webgl 1 and 2.
  7388. * You will need to pass the name of the uniform as well as the value.
  7389. */
  7390. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7391. /**
  7392. * Lambda to Update a vec3 of float in a uniform buffer.
  7393. * This is dynamic to allow compat with webgl 1 and 2.
  7394. * You will need to pass the name of the uniform as well as the value.
  7395. */
  7396. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7397. /**
  7398. * Lambda to Update a vec4 of float in a uniform buffer.
  7399. * This is dynamic to allow compat with webgl 1 and 2.
  7400. * You will need to pass the name of the uniform as well as the value.
  7401. */
  7402. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7403. /**
  7404. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7405. * This is dynamic to allow compat with webgl 1 and 2.
  7406. * You will need to pass the name of the uniform as well as the value.
  7407. */
  7408. updateMatrix: (name: string, mat: Matrix) => void;
  7409. /**
  7410. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7411. * This is dynamic to allow compat with webgl 1 and 2.
  7412. * You will need to pass the name of the uniform as well as the value.
  7413. */
  7414. updateVector3: (name: string, vector: Vector3) => void;
  7415. /**
  7416. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7417. * This is dynamic to allow compat with webgl 1 and 2.
  7418. * You will need to pass the name of the uniform as well as the value.
  7419. */
  7420. updateVector4: (name: string, vector: Vector4) => void;
  7421. /**
  7422. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7423. * This is dynamic to allow compat with webgl 1 and 2.
  7424. * You will need to pass the name of the uniform as well as the value.
  7425. */
  7426. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7427. /**
  7428. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7429. * This is dynamic to allow compat with webgl 1 and 2.
  7430. * You will need to pass the name of the uniform as well as the value.
  7431. */
  7432. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7433. /**
  7434. * Instantiates a new Uniform buffer objects.
  7435. *
  7436. * Handles blocks of uniform on the GPU.
  7437. *
  7438. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7439. *
  7440. * For more information, please refer to :
  7441. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7442. * @param engine Define the engine the buffer is associated with
  7443. * @param data Define the data contained in the buffer
  7444. * @param dynamic Define if the buffer is updatable
  7445. */
  7446. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7447. /**
  7448. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7449. * or just falling back on setUniformXXX calls.
  7450. */
  7451. get useUbo(): boolean;
  7452. /**
  7453. * Indicates if the WebGL underlying uniform buffer is in sync
  7454. * with the javascript cache data.
  7455. */
  7456. get isSync(): boolean;
  7457. /**
  7458. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7459. * Also, a dynamic UniformBuffer will disable cache verification and always
  7460. * update the underlying WebGL uniform buffer to the GPU.
  7461. * @returns if Dynamic, otherwise false
  7462. */
  7463. isDynamic(): boolean;
  7464. /**
  7465. * The data cache on JS side.
  7466. * @returns the underlying data as a float array
  7467. */
  7468. getData(): Float32Array;
  7469. /**
  7470. * The underlying WebGL Uniform buffer.
  7471. * @returns the webgl buffer
  7472. */
  7473. getBuffer(): Nullable<DataBuffer>;
  7474. /**
  7475. * std140 layout specifies how to align data within an UBO structure.
  7476. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7477. * for specs.
  7478. */
  7479. private _fillAlignment;
  7480. /**
  7481. * Adds an uniform in the buffer.
  7482. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7483. * for the layout to be correct !
  7484. * @param name Name of the uniform, as used in the uniform block in the shader.
  7485. * @param size Data size, or data directly.
  7486. */
  7487. addUniform(name: string, size: number | number[]): void;
  7488. /**
  7489. * Adds a Matrix 4x4 to the uniform buffer.
  7490. * @param name Name of the uniform, as used in the uniform block in the shader.
  7491. * @param mat A 4x4 matrix.
  7492. */
  7493. addMatrix(name: string, mat: Matrix): void;
  7494. /**
  7495. * Adds a vec2 to the uniform buffer.
  7496. * @param name Name of the uniform, as used in the uniform block in the shader.
  7497. * @param x Define the x component value of the vec2
  7498. * @param y Define the y component value of the vec2
  7499. */
  7500. addFloat2(name: string, x: number, y: number): void;
  7501. /**
  7502. * Adds a vec3 to the uniform buffer.
  7503. * @param name Name of the uniform, as used in the uniform block in the shader.
  7504. * @param x Define the x component value of the vec3
  7505. * @param y Define the y component value of the vec3
  7506. * @param z Define the z component value of the vec3
  7507. */
  7508. addFloat3(name: string, x: number, y: number, z: number): void;
  7509. /**
  7510. * Adds a vec3 to the uniform buffer.
  7511. * @param name Name of the uniform, as used in the uniform block in the shader.
  7512. * @param color Define the vec3 from a Color
  7513. */
  7514. addColor3(name: string, color: Color3): void;
  7515. /**
  7516. * Adds a vec4 to the uniform buffer.
  7517. * @param name Name of the uniform, as used in the uniform block in the shader.
  7518. * @param color Define the rgb components from a Color
  7519. * @param alpha Define the a component of the vec4
  7520. */
  7521. addColor4(name: string, color: Color3, alpha: number): void;
  7522. /**
  7523. * Adds a vec3 to the uniform buffer.
  7524. * @param name Name of the uniform, as used in the uniform block in the shader.
  7525. * @param vector Define the vec3 components from a Vector
  7526. */
  7527. addVector3(name: string, vector: Vector3): void;
  7528. /**
  7529. * Adds a Matrix 3x3 to the uniform buffer.
  7530. * @param name Name of the uniform, as used in the uniform block in the shader.
  7531. */
  7532. addMatrix3x3(name: string): void;
  7533. /**
  7534. * Adds a Matrix 2x2 to the uniform buffer.
  7535. * @param name Name of the uniform, as used in the uniform block in the shader.
  7536. */
  7537. addMatrix2x2(name: string): void;
  7538. /**
  7539. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7540. */
  7541. create(): void;
  7542. /** @hidden */
  7543. _rebuild(): void;
  7544. /**
  7545. * Updates the WebGL Uniform Buffer on the GPU.
  7546. * If the `dynamic` flag is set to true, no cache comparison is done.
  7547. * Otherwise, the buffer will be updated only if the cache differs.
  7548. */
  7549. update(): void;
  7550. /**
  7551. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7552. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7553. * @param data Define the flattened data
  7554. * @param size Define the size of the data.
  7555. */
  7556. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7557. private _valueCache;
  7558. private _cacheMatrix;
  7559. private _updateMatrix3x3ForUniform;
  7560. private _updateMatrix3x3ForEffect;
  7561. private _updateMatrix2x2ForEffect;
  7562. private _updateMatrix2x2ForUniform;
  7563. private _updateFloatForEffect;
  7564. private _updateFloatForUniform;
  7565. private _updateFloat2ForEffect;
  7566. private _updateFloat2ForUniform;
  7567. private _updateFloat3ForEffect;
  7568. private _updateFloat3ForUniform;
  7569. private _updateFloat4ForEffect;
  7570. private _updateFloat4ForUniform;
  7571. private _updateMatrixForEffect;
  7572. private _updateMatrixForUniform;
  7573. private _updateVector3ForEffect;
  7574. private _updateVector3ForUniform;
  7575. private _updateVector4ForEffect;
  7576. private _updateVector4ForUniform;
  7577. private _updateColor3ForEffect;
  7578. private _updateColor3ForUniform;
  7579. private _updateColor4ForEffect;
  7580. private _updateColor4ForUniform;
  7581. /**
  7582. * Sets a sampler uniform on the effect.
  7583. * @param name Define the name of the sampler.
  7584. * @param texture Define the texture to set in the sampler
  7585. */
  7586. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7587. /**
  7588. * Directly updates the value of the uniform in the cache AND on the GPU.
  7589. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7590. * @param data Define the flattened data
  7591. */
  7592. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7593. /**
  7594. * Binds this uniform buffer to an effect.
  7595. * @param effect Define the effect to bind the buffer to
  7596. * @param name Name of the uniform block in the shader.
  7597. */
  7598. bindToEffect(effect: Effect, name: string): void;
  7599. /**
  7600. * Disposes the uniform buffer.
  7601. */
  7602. dispose(): void;
  7603. }
  7604. }
  7605. declare module "babylonjs/Misc/iInspectable" {
  7606. /**
  7607. * Enum that determines the text-wrapping mode to use.
  7608. */
  7609. export enum InspectableType {
  7610. /**
  7611. * Checkbox for booleans
  7612. */
  7613. Checkbox = 0,
  7614. /**
  7615. * Sliders for numbers
  7616. */
  7617. Slider = 1,
  7618. /**
  7619. * Vector3
  7620. */
  7621. Vector3 = 2,
  7622. /**
  7623. * Quaternions
  7624. */
  7625. Quaternion = 3,
  7626. /**
  7627. * Color3
  7628. */
  7629. Color3 = 4,
  7630. /**
  7631. * String
  7632. */
  7633. String = 5
  7634. }
  7635. /**
  7636. * Interface used to define custom inspectable properties.
  7637. * This interface is used by the inspector to display custom property grids
  7638. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7639. */
  7640. export interface IInspectable {
  7641. /**
  7642. * Gets the label to display
  7643. */
  7644. label: string;
  7645. /**
  7646. * Gets the name of the property to edit
  7647. */
  7648. propertyName: string;
  7649. /**
  7650. * Gets the type of the editor to use
  7651. */
  7652. type: InspectableType;
  7653. /**
  7654. * Gets the minimum value of the property when using in "slider" mode
  7655. */
  7656. min?: number;
  7657. /**
  7658. * Gets the maximum value of the property when using in "slider" mode
  7659. */
  7660. max?: number;
  7661. /**
  7662. * Gets the setp to use when using in "slider" mode
  7663. */
  7664. step?: number;
  7665. }
  7666. }
  7667. declare module "babylonjs/Misc/timingTools" {
  7668. /**
  7669. * Class used to provide helper for timing
  7670. */
  7671. export class TimingTools {
  7672. /**
  7673. * Polyfill for setImmediate
  7674. * @param action defines the action to execute after the current execution block
  7675. */
  7676. static SetImmediate(action: () => void): void;
  7677. }
  7678. }
  7679. declare module "babylonjs/Misc/instantiationTools" {
  7680. /**
  7681. * Class used to enable instatition of objects by class name
  7682. */
  7683. export class InstantiationTools {
  7684. /**
  7685. * Use this object to register external classes like custom textures or material
  7686. * to allow the laoders to instantiate them
  7687. */
  7688. static RegisteredExternalClasses: {
  7689. [key: string]: Object;
  7690. };
  7691. /**
  7692. * Tries to instantiate a new object from a given class name
  7693. * @param className defines the class name to instantiate
  7694. * @returns the new object or null if the system was not able to do the instantiation
  7695. */
  7696. static Instantiate(className: string): any;
  7697. }
  7698. }
  7699. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7700. /**
  7701. * Define options used to create a depth texture
  7702. */
  7703. export class DepthTextureCreationOptions {
  7704. /** Specifies whether or not a stencil should be allocated in the texture */
  7705. generateStencil?: boolean;
  7706. /** Specifies whether or not bilinear filtering is enable on the texture */
  7707. bilinearFiltering?: boolean;
  7708. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7709. comparisonFunction?: number;
  7710. /** Specifies if the created texture is a cube texture */
  7711. isCube?: boolean;
  7712. }
  7713. }
  7714. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7715. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7716. import { Nullable } from "babylonjs/types";
  7717. import { Scene } from "babylonjs/scene";
  7718. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7719. module "babylonjs/Engines/thinEngine" {
  7720. interface ThinEngine {
  7721. /**
  7722. * Creates a depth stencil cube texture.
  7723. * This is only available in WebGL 2.
  7724. * @param size The size of face edge in the cube texture.
  7725. * @param options The options defining the cube texture.
  7726. * @returns The cube texture
  7727. */
  7728. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7729. /**
  7730. * Creates a cube texture
  7731. * @param rootUrl defines the url where the files to load is located
  7732. * @param scene defines the current scene
  7733. * @param files defines the list of files to load (1 per face)
  7734. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7735. * @param onLoad defines an optional callback raised when the texture is loaded
  7736. * @param onError defines an optional callback raised if there is an issue to load the texture
  7737. * @param format defines the format of the data
  7738. * @param forcedExtension defines the extension to use to pick the right loader
  7739. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7740. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7741. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7742. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7743. * @returns the cube texture as an InternalTexture
  7744. */
  7745. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>): InternalTexture;
  7746. /**
  7747. * Creates a cube texture
  7748. * @param rootUrl defines the url where the files to load is located
  7749. * @param scene defines the current scene
  7750. * @param files defines the list of files to load (1 per face)
  7751. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7752. * @param onLoad defines an optional callback raised when the texture is loaded
  7753. * @param onError defines an optional callback raised if there is an issue to load the texture
  7754. * @param format defines the format of the data
  7755. * @param forcedExtension defines the extension to use to pick the right loader
  7756. * @returns the cube texture as an InternalTexture
  7757. */
  7758. 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;
  7759. /**
  7760. * Creates a cube texture
  7761. * @param rootUrl defines the url where the files to load is located
  7762. * @param scene defines the current scene
  7763. * @param files defines the list of files to load (1 per face)
  7764. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7765. * @param onLoad defines an optional callback raised when the texture is loaded
  7766. * @param onError defines an optional callback raised if there is an issue to load the texture
  7767. * @param format defines the format of the data
  7768. * @param forcedExtension defines the extension to use to pick the right loader
  7769. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7770. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7771. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7772. * @returns the cube texture as an InternalTexture
  7773. */
  7774. 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;
  7775. /** @hidden */
  7776. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7777. /** @hidden */
  7778. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7779. /** @hidden */
  7780. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7781. /** @hidden */
  7782. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7783. /**
  7784. * @hidden
  7785. */
  7786. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7787. }
  7788. }
  7789. }
  7790. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7791. import { Nullable } from "babylonjs/types";
  7792. import { Scene } from "babylonjs/scene";
  7793. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7794. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7795. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7796. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7797. import { Observable } from "babylonjs/Misc/observable";
  7798. /**
  7799. * Class for creating a cube texture
  7800. */
  7801. export class CubeTexture extends BaseTexture {
  7802. private _delayedOnLoad;
  7803. /**
  7804. * Observable triggered once the texture has been loaded.
  7805. */
  7806. onLoadObservable: Observable<CubeTexture>;
  7807. /**
  7808. * The url of the texture
  7809. */
  7810. url: string;
  7811. /**
  7812. * Gets or sets the center of the bounding box associated with the cube texture.
  7813. * It must define where the camera used to render the texture was set
  7814. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7815. */
  7816. boundingBoxPosition: Vector3;
  7817. private _boundingBoxSize;
  7818. /**
  7819. * Gets or sets the size of the bounding box associated with the cube texture
  7820. * When defined, the cubemap will switch to local mode
  7821. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7822. * @example https://www.babylonjs-playground.com/#RNASML
  7823. */
  7824. set boundingBoxSize(value: Vector3);
  7825. /**
  7826. * Returns the bounding box size
  7827. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7828. */
  7829. get boundingBoxSize(): Vector3;
  7830. protected _rotationY: number;
  7831. /**
  7832. * Sets texture matrix rotation angle around Y axis in radians.
  7833. */
  7834. set rotationY(value: number);
  7835. /**
  7836. * Gets texture matrix rotation angle around Y axis radians.
  7837. */
  7838. get rotationY(): number;
  7839. /**
  7840. * Are mip maps generated for this texture or not.
  7841. */
  7842. get noMipmap(): boolean;
  7843. private _noMipmap;
  7844. private _files;
  7845. protected _forcedExtension: Nullable<string>;
  7846. private _extensions;
  7847. private _textureMatrix;
  7848. private _format;
  7849. private _createPolynomials;
  7850. /**
  7851. * Creates a cube texture from an array of image urls
  7852. * @param files defines an array of image urls
  7853. * @param scene defines the hosting scene
  7854. * @param noMipmap specifies if mip maps are not used
  7855. * @returns a cube texture
  7856. */
  7857. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7858. /**
  7859. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7860. * @param url defines the url of the prefiltered texture
  7861. * @param scene defines the scene the texture is attached to
  7862. * @param forcedExtension defines the extension of the file if different from the url
  7863. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7864. * @return the prefiltered texture
  7865. */
  7866. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7867. /**
  7868. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7869. * as prefiltered data.
  7870. * @param rootUrl defines the url of the texture or the root name of the six images
  7871. * @param null defines the scene or engine the texture is attached to
  7872. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7873. * @param noMipmap defines if mipmaps should be created or not
  7874. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7875. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7876. * @param onError defines a callback triggered in case of error during load
  7877. * @param format defines the internal format to use for the texture once loaded
  7878. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7879. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7880. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7881. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7882. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7883. * @return the cube texture
  7884. */
  7885. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  7886. /**
  7887. * Get the current class name of the texture useful for serialization or dynamic coding.
  7888. * @returns "CubeTexture"
  7889. */
  7890. getClassName(): string;
  7891. /**
  7892. * Update the url (and optional buffer) of this texture if url was null during construction.
  7893. * @param url the url of the texture
  7894. * @param forcedExtension defines the extension to use
  7895. * @param onLoad callback called when the texture is loaded (defaults to null)
  7896. * @param prefiltered Defines whether the updated texture is prefiltered or not
  7897. */
  7898. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  7899. /**
  7900. * Delays loading of the cube texture
  7901. * @param forcedExtension defines the extension to use
  7902. */
  7903. delayLoad(forcedExtension?: string): void;
  7904. /**
  7905. * Returns the reflection texture matrix
  7906. * @returns the reflection texture matrix
  7907. */
  7908. getReflectionTextureMatrix(): Matrix;
  7909. /**
  7910. * Sets the reflection texture matrix
  7911. * @param value Reflection texture matrix
  7912. */
  7913. setReflectionTextureMatrix(value: Matrix): void;
  7914. /**
  7915. * Parses text to create a cube texture
  7916. * @param parsedTexture define the serialized text to read from
  7917. * @param scene defines the hosting scene
  7918. * @param rootUrl defines the root url of the cube texture
  7919. * @returns a cube texture
  7920. */
  7921. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  7922. /**
  7923. * Makes a clone, or deep copy, of the cube texture
  7924. * @returns a new cube texture
  7925. */
  7926. clone(): CubeTexture;
  7927. }
  7928. }
  7929. declare module "babylonjs/Materials/materialDefines" {
  7930. /**
  7931. * Manages the defines for the Material
  7932. */
  7933. export class MaterialDefines {
  7934. /** @hidden */
  7935. protected _keys: string[];
  7936. private _isDirty;
  7937. /** @hidden */
  7938. _renderId: number;
  7939. /** @hidden */
  7940. _areLightsDirty: boolean;
  7941. /** @hidden */
  7942. _areLightsDisposed: boolean;
  7943. /** @hidden */
  7944. _areAttributesDirty: boolean;
  7945. /** @hidden */
  7946. _areTexturesDirty: boolean;
  7947. /** @hidden */
  7948. _areFresnelDirty: boolean;
  7949. /** @hidden */
  7950. _areMiscDirty: boolean;
  7951. /** @hidden */
  7952. _areImageProcessingDirty: boolean;
  7953. /** @hidden */
  7954. _normals: boolean;
  7955. /** @hidden */
  7956. _uvs: boolean;
  7957. /** @hidden */
  7958. _needNormals: boolean;
  7959. /** @hidden */
  7960. _needUVs: boolean;
  7961. [id: string]: any;
  7962. /**
  7963. * Specifies if the material needs to be re-calculated
  7964. */
  7965. get isDirty(): boolean;
  7966. /**
  7967. * Marks the material to indicate that it has been re-calculated
  7968. */
  7969. markAsProcessed(): void;
  7970. /**
  7971. * Marks the material to indicate that it needs to be re-calculated
  7972. */
  7973. markAsUnprocessed(): void;
  7974. /**
  7975. * Marks the material to indicate all of its defines need to be re-calculated
  7976. */
  7977. markAllAsDirty(): void;
  7978. /**
  7979. * Marks the material to indicate that image processing needs to be re-calculated
  7980. */
  7981. markAsImageProcessingDirty(): void;
  7982. /**
  7983. * Marks the material to indicate the lights need to be re-calculated
  7984. * @param disposed Defines whether the light is dirty due to dispose or not
  7985. */
  7986. markAsLightDirty(disposed?: boolean): void;
  7987. /**
  7988. * Marks the attribute state as changed
  7989. */
  7990. markAsAttributesDirty(): void;
  7991. /**
  7992. * Marks the texture state as changed
  7993. */
  7994. markAsTexturesDirty(): void;
  7995. /**
  7996. * Marks the fresnel state as changed
  7997. */
  7998. markAsFresnelDirty(): void;
  7999. /**
  8000. * Marks the misc state as changed
  8001. */
  8002. markAsMiscDirty(): void;
  8003. /**
  8004. * Rebuilds the material defines
  8005. */
  8006. rebuild(): void;
  8007. /**
  8008. * Specifies if two material defines are equal
  8009. * @param other - A material define instance to compare to
  8010. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8011. */
  8012. isEqual(other: MaterialDefines): boolean;
  8013. /**
  8014. * Clones this instance's defines to another instance
  8015. * @param other - material defines to clone values to
  8016. */
  8017. cloneTo(other: MaterialDefines): void;
  8018. /**
  8019. * Resets the material define values
  8020. */
  8021. reset(): void;
  8022. /**
  8023. * Converts the material define values to a string
  8024. * @returns - String of material define information
  8025. */
  8026. toString(): string;
  8027. }
  8028. }
  8029. declare module "babylonjs/Materials/colorCurves" {
  8030. import { Effect } from "babylonjs/Materials/effect";
  8031. /**
  8032. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8033. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8034. * 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;
  8035. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8036. */
  8037. export class ColorCurves {
  8038. private _dirty;
  8039. private _tempColor;
  8040. private _globalCurve;
  8041. private _highlightsCurve;
  8042. private _midtonesCurve;
  8043. private _shadowsCurve;
  8044. private _positiveCurve;
  8045. private _negativeCurve;
  8046. private _globalHue;
  8047. private _globalDensity;
  8048. private _globalSaturation;
  8049. private _globalExposure;
  8050. /**
  8051. * Gets the global Hue value.
  8052. * 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).
  8053. */
  8054. get globalHue(): number;
  8055. /**
  8056. * Sets the global Hue value.
  8057. * 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).
  8058. */
  8059. set globalHue(value: number);
  8060. /**
  8061. * Gets the global Density value.
  8062. * 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.
  8063. * Values less than zero provide a filter of opposite hue.
  8064. */
  8065. get globalDensity(): number;
  8066. /**
  8067. * Sets the global Density value.
  8068. * 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.
  8069. * Values less than zero provide a filter of opposite hue.
  8070. */
  8071. set globalDensity(value: number);
  8072. /**
  8073. * Gets the global Saturation 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 saturation and negative values decrease saturation.
  8075. */
  8076. get globalSaturation(): number;
  8077. /**
  8078. * Sets the global Saturation value.
  8079. * 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.
  8080. */
  8081. set globalSaturation(value: number);
  8082. /**
  8083. * Gets the global Exposure value.
  8084. * 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.
  8085. */
  8086. get globalExposure(): number;
  8087. /**
  8088. * Sets the global Exposure value.
  8089. * 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.
  8090. */
  8091. set globalExposure(value: number);
  8092. private _highlightsHue;
  8093. private _highlightsDensity;
  8094. private _highlightsSaturation;
  8095. private _highlightsExposure;
  8096. /**
  8097. * Gets the highlights Hue value.
  8098. * 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).
  8099. */
  8100. get highlightsHue(): number;
  8101. /**
  8102. * Sets the highlights Hue value.
  8103. * 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).
  8104. */
  8105. set highlightsHue(value: number);
  8106. /**
  8107. * Gets the highlights Density value.
  8108. * 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.
  8109. * Values less than zero provide a filter of opposite hue.
  8110. */
  8111. get highlightsDensity(): number;
  8112. /**
  8113. * Sets the highlights Density value.
  8114. * 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.
  8115. * Values less than zero provide a filter of opposite hue.
  8116. */
  8117. set highlightsDensity(value: number);
  8118. /**
  8119. * Gets the highlights Saturation value.
  8120. * 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.
  8121. */
  8122. get highlightsSaturation(): number;
  8123. /**
  8124. * Sets the highlights Saturation value.
  8125. * 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.
  8126. */
  8127. set highlightsSaturation(value: number);
  8128. /**
  8129. * Gets the highlights Exposure value.
  8130. * 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.
  8131. */
  8132. get highlightsExposure(): number;
  8133. /**
  8134. * Sets the highlights Exposure value.
  8135. * 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.
  8136. */
  8137. set highlightsExposure(value: number);
  8138. private _midtonesHue;
  8139. private _midtonesDensity;
  8140. private _midtonesSaturation;
  8141. private _midtonesExposure;
  8142. /**
  8143. * Gets the midtones Hue value.
  8144. * 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).
  8145. */
  8146. get midtonesHue(): number;
  8147. /**
  8148. * Sets the midtones Hue value.
  8149. * 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).
  8150. */
  8151. set midtonesHue(value: number);
  8152. /**
  8153. * Gets the midtones Density value.
  8154. * 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.
  8155. * Values less than zero provide a filter of opposite hue.
  8156. */
  8157. get midtonesDensity(): number;
  8158. /**
  8159. * Sets the midtones Density value.
  8160. * 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.
  8161. * Values less than zero provide a filter of opposite hue.
  8162. */
  8163. set midtonesDensity(value: number);
  8164. /**
  8165. * Gets the midtones Saturation value.
  8166. * 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.
  8167. */
  8168. get midtonesSaturation(): number;
  8169. /**
  8170. * Sets the midtones Saturation value.
  8171. * 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.
  8172. */
  8173. set midtonesSaturation(value: number);
  8174. /**
  8175. * Gets the midtones Exposure value.
  8176. * 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.
  8177. */
  8178. get midtonesExposure(): number;
  8179. /**
  8180. * Sets the midtones Exposure value.
  8181. * 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.
  8182. */
  8183. set midtonesExposure(value: number);
  8184. private _shadowsHue;
  8185. private _shadowsDensity;
  8186. private _shadowsSaturation;
  8187. private _shadowsExposure;
  8188. /**
  8189. * Gets the shadows Hue value.
  8190. * 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).
  8191. */
  8192. get shadowsHue(): number;
  8193. /**
  8194. * Sets the shadows Hue value.
  8195. * 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).
  8196. */
  8197. set shadowsHue(value: number);
  8198. /**
  8199. * Gets the shadows Density value.
  8200. * 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.
  8201. * Values less than zero provide a filter of opposite hue.
  8202. */
  8203. get shadowsDensity(): number;
  8204. /**
  8205. * Sets the shadows Density value.
  8206. * 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.
  8207. * Values less than zero provide a filter of opposite hue.
  8208. */
  8209. set shadowsDensity(value: number);
  8210. /**
  8211. * Gets the shadows Saturation value.
  8212. * 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.
  8213. */
  8214. get shadowsSaturation(): number;
  8215. /**
  8216. * Sets the shadows Saturation value.
  8217. * 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.
  8218. */
  8219. set shadowsSaturation(value: number);
  8220. /**
  8221. * Gets the shadows Exposure value.
  8222. * 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.
  8223. */
  8224. get shadowsExposure(): number;
  8225. /**
  8226. * Sets the shadows Exposure value.
  8227. * 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.
  8228. */
  8229. set shadowsExposure(value: number);
  8230. /**
  8231. * Returns the class name
  8232. * @returns The class name
  8233. */
  8234. getClassName(): string;
  8235. /**
  8236. * Binds the color curves to the shader.
  8237. * @param colorCurves The color curve to bind
  8238. * @param effect The effect to bind to
  8239. * @param positiveUniform The positive uniform shader parameter
  8240. * @param neutralUniform The neutral uniform shader parameter
  8241. * @param negativeUniform The negative uniform shader parameter
  8242. */
  8243. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8244. /**
  8245. * Prepare the list of uniforms associated with the ColorCurves effects.
  8246. * @param uniformsList The list of uniforms used in the effect
  8247. */
  8248. static PrepareUniforms(uniformsList: string[]): void;
  8249. /**
  8250. * Returns color grading data based on a hue, density, saturation and exposure value.
  8251. * @param filterHue The hue of the color filter.
  8252. * @param filterDensity The density of the color filter.
  8253. * @param saturation The saturation.
  8254. * @param exposure The exposure.
  8255. * @param result The result data container.
  8256. */
  8257. private getColorGradingDataToRef;
  8258. /**
  8259. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8260. * @param value The input slider value in range [-100,100].
  8261. * @returns Adjusted value.
  8262. */
  8263. private static applyColorGradingSliderNonlinear;
  8264. /**
  8265. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8266. * @param hue The hue (H) input.
  8267. * @param saturation The saturation (S) input.
  8268. * @param brightness The brightness (B) input.
  8269. * @result An RGBA color represented as Vector4.
  8270. */
  8271. private static fromHSBToRef;
  8272. /**
  8273. * Returns a value clamped between min and max
  8274. * @param value The value to clamp
  8275. * @param min The minimum of value
  8276. * @param max The maximum of value
  8277. * @returns The clamped value.
  8278. */
  8279. private static clamp;
  8280. /**
  8281. * Clones the current color curve instance.
  8282. * @return The cloned curves
  8283. */
  8284. clone(): ColorCurves;
  8285. /**
  8286. * Serializes the current color curve instance to a json representation.
  8287. * @return a JSON representation
  8288. */
  8289. serialize(): any;
  8290. /**
  8291. * Parses the color curve from a json representation.
  8292. * @param source the JSON source to parse
  8293. * @return The parsed curves
  8294. */
  8295. static Parse(source: any): ColorCurves;
  8296. }
  8297. }
  8298. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8299. import { Observable } from "babylonjs/Misc/observable";
  8300. import { Nullable } from "babylonjs/types";
  8301. import { Color4 } from "babylonjs/Maths/math.color";
  8302. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8303. import { Effect } from "babylonjs/Materials/effect";
  8304. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8305. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8306. /**
  8307. * Interface to follow in your material defines to integrate easily the
  8308. * Image proccessing functions.
  8309. * @hidden
  8310. */
  8311. export interface IImageProcessingConfigurationDefines {
  8312. IMAGEPROCESSING: boolean;
  8313. VIGNETTE: boolean;
  8314. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8315. VIGNETTEBLENDMODEOPAQUE: boolean;
  8316. TONEMAPPING: boolean;
  8317. TONEMAPPING_ACES: boolean;
  8318. CONTRAST: boolean;
  8319. EXPOSURE: boolean;
  8320. COLORCURVES: boolean;
  8321. COLORGRADING: boolean;
  8322. COLORGRADING3D: boolean;
  8323. SAMPLER3DGREENDEPTH: boolean;
  8324. SAMPLER3DBGRMAP: boolean;
  8325. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8326. }
  8327. /**
  8328. * @hidden
  8329. */
  8330. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8331. IMAGEPROCESSING: boolean;
  8332. VIGNETTE: boolean;
  8333. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8334. VIGNETTEBLENDMODEOPAQUE: boolean;
  8335. TONEMAPPING: boolean;
  8336. TONEMAPPING_ACES: boolean;
  8337. CONTRAST: boolean;
  8338. COLORCURVES: boolean;
  8339. COLORGRADING: boolean;
  8340. COLORGRADING3D: boolean;
  8341. SAMPLER3DGREENDEPTH: boolean;
  8342. SAMPLER3DBGRMAP: boolean;
  8343. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8344. EXPOSURE: boolean;
  8345. constructor();
  8346. }
  8347. /**
  8348. * This groups together the common properties used for image processing either in direct forward pass
  8349. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8350. * or not.
  8351. */
  8352. export class ImageProcessingConfiguration {
  8353. /**
  8354. * Default tone mapping applied in BabylonJS.
  8355. */
  8356. static readonly TONEMAPPING_STANDARD: number;
  8357. /**
  8358. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8359. * to other engines rendering to increase portability.
  8360. */
  8361. static readonly TONEMAPPING_ACES: number;
  8362. /**
  8363. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8364. */
  8365. colorCurves: Nullable<ColorCurves>;
  8366. private _colorCurvesEnabled;
  8367. /**
  8368. * Gets wether the color curves effect is enabled.
  8369. */
  8370. get colorCurvesEnabled(): boolean;
  8371. /**
  8372. * Sets wether the color curves effect is enabled.
  8373. */
  8374. set colorCurvesEnabled(value: boolean);
  8375. private _colorGradingTexture;
  8376. /**
  8377. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8378. */
  8379. get colorGradingTexture(): Nullable<BaseTexture>;
  8380. /**
  8381. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8382. */
  8383. set colorGradingTexture(value: Nullable<BaseTexture>);
  8384. private _colorGradingEnabled;
  8385. /**
  8386. * Gets wether the color grading effect is enabled.
  8387. */
  8388. get colorGradingEnabled(): boolean;
  8389. /**
  8390. * Sets wether the color grading effect is enabled.
  8391. */
  8392. set colorGradingEnabled(value: boolean);
  8393. private _colorGradingWithGreenDepth;
  8394. /**
  8395. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8396. */
  8397. get colorGradingWithGreenDepth(): boolean;
  8398. /**
  8399. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8400. */
  8401. set colorGradingWithGreenDepth(value: boolean);
  8402. private _colorGradingBGR;
  8403. /**
  8404. * Gets wether the color grading texture contains BGR values.
  8405. */
  8406. get colorGradingBGR(): boolean;
  8407. /**
  8408. * Sets wether the color grading texture contains BGR values.
  8409. */
  8410. set colorGradingBGR(value: boolean);
  8411. /** @hidden */
  8412. _exposure: number;
  8413. /**
  8414. * Gets the Exposure used in the effect.
  8415. */
  8416. get exposure(): number;
  8417. /**
  8418. * Sets the Exposure used in the effect.
  8419. */
  8420. set exposure(value: number);
  8421. private _toneMappingEnabled;
  8422. /**
  8423. * Gets wether the tone mapping effect is enabled.
  8424. */
  8425. get toneMappingEnabled(): boolean;
  8426. /**
  8427. * Sets wether the tone mapping effect is enabled.
  8428. */
  8429. set toneMappingEnabled(value: boolean);
  8430. private _toneMappingType;
  8431. /**
  8432. * Gets the type of tone mapping effect.
  8433. */
  8434. get toneMappingType(): number;
  8435. /**
  8436. * Sets the type of tone mapping effect used in BabylonJS.
  8437. */
  8438. set toneMappingType(value: number);
  8439. protected _contrast: number;
  8440. /**
  8441. * Gets the contrast used in the effect.
  8442. */
  8443. get contrast(): number;
  8444. /**
  8445. * Sets the contrast used in the effect.
  8446. */
  8447. set contrast(value: number);
  8448. /**
  8449. * Vignette stretch size.
  8450. */
  8451. vignetteStretch: number;
  8452. /**
  8453. * Vignette centre X Offset.
  8454. */
  8455. vignetteCentreX: number;
  8456. /**
  8457. * Vignette centre Y Offset.
  8458. */
  8459. vignetteCentreY: number;
  8460. /**
  8461. * Vignette weight or intensity of the vignette effect.
  8462. */
  8463. vignetteWeight: number;
  8464. /**
  8465. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8466. * if vignetteEnabled is set to true.
  8467. */
  8468. vignetteColor: Color4;
  8469. /**
  8470. * Camera field of view used by the Vignette effect.
  8471. */
  8472. vignetteCameraFov: number;
  8473. private _vignetteBlendMode;
  8474. /**
  8475. * Gets the vignette blend mode allowing different kind of effect.
  8476. */
  8477. get vignetteBlendMode(): number;
  8478. /**
  8479. * Sets the vignette blend mode allowing different kind of effect.
  8480. */
  8481. set vignetteBlendMode(value: number);
  8482. private _vignetteEnabled;
  8483. /**
  8484. * Gets wether the vignette effect is enabled.
  8485. */
  8486. get vignetteEnabled(): boolean;
  8487. /**
  8488. * Sets wether the vignette effect is enabled.
  8489. */
  8490. set vignetteEnabled(value: boolean);
  8491. private _applyByPostProcess;
  8492. /**
  8493. * Gets wether the image processing is applied through a post process or not.
  8494. */
  8495. get applyByPostProcess(): boolean;
  8496. /**
  8497. * Sets wether the image processing is applied through a post process or not.
  8498. */
  8499. set applyByPostProcess(value: boolean);
  8500. private _isEnabled;
  8501. /**
  8502. * Gets wether the image processing is enabled or not.
  8503. */
  8504. get isEnabled(): boolean;
  8505. /**
  8506. * Sets wether the image processing is enabled or not.
  8507. */
  8508. set isEnabled(value: boolean);
  8509. /**
  8510. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8511. */
  8512. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8513. /**
  8514. * Method called each time the image processing information changes requires to recompile the effect.
  8515. */
  8516. protected _updateParameters(): void;
  8517. /**
  8518. * Gets the current class name.
  8519. * @return "ImageProcessingConfiguration"
  8520. */
  8521. getClassName(): string;
  8522. /**
  8523. * Prepare the list of uniforms associated with the Image Processing effects.
  8524. * @param uniforms The list of uniforms used in the effect
  8525. * @param defines the list of defines currently in use
  8526. */
  8527. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8528. /**
  8529. * Prepare the list of samplers associated with the Image Processing effects.
  8530. * @param samplersList The list of uniforms used in the effect
  8531. * @param defines the list of defines currently in use
  8532. */
  8533. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8534. /**
  8535. * Prepare the list of defines associated to the shader.
  8536. * @param defines the list of defines to complete
  8537. * @param forPostProcess Define if we are currently in post process mode or not
  8538. */
  8539. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8540. /**
  8541. * Returns true if all the image processing information are ready.
  8542. * @returns True if ready, otherwise, false
  8543. */
  8544. isReady(): boolean;
  8545. /**
  8546. * Binds the image processing to the shader.
  8547. * @param effect The effect to bind to
  8548. * @param overrideAspectRatio Override the aspect ratio of the effect
  8549. */
  8550. bind(effect: Effect, overrideAspectRatio?: number): void;
  8551. /**
  8552. * Clones the current image processing instance.
  8553. * @return The cloned image processing
  8554. */
  8555. clone(): ImageProcessingConfiguration;
  8556. /**
  8557. * Serializes the current image processing instance to a json representation.
  8558. * @return a JSON representation
  8559. */
  8560. serialize(): any;
  8561. /**
  8562. * Parses the image processing from a json representation.
  8563. * @param source the JSON source to parse
  8564. * @return The parsed image processing
  8565. */
  8566. static Parse(source: any): ImageProcessingConfiguration;
  8567. private static _VIGNETTEMODE_MULTIPLY;
  8568. private static _VIGNETTEMODE_OPAQUE;
  8569. /**
  8570. * Used to apply the vignette as a mix with the pixel color.
  8571. */
  8572. static get VIGNETTEMODE_MULTIPLY(): number;
  8573. /**
  8574. * Used to apply the vignette as a replacement of the pixel color.
  8575. */
  8576. static get VIGNETTEMODE_OPAQUE(): number;
  8577. }
  8578. }
  8579. declare module "babylonjs/Shaders/postprocess.vertex" {
  8580. /** @hidden */
  8581. export var postprocessVertexShader: {
  8582. name: string;
  8583. shader: string;
  8584. };
  8585. }
  8586. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8587. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8588. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8589. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8590. module "babylonjs/Engines/thinEngine" {
  8591. interface ThinEngine {
  8592. /**
  8593. * Creates a new render target texture
  8594. * @param size defines the size of the texture
  8595. * @param options defines the options used to create the texture
  8596. * @returns a new render target texture stored in an InternalTexture
  8597. */
  8598. createRenderTargetTexture(size: number | {
  8599. width: number;
  8600. height: number;
  8601. layers?: number;
  8602. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8603. /**
  8604. * Creates a depth stencil texture.
  8605. * This is only available in WebGL 2 or with the depth texture extension available.
  8606. * @param size The size of face edge in the texture.
  8607. * @param options The options defining the texture.
  8608. * @returns The texture
  8609. */
  8610. createDepthStencilTexture(size: number | {
  8611. width: number;
  8612. height: number;
  8613. layers?: number;
  8614. }, options: DepthTextureCreationOptions): InternalTexture;
  8615. /** @hidden */
  8616. _createDepthStencilTexture(size: number | {
  8617. width: number;
  8618. height: number;
  8619. layers?: number;
  8620. }, options: DepthTextureCreationOptions): InternalTexture;
  8621. }
  8622. }
  8623. }
  8624. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8625. /**
  8626. * Defines the kind of connection point for node based material
  8627. */
  8628. export enum NodeMaterialBlockConnectionPointTypes {
  8629. /** Float */
  8630. Float = 1,
  8631. /** Int */
  8632. Int = 2,
  8633. /** Vector2 */
  8634. Vector2 = 4,
  8635. /** Vector3 */
  8636. Vector3 = 8,
  8637. /** Vector4 */
  8638. Vector4 = 16,
  8639. /** Color3 */
  8640. Color3 = 32,
  8641. /** Color4 */
  8642. Color4 = 64,
  8643. /** Matrix */
  8644. Matrix = 128,
  8645. /** Custom object */
  8646. Object = 256,
  8647. /** Detect type based on connection */
  8648. AutoDetect = 1024,
  8649. /** Output type that will be defined by input type */
  8650. BasedOnInput = 2048
  8651. }
  8652. }
  8653. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8654. /**
  8655. * Enum used to define the target of a block
  8656. */
  8657. export enum NodeMaterialBlockTargets {
  8658. /** Vertex shader */
  8659. Vertex = 1,
  8660. /** Fragment shader */
  8661. Fragment = 2,
  8662. /** Neutral */
  8663. Neutral = 4,
  8664. /** Vertex and Fragment */
  8665. VertexAndFragment = 3
  8666. }
  8667. }
  8668. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8669. /**
  8670. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8671. */
  8672. export enum NodeMaterialBlockConnectionPointMode {
  8673. /** Value is an uniform */
  8674. Uniform = 0,
  8675. /** Value is a mesh attribute */
  8676. Attribute = 1,
  8677. /** Value is a varying between vertex and fragment shaders */
  8678. Varying = 2,
  8679. /** Mode is undefined */
  8680. Undefined = 3
  8681. }
  8682. }
  8683. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8684. /**
  8685. * Enum used to define system values e.g. values automatically provided by the system
  8686. */
  8687. export enum NodeMaterialSystemValues {
  8688. /** World */
  8689. World = 1,
  8690. /** View */
  8691. View = 2,
  8692. /** Projection */
  8693. Projection = 3,
  8694. /** ViewProjection */
  8695. ViewProjection = 4,
  8696. /** WorldView */
  8697. WorldView = 5,
  8698. /** WorldViewProjection */
  8699. WorldViewProjection = 6,
  8700. /** CameraPosition */
  8701. CameraPosition = 7,
  8702. /** Fog Color */
  8703. FogColor = 8,
  8704. /** Delta time */
  8705. DeltaTime = 9
  8706. }
  8707. }
  8708. declare module "babylonjs/Maths/math.axis" {
  8709. import { Vector3 } from "babylonjs/Maths/math.vector";
  8710. /** Defines supported spaces */
  8711. export enum Space {
  8712. /** Local (object) space */
  8713. LOCAL = 0,
  8714. /** World space */
  8715. WORLD = 1,
  8716. /** Bone space */
  8717. BONE = 2
  8718. }
  8719. /** Defines the 3 main axes */
  8720. export class Axis {
  8721. /** X axis */
  8722. static X: Vector3;
  8723. /** Y axis */
  8724. static Y: Vector3;
  8725. /** Z axis */
  8726. static Z: Vector3;
  8727. }
  8728. }
  8729. declare module "babylonjs/Maths/math.frustum" {
  8730. import { Matrix } from "babylonjs/Maths/math.vector";
  8731. import { DeepImmutable } from "babylonjs/types";
  8732. import { Plane } from "babylonjs/Maths/math.plane";
  8733. /**
  8734. * Represents a camera frustum
  8735. */
  8736. export class Frustum {
  8737. /**
  8738. * Gets the planes representing the frustum
  8739. * @param transform matrix to be applied to the returned planes
  8740. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8741. */
  8742. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8743. /**
  8744. * Gets the near frustum plane transformed by the transform matrix
  8745. * @param transform transformation matrix to be applied to the resulting frustum plane
  8746. * @param frustumPlane the resuling frustum plane
  8747. */
  8748. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8749. /**
  8750. * Gets the far frustum plane transformed by the transform matrix
  8751. * @param transform transformation matrix to be applied to the resulting frustum plane
  8752. * @param frustumPlane the resuling frustum plane
  8753. */
  8754. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8755. /**
  8756. * Gets the left frustum plane transformed by the transform matrix
  8757. * @param transform transformation matrix to be applied to the resulting frustum plane
  8758. * @param frustumPlane the resuling frustum plane
  8759. */
  8760. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8761. /**
  8762. * Gets the right frustum plane transformed by the transform matrix
  8763. * @param transform transformation matrix to be applied to the resulting frustum plane
  8764. * @param frustumPlane the resuling frustum plane
  8765. */
  8766. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8767. /**
  8768. * Gets the top frustum plane transformed by the transform matrix
  8769. * @param transform transformation matrix to be applied to the resulting frustum plane
  8770. * @param frustumPlane the resuling frustum plane
  8771. */
  8772. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8773. /**
  8774. * Gets the bottom frustum plane transformed by the transform matrix
  8775. * @param transform transformation matrix to be applied to the resulting frustum plane
  8776. * @param frustumPlane the resuling frustum plane
  8777. */
  8778. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8779. /**
  8780. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8781. * @param transform transformation matrix to be applied to the resulting frustum planes
  8782. * @param frustumPlanes the resuling frustum planes
  8783. */
  8784. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8785. }
  8786. }
  8787. declare module "babylonjs/Maths/math.size" {
  8788. /**
  8789. * Interface for the size containing width and height
  8790. */
  8791. export interface ISize {
  8792. /**
  8793. * Width
  8794. */
  8795. width: number;
  8796. /**
  8797. * Heighht
  8798. */
  8799. height: number;
  8800. }
  8801. /**
  8802. * Size containing widht and height
  8803. */
  8804. export class Size implements ISize {
  8805. /**
  8806. * Width
  8807. */
  8808. width: number;
  8809. /**
  8810. * Height
  8811. */
  8812. height: number;
  8813. /**
  8814. * Creates a Size object from the given width and height (floats).
  8815. * @param width width of the new size
  8816. * @param height height of the new size
  8817. */
  8818. constructor(width: number, height: number);
  8819. /**
  8820. * Returns a string with the Size width and height
  8821. * @returns a string with the Size width and height
  8822. */
  8823. toString(): string;
  8824. /**
  8825. * "Size"
  8826. * @returns the string "Size"
  8827. */
  8828. getClassName(): string;
  8829. /**
  8830. * Returns the Size hash code.
  8831. * @returns a hash code for a unique width and height
  8832. */
  8833. getHashCode(): number;
  8834. /**
  8835. * Updates the current size from the given one.
  8836. * @param src the given size
  8837. */
  8838. copyFrom(src: Size): void;
  8839. /**
  8840. * Updates in place the current Size from the given floats.
  8841. * @param width width of the new size
  8842. * @param height height of the new size
  8843. * @returns the updated Size.
  8844. */
  8845. copyFromFloats(width: number, height: number): Size;
  8846. /**
  8847. * Updates in place the current Size from the given floats.
  8848. * @param width width to set
  8849. * @param height height to set
  8850. * @returns the updated Size.
  8851. */
  8852. set(width: number, height: number): Size;
  8853. /**
  8854. * Multiplies the width and height by numbers
  8855. * @param w factor to multiple the width by
  8856. * @param h factor to multiple the height by
  8857. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8858. */
  8859. multiplyByFloats(w: number, h: number): Size;
  8860. /**
  8861. * Clones the size
  8862. * @returns a new Size copied from the given one.
  8863. */
  8864. clone(): Size;
  8865. /**
  8866. * True if the current Size and the given one width and height are strictly equal.
  8867. * @param other the other size to compare against
  8868. * @returns True if the current Size and the given one width and height are strictly equal.
  8869. */
  8870. equals(other: Size): boolean;
  8871. /**
  8872. * The surface of the Size : width * height (float).
  8873. */
  8874. get surface(): number;
  8875. /**
  8876. * Create a new size of zero
  8877. * @returns a new Size set to (0.0, 0.0)
  8878. */
  8879. static Zero(): Size;
  8880. /**
  8881. * Sums the width and height of two sizes
  8882. * @param otherSize size to add to this size
  8883. * @returns a new Size set as the addition result of the current Size and the given one.
  8884. */
  8885. add(otherSize: Size): Size;
  8886. /**
  8887. * Subtracts the width and height of two
  8888. * @param otherSize size to subtract to this size
  8889. * @returns a new Size set as the subtraction result of the given one from the current Size.
  8890. */
  8891. subtract(otherSize: Size): Size;
  8892. /**
  8893. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  8894. * @param start starting size to lerp between
  8895. * @param end end size to lerp between
  8896. * @param amount amount to lerp between the start and end values
  8897. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  8898. */
  8899. static Lerp(start: Size, end: Size, amount: number): Size;
  8900. }
  8901. }
  8902. declare module "babylonjs/Maths/math.vertexFormat" {
  8903. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8904. /**
  8905. * Contains position and normal vectors for a vertex
  8906. */
  8907. export class PositionNormalVertex {
  8908. /** the position of the vertex (defaut: 0,0,0) */
  8909. position: Vector3;
  8910. /** the normal of the vertex (defaut: 0,1,0) */
  8911. normal: Vector3;
  8912. /**
  8913. * Creates a PositionNormalVertex
  8914. * @param position the position of the vertex (defaut: 0,0,0)
  8915. * @param normal the normal of the vertex (defaut: 0,1,0)
  8916. */
  8917. constructor(
  8918. /** the position of the vertex (defaut: 0,0,0) */
  8919. position?: Vector3,
  8920. /** the normal of the vertex (defaut: 0,1,0) */
  8921. normal?: Vector3);
  8922. /**
  8923. * Clones the PositionNormalVertex
  8924. * @returns the cloned PositionNormalVertex
  8925. */
  8926. clone(): PositionNormalVertex;
  8927. }
  8928. /**
  8929. * Contains position, normal and uv vectors for a vertex
  8930. */
  8931. export class PositionNormalTextureVertex {
  8932. /** the position of the vertex (defaut: 0,0,0) */
  8933. position: Vector3;
  8934. /** the normal of the vertex (defaut: 0,1,0) */
  8935. normal: Vector3;
  8936. /** the uv of the vertex (default: 0,0) */
  8937. uv: Vector2;
  8938. /**
  8939. * Creates a PositionNormalTextureVertex
  8940. * @param position the position of the vertex (defaut: 0,0,0)
  8941. * @param normal the normal of the vertex (defaut: 0,1,0)
  8942. * @param uv the uv of the vertex (default: 0,0)
  8943. */
  8944. constructor(
  8945. /** the position of the vertex (defaut: 0,0,0) */
  8946. position?: Vector3,
  8947. /** the normal of the vertex (defaut: 0,1,0) */
  8948. normal?: Vector3,
  8949. /** the uv of the vertex (default: 0,0) */
  8950. uv?: Vector2);
  8951. /**
  8952. * Clones the PositionNormalTextureVertex
  8953. * @returns the cloned PositionNormalTextureVertex
  8954. */
  8955. clone(): PositionNormalTextureVertex;
  8956. }
  8957. }
  8958. declare module "babylonjs/Maths/math" {
  8959. export * from "babylonjs/Maths/math.axis";
  8960. export * from "babylonjs/Maths/math.color";
  8961. export * from "babylonjs/Maths/math.constants";
  8962. export * from "babylonjs/Maths/math.frustum";
  8963. export * from "babylonjs/Maths/math.path";
  8964. export * from "babylonjs/Maths/math.plane";
  8965. export * from "babylonjs/Maths/math.size";
  8966. export * from "babylonjs/Maths/math.vector";
  8967. export * from "babylonjs/Maths/math.vertexFormat";
  8968. export * from "babylonjs/Maths/math.viewport";
  8969. }
  8970. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  8971. /**
  8972. * Enum defining the type of animations supported by InputBlock
  8973. */
  8974. export enum AnimatedInputBlockTypes {
  8975. /** No animation */
  8976. None = 0,
  8977. /** Time based animation. Will only work for floats */
  8978. Time = 1
  8979. }
  8980. }
  8981. declare module "babylonjs/Lights/shadowLight" {
  8982. import { Camera } from "babylonjs/Cameras/camera";
  8983. import { Scene } from "babylonjs/scene";
  8984. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  8985. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8986. import { Light } from "babylonjs/Lights/light";
  8987. /**
  8988. * Interface describing all the common properties and methods a shadow light needs to implement.
  8989. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  8990. * as well as binding the different shadow properties to the effects.
  8991. */
  8992. export interface IShadowLight extends Light {
  8993. /**
  8994. * The light id in the scene (used in scene.findLighById for instance)
  8995. */
  8996. id: string;
  8997. /**
  8998. * The position the shdow will be casted from.
  8999. */
  9000. position: Vector3;
  9001. /**
  9002. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9003. */
  9004. direction: Vector3;
  9005. /**
  9006. * The transformed position. Position of the light in world space taking parenting in account.
  9007. */
  9008. transformedPosition: Vector3;
  9009. /**
  9010. * The transformed direction. Direction of the light in world space taking parenting in account.
  9011. */
  9012. transformedDirection: Vector3;
  9013. /**
  9014. * The friendly name of the light in the scene.
  9015. */
  9016. name: string;
  9017. /**
  9018. * Defines the shadow projection clipping minimum z value.
  9019. */
  9020. shadowMinZ: number;
  9021. /**
  9022. * Defines the shadow projection clipping maximum z value.
  9023. */
  9024. shadowMaxZ: number;
  9025. /**
  9026. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9027. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9028. */
  9029. computeTransformedInformation(): boolean;
  9030. /**
  9031. * Gets the scene the light belongs to.
  9032. * @returns The scene
  9033. */
  9034. getScene(): Scene;
  9035. /**
  9036. * Callback defining a custom Projection Matrix Builder.
  9037. * This can be used to override the default projection matrix computation.
  9038. */
  9039. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9040. /**
  9041. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9042. * @param matrix The materix to updated with the projection information
  9043. * @param viewMatrix The transform matrix of the light
  9044. * @param renderList The list of mesh to render in the map
  9045. * @returns The current light
  9046. */
  9047. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9048. /**
  9049. * Gets the current depth scale used in ESM.
  9050. * @returns The scale
  9051. */
  9052. getDepthScale(): number;
  9053. /**
  9054. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9055. * @returns true if a cube texture needs to be use
  9056. */
  9057. needCube(): boolean;
  9058. /**
  9059. * Detects if the projection matrix requires to be recomputed this frame.
  9060. * @returns true if it requires to be recomputed otherwise, false.
  9061. */
  9062. needProjectionMatrixCompute(): boolean;
  9063. /**
  9064. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9065. */
  9066. forceProjectionMatrixCompute(): void;
  9067. /**
  9068. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9069. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9070. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9071. */
  9072. getShadowDirection(faceIndex?: number): Vector3;
  9073. /**
  9074. * Gets the minZ used for shadow according to both the scene and the light.
  9075. * @param activeCamera The camera we are returning the min for
  9076. * @returns the depth min z
  9077. */
  9078. getDepthMinZ(activeCamera: Camera): number;
  9079. /**
  9080. * Gets the maxZ used for shadow according to both the scene and the light.
  9081. * @param activeCamera The camera we are returning the max for
  9082. * @returns the depth max z
  9083. */
  9084. getDepthMaxZ(activeCamera: Camera): number;
  9085. }
  9086. /**
  9087. * Base implementation IShadowLight
  9088. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9089. */
  9090. export abstract class ShadowLight extends Light implements IShadowLight {
  9091. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9092. protected _position: Vector3;
  9093. protected _setPosition(value: Vector3): void;
  9094. /**
  9095. * Sets the position the shadow will be casted from. Also use as the light position for both
  9096. * point and spot lights.
  9097. */
  9098. get position(): Vector3;
  9099. /**
  9100. * Sets the position the shadow will be casted from. Also use as the light position for both
  9101. * point and spot lights.
  9102. */
  9103. set position(value: Vector3);
  9104. protected _direction: Vector3;
  9105. protected _setDirection(value: Vector3): void;
  9106. /**
  9107. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9108. * Also use as the light direction on spot and directional lights.
  9109. */
  9110. get direction(): Vector3;
  9111. /**
  9112. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9113. * Also use as the light direction on spot and directional lights.
  9114. */
  9115. set direction(value: Vector3);
  9116. protected _shadowMinZ: number;
  9117. /**
  9118. * Gets the shadow projection clipping minimum z value.
  9119. */
  9120. get shadowMinZ(): number;
  9121. /**
  9122. * Sets the shadow projection clipping minimum z value.
  9123. */
  9124. set shadowMinZ(value: number);
  9125. protected _shadowMaxZ: number;
  9126. /**
  9127. * Sets the shadow projection clipping maximum z value.
  9128. */
  9129. get shadowMaxZ(): number;
  9130. /**
  9131. * Gets the shadow projection clipping maximum z value.
  9132. */
  9133. set shadowMaxZ(value: number);
  9134. /**
  9135. * Callback defining a custom Projection Matrix Builder.
  9136. * This can be used to override the default projection matrix computation.
  9137. */
  9138. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9139. /**
  9140. * The transformed position. Position of the light in world space taking parenting in account.
  9141. */
  9142. transformedPosition: Vector3;
  9143. /**
  9144. * The transformed direction. Direction of the light in world space taking parenting in account.
  9145. */
  9146. transformedDirection: Vector3;
  9147. private _needProjectionMatrixCompute;
  9148. /**
  9149. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9150. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9151. */
  9152. computeTransformedInformation(): boolean;
  9153. /**
  9154. * Return the depth scale used for the shadow map.
  9155. * @returns the depth scale.
  9156. */
  9157. getDepthScale(): number;
  9158. /**
  9159. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9160. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9161. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9162. */
  9163. getShadowDirection(faceIndex?: number): Vector3;
  9164. /**
  9165. * Returns the ShadowLight absolute position in the World.
  9166. * @returns the position vector in world space
  9167. */
  9168. getAbsolutePosition(): Vector3;
  9169. /**
  9170. * Sets the ShadowLight direction toward the passed target.
  9171. * @param target The point to target in local space
  9172. * @returns the updated ShadowLight direction
  9173. */
  9174. setDirectionToTarget(target: Vector3): Vector3;
  9175. /**
  9176. * Returns the light rotation in euler definition.
  9177. * @returns the x y z rotation in local space.
  9178. */
  9179. getRotation(): Vector3;
  9180. /**
  9181. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9182. * @returns true if a cube texture needs to be use
  9183. */
  9184. needCube(): boolean;
  9185. /**
  9186. * Detects if the projection matrix requires to be recomputed this frame.
  9187. * @returns true if it requires to be recomputed otherwise, false.
  9188. */
  9189. needProjectionMatrixCompute(): boolean;
  9190. /**
  9191. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9192. */
  9193. forceProjectionMatrixCompute(): void;
  9194. /** @hidden */
  9195. _initCache(): void;
  9196. /** @hidden */
  9197. _isSynchronized(): boolean;
  9198. /**
  9199. * Computes the world matrix of the node
  9200. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9201. * @returns the world matrix
  9202. */
  9203. computeWorldMatrix(force?: boolean): Matrix;
  9204. /**
  9205. * Gets the minZ used for shadow according to both the scene and the light.
  9206. * @param activeCamera The camera we are returning the min for
  9207. * @returns the depth min z
  9208. */
  9209. getDepthMinZ(activeCamera: Camera): number;
  9210. /**
  9211. * Gets the maxZ used for shadow according to both the scene and the light.
  9212. * @param activeCamera The camera we are returning the max for
  9213. * @returns the depth max z
  9214. */
  9215. getDepthMaxZ(activeCamera: Camera): number;
  9216. /**
  9217. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9218. * @param matrix The materix to updated with the projection information
  9219. * @param viewMatrix The transform matrix of the light
  9220. * @param renderList The list of mesh to render in the map
  9221. * @returns The current light
  9222. */
  9223. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9224. }
  9225. }
  9226. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9227. /** @hidden */
  9228. export var packingFunctions: {
  9229. name: string;
  9230. shader: string;
  9231. };
  9232. }
  9233. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9234. /** @hidden */
  9235. export var bayerDitherFunctions: {
  9236. name: string;
  9237. shader: string;
  9238. };
  9239. }
  9240. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9241. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9242. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9243. /** @hidden */
  9244. export var shadowMapFragmentDeclaration: {
  9245. name: string;
  9246. shader: string;
  9247. };
  9248. }
  9249. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9250. /** @hidden */
  9251. export var clipPlaneFragmentDeclaration: {
  9252. name: string;
  9253. shader: string;
  9254. };
  9255. }
  9256. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9257. /** @hidden */
  9258. export var clipPlaneFragment: {
  9259. name: string;
  9260. shader: string;
  9261. };
  9262. }
  9263. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9264. /** @hidden */
  9265. export var shadowMapFragment: {
  9266. name: string;
  9267. shader: string;
  9268. };
  9269. }
  9270. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9271. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9272. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9273. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9274. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9275. /** @hidden */
  9276. export var shadowMapPixelShader: {
  9277. name: string;
  9278. shader: string;
  9279. };
  9280. }
  9281. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9282. /** @hidden */
  9283. export var bonesDeclaration: {
  9284. name: string;
  9285. shader: string;
  9286. };
  9287. }
  9288. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9289. /** @hidden */
  9290. export var morphTargetsVertexGlobalDeclaration: {
  9291. name: string;
  9292. shader: string;
  9293. };
  9294. }
  9295. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9296. /** @hidden */
  9297. export var morphTargetsVertexDeclaration: {
  9298. name: string;
  9299. shader: string;
  9300. };
  9301. }
  9302. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9303. /** @hidden */
  9304. export var instancesDeclaration: {
  9305. name: string;
  9306. shader: string;
  9307. };
  9308. }
  9309. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9310. /** @hidden */
  9311. export var helperFunctions: {
  9312. name: string;
  9313. shader: string;
  9314. };
  9315. }
  9316. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9317. /** @hidden */
  9318. export var shadowMapVertexDeclaration: {
  9319. name: string;
  9320. shader: string;
  9321. };
  9322. }
  9323. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9324. /** @hidden */
  9325. export var clipPlaneVertexDeclaration: {
  9326. name: string;
  9327. shader: string;
  9328. };
  9329. }
  9330. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9331. /** @hidden */
  9332. export var morphTargetsVertex: {
  9333. name: string;
  9334. shader: string;
  9335. };
  9336. }
  9337. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9338. /** @hidden */
  9339. export var instancesVertex: {
  9340. name: string;
  9341. shader: string;
  9342. };
  9343. }
  9344. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9345. /** @hidden */
  9346. export var bonesVertex: {
  9347. name: string;
  9348. shader: string;
  9349. };
  9350. }
  9351. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9352. /** @hidden */
  9353. export var shadowMapVertexNormalBias: {
  9354. name: string;
  9355. shader: string;
  9356. };
  9357. }
  9358. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9359. /** @hidden */
  9360. export var shadowMapVertexMetric: {
  9361. name: string;
  9362. shader: string;
  9363. };
  9364. }
  9365. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9366. /** @hidden */
  9367. export var clipPlaneVertex: {
  9368. name: string;
  9369. shader: string;
  9370. };
  9371. }
  9372. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9373. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9374. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9375. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9376. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9377. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9378. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9379. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9380. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9381. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9382. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9383. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9384. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9385. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9386. /** @hidden */
  9387. export var shadowMapVertexShader: {
  9388. name: string;
  9389. shader: string;
  9390. };
  9391. }
  9392. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9393. /** @hidden */
  9394. export var depthBoxBlurPixelShader: {
  9395. name: string;
  9396. shader: string;
  9397. };
  9398. }
  9399. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9400. /** @hidden */
  9401. export var shadowMapFragmentSoftTransparentShadow: {
  9402. name: string;
  9403. shader: string;
  9404. };
  9405. }
  9406. declare module "babylonjs/Materials/effectFallbacks" {
  9407. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9408. import { Effect } from "babylonjs/Materials/effect";
  9409. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9410. /**
  9411. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9412. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9413. */
  9414. export class EffectFallbacks implements IEffectFallbacks {
  9415. private _defines;
  9416. private _currentRank;
  9417. private _maxRank;
  9418. private _mesh;
  9419. /**
  9420. * Removes the fallback from the bound mesh.
  9421. */
  9422. unBindMesh(): void;
  9423. /**
  9424. * Adds a fallback on the specified property.
  9425. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9426. * @param define The name of the define in the shader
  9427. */
  9428. addFallback(rank: number, define: string): void;
  9429. /**
  9430. * Sets the mesh to use CPU skinning when needing to fallback.
  9431. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9432. * @param mesh The mesh to use the fallbacks.
  9433. */
  9434. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9435. /**
  9436. * Checks to see if more fallbacks are still availible.
  9437. */
  9438. get hasMoreFallbacks(): boolean;
  9439. /**
  9440. * Removes the defines that should be removed when falling back.
  9441. * @param currentDefines defines the current define statements for the shader.
  9442. * @param effect defines the current effect we try to compile
  9443. * @returns The resulting defines with defines of the current rank removed.
  9444. */
  9445. reduce(currentDefines: string, effect: Effect): string;
  9446. }
  9447. }
  9448. declare module "babylonjs/Actions/action" {
  9449. import { Observable } from "babylonjs/Misc/observable";
  9450. import { Condition } from "babylonjs/Actions/condition";
  9451. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9452. import { ActionManager } from "babylonjs/Actions/actionManager";
  9453. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9454. /**
  9455. * Interface used to define Action
  9456. */
  9457. export interface IAction {
  9458. /**
  9459. * Trigger for the action
  9460. */
  9461. trigger: number;
  9462. /** Options of the trigger */
  9463. triggerOptions: any;
  9464. /**
  9465. * Gets the trigger parameters
  9466. * @returns the trigger parameters
  9467. */
  9468. getTriggerParameter(): any;
  9469. /**
  9470. * Internal only - executes current action event
  9471. * @hidden
  9472. */
  9473. _executeCurrent(evt?: ActionEvent): void;
  9474. /**
  9475. * Serialize placeholder for child classes
  9476. * @param parent of child
  9477. * @returns the serialized object
  9478. */
  9479. serialize(parent: any): any;
  9480. /**
  9481. * Internal only
  9482. * @hidden
  9483. */
  9484. _prepare(): void;
  9485. /**
  9486. * Internal only - manager for action
  9487. * @hidden
  9488. */
  9489. _actionManager: AbstractActionManager;
  9490. /**
  9491. * Adds action to chain of actions, may be a DoNothingAction
  9492. * @param action defines the next action to execute
  9493. * @returns The action passed in
  9494. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9495. */
  9496. then(action: IAction): IAction;
  9497. }
  9498. /**
  9499. * The action to be carried out following a trigger
  9500. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9501. */
  9502. export class Action implements IAction {
  9503. /** the trigger, with or without parameters, for the action */
  9504. triggerOptions: any;
  9505. /**
  9506. * Trigger for the action
  9507. */
  9508. trigger: number;
  9509. /**
  9510. * Internal only - manager for action
  9511. * @hidden
  9512. */
  9513. _actionManager: ActionManager;
  9514. private _nextActiveAction;
  9515. private _child;
  9516. private _condition?;
  9517. private _triggerParameter;
  9518. /**
  9519. * An event triggered prior to action being executed.
  9520. */
  9521. onBeforeExecuteObservable: Observable<Action>;
  9522. /**
  9523. * Creates a new Action
  9524. * @param triggerOptions the trigger, with or without parameters, for the action
  9525. * @param condition an optional determinant of action
  9526. */
  9527. constructor(
  9528. /** the trigger, with or without parameters, for the action */
  9529. triggerOptions: any, condition?: Condition);
  9530. /**
  9531. * Internal only
  9532. * @hidden
  9533. */
  9534. _prepare(): void;
  9535. /**
  9536. * Gets the trigger parameters
  9537. * @returns the trigger parameters
  9538. */
  9539. getTriggerParameter(): any;
  9540. /**
  9541. * Internal only - executes current action event
  9542. * @hidden
  9543. */
  9544. _executeCurrent(evt?: ActionEvent): void;
  9545. /**
  9546. * Execute placeholder for child classes
  9547. * @param evt optional action event
  9548. */
  9549. execute(evt?: ActionEvent): void;
  9550. /**
  9551. * Skips to next active action
  9552. */
  9553. skipToNextActiveAction(): void;
  9554. /**
  9555. * Adds action to chain of actions, may be a DoNothingAction
  9556. * @param action defines the next action to execute
  9557. * @returns The action passed in
  9558. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9559. */
  9560. then(action: Action): Action;
  9561. /**
  9562. * Internal only
  9563. * @hidden
  9564. */
  9565. _getProperty(propertyPath: string): string;
  9566. /**
  9567. * Internal only
  9568. * @hidden
  9569. */
  9570. _getEffectiveTarget(target: any, propertyPath: string): any;
  9571. /**
  9572. * Serialize placeholder for child classes
  9573. * @param parent of child
  9574. * @returns the serialized object
  9575. */
  9576. serialize(parent: any): any;
  9577. /**
  9578. * Internal only called by serialize
  9579. * @hidden
  9580. */
  9581. protected _serialize(serializedAction: any, parent?: any): any;
  9582. /**
  9583. * Internal only
  9584. * @hidden
  9585. */
  9586. static _SerializeValueAsString: (value: any) => string;
  9587. /**
  9588. * Internal only
  9589. * @hidden
  9590. */
  9591. static _GetTargetProperty: (target: import("babylonjs/node").Node | import("babylonjs/scene").Scene) => {
  9592. name: string;
  9593. targetType: string;
  9594. value: string;
  9595. };
  9596. }
  9597. }
  9598. declare module "babylonjs/Actions/condition" {
  9599. import { ActionManager } from "babylonjs/Actions/actionManager";
  9600. /**
  9601. * A Condition applied to an Action
  9602. */
  9603. export class Condition {
  9604. /**
  9605. * Internal only - manager for action
  9606. * @hidden
  9607. */
  9608. _actionManager: ActionManager;
  9609. /**
  9610. * Internal only
  9611. * @hidden
  9612. */
  9613. _evaluationId: number;
  9614. /**
  9615. * Internal only
  9616. * @hidden
  9617. */
  9618. _currentResult: boolean;
  9619. /**
  9620. * Creates a new Condition
  9621. * @param actionManager the manager of the action the condition is applied to
  9622. */
  9623. constructor(actionManager: ActionManager);
  9624. /**
  9625. * Check if the current condition is valid
  9626. * @returns a boolean
  9627. */
  9628. isValid(): boolean;
  9629. /**
  9630. * Internal only
  9631. * @hidden
  9632. */
  9633. _getProperty(propertyPath: string): string;
  9634. /**
  9635. * Internal only
  9636. * @hidden
  9637. */
  9638. _getEffectiveTarget(target: any, propertyPath: string): any;
  9639. /**
  9640. * Serialize placeholder for child classes
  9641. * @returns the serialized object
  9642. */
  9643. serialize(): any;
  9644. /**
  9645. * Internal only
  9646. * @hidden
  9647. */
  9648. protected _serialize(serializedCondition: any): any;
  9649. }
  9650. /**
  9651. * Defines specific conditional operators as extensions of Condition
  9652. */
  9653. export class ValueCondition extends Condition {
  9654. /** path to specify the property of the target the conditional operator uses */
  9655. propertyPath: string;
  9656. /** the value compared by the conditional operator against the current value of the property */
  9657. value: any;
  9658. /** the conditional operator, default ValueCondition.IsEqual */
  9659. operator: number;
  9660. /**
  9661. * Internal only
  9662. * @hidden
  9663. */
  9664. private static _IsEqual;
  9665. /**
  9666. * Internal only
  9667. * @hidden
  9668. */
  9669. private static _IsDifferent;
  9670. /**
  9671. * Internal only
  9672. * @hidden
  9673. */
  9674. private static _IsGreater;
  9675. /**
  9676. * Internal only
  9677. * @hidden
  9678. */
  9679. private static _IsLesser;
  9680. /**
  9681. * returns the number for IsEqual
  9682. */
  9683. static get IsEqual(): number;
  9684. /**
  9685. * Returns the number for IsDifferent
  9686. */
  9687. static get IsDifferent(): number;
  9688. /**
  9689. * Returns the number for IsGreater
  9690. */
  9691. static get IsGreater(): number;
  9692. /**
  9693. * Returns the number for IsLesser
  9694. */
  9695. static get IsLesser(): number;
  9696. /**
  9697. * Internal only The action manager for the condition
  9698. * @hidden
  9699. */
  9700. _actionManager: ActionManager;
  9701. /**
  9702. * Internal only
  9703. * @hidden
  9704. */
  9705. private _target;
  9706. /**
  9707. * Internal only
  9708. * @hidden
  9709. */
  9710. private _effectiveTarget;
  9711. /**
  9712. * Internal only
  9713. * @hidden
  9714. */
  9715. private _property;
  9716. /**
  9717. * Creates a new ValueCondition
  9718. * @param actionManager manager for the action the condition applies to
  9719. * @param target for the action
  9720. * @param propertyPath path to specify the property of the target the conditional operator uses
  9721. * @param value the value compared by the conditional operator against the current value of the property
  9722. * @param operator the conditional operator, default ValueCondition.IsEqual
  9723. */
  9724. constructor(actionManager: ActionManager, target: any,
  9725. /** path to specify the property of the target the conditional operator uses */
  9726. propertyPath: string,
  9727. /** the value compared by the conditional operator against the current value of the property */
  9728. value: any,
  9729. /** the conditional operator, default ValueCondition.IsEqual */
  9730. operator?: number);
  9731. /**
  9732. * Compares the given value with the property value for the specified conditional operator
  9733. * @returns the result of the comparison
  9734. */
  9735. isValid(): boolean;
  9736. /**
  9737. * Serialize the ValueCondition into a JSON compatible object
  9738. * @returns serialization object
  9739. */
  9740. serialize(): any;
  9741. /**
  9742. * Gets the name of the conditional operator for the ValueCondition
  9743. * @param operator the conditional operator
  9744. * @returns the name
  9745. */
  9746. static GetOperatorName(operator: number): string;
  9747. }
  9748. /**
  9749. * Defines a predicate condition as an extension of Condition
  9750. */
  9751. export class PredicateCondition extends Condition {
  9752. /** defines the predicate function used to validate the condition */
  9753. predicate: () => boolean;
  9754. /**
  9755. * Internal only - manager for action
  9756. * @hidden
  9757. */
  9758. _actionManager: ActionManager;
  9759. /**
  9760. * Creates a new PredicateCondition
  9761. * @param actionManager manager for the action the condition applies to
  9762. * @param predicate defines the predicate function used to validate the condition
  9763. */
  9764. constructor(actionManager: ActionManager,
  9765. /** defines the predicate function used to validate the condition */
  9766. predicate: () => boolean);
  9767. /**
  9768. * @returns the validity of the predicate condition
  9769. */
  9770. isValid(): boolean;
  9771. }
  9772. /**
  9773. * Defines a state condition as an extension of Condition
  9774. */
  9775. export class StateCondition extends Condition {
  9776. /** Value to compare with target state */
  9777. value: string;
  9778. /**
  9779. * Internal only - manager for action
  9780. * @hidden
  9781. */
  9782. _actionManager: ActionManager;
  9783. /**
  9784. * Internal only
  9785. * @hidden
  9786. */
  9787. private _target;
  9788. /**
  9789. * Creates a new StateCondition
  9790. * @param actionManager manager for the action the condition applies to
  9791. * @param target of the condition
  9792. * @param value to compare with target state
  9793. */
  9794. constructor(actionManager: ActionManager, target: any,
  9795. /** Value to compare with target state */
  9796. value: string);
  9797. /**
  9798. * Gets a boolean indicating if the current condition is met
  9799. * @returns the validity of the state
  9800. */
  9801. isValid(): boolean;
  9802. /**
  9803. * Serialize the StateCondition into a JSON compatible object
  9804. * @returns serialization object
  9805. */
  9806. serialize(): any;
  9807. }
  9808. }
  9809. declare module "babylonjs/Actions/directActions" {
  9810. import { Action } from "babylonjs/Actions/action";
  9811. import { Condition } from "babylonjs/Actions/condition";
  9812. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9813. /**
  9814. * This defines an action responsible to toggle a boolean once triggered.
  9815. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  9816. */
  9817. export class SwitchBooleanAction extends Action {
  9818. /**
  9819. * The path to the boolean property in the target object
  9820. */
  9821. propertyPath: string;
  9822. private _target;
  9823. private _effectiveTarget;
  9824. private _property;
  9825. /**
  9826. * Instantiate the action
  9827. * @param triggerOptions defines the trigger options
  9828. * @param target defines the object containing the boolean
  9829. * @param propertyPath defines the path to the boolean property in the target object
  9830. * @param condition defines the trigger related conditions
  9831. */
  9832. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9833. /** @hidden */
  9834. _prepare(): void;
  9835. /**
  9836. * Execute the action toggle the boolean value.
  9837. */
  9838. execute(): void;
  9839. /**
  9840. * Serializes the actions and its related information.
  9841. * @param parent defines the object to serialize in
  9842. * @returns the serialized object
  9843. */
  9844. serialize(parent: any): any;
  9845. }
  9846. /**
  9847. * This defines an action responsible to set a the state field of the target
  9848. * to a desired value once triggered.
  9849. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  9850. */
  9851. export class SetStateAction extends Action {
  9852. /**
  9853. * The value to store in the state field.
  9854. */
  9855. value: string;
  9856. private _target;
  9857. /**
  9858. * Instantiate the action
  9859. * @param triggerOptions defines the trigger options
  9860. * @param target defines the object containing the state property
  9861. * @param value defines the value to store in the state field
  9862. * @param condition defines the trigger related conditions
  9863. */
  9864. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9865. /**
  9866. * Execute the action and store the value on the target state property.
  9867. */
  9868. execute(): void;
  9869. /**
  9870. * Serializes the actions and its related information.
  9871. * @param parent defines the object to serialize in
  9872. * @returns the serialized object
  9873. */
  9874. serialize(parent: any): any;
  9875. }
  9876. /**
  9877. * This defines an action responsible to set a property of the target
  9878. * to a desired value once triggered.
  9879. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  9880. */
  9881. export class SetValueAction extends Action {
  9882. /**
  9883. * The path of the property to set in the target.
  9884. */
  9885. propertyPath: string;
  9886. /**
  9887. * The value to set in the property
  9888. */
  9889. value: any;
  9890. private _target;
  9891. private _effectiveTarget;
  9892. private _property;
  9893. /**
  9894. * Instantiate the action
  9895. * @param triggerOptions defines the trigger options
  9896. * @param target defines the object containing the property
  9897. * @param propertyPath defines the path of the property to set in the target
  9898. * @param value defines the value to set in the property
  9899. * @param condition defines the trigger related conditions
  9900. */
  9901. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9902. /** @hidden */
  9903. _prepare(): void;
  9904. /**
  9905. * Execute the action and set the targetted property to the desired value.
  9906. */
  9907. execute(): void;
  9908. /**
  9909. * Serializes the actions and its related information.
  9910. * @param parent defines the object to serialize in
  9911. * @returns the serialized object
  9912. */
  9913. serialize(parent: any): any;
  9914. }
  9915. /**
  9916. * This defines an action responsible to increment the target value
  9917. * to a desired value once triggered.
  9918. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  9919. */
  9920. export class IncrementValueAction extends Action {
  9921. /**
  9922. * The path of the property to increment in the target.
  9923. */
  9924. propertyPath: string;
  9925. /**
  9926. * The value we should increment the property by.
  9927. */
  9928. value: any;
  9929. private _target;
  9930. private _effectiveTarget;
  9931. private _property;
  9932. /**
  9933. * Instantiate the action
  9934. * @param triggerOptions defines the trigger options
  9935. * @param target defines the object containing the property
  9936. * @param propertyPath defines the path of the property to increment in the target
  9937. * @param value defines the value value we should increment the property by
  9938. * @param condition defines the trigger related conditions
  9939. */
  9940. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9941. /** @hidden */
  9942. _prepare(): void;
  9943. /**
  9944. * Execute the action and increment the target of the value amount.
  9945. */
  9946. execute(): void;
  9947. /**
  9948. * Serializes the actions and its related information.
  9949. * @param parent defines the object to serialize in
  9950. * @returns the serialized object
  9951. */
  9952. serialize(parent: any): any;
  9953. }
  9954. /**
  9955. * This defines an action responsible to start an animation once triggered.
  9956. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  9957. */
  9958. export class PlayAnimationAction extends Action {
  9959. /**
  9960. * Where the animation should start (animation frame)
  9961. */
  9962. from: number;
  9963. /**
  9964. * Where the animation should stop (animation frame)
  9965. */
  9966. to: number;
  9967. /**
  9968. * Define if the animation should loop or stop after the first play.
  9969. */
  9970. loop?: boolean;
  9971. private _target;
  9972. /**
  9973. * Instantiate the action
  9974. * @param triggerOptions defines the trigger options
  9975. * @param target defines the target animation or animation name
  9976. * @param from defines from where the animation should start (animation frame)
  9977. * @param end defines where the animation should stop (animation frame)
  9978. * @param loop defines if the animation should loop or stop after the first play
  9979. * @param condition defines the trigger related conditions
  9980. */
  9981. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  9982. /** @hidden */
  9983. _prepare(): void;
  9984. /**
  9985. * Execute the action and play the animation.
  9986. */
  9987. execute(): void;
  9988. /**
  9989. * Serializes the actions and its related information.
  9990. * @param parent defines the object to serialize in
  9991. * @returns the serialized object
  9992. */
  9993. serialize(parent: any): any;
  9994. }
  9995. /**
  9996. * This defines an action responsible to stop an animation once triggered.
  9997. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  9998. */
  9999. export class StopAnimationAction extends Action {
  10000. private _target;
  10001. /**
  10002. * Instantiate the action
  10003. * @param triggerOptions defines the trigger options
  10004. * @param target defines the target animation or animation name
  10005. * @param condition defines the trigger related conditions
  10006. */
  10007. constructor(triggerOptions: any, target: any, condition?: Condition);
  10008. /** @hidden */
  10009. _prepare(): void;
  10010. /**
  10011. * Execute the action and stop the animation.
  10012. */
  10013. execute(): void;
  10014. /**
  10015. * Serializes the actions and its related information.
  10016. * @param parent defines the object to serialize in
  10017. * @returns the serialized object
  10018. */
  10019. serialize(parent: any): any;
  10020. }
  10021. /**
  10022. * This defines an action responsible that does nothing once triggered.
  10023. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10024. */
  10025. export class DoNothingAction extends Action {
  10026. /**
  10027. * Instantiate the action
  10028. * @param triggerOptions defines the trigger options
  10029. * @param condition defines the trigger related conditions
  10030. */
  10031. constructor(triggerOptions?: any, condition?: Condition);
  10032. /**
  10033. * Execute the action and do nothing.
  10034. */
  10035. execute(): void;
  10036. /**
  10037. * Serializes the actions and its related information.
  10038. * @param parent defines the object to serialize in
  10039. * @returns the serialized object
  10040. */
  10041. serialize(parent: any): any;
  10042. }
  10043. /**
  10044. * This defines an action responsible to trigger several actions once triggered.
  10045. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10046. */
  10047. export class CombineAction extends Action {
  10048. /**
  10049. * The list of aggregated animations to run.
  10050. */
  10051. children: Action[];
  10052. /**
  10053. * Instantiate the action
  10054. * @param triggerOptions defines the trigger options
  10055. * @param children defines the list of aggregated animations to run
  10056. * @param condition defines the trigger related conditions
  10057. */
  10058. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10059. /** @hidden */
  10060. _prepare(): void;
  10061. /**
  10062. * Execute the action and executes all the aggregated actions.
  10063. */
  10064. execute(evt: ActionEvent): void;
  10065. /**
  10066. * Serializes the actions and its related information.
  10067. * @param parent defines the object to serialize in
  10068. * @returns the serialized object
  10069. */
  10070. serialize(parent: any): any;
  10071. }
  10072. /**
  10073. * This defines an action responsible to run code (external event) once triggered.
  10074. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10075. */
  10076. export class ExecuteCodeAction extends Action {
  10077. /**
  10078. * The callback function to run.
  10079. */
  10080. func: (evt: ActionEvent) => void;
  10081. /**
  10082. * Instantiate the action
  10083. * @param triggerOptions defines the trigger options
  10084. * @param func defines the callback function to run
  10085. * @param condition defines the trigger related conditions
  10086. */
  10087. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10088. /**
  10089. * Execute the action and run the attached code.
  10090. */
  10091. execute(evt: ActionEvent): void;
  10092. }
  10093. /**
  10094. * This defines an action responsible to set the parent property of the target once triggered.
  10095. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10096. */
  10097. export class SetParentAction extends Action {
  10098. private _parent;
  10099. private _target;
  10100. /**
  10101. * Instantiate the action
  10102. * @param triggerOptions defines the trigger options
  10103. * @param target defines the target containing the parent property
  10104. * @param parent defines from where the animation should start (animation frame)
  10105. * @param condition defines the trigger related conditions
  10106. */
  10107. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10108. /** @hidden */
  10109. _prepare(): void;
  10110. /**
  10111. * Execute the action and set the parent property.
  10112. */
  10113. execute(): void;
  10114. /**
  10115. * Serializes the actions and its related information.
  10116. * @param parent defines the object to serialize in
  10117. * @returns the serialized object
  10118. */
  10119. serialize(parent: any): any;
  10120. }
  10121. }
  10122. declare module "babylonjs/Actions/actionManager" {
  10123. import { Nullable } from "babylonjs/types";
  10124. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10125. import { Scene } from "babylonjs/scene";
  10126. import { IAction } from "babylonjs/Actions/action";
  10127. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10128. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10129. /**
  10130. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10131. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10132. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10133. */
  10134. export class ActionManager extends AbstractActionManager {
  10135. /**
  10136. * Nothing
  10137. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10138. */
  10139. static readonly NothingTrigger: number;
  10140. /**
  10141. * On pick
  10142. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10143. */
  10144. static readonly OnPickTrigger: number;
  10145. /**
  10146. * On left pick
  10147. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10148. */
  10149. static readonly OnLeftPickTrigger: number;
  10150. /**
  10151. * On right pick
  10152. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10153. */
  10154. static readonly OnRightPickTrigger: number;
  10155. /**
  10156. * On center pick
  10157. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10158. */
  10159. static readonly OnCenterPickTrigger: number;
  10160. /**
  10161. * On pick down
  10162. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10163. */
  10164. static readonly OnPickDownTrigger: number;
  10165. /**
  10166. * On double pick
  10167. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10168. */
  10169. static readonly OnDoublePickTrigger: number;
  10170. /**
  10171. * On pick up
  10172. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10173. */
  10174. static readonly OnPickUpTrigger: number;
  10175. /**
  10176. * On pick out.
  10177. * This trigger will only be raised if you also declared a OnPickDown
  10178. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10179. */
  10180. static readonly OnPickOutTrigger: number;
  10181. /**
  10182. * On long press
  10183. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10184. */
  10185. static readonly OnLongPressTrigger: number;
  10186. /**
  10187. * On pointer over
  10188. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10189. */
  10190. static readonly OnPointerOverTrigger: number;
  10191. /**
  10192. * On pointer out
  10193. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10194. */
  10195. static readonly OnPointerOutTrigger: number;
  10196. /**
  10197. * On every frame
  10198. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10199. */
  10200. static readonly OnEveryFrameTrigger: number;
  10201. /**
  10202. * On intersection enter
  10203. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10204. */
  10205. static readonly OnIntersectionEnterTrigger: number;
  10206. /**
  10207. * On intersection exit
  10208. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10209. */
  10210. static readonly OnIntersectionExitTrigger: number;
  10211. /**
  10212. * On key down
  10213. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10214. */
  10215. static readonly OnKeyDownTrigger: number;
  10216. /**
  10217. * On key up
  10218. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10219. */
  10220. static readonly OnKeyUpTrigger: number;
  10221. private _scene;
  10222. /**
  10223. * Creates a new action manager
  10224. * @param scene defines the hosting scene
  10225. */
  10226. constructor(scene: Scene);
  10227. /**
  10228. * Releases all associated resources
  10229. */
  10230. dispose(): void;
  10231. /**
  10232. * Gets hosting scene
  10233. * @returns the hosting scene
  10234. */
  10235. getScene(): Scene;
  10236. /**
  10237. * Does this action manager handles actions of any of the given triggers
  10238. * @param triggers defines the triggers to be tested
  10239. * @return a boolean indicating whether one (or more) of the triggers is handled
  10240. */
  10241. hasSpecificTriggers(triggers: number[]): boolean;
  10242. /**
  10243. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10244. * speed.
  10245. * @param triggerA defines the trigger to be tested
  10246. * @param triggerB defines the trigger to be tested
  10247. * @return a boolean indicating whether one (or more) of the triggers is handled
  10248. */
  10249. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10250. /**
  10251. * Does this action manager handles actions of a given trigger
  10252. * @param trigger defines the trigger to be tested
  10253. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10254. * @return whether the trigger is handled
  10255. */
  10256. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10257. /**
  10258. * Does this action manager has pointer triggers
  10259. */
  10260. get hasPointerTriggers(): boolean;
  10261. /**
  10262. * Does this action manager has pick triggers
  10263. */
  10264. get hasPickTriggers(): boolean;
  10265. /**
  10266. * Registers an action to this action manager
  10267. * @param action defines the action to be registered
  10268. * @return the action amended (prepared) after registration
  10269. */
  10270. registerAction(action: IAction): Nullable<IAction>;
  10271. /**
  10272. * Unregisters an action to this action manager
  10273. * @param action defines the action to be unregistered
  10274. * @return a boolean indicating whether the action has been unregistered
  10275. */
  10276. unregisterAction(action: IAction): Boolean;
  10277. /**
  10278. * Process a specific trigger
  10279. * @param trigger defines the trigger to process
  10280. * @param evt defines the event details to be processed
  10281. */
  10282. processTrigger(trigger: number, evt?: IActionEvent): void;
  10283. /** @hidden */
  10284. _getEffectiveTarget(target: any, propertyPath: string): any;
  10285. /** @hidden */
  10286. _getProperty(propertyPath: string): string;
  10287. /**
  10288. * Serialize this manager to a JSON object
  10289. * @param name defines the property name to store this manager
  10290. * @returns a JSON representation of this manager
  10291. */
  10292. serialize(name: string): any;
  10293. /**
  10294. * Creates a new ActionManager from a JSON data
  10295. * @param parsedActions defines the JSON data to read from
  10296. * @param object defines the hosting mesh
  10297. * @param scene defines the hosting scene
  10298. */
  10299. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10300. /**
  10301. * Get a trigger name by index
  10302. * @param trigger defines the trigger index
  10303. * @returns a trigger name
  10304. */
  10305. static GetTriggerName(trigger: number): string;
  10306. }
  10307. }
  10308. declare module "babylonjs/Sprites/sprite" {
  10309. import { Vector3 } from "babylonjs/Maths/math.vector";
  10310. import { Nullable } from "babylonjs/types";
  10311. import { ActionManager } from "babylonjs/Actions/actionManager";
  10312. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10313. import { Color4 } from "babylonjs/Maths/math.color";
  10314. import { Observable } from "babylonjs/Misc/observable";
  10315. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10316. import { Animation } from "babylonjs/Animations/animation";
  10317. /**
  10318. * Class used to represent a sprite
  10319. * @see http://doc.babylonjs.com/babylon101/sprites
  10320. */
  10321. export class Sprite implements IAnimatable {
  10322. /** defines the name */
  10323. name: string;
  10324. /** Gets or sets the current world position */
  10325. position: Vector3;
  10326. /** Gets or sets the main color */
  10327. color: Color4;
  10328. /** Gets or sets the width */
  10329. width: number;
  10330. /** Gets or sets the height */
  10331. height: number;
  10332. /** Gets or sets rotation angle */
  10333. angle: number;
  10334. /** Gets or sets the cell index in the sprite sheet */
  10335. cellIndex: number;
  10336. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10337. cellRef: string;
  10338. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10339. invertU: boolean;
  10340. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10341. invertV: boolean;
  10342. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10343. disposeWhenFinishedAnimating: boolean;
  10344. /** Gets the list of attached animations */
  10345. animations: Nullable<Array<Animation>>;
  10346. /** Gets or sets a boolean indicating if the sprite can be picked */
  10347. isPickable: boolean;
  10348. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10349. useAlphaForPicking: boolean;
  10350. /** @hidden */
  10351. _xOffset: number;
  10352. /** @hidden */
  10353. _yOffset: number;
  10354. /** @hidden */
  10355. _xSize: number;
  10356. /** @hidden */
  10357. _ySize: number;
  10358. /**
  10359. * Gets or sets the associated action manager
  10360. */
  10361. actionManager: Nullable<ActionManager>;
  10362. /**
  10363. * An event triggered when the control has been disposed
  10364. */
  10365. onDisposeObservable: Observable<Sprite>;
  10366. private _animationStarted;
  10367. private _loopAnimation;
  10368. private _fromIndex;
  10369. private _toIndex;
  10370. private _delay;
  10371. private _direction;
  10372. private _manager;
  10373. private _time;
  10374. private _onAnimationEnd;
  10375. /**
  10376. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10377. */
  10378. isVisible: boolean;
  10379. /**
  10380. * Gets or sets the sprite size
  10381. */
  10382. get size(): number;
  10383. set size(value: number);
  10384. /**
  10385. * Returns a boolean indicating if the animation is started
  10386. */
  10387. get animationStarted(): boolean;
  10388. /**
  10389. * Gets or sets the unique id of the sprite
  10390. */
  10391. uniqueId: number;
  10392. /**
  10393. * Gets the manager of this sprite
  10394. */
  10395. get manager(): ISpriteManager;
  10396. /**
  10397. * Creates a new Sprite
  10398. * @param name defines the name
  10399. * @param manager defines the manager
  10400. */
  10401. constructor(
  10402. /** defines the name */
  10403. name: string, manager: ISpriteManager);
  10404. /**
  10405. * Returns the string "Sprite"
  10406. * @returns "Sprite"
  10407. */
  10408. getClassName(): string;
  10409. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10410. get fromIndex(): number;
  10411. set fromIndex(value: number);
  10412. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10413. get toIndex(): number;
  10414. set toIndex(value: number);
  10415. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10416. get loopAnimation(): boolean;
  10417. set loopAnimation(value: boolean);
  10418. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10419. get delay(): number;
  10420. set delay(value: number);
  10421. /**
  10422. * Starts an animation
  10423. * @param from defines the initial key
  10424. * @param to defines the end key
  10425. * @param loop defines if the animation must loop
  10426. * @param delay defines the start delay (in ms)
  10427. * @param onAnimationEnd defines a callback to call when animation ends
  10428. */
  10429. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10430. /** Stops current animation (if any) */
  10431. stopAnimation(): void;
  10432. /** @hidden */
  10433. _animate(deltaTime: number): void;
  10434. /** Release associated resources */
  10435. dispose(): void;
  10436. /**
  10437. * Serializes the sprite to a JSON object
  10438. * @returns the JSON object
  10439. */
  10440. serialize(): any;
  10441. /**
  10442. * Parses a JSON object to create a new sprite
  10443. * @param parsedSprite The JSON object to parse
  10444. * @param manager defines the hosting manager
  10445. * @returns the new sprite
  10446. */
  10447. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10448. }
  10449. }
  10450. declare module "babylonjs/Collisions/pickingInfo" {
  10451. import { Nullable } from "babylonjs/types";
  10452. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10453. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10454. import { Sprite } from "babylonjs/Sprites/sprite";
  10455. import { Ray } from "babylonjs/Culling/ray";
  10456. /**
  10457. * Information about the result of picking within a scene
  10458. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10459. */
  10460. export class PickingInfo {
  10461. /** @hidden */
  10462. _pickingUnavailable: boolean;
  10463. /**
  10464. * If the pick collided with an object
  10465. */
  10466. hit: boolean;
  10467. /**
  10468. * Distance away where the pick collided
  10469. */
  10470. distance: number;
  10471. /**
  10472. * The location of pick collision
  10473. */
  10474. pickedPoint: Nullable<Vector3>;
  10475. /**
  10476. * The mesh corresponding the the pick collision
  10477. */
  10478. pickedMesh: Nullable<AbstractMesh>;
  10479. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10480. bu: number;
  10481. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10482. bv: number;
  10483. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10484. faceId: number;
  10485. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10486. subMeshFaceId: number;
  10487. /** Id of the the submesh that was picked */
  10488. subMeshId: number;
  10489. /** If a sprite was picked, this will be the sprite the pick collided with */
  10490. pickedSprite: Nullable<Sprite>;
  10491. /**
  10492. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10493. */
  10494. originMesh: Nullable<AbstractMesh>;
  10495. /**
  10496. * The ray that was used to perform the picking.
  10497. */
  10498. ray: Nullable<Ray>;
  10499. /**
  10500. * Gets the normal correspodning to the face the pick collided with
  10501. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10502. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10503. * @returns The normal correspodning to the face the pick collided with
  10504. */
  10505. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10506. /**
  10507. * Gets the texture coordinates of where the pick occured
  10508. * @returns the vector containing the coordnates of the texture
  10509. */
  10510. getTextureCoordinates(): Nullable<Vector2>;
  10511. }
  10512. }
  10513. declare module "babylonjs/Culling/ray" {
  10514. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10515. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10516. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10517. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10518. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10519. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10520. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10521. import { Plane } from "babylonjs/Maths/math.plane";
  10522. /**
  10523. * Class representing a ray with position and direction
  10524. */
  10525. export class Ray {
  10526. /** origin point */
  10527. origin: Vector3;
  10528. /** direction */
  10529. direction: Vector3;
  10530. /** length of the ray */
  10531. length: number;
  10532. private static readonly TmpVector3;
  10533. private _tmpRay;
  10534. /**
  10535. * Creates a new ray
  10536. * @param origin origin point
  10537. * @param direction direction
  10538. * @param length length of the ray
  10539. */
  10540. constructor(
  10541. /** origin point */
  10542. origin: Vector3,
  10543. /** direction */
  10544. direction: Vector3,
  10545. /** length of the ray */
  10546. length?: number);
  10547. /**
  10548. * Checks if the ray intersects a box
  10549. * This does not account for the ray lenght by design to improve perfs.
  10550. * @param minimum bound of the box
  10551. * @param maximum bound of the box
  10552. * @param intersectionTreshold extra extend to be added to the box in all direction
  10553. * @returns if the box was hit
  10554. */
  10555. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10556. /**
  10557. * Checks if the ray intersects a box
  10558. * This does not account for the ray lenght by design to improve perfs.
  10559. * @param box the bounding box to check
  10560. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10561. * @returns if the box was hit
  10562. */
  10563. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10564. /**
  10565. * If the ray hits a sphere
  10566. * @param sphere the bounding sphere to check
  10567. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10568. * @returns true if it hits the sphere
  10569. */
  10570. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10571. /**
  10572. * If the ray hits a triange
  10573. * @param vertex0 triangle vertex
  10574. * @param vertex1 triangle vertex
  10575. * @param vertex2 triangle vertex
  10576. * @returns intersection information if hit
  10577. */
  10578. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10579. /**
  10580. * Checks if ray intersects a plane
  10581. * @param plane the plane to check
  10582. * @returns the distance away it was hit
  10583. */
  10584. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10585. /**
  10586. * Calculate the intercept of a ray on a given axis
  10587. * @param axis to check 'x' | 'y' | 'z'
  10588. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10589. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10590. */
  10591. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10592. /**
  10593. * Checks if ray intersects a mesh
  10594. * @param mesh the mesh to check
  10595. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10596. * @returns picking info of the intersecton
  10597. */
  10598. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10599. /**
  10600. * Checks if ray intersects a mesh
  10601. * @param meshes the meshes to check
  10602. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10603. * @param results array to store result in
  10604. * @returns Array of picking infos
  10605. */
  10606. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10607. private _comparePickingInfo;
  10608. private static smallnum;
  10609. private static rayl;
  10610. /**
  10611. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10612. * @param sega the first point of the segment to test the intersection against
  10613. * @param segb the second point of the segment to test the intersection against
  10614. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10615. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10616. */
  10617. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10618. /**
  10619. * Update the ray from viewport position
  10620. * @param x position
  10621. * @param y y position
  10622. * @param viewportWidth viewport width
  10623. * @param viewportHeight viewport height
  10624. * @param world world matrix
  10625. * @param view view matrix
  10626. * @param projection projection matrix
  10627. * @returns this ray updated
  10628. */
  10629. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10630. /**
  10631. * Creates a ray with origin and direction of 0,0,0
  10632. * @returns the new ray
  10633. */
  10634. static Zero(): Ray;
  10635. /**
  10636. * Creates a new ray from screen space and viewport
  10637. * @param x position
  10638. * @param y y position
  10639. * @param viewportWidth viewport width
  10640. * @param viewportHeight viewport height
  10641. * @param world world matrix
  10642. * @param view view matrix
  10643. * @param projection projection matrix
  10644. * @returns new ray
  10645. */
  10646. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10647. /**
  10648. * 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
  10649. * transformed to the given world matrix.
  10650. * @param origin The origin point
  10651. * @param end The end point
  10652. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10653. * @returns the new ray
  10654. */
  10655. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10656. /**
  10657. * Transforms a ray by a matrix
  10658. * @param ray ray to transform
  10659. * @param matrix matrix to apply
  10660. * @returns the resulting new ray
  10661. */
  10662. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10663. /**
  10664. * Transforms a ray by a matrix
  10665. * @param ray ray to transform
  10666. * @param matrix matrix to apply
  10667. * @param result ray to store result in
  10668. */
  10669. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10670. /**
  10671. * Unproject a ray from screen space to object space
  10672. * @param sourceX defines the screen space x coordinate to use
  10673. * @param sourceY defines the screen space y coordinate to use
  10674. * @param viewportWidth defines the current width of the viewport
  10675. * @param viewportHeight defines the current height of the viewport
  10676. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10677. * @param view defines the view matrix to use
  10678. * @param projection defines the projection matrix to use
  10679. */
  10680. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10681. }
  10682. /**
  10683. * Type used to define predicate used to select faces when a mesh intersection is detected
  10684. */
  10685. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10686. module "babylonjs/scene" {
  10687. interface Scene {
  10688. /** @hidden */
  10689. _tempPickingRay: Nullable<Ray>;
  10690. /** @hidden */
  10691. _cachedRayForTransform: Ray;
  10692. /** @hidden */
  10693. _pickWithRayInverseMatrix: Matrix;
  10694. /** @hidden */
  10695. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10696. /** @hidden */
  10697. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10698. }
  10699. }
  10700. }
  10701. declare module "babylonjs/sceneComponent" {
  10702. import { Scene } from "babylonjs/scene";
  10703. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10704. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10705. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10706. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10707. import { Nullable } from "babylonjs/types";
  10708. import { Camera } from "babylonjs/Cameras/camera";
  10709. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10710. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10711. import { AbstractScene } from "babylonjs/abstractScene";
  10712. import { Mesh } from "babylonjs/Meshes/mesh";
  10713. /**
  10714. * Groups all the scene component constants in one place to ease maintenance.
  10715. * @hidden
  10716. */
  10717. export class SceneComponentConstants {
  10718. static readonly NAME_EFFECTLAYER: string;
  10719. static readonly NAME_LAYER: string;
  10720. static readonly NAME_LENSFLARESYSTEM: string;
  10721. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10722. static readonly NAME_PARTICLESYSTEM: string;
  10723. static readonly NAME_GAMEPAD: string;
  10724. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10725. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10726. static readonly NAME_DEPTHRENDERER: string;
  10727. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10728. static readonly NAME_SPRITE: string;
  10729. static readonly NAME_OUTLINERENDERER: string;
  10730. static readonly NAME_PROCEDURALTEXTURE: string;
  10731. static readonly NAME_SHADOWGENERATOR: string;
  10732. static readonly NAME_OCTREE: string;
  10733. static readonly NAME_PHYSICSENGINE: string;
  10734. static readonly NAME_AUDIO: string;
  10735. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10736. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10737. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10738. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10739. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10740. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10741. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10742. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10743. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10744. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10745. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10746. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10747. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10748. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10749. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10750. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10751. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10752. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10753. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10754. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10755. static readonly STEP_AFTERRENDER_AUDIO: number;
  10756. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10757. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10758. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10759. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10760. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10761. static readonly STEP_POINTERMOVE_SPRITE: number;
  10762. static readonly STEP_POINTERDOWN_SPRITE: number;
  10763. static readonly STEP_POINTERUP_SPRITE: number;
  10764. }
  10765. /**
  10766. * This represents a scene component.
  10767. *
  10768. * This is used to decouple the dependency the scene is having on the different workloads like
  10769. * layers, post processes...
  10770. */
  10771. export interface ISceneComponent {
  10772. /**
  10773. * The name of the component. Each component must have a unique name.
  10774. */
  10775. name: string;
  10776. /**
  10777. * The scene the component belongs to.
  10778. */
  10779. scene: Scene;
  10780. /**
  10781. * Register the component to one instance of a scene.
  10782. */
  10783. register(): void;
  10784. /**
  10785. * Rebuilds the elements related to this component in case of
  10786. * context lost for instance.
  10787. */
  10788. rebuild(): void;
  10789. /**
  10790. * Disposes the component and the associated ressources.
  10791. */
  10792. dispose(): void;
  10793. }
  10794. /**
  10795. * This represents a SERIALIZABLE scene component.
  10796. *
  10797. * This extends Scene Component to add Serialization methods on top.
  10798. */
  10799. export interface ISceneSerializableComponent extends ISceneComponent {
  10800. /**
  10801. * Adds all the elements from the container to the scene
  10802. * @param container the container holding the elements
  10803. */
  10804. addFromContainer(container: AbstractScene): void;
  10805. /**
  10806. * Removes all the elements in the container from the scene
  10807. * @param container contains the elements to remove
  10808. * @param dispose if the removed element should be disposed (default: false)
  10809. */
  10810. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10811. /**
  10812. * Serializes the component data to the specified json object
  10813. * @param serializationObject The object to serialize to
  10814. */
  10815. serialize(serializationObject: any): void;
  10816. }
  10817. /**
  10818. * Strong typing of a Mesh related stage step action
  10819. */
  10820. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10821. /**
  10822. * Strong typing of a Evaluate Sub Mesh related stage step action
  10823. */
  10824. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10825. /**
  10826. * Strong typing of a Active Mesh related stage step action
  10827. */
  10828. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10829. /**
  10830. * Strong typing of a Camera related stage step action
  10831. */
  10832. export type CameraStageAction = (camera: Camera) => void;
  10833. /**
  10834. * Strong typing of a Camera Frame buffer related stage step action
  10835. */
  10836. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10837. /**
  10838. * Strong typing of a Render Target related stage step action
  10839. */
  10840. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10841. /**
  10842. * Strong typing of a RenderingGroup related stage step action
  10843. */
  10844. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10845. /**
  10846. * Strong typing of a Mesh Render related stage step action
  10847. */
  10848. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10849. /**
  10850. * Strong typing of a simple stage step action
  10851. */
  10852. export type SimpleStageAction = () => void;
  10853. /**
  10854. * Strong typing of a render target action.
  10855. */
  10856. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10857. /**
  10858. * Strong typing of a pointer move action.
  10859. */
  10860. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10861. /**
  10862. * Strong typing of a pointer up/down action.
  10863. */
  10864. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10865. /**
  10866. * Representation of a stage in the scene (Basically a list of ordered steps)
  10867. * @hidden
  10868. */
  10869. export class Stage<T extends Function> extends Array<{
  10870. index: number;
  10871. component: ISceneComponent;
  10872. action: T;
  10873. }> {
  10874. /**
  10875. * Hide ctor from the rest of the world.
  10876. * @param items The items to add.
  10877. */
  10878. private constructor();
  10879. /**
  10880. * Creates a new Stage.
  10881. * @returns A new instance of a Stage
  10882. */
  10883. static Create<T extends Function>(): Stage<T>;
  10884. /**
  10885. * Registers a step in an ordered way in the targeted stage.
  10886. * @param index Defines the position to register the step in
  10887. * @param component Defines the component attached to the step
  10888. * @param action Defines the action to launch during the step
  10889. */
  10890. registerStep(index: number, component: ISceneComponent, action: T): void;
  10891. /**
  10892. * Clears all the steps from the stage.
  10893. */
  10894. clear(): void;
  10895. }
  10896. }
  10897. declare module "babylonjs/Sprites/spriteSceneComponent" {
  10898. import { Nullable } from "babylonjs/types";
  10899. import { Observable } from "babylonjs/Misc/observable";
  10900. import { Scene } from "babylonjs/scene";
  10901. import { Sprite } from "babylonjs/Sprites/sprite";
  10902. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  10903. import { Ray } from "babylonjs/Culling/ray";
  10904. import { Camera } from "babylonjs/Cameras/camera";
  10905. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10906. import { ISceneComponent } from "babylonjs/sceneComponent";
  10907. module "babylonjs/scene" {
  10908. interface Scene {
  10909. /** @hidden */
  10910. _pointerOverSprite: Nullable<Sprite>;
  10911. /** @hidden */
  10912. _pickedDownSprite: Nullable<Sprite>;
  10913. /** @hidden */
  10914. _tempSpritePickingRay: Nullable<Ray>;
  10915. /**
  10916. * All of the sprite managers added to this scene
  10917. * @see http://doc.babylonjs.com/babylon101/sprites
  10918. */
  10919. spriteManagers: Array<ISpriteManager>;
  10920. /**
  10921. * An event triggered when sprites rendering is about to start
  10922. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  10923. */
  10924. onBeforeSpritesRenderingObservable: Observable<Scene>;
  10925. /**
  10926. * An event triggered when sprites rendering is done
  10927. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  10928. */
  10929. onAfterSpritesRenderingObservable: Observable<Scene>;
  10930. /** @hidden */
  10931. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  10932. /** Launch a ray to try to pick a sprite in the scene
  10933. * @param x position on screen
  10934. * @param y position on screen
  10935. * @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
  10936. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10937. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  10938. * @returns a PickingInfo
  10939. */
  10940. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  10941. /** Use the given ray to pick a sprite in the scene
  10942. * @param ray The ray (in world space) to use to pick meshes
  10943. * @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
  10944. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10945. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  10946. * @returns a PickingInfo
  10947. */
  10948. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  10949. /** @hidden */
  10950. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  10951. /** Launch a ray to try to pick sprites in the scene
  10952. * @param x position on screen
  10953. * @param y position on screen
  10954. * @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
  10955. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  10956. * @returns a PickingInfo array
  10957. */
  10958. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  10959. /** Use the given ray to pick sprites in the scene
  10960. * @param ray The ray (in world space) to use to pick meshes
  10961. * @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
  10962. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  10963. * @returns a PickingInfo array
  10964. */
  10965. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  10966. /**
  10967. * Force the sprite under the pointer
  10968. * @param sprite defines the sprite to use
  10969. */
  10970. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  10971. /**
  10972. * Gets the sprite under the pointer
  10973. * @returns a Sprite or null if no sprite is under the pointer
  10974. */
  10975. getPointerOverSprite(): Nullable<Sprite>;
  10976. }
  10977. }
  10978. /**
  10979. * Defines the sprite scene component responsible to manage sprites
  10980. * in a given scene.
  10981. */
  10982. export class SpriteSceneComponent implements ISceneComponent {
  10983. /**
  10984. * The component name helpfull to identify the component in the list of scene components.
  10985. */
  10986. readonly name: string;
  10987. /**
  10988. * The scene the component belongs to.
  10989. */
  10990. scene: Scene;
  10991. /** @hidden */
  10992. private _spritePredicate;
  10993. /**
  10994. * Creates a new instance of the component for the given scene
  10995. * @param scene Defines the scene to register the component in
  10996. */
  10997. constructor(scene: Scene);
  10998. /**
  10999. * Registers the component in a given scene
  11000. */
  11001. register(): void;
  11002. /**
  11003. * Rebuilds the elements related to this component in case of
  11004. * context lost for instance.
  11005. */
  11006. rebuild(): void;
  11007. /**
  11008. * Disposes the component and the associated ressources.
  11009. */
  11010. dispose(): void;
  11011. private _pickSpriteButKeepRay;
  11012. private _pointerMove;
  11013. private _pointerDown;
  11014. private _pointerUp;
  11015. }
  11016. }
  11017. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11018. /** @hidden */
  11019. export var fogFragmentDeclaration: {
  11020. name: string;
  11021. shader: string;
  11022. };
  11023. }
  11024. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11025. /** @hidden */
  11026. export var fogFragment: {
  11027. name: string;
  11028. shader: string;
  11029. };
  11030. }
  11031. declare module "babylonjs/Shaders/sprites.fragment" {
  11032. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11033. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11034. /** @hidden */
  11035. export var spritesPixelShader: {
  11036. name: string;
  11037. shader: string;
  11038. };
  11039. }
  11040. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11041. /** @hidden */
  11042. export var fogVertexDeclaration: {
  11043. name: string;
  11044. shader: string;
  11045. };
  11046. }
  11047. declare module "babylonjs/Shaders/sprites.vertex" {
  11048. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11049. /** @hidden */
  11050. export var spritesVertexShader: {
  11051. name: string;
  11052. shader: string;
  11053. };
  11054. }
  11055. declare module "babylonjs/Sprites/spriteManager" {
  11056. import { IDisposable, Scene } from "babylonjs/scene";
  11057. import { Nullable } from "babylonjs/types";
  11058. import { Observable } from "babylonjs/Misc/observable";
  11059. import { Sprite } from "babylonjs/Sprites/sprite";
  11060. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11061. import { Camera } from "babylonjs/Cameras/camera";
  11062. import { Texture } from "babylonjs/Materials/Textures/texture";
  11063. import "babylonjs/Shaders/sprites.fragment";
  11064. import "babylonjs/Shaders/sprites.vertex";
  11065. import { Ray } from "babylonjs/Culling/ray";
  11066. /**
  11067. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11068. */
  11069. export interface ISpriteManager extends IDisposable {
  11070. /**
  11071. * Gets manager's name
  11072. */
  11073. name: string;
  11074. /**
  11075. * Restricts the camera to viewing objects with the same layerMask.
  11076. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11077. */
  11078. layerMask: number;
  11079. /**
  11080. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11081. */
  11082. isPickable: boolean;
  11083. /**
  11084. * Gets the hosting scene
  11085. */
  11086. scene: Scene;
  11087. /**
  11088. * Specifies the rendering group id for this mesh (0 by default)
  11089. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11090. */
  11091. renderingGroupId: number;
  11092. /**
  11093. * Defines the list of sprites managed by the manager.
  11094. */
  11095. sprites: Array<Sprite>;
  11096. /**
  11097. * Gets or sets the spritesheet texture
  11098. */
  11099. texture: Texture;
  11100. /** Defines the default width of a cell in the spritesheet */
  11101. cellWidth: number;
  11102. /** Defines the default height of a cell in the spritesheet */
  11103. cellHeight: number;
  11104. /**
  11105. * Tests the intersection of a sprite with a specific ray.
  11106. * @param ray The ray we are sending to test the collision
  11107. * @param camera The camera space we are sending rays in
  11108. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11109. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11110. * @returns picking info or null.
  11111. */
  11112. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11113. /**
  11114. * Intersects the sprites with a ray
  11115. * @param ray defines the ray to intersect with
  11116. * @param camera defines the current active camera
  11117. * @param predicate defines a predicate used to select candidate sprites
  11118. * @returns null if no hit or a PickingInfo array
  11119. */
  11120. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11121. /**
  11122. * Renders the list of sprites on screen.
  11123. */
  11124. render(): void;
  11125. }
  11126. /**
  11127. * Class used to manage multiple sprites on the same spritesheet
  11128. * @see http://doc.babylonjs.com/babylon101/sprites
  11129. */
  11130. export class SpriteManager implements ISpriteManager {
  11131. /** defines the manager's name */
  11132. name: string;
  11133. /** Define the Url to load snippets */
  11134. static SnippetUrl: string;
  11135. /** Snippet ID if the manager was created from the snippet server */
  11136. snippetId: string;
  11137. /** Gets the list of sprites */
  11138. sprites: Sprite[];
  11139. /** Gets or sets the rendering group id (0 by default) */
  11140. renderingGroupId: number;
  11141. /** Gets or sets camera layer mask */
  11142. layerMask: number;
  11143. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11144. fogEnabled: boolean;
  11145. /** Gets or sets a boolean indicating if the sprites are pickable */
  11146. isPickable: boolean;
  11147. /** Defines the default width of a cell in the spritesheet */
  11148. cellWidth: number;
  11149. /** Defines the default height of a cell in the spritesheet */
  11150. cellHeight: number;
  11151. /** Associative array from JSON sprite data file */
  11152. private _cellData;
  11153. /** Array of sprite names from JSON sprite data file */
  11154. private _spriteMap;
  11155. /** True when packed cell data from JSON file is ready*/
  11156. private _packedAndReady;
  11157. private _textureContent;
  11158. /**
  11159. * An event triggered when the manager is disposed.
  11160. */
  11161. onDisposeObservable: Observable<SpriteManager>;
  11162. private _onDisposeObserver;
  11163. /**
  11164. * Callback called when the manager is disposed
  11165. */
  11166. set onDispose(callback: () => void);
  11167. private _capacity;
  11168. private _fromPacked;
  11169. private _spriteTexture;
  11170. private _epsilon;
  11171. private _scene;
  11172. private _vertexData;
  11173. private _buffer;
  11174. private _vertexBuffers;
  11175. private _indexBuffer;
  11176. private _effectBase;
  11177. private _effectFog;
  11178. /**
  11179. * Gets or sets the unique id of the sprite
  11180. */
  11181. uniqueId: number;
  11182. /**
  11183. * Gets the array of sprites
  11184. */
  11185. get children(): Sprite[];
  11186. /**
  11187. * Gets the hosting scene
  11188. */
  11189. get scene(): Scene;
  11190. /**
  11191. * Gets the capacity of the manager
  11192. */
  11193. get capacity(): number;
  11194. /**
  11195. * Gets or sets the spritesheet texture
  11196. */
  11197. get texture(): Texture;
  11198. set texture(value: Texture);
  11199. private _blendMode;
  11200. /**
  11201. * Blend mode use to render the particle, it can be any of
  11202. * the static Constants.ALPHA_x properties provided in this class.
  11203. * Default value is Constants.ALPHA_COMBINE
  11204. */
  11205. get blendMode(): number;
  11206. set blendMode(blendMode: number);
  11207. /** Disables writing to the depth buffer when rendering the sprites.
  11208. * It can be handy to disable depth writing when using textures without alpha channel
  11209. * and setting some specific blend modes.
  11210. */
  11211. disableDepthWrite: boolean;
  11212. /**
  11213. * Creates a new sprite manager
  11214. * @param name defines the manager's name
  11215. * @param imgUrl defines the sprite sheet url
  11216. * @param capacity defines the maximum allowed number of sprites
  11217. * @param cellSize defines the size of a sprite cell
  11218. * @param scene defines the hosting scene
  11219. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11220. * @param samplingMode defines the smapling mode to use with spritesheet
  11221. * @param fromPacked set to false; do not alter
  11222. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11223. */
  11224. constructor(
  11225. /** defines the manager's name */
  11226. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11227. /**
  11228. * Returns the string "SpriteManager"
  11229. * @returns "SpriteManager"
  11230. */
  11231. getClassName(): string;
  11232. private _makePacked;
  11233. private _appendSpriteVertex;
  11234. private _checkTextureAlpha;
  11235. /**
  11236. * Intersects the sprites with a ray
  11237. * @param ray defines the ray to intersect with
  11238. * @param camera defines the current active camera
  11239. * @param predicate defines a predicate used to select candidate sprites
  11240. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11241. * @returns null if no hit or a PickingInfo
  11242. */
  11243. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11244. /**
  11245. * Intersects the sprites with a ray
  11246. * @param ray defines the ray to intersect with
  11247. * @param camera defines the current active camera
  11248. * @param predicate defines a predicate used to select candidate sprites
  11249. * @returns null if no hit or a PickingInfo array
  11250. */
  11251. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11252. /**
  11253. * Render all child sprites
  11254. */
  11255. render(): void;
  11256. /**
  11257. * Release associated resources
  11258. */
  11259. dispose(): void;
  11260. /**
  11261. * Serializes the sprite manager to a JSON object
  11262. * @param serializeTexture defines if the texture must be serialized as well
  11263. * @returns the JSON object
  11264. */
  11265. serialize(serializeTexture?: boolean): any;
  11266. /**
  11267. * Parses a JSON object to create a new sprite manager.
  11268. * @param parsedManager The JSON object to parse
  11269. * @param scene The scene to create the sprite managerin
  11270. * @param rootUrl The root url to use to load external dependencies like texture
  11271. * @returns the new sprite manager
  11272. */
  11273. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11274. /**
  11275. * Creates a sprite manager from a snippet saved in a remote file
  11276. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11277. * @param url defines the url to load from
  11278. * @param scene defines the hosting scene
  11279. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11280. * @returns a promise that will resolve to the new sprite manager
  11281. */
  11282. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11283. /**
  11284. * Creates a sprite manager from a snippet saved by the sprite editor
  11285. * @param snippetId defines the snippet to load
  11286. * @param scene defines the hosting scene
  11287. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11288. * @returns a promise that will resolve to the new sprite manager
  11289. */
  11290. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11291. }
  11292. }
  11293. declare module "babylonjs/Misc/gradients" {
  11294. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11295. /** Interface used by value gradients (color, factor, ...) */
  11296. export interface IValueGradient {
  11297. /**
  11298. * Gets or sets the gradient value (between 0 and 1)
  11299. */
  11300. gradient: number;
  11301. }
  11302. /** Class used to store color4 gradient */
  11303. export class ColorGradient implements IValueGradient {
  11304. /**
  11305. * Gets or sets the gradient value (between 0 and 1)
  11306. */
  11307. gradient: number;
  11308. /**
  11309. * Gets or sets first associated color
  11310. */
  11311. color1: Color4;
  11312. /**
  11313. * Gets or sets second associated color
  11314. */
  11315. color2?: Color4 | undefined;
  11316. /**
  11317. * Creates a new color4 gradient
  11318. * @param gradient gets or sets the gradient value (between 0 and 1)
  11319. * @param color1 gets or sets first associated color
  11320. * @param color2 gets or sets first second color
  11321. */
  11322. constructor(
  11323. /**
  11324. * Gets or sets the gradient value (between 0 and 1)
  11325. */
  11326. gradient: number,
  11327. /**
  11328. * Gets or sets first associated color
  11329. */
  11330. color1: Color4,
  11331. /**
  11332. * Gets or sets second associated color
  11333. */
  11334. color2?: Color4 | undefined);
  11335. /**
  11336. * Will get a color picked randomly between color1 and color2.
  11337. * If color2 is undefined then color1 will be used
  11338. * @param result defines the target Color4 to store the result in
  11339. */
  11340. getColorToRef(result: Color4): void;
  11341. }
  11342. /** Class used to store color 3 gradient */
  11343. export class Color3Gradient implements IValueGradient {
  11344. /**
  11345. * Gets or sets the gradient value (between 0 and 1)
  11346. */
  11347. gradient: number;
  11348. /**
  11349. * Gets or sets the associated color
  11350. */
  11351. color: Color3;
  11352. /**
  11353. * Creates a new color3 gradient
  11354. * @param gradient gets or sets the gradient value (between 0 and 1)
  11355. * @param color gets or sets associated color
  11356. */
  11357. constructor(
  11358. /**
  11359. * Gets or sets the gradient value (between 0 and 1)
  11360. */
  11361. gradient: number,
  11362. /**
  11363. * Gets or sets the associated color
  11364. */
  11365. color: Color3);
  11366. }
  11367. /** Class used to store factor gradient */
  11368. export class FactorGradient implements IValueGradient {
  11369. /**
  11370. * Gets or sets the gradient value (between 0 and 1)
  11371. */
  11372. gradient: number;
  11373. /**
  11374. * Gets or sets first associated factor
  11375. */
  11376. factor1: number;
  11377. /**
  11378. * Gets or sets second associated factor
  11379. */
  11380. factor2?: number | undefined;
  11381. /**
  11382. * Creates a new factor gradient
  11383. * @param gradient gets or sets the gradient value (between 0 and 1)
  11384. * @param factor1 gets or sets first associated factor
  11385. * @param factor2 gets or sets second associated factor
  11386. */
  11387. constructor(
  11388. /**
  11389. * Gets or sets the gradient value (between 0 and 1)
  11390. */
  11391. gradient: number,
  11392. /**
  11393. * Gets or sets first associated factor
  11394. */
  11395. factor1: number,
  11396. /**
  11397. * Gets or sets second associated factor
  11398. */
  11399. factor2?: number | undefined);
  11400. /**
  11401. * Will get a number picked randomly between factor1 and factor2.
  11402. * If factor2 is undefined then factor1 will be used
  11403. * @returns the picked number
  11404. */
  11405. getFactor(): number;
  11406. }
  11407. /**
  11408. * Helper used to simplify some generic gradient tasks
  11409. */
  11410. export class GradientHelper {
  11411. /**
  11412. * Gets the current gradient from an array of IValueGradient
  11413. * @param ratio defines the current ratio to get
  11414. * @param gradients defines the array of IValueGradient
  11415. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11416. */
  11417. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11418. }
  11419. }
  11420. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11421. import { Nullable } from "babylonjs/types";
  11422. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11423. import { Scene } from "babylonjs/scene";
  11424. module "babylonjs/Engines/thinEngine" {
  11425. interface ThinEngine {
  11426. /**
  11427. * Creates a raw texture
  11428. * @param data defines the data to store in the texture
  11429. * @param width defines the width of the texture
  11430. * @param height defines the height of the texture
  11431. * @param format defines the format of the data
  11432. * @param generateMipMaps defines if the engine should generate the mip levels
  11433. * @param invertY defines if data must be stored with Y axis inverted
  11434. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11435. * @param compression defines the compression used (null by default)
  11436. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11437. * @returns the raw texture inside an InternalTexture
  11438. */
  11439. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11440. /**
  11441. * Update a raw texture
  11442. * @param texture defines the texture to update
  11443. * @param data defines the data to store in the texture
  11444. * @param format defines the format of the data
  11445. * @param invertY defines if data must be stored with Y axis inverted
  11446. */
  11447. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11448. /**
  11449. * Update a raw texture
  11450. * @param texture defines the texture to update
  11451. * @param data defines the data to store in the texture
  11452. * @param format defines the format of the data
  11453. * @param invertY defines if data must be stored with Y axis inverted
  11454. * @param compression defines the compression used (null by default)
  11455. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11456. */
  11457. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11458. /**
  11459. * Creates a new raw cube texture
  11460. * @param data defines the array of data to use to create each face
  11461. * @param size defines the size of the textures
  11462. * @param format defines the format of the data
  11463. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11464. * @param generateMipMaps defines if the engine should generate the mip levels
  11465. * @param invertY defines if data must be stored with Y axis inverted
  11466. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11467. * @param compression defines the compression used (null by default)
  11468. * @returns the cube texture as an InternalTexture
  11469. */
  11470. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11471. /**
  11472. * Update a raw cube texture
  11473. * @param texture defines the texture to udpdate
  11474. * @param data defines the data to store
  11475. * @param format defines the data format
  11476. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11477. * @param invertY defines if data must be stored with Y axis inverted
  11478. */
  11479. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11480. /**
  11481. * Update a raw cube texture
  11482. * @param texture defines the texture to udpdate
  11483. * @param data defines the data to store
  11484. * @param format defines the data format
  11485. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11486. * @param invertY defines if data must be stored with Y axis inverted
  11487. * @param compression defines the compression used (null by default)
  11488. */
  11489. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11490. /**
  11491. * Update a raw cube texture
  11492. * @param texture defines the texture to udpdate
  11493. * @param data defines the data to store
  11494. * @param format defines the data format
  11495. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11496. * @param invertY defines if data must be stored with Y axis inverted
  11497. * @param compression defines the compression used (null by default)
  11498. * @param level defines which level of the texture to update
  11499. */
  11500. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11501. /**
  11502. * Creates a new raw cube texture from a specified url
  11503. * @param url defines the url where the data is located
  11504. * @param scene defines the current scene
  11505. * @param size defines the size of the textures
  11506. * @param format defines the format of the data
  11507. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11508. * @param noMipmap defines if the engine should avoid generating the mip levels
  11509. * @param callback defines a callback used to extract texture data from loaded data
  11510. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11511. * @param onLoad defines a callback called when texture is loaded
  11512. * @param onError defines a callback called if there is an error
  11513. * @returns the cube texture as an InternalTexture
  11514. */
  11515. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  11516. /**
  11517. * Creates a new raw cube texture from a specified url
  11518. * @param url defines the url where the data is located
  11519. * @param scene defines the current scene
  11520. * @param size defines the size of the textures
  11521. * @param format defines the format of the data
  11522. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11523. * @param noMipmap defines if the engine should avoid generating the mip levels
  11524. * @param callback defines a callback used to extract texture data from loaded data
  11525. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11526. * @param onLoad defines a callback called when texture is loaded
  11527. * @param onError defines a callback called if there is an error
  11528. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11529. * @param invertY defines if data must be stored with Y axis inverted
  11530. * @returns the cube texture as an InternalTexture
  11531. */
  11532. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  11533. /**
  11534. * Creates a new raw 3D texture
  11535. * @param data defines the data used to create the texture
  11536. * @param width defines the width of the texture
  11537. * @param height defines the height of the texture
  11538. * @param depth defines the depth of the texture
  11539. * @param format defines the format of the texture
  11540. * @param generateMipMaps defines if the engine must generate mip levels
  11541. * @param invertY defines if data must be stored with Y axis inverted
  11542. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11543. * @param compression defines the compressed used (can be null)
  11544. * @param textureType defines the compressed used (can be null)
  11545. * @returns a new raw 3D texture (stored in an InternalTexture)
  11546. */
  11547. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11548. /**
  11549. * Update a raw 3D texture
  11550. * @param texture defines the texture to update
  11551. * @param data defines the data to store
  11552. * @param format defines the data format
  11553. * @param invertY defines if data must be stored with Y axis inverted
  11554. */
  11555. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11556. /**
  11557. * Update a raw 3D texture
  11558. * @param texture defines the texture to update
  11559. * @param data defines the data to store
  11560. * @param format defines the data format
  11561. * @param invertY defines if data must be stored with Y axis inverted
  11562. * @param compression defines the used compression (can be null)
  11563. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11564. */
  11565. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11566. /**
  11567. * Creates a new raw 2D array texture
  11568. * @param data defines the data used to create the texture
  11569. * @param width defines the width of the texture
  11570. * @param height defines the height of the texture
  11571. * @param depth defines the number of layers of the texture
  11572. * @param format defines the format of the texture
  11573. * @param generateMipMaps defines if the engine must generate mip levels
  11574. * @param invertY defines if data must be stored with Y axis inverted
  11575. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11576. * @param compression defines the compressed used (can be null)
  11577. * @param textureType defines the compressed used (can be null)
  11578. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11579. */
  11580. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11581. /**
  11582. * Update a raw 2D array texture
  11583. * @param texture defines the texture to update
  11584. * @param data defines the data to store
  11585. * @param format defines the data format
  11586. * @param invertY defines if data must be stored with Y axis inverted
  11587. */
  11588. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11589. /**
  11590. * Update a raw 2D array texture
  11591. * @param texture defines the texture to update
  11592. * @param data defines the data to store
  11593. * @param format defines the data format
  11594. * @param invertY defines if data must be stored with Y axis inverted
  11595. * @param compression defines the used compression (can be null)
  11596. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11597. */
  11598. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11599. }
  11600. }
  11601. }
  11602. declare module "babylonjs/Materials/Textures/rawTexture" {
  11603. import { Scene } from "babylonjs/scene";
  11604. import { Texture } from "babylonjs/Materials/Textures/texture";
  11605. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11606. /**
  11607. * Raw texture can help creating a texture directly from an array of data.
  11608. * This can be super useful if you either get the data from an uncompressed source or
  11609. * if you wish to create your texture pixel by pixel.
  11610. */
  11611. export class RawTexture extends Texture {
  11612. /**
  11613. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11614. */
  11615. format: number;
  11616. /**
  11617. * Instantiates a new RawTexture.
  11618. * Raw texture can help creating a texture directly from an array of data.
  11619. * This can be super useful if you either get the data from an uncompressed source or
  11620. * if you wish to create your texture pixel by pixel.
  11621. * @param data define the array of data to use to create the texture
  11622. * @param width define the width of the texture
  11623. * @param height define the height of the texture
  11624. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11625. * @param scene define the scene the texture belongs to
  11626. * @param generateMipMaps define whether mip maps should be generated or not
  11627. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11628. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11629. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11630. */
  11631. constructor(data: ArrayBufferView, width: number, height: number,
  11632. /**
  11633. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11634. */
  11635. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11636. /**
  11637. * Updates the texture underlying data.
  11638. * @param data Define the new data of the texture
  11639. */
  11640. update(data: ArrayBufferView): void;
  11641. /**
  11642. * Creates a luminance texture from some data.
  11643. * @param data Define the texture data
  11644. * @param width Define the width of the texture
  11645. * @param height Define the height of the texture
  11646. * @param scene Define the scene the texture belongs to
  11647. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11648. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11649. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11650. * @returns the luminance texture
  11651. */
  11652. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11653. /**
  11654. * Creates a luminance alpha texture from some data.
  11655. * @param data Define the texture data
  11656. * @param width Define the width of the texture
  11657. * @param height Define the height of the texture
  11658. * @param scene Define the scene the texture belongs to
  11659. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11660. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11661. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11662. * @returns the luminance alpha texture
  11663. */
  11664. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11665. /**
  11666. * Creates an alpha texture from some data.
  11667. * @param data Define the texture data
  11668. * @param width Define the width of the texture
  11669. * @param height Define the height of the texture
  11670. * @param scene Define the scene the texture belongs to
  11671. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11672. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11673. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11674. * @returns the alpha texture
  11675. */
  11676. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11677. /**
  11678. * Creates a RGB texture from some data.
  11679. * @param data Define the texture data
  11680. * @param width Define the width of the texture
  11681. * @param height Define the height of the texture
  11682. * @param scene Define the scene the texture belongs to
  11683. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11684. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11685. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11686. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11687. * @returns the RGB alpha texture
  11688. */
  11689. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11690. /**
  11691. * Creates a RGBA texture from some data.
  11692. * @param data Define the texture data
  11693. * @param width Define the width of the texture
  11694. * @param height Define the height of the texture
  11695. * @param scene Define the scene the texture belongs to
  11696. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11697. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11698. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11699. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11700. * @returns the RGBA texture
  11701. */
  11702. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11703. /**
  11704. * Creates a R texture from some data.
  11705. * @param data Define the texture data
  11706. * @param width Define the width of the texture
  11707. * @param height Define the height of the texture
  11708. * @param scene Define the scene the texture belongs to
  11709. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11710. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11711. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11712. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11713. * @returns the R texture
  11714. */
  11715. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11716. }
  11717. }
  11718. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11719. import { Scene } from "babylonjs/scene";
  11720. import { ISceneComponent } from "babylonjs/sceneComponent";
  11721. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11722. module "babylonjs/abstractScene" {
  11723. interface AbstractScene {
  11724. /**
  11725. * The list of procedural textures added to the scene
  11726. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11727. */
  11728. proceduralTextures: Array<ProceduralTexture>;
  11729. }
  11730. }
  11731. /**
  11732. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11733. * in a given scene.
  11734. */
  11735. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11736. /**
  11737. * The component name helpfull to identify the component in the list of scene components.
  11738. */
  11739. readonly name: string;
  11740. /**
  11741. * The scene the component belongs to.
  11742. */
  11743. scene: Scene;
  11744. /**
  11745. * Creates a new instance of the component for the given scene
  11746. * @param scene Defines the scene to register the component in
  11747. */
  11748. constructor(scene: Scene);
  11749. /**
  11750. * Registers the component in a given scene
  11751. */
  11752. register(): void;
  11753. /**
  11754. * Rebuilds the elements related to this component in case of
  11755. * context lost for instance.
  11756. */
  11757. rebuild(): void;
  11758. /**
  11759. * Disposes the component and the associated ressources.
  11760. */
  11761. dispose(): void;
  11762. private _beforeClear;
  11763. }
  11764. }
  11765. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11766. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11767. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11768. module "babylonjs/Engines/thinEngine" {
  11769. interface ThinEngine {
  11770. /**
  11771. * Creates a new render target cube texture
  11772. * @param size defines the size of the texture
  11773. * @param options defines the options used to create the texture
  11774. * @returns a new render target cube texture stored in an InternalTexture
  11775. */
  11776. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11777. }
  11778. }
  11779. }
  11780. declare module "babylonjs/Shaders/procedural.vertex" {
  11781. /** @hidden */
  11782. export var proceduralVertexShader: {
  11783. name: string;
  11784. shader: string;
  11785. };
  11786. }
  11787. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11788. import { Observable } from "babylonjs/Misc/observable";
  11789. import { Nullable } from "babylonjs/types";
  11790. import { Scene } from "babylonjs/scene";
  11791. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11792. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11793. import { Effect } from "babylonjs/Materials/effect";
  11794. import { Texture } from "babylonjs/Materials/Textures/texture";
  11795. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11796. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11797. import "babylonjs/Shaders/procedural.vertex";
  11798. /**
  11799. * 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.
  11800. * This is the base class of any Procedural texture and contains most of the shareable code.
  11801. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11802. */
  11803. export class ProceduralTexture extends Texture {
  11804. isCube: boolean;
  11805. /**
  11806. * Define if the texture is enabled or not (disabled texture will not render)
  11807. */
  11808. isEnabled: boolean;
  11809. /**
  11810. * Define if the texture must be cleared before rendering (default is true)
  11811. */
  11812. autoClear: boolean;
  11813. /**
  11814. * Callback called when the texture is generated
  11815. */
  11816. onGenerated: () => void;
  11817. /**
  11818. * Event raised when the texture is generated
  11819. */
  11820. onGeneratedObservable: Observable<ProceduralTexture>;
  11821. /** @hidden */
  11822. _generateMipMaps: boolean;
  11823. /** @hidden **/
  11824. _effect: Effect;
  11825. /** @hidden */
  11826. _textures: {
  11827. [key: string]: Texture;
  11828. };
  11829. /** @hidden */
  11830. protected _fallbackTexture: Nullable<Texture>;
  11831. private _size;
  11832. private _currentRefreshId;
  11833. private _frameId;
  11834. private _refreshRate;
  11835. private _vertexBuffers;
  11836. private _indexBuffer;
  11837. private _uniforms;
  11838. private _samplers;
  11839. private _fragment;
  11840. private _floats;
  11841. private _ints;
  11842. private _floatsArrays;
  11843. private _colors3;
  11844. private _colors4;
  11845. private _vectors2;
  11846. private _vectors3;
  11847. private _matrices;
  11848. private _fallbackTextureUsed;
  11849. private _fullEngine;
  11850. private _cachedDefines;
  11851. private _contentUpdateId;
  11852. private _contentData;
  11853. /**
  11854. * Instantiates a new procedural texture.
  11855. * 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.
  11856. * This is the base class of any Procedural texture and contains most of the shareable code.
  11857. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11858. * @param name Define the name of the texture
  11859. * @param size Define the size of the texture to create
  11860. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  11861. * @param scene Define the scene the texture belongs to
  11862. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  11863. * @param generateMipMaps Define if the texture should creates mip maps or not
  11864. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  11865. */
  11866. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  11867. /**
  11868. * The effect that is created when initializing the post process.
  11869. * @returns The created effect corresponding the the postprocess.
  11870. */
  11871. getEffect(): Effect;
  11872. /**
  11873. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  11874. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  11875. */
  11876. getContent(): Nullable<ArrayBufferView>;
  11877. private _createIndexBuffer;
  11878. /** @hidden */
  11879. _rebuild(): void;
  11880. /**
  11881. * Resets the texture in order to recreate its associated resources.
  11882. * This can be called in case of context loss
  11883. */
  11884. reset(): void;
  11885. protected _getDefines(): string;
  11886. /**
  11887. * Is the texture ready to be used ? (rendered at least once)
  11888. * @returns true if ready, otherwise, false.
  11889. */
  11890. isReady(): boolean;
  11891. /**
  11892. * Resets the refresh counter of the texture and start bak from scratch.
  11893. * Could be useful to regenerate the texture if it is setup to render only once.
  11894. */
  11895. resetRefreshCounter(): void;
  11896. /**
  11897. * Set the fragment shader to use in order to render the texture.
  11898. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  11899. */
  11900. setFragment(fragment: any): void;
  11901. /**
  11902. * Define the refresh rate of the texture or the rendering frequency.
  11903. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  11904. */
  11905. get refreshRate(): number;
  11906. set refreshRate(value: number);
  11907. /** @hidden */
  11908. _shouldRender(): boolean;
  11909. /**
  11910. * Get the size the texture is rendering at.
  11911. * @returns the size (texture is always squared)
  11912. */
  11913. getRenderSize(): number;
  11914. /**
  11915. * Resize the texture to new value.
  11916. * @param size Define the new size the texture should have
  11917. * @param generateMipMaps Define whether the new texture should create mip maps
  11918. */
  11919. resize(size: number, generateMipMaps: boolean): void;
  11920. private _checkUniform;
  11921. /**
  11922. * Set a texture in the shader program used to render.
  11923. * @param name Define the name of the uniform samplers as defined in the shader
  11924. * @param texture Define the texture to bind to this sampler
  11925. * @return the texture itself allowing "fluent" like uniform updates
  11926. */
  11927. setTexture(name: string, texture: Texture): ProceduralTexture;
  11928. /**
  11929. * Set a float in the shader.
  11930. * @param name Define the name of the uniform as defined in the shader
  11931. * @param value Define the value to give to the uniform
  11932. * @return the texture itself allowing "fluent" like uniform updates
  11933. */
  11934. setFloat(name: string, value: number): ProceduralTexture;
  11935. /**
  11936. * Set a int in the shader.
  11937. * @param name Define the name of the uniform as defined in the shader
  11938. * @param value Define the value to give to the uniform
  11939. * @return the texture itself allowing "fluent" like uniform updates
  11940. */
  11941. setInt(name: string, value: number): ProceduralTexture;
  11942. /**
  11943. * Set an array of floats in the shader.
  11944. * @param name Define the name of the uniform as defined in the shader
  11945. * @param value Define the value to give to the uniform
  11946. * @return the texture itself allowing "fluent" like uniform updates
  11947. */
  11948. setFloats(name: string, value: number[]): ProceduralTexture;
  11949. /**
  11950. * Set a vec3 in the shader from a Color3.
  11951. * @param name Define the name of the uniform as defined in the shader
  11952. * @param value Define the value to give to the uniform
  11953. * @return the texture itself allowing "fluent" like uniform updates
  11954. */
  11955. setColor3(name: string, value: Color3): ProceduralTexture;
  11956. /**
  11957. * Set a vec4 in the shader from a Color4.
  11958. * @param name Define the name of the uniform as defined in the shader
  11959. * @param value Define the value to give to the uniform
  11960. * @return the texture itself allowing "fluent" like uniform updates
  11961. */
  11962. setColor4(name: string, value: Color4): ProceduralTexture;
  11963. /**
  11964. * Set a vec2 in the shader from a Vector2.
  11965. * @param name Define the name of the uniform as defined in the shader
  11966. * @param value Define the value to give to the uniform
  11967. * @return the texture itself allowing "fluent" like uniform updates
  11968. */
  11969. setVector2(name: string, value: Vector2): ProceduralTexture;
  11970. /**
  11971. * Set a vec3 in the shader from a Vector3.
  11972. * @param name Define the name of the uniform as defined in the shader
  11973. * @param value Define the value to give to the uniform
  11974. * @return the texture itself allowing "fluent" like uniform updates
  11975. */
  11976. setVector3(name: string, value: Vector3): ProceduralTexture;
  11977. /**
  11978. * Set a mat4 in the shader from a MAtrix.
  11979. * @param name Define the name of the uniform as defined in the shader
  11980. * @param value Define the value to give to the uniform
  11981. * @return the texture itself allowing "fluent" like uniform updates
  11982. */
  11983. setMatrix(name: string, value: Matrix): ProceduralTexture;
  11984. /**
  11985. * Render the texture to its associated render target.
  11986. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  11987. */
  11988. render(useCameraPostProcess?: boolean): void;
  11989. /**
  11990. * Clone the texture.
  11991. * @returns the cloned texture
  11992. */
  11993. clone(): ProceduralTexture;
  11994. /**
  11995. * Dispose the texture and release its asoociated resources.
  11996. */
  11997. dispose(): void;
  11998. }
  11999. }
  12000. declare module "babylonjs/Particles/baseParticleSystem" {
  12001. import { Nullable } from "babylonjs/types";
  12002. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12003. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12004. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12005. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12006. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12007. import { Scene } from "babylonjs/scene";
  12008. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12009. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12010. import { Texture } from "babylonjs/Materials/Textures/texture";
  12011. import { Color4 } from "babylonjs/Maths/math.color";
  12012. import { Animation } from "babylonjs/Animations/animation";
  12013. /**
  12014. * This represents the base class for particle system in Babylon.
  12015. * 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.
  12016. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12017. * @example https://doc.babylonjs.com/babylon101/particles
  12018. */
  12019. export class BaseParticleSystem {
  12020. /**
  12021. * Source color is added to the destination color without alpha affecting the result
  12022. */
  12023. static BLENDMODE_ONEONE: number;
  12024. /**
  12025. * Blend current color and particle color using particle’s alpha
  12026. */
  12027. static BLENDMODE_STANDARD: number;
  12028. /**
  12029. * Add current color and particle color multiplied by particle’s alpha
  12030. */
  12031. static BLENDMODE_ADD: number;
  12032. /**
  12033. * Multiply current color with particle color
  12034. */
  12035. static BLENDMODE_MULTIPLY: number;
  12036. /**
  12037. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12038. */
  12039. static BLENDMODE_MULTIPLYADD: number;
  12040. /**
  12041. * List of animations used by the particle system.
  12042. */
  12043. animations: Animation[];
  12044. /**
  12045. * Gets or sets the unique id of the particle system
  12046. */
  12047. uniqueId: number;
  12048. /**
  12049. * The id of the Particle system.
  12050. */
  12051. id: string;
  12052. /**
  12053. * The friendly name of the Particle system.
  12054. */
  12055. name: string;
  12056. /**
  12057. * Snippet ID if the particle system was created from the snippet server
  12058. */
  12059. snippetId: string;
  12060. /**
  12061. * The rendering group used by the Particle system to chose when to render.
  12062. */
  12063. renderingGroupId: number;
  12064. /**
  12065. * The emitter represents the Mesh or position we are attaching the particle system to.
  12066. */
  12067. emitter: Nullable<AbstractMesh | Vector3>;
  12068. /**
  12069. * The maximum number of particles to emit per frame
  12070. */
  12071. emitRate: number;
  12072. /**
  12073. * If you want to launch only a few particles at once, that can be done, as well.
  12074. */
  12075. manualEmitCount: number;
  12076. /**
  12077. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12078. */
  12079. updateSpeed: number;
  12080. /**
  12081. * The amount of time the particle system is running (depends of the overall update speed).
  12082. */
  12083. targetStopDuration: number;
  12084. /**
  12085. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12086. */
  12087. disposeOnStop: boolean;
  12088. /**
  12089. * Minimum power of emitting particles.
  12090. */
  12091. minEmitPower: number;
  12092. /**
  12093. * Maximum power of emitting particles.
  12094. */
  12095. maxEmitPower: number;
  12096. /**
  12097. * Minimum life time of emitting particles.
  12098. */
  12099. minLifeTime: number;
  12100. /**
  12101. * Maximum life time of emitting particles.
  12102. */
  12103. maxLifeTime: number;
  12104. /**
  12105. * Minimum Size of emitting particles.
  12106. */
  12107. minSize: number;
  12108. /**
  12109. * Maximum Size of emitting particles.
  12110. */
  12111. maxSize: number;
  12112. /**
  12113. * Minimum scale of emitting particles on X axis.
  12114. */
  12115. minScaleX: number;
  12116. /**
  12117. * Maximum scale of emitting particles on X axis.
  12118. */
  12119. maxScaleX: number;
  12120. /**
  12121. * Minimum scale of emitting particles on Y axis.
  12122. */
  12123. minScaleY: number;
  12124. /**
  12125. * Maximum scale of emitting particles on Y axis.
  12126. */
  12127. maxScaleY: number;
  12128. /**
  12129. * Gets or sets the minimal initial rotation in radians.
  12130. */
  12131. minInitialRotation: number;
  12132. /**
  12133. * Gets or sets the maximal initial rotation in radians.
  12134. */
  12135. maxInitialRotation: number;
  12136. /**
  12137. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12138. */
  12139. minAngularSpeed: number;
  12140. /**
  12141. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12142. */
  12143. maxAngularSpeed: number;
  12144. /**
  12145. * The texture used to render each particle. (this can be a spritesheet)
  12146. */
  12147. particleTexture: Nullable<Texture>;
  12148. /**
  12149. * The layer mask we are rendering the particles through.
  12150. */
  12151. layerMask: number;
  12152. /**
  12153. * This can help using your own shader to render the particle system.
  12154. * The according effect will be created
  12155. */
  12156. customShader: any;
  12157. /**
  12158. * By default particle system starts as soon as they are created. This prevents the
  12159. * automatic start to happen and let you decide when to start emitting particles.
  12160. */
  12161. preventAutoStart: boolean;
  12162. private _noiseTexture;
  12163. /**
  12164. * Gets or sets a texture used to add random noise to particle positions
  12165. */
  12166. get noiseTexture(): Nullable<ProceduralTexture>;
  12167. set noiseTexture(value: Nullable<ProceduralTexture>);
  12168. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12169. noiseStrength: Vector3;
  12170. /**
  12171. * Callback triggered when the particle animation is ending.
  12172. */
  12173. onAnimationEnd: Nullable<() => void>;
  12174. /**
  12175. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12176. */
  12177. blendMode: number;
  12178. /**
  12179. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12180. * to override the particles.
  12181. */
  12182. forceDepthWrite: boolean;
  12183. /** 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 */
  12184. preWarmCycles: number;
  12185. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12186. preWarmStepOffset: number;
  12187. /**
  12188. * 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)
  12189. */
  12190. spriteCellChangeSpeed: number;
  12191. /**
  12192. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12193. */
  12194. startSpriteCellID: number;
  12195. /**
  12196. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12197. */
  12198. endSpriteCellID: number;
  12199. /**
  12200. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12201. */
  12202. spriteCellWidth: number;
  12203. /**
  12204. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12205. */
  12206. spriteCellHeight: number;
  12207. /**
  12208. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12209. */
  12210. spriteRandomStartCell: boolean;
  12211. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12212. translationPivot: Vector2;
  12213. /** @hidden */
  12214. protected _isAnimationSheetEnabled: boolean;
  12215. /**
  12216. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12217. */
  12218. beginAnimationOnStart: boolean;
  12219. /**
  12220. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12221. */
  12222. beginAnimationFrom: number;
  12223. /**
  12224. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12225. */
  12226. beginAnimationTo: number;
  12227. /**
  12228. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12229. */
  12230. beginAnimationLoop: boolean;
  12231. /**
  12232. * Gets or sets a world offset applied to all particles
  12233. */
  12234. worldOffset: Vector3;
  12235. /**
  12236. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12237. */
  12238. get isAnimationSheetEnabled(): boolean;
  12239. set isAnimationSheetEnabled(value: boolean);
  12240. /**
  12241. * Get hosting scene
  12242. * @returns the scene
  12243. */
  12244. getScene(): Scene;
  12245. /**
  12246. * You can use gravity if you want to give an orientation to your particles.
  12247. */
  12248. gravity: Vector3;
  12249. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12250. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12251. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12252. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12253. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12254. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12255. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12256. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12257. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12258. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12259. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12260. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12261. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12262. /**
  12263. * Defines the delay in milliseconds before starting the system (0 by default)
  12264. */
  12265. startDelay: number;
  12266. /**
  12267. * Gets the current list of drag gradients.
  12268. * You must use addDragGradient and removeDragGradient to udpate this list
  12269. * @returns the list of drag gradients
  12270. */
  12271. getDragGradients(): Nullable<Array<FactorGradient>>;
  12272. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12273. limitVelocityDamping: number;
  12274. /**
  12275. * Gets the current list of limit velocity gradients.
  12276. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12277. * @returns the list of limit velocity gradients
  12278. */
  12279. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12280. /**
  12281. * Gets the current list of color gradients.
  12282. * You must use addColorGradient and removeColorGradient to udpate this list
  12283. * @returns the list of color gradients
  12284. */
  12285. getColorGradients(): Nullable<Array<ColorGradient>>;
  12286. /**
  12287. * Gets the current list of size gradients.
  12288. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12289. * @returns the list of size gradients
  12290. */
  12291. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12292. /**
  12293. * Gets the current list of color remap gradients.
  12294. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12295. * @returns the list of color remap gradients
  12296. */
  12297. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12298. /**
  12299. * Gets the current list of alpha remap gradients.
  12300. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12301. * @returns the list of alpha remap gradients
  12302. */
  12303. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12304. /**
  12305. * Gets the current list of life time gradients.
  12306. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12307. * @returns the list of life time gradients
  12308. */
  12309. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12310. /**
  12311. * Gets the current list of angular speed gradients.
  12312. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12313. * @returns the list of angular speed gradients
  12314. */
  12315. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12316. /**
  12317. * Gets the current list of velocity gradients.
  12318. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12319. * @returns the list of velocity gradients
  12320. */
  12321. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12322. /**
  12323. * Gets the current list of start size gradients.
  12324. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12325. * @returns the list of start size gradients
  12326. */
  12327. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12328. /**
  12329. * Gets the current list of emit rate gradients.
  12330. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12331. * @returns the list of emit rate gradients
  12332. */
  12333. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12334. /**
  12335. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12336. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12337. */
  12338. get direction1(): Vector3;
  12339. set direction1(value: Vector3);
  12340. /**
  12341. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12342. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12343. */
  12344. get direction2(): Vector3;
  12345. set direction2(value: Vector3);
  12346. /**
  12347. * 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.
  12348. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12349. */
  12350. get minEmitBox(): Vector3;
  12351. set minEmitBox(value: Vector3);
  12352. /**
  12353. * 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.
  12354. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12355. */
  12356. get maxEmitBox(): Vector3;
  12357. set maxEmitBox(value: Vector3);
  12358. /**
  12359. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12360. */
  12361. color1: Color4;
  12362. /**
  12363. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12364. */
  12365. color2: Color4;
  12366. /**
  12367. * Color the particle will have at the end of its lifetime
  12368. */
  12369. colorDead: Color4;
  12370. /**
  12371. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12372. */
  12373. textureMask: Color4;
  12374. /**
  12375. * The particle emitter type defines the emitter used by the particle system.
  12376. * It can be for example box, sphere, or cone...
  12377. */
  12378. particleEmitterType: IParticleEmitterType;
  12379. /** @hidden */
  12380. _isSubEmitter: boolean;
  12381. /**
  12382. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12383. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12384. */
  12385. billboardMode: number;
  12386. protected _isBillboardBased: boolean;
  12387. /**
  12388. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12389. */
  12390. get isBillboardBased(): boolean;
  12391. set isBillboardBased(value: boolean);
  12392. /**
  12393. * The scene the particle system belongs to.
  12394. */
  12395. protected _scene: Scene;
  12396. /**
  12397. * Local cache of defines for image processing.
  12398. */
  12399. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12400. /**
  12401. * Default configuration related to image processing available in the standard Material.
  12402. */
  12403. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  12404. /**
  12405. * Gets the image processing configuration used either in this material.
  12406. */
  12407. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  12408. /**
  12409. * Sets the Default image processing configuration used either in the this material.
  12410. *
  12411. * If sets to null, the scene one is in use.
  12412. */
  12413. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  12414. /**
  12415. * Attaches a new image processing configuration to the Standard Material.
  12416. * @param configuration
  12417. */
  12418. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12419. /** @hidden */
  12420. protected _reset(): void;
  12421. /** @hidden */
  12422. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12423. /**
  12424. * Instantiates a particle system.
  12425. * 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.
  12426. * @param name The name of the particle system
  12427. */
  12428. constructor(name: string);
  12429. /**
  12430. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12431. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12432. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12433. * @returns the emitter
  12434. */
  12435. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12436. /**
  12437. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12438. * @param radius The radius of the hemisphere to emit from
  12439. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12440. * @returns the emitter
  12441. */
  12442. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12443. /**
  12444. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12445. * @param radius The radius of the sphere to emit from
  12446. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12447. * @returns the emitter
  12448. */
  12449. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12450. /**
  12451. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12452. * @param radius The radius of the sphere to emit from
  12453. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12454. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12455. * @returns the emitter
  12456. */
  12457. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12458. /**
  12459. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12460. * @param radius The radius of the emission cylinder
  12461. * @param height The height of the emission cylinder
  12462. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12463. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12464. * @returns the emitter
  12465. */
  12466. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12467. /**
  12468. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12469. * @param radius The radius of the cylinder to emit from
  12470. * @param height The height of the emission cylinder
  12471. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12472. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12473. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12474. * @returns the emitter
  12475. */
  12476. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12477. /**
  12478. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12479. * @param radius The radius of the cone to emit from
  12480. * @param angle The base angle of the cone
  12481. * @returns the emitter
  12482. */
  12483. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12484. /**
  12485. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12486. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12487. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12488. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12489. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12490. * @returns the emitter
  12491. */
  12492. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12493. }
  12494. }
  12495. declare module "babylonjs/Particles/subEmitter" {
  12496. import { Scene } from "babylonjs/scene";
  12497. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12498. /**
  12499. * Type of sub emitter
  12500. */
  12501. export enum SubEmitterType {
  12502. /**
  12503. * Attached to the particle over it's lifetime
  12504. */
  12505. ATTACHED = 0,
  12506. /**
  12507. * Created when the particle dies
  12508. */
  12509. END = 1
  12510. }
  12511. /**
  12512. * Sub emitter class used to emit particles from an existing particle
  12513. */
  12514. export class SubEmitter {
  12515. /**
  12516. * the particle system to be used by the sub emitter
  12517. */
  12518. particleSystem: ParticleSystem;
  12519. /**
  12520. * Type of the submitter (Default: END)
  12521. */
  12522. type: SubEmitterType;
  12523. /**
  12524. * 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)
  12525. * Note: This only is supported when using an emitter of type Mesh
  12526. */
  12527. inheritDirection: boolean;
  12528. /**
  12529. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12530. */
  12531. inheritedVelocityAmount: number;
  12532. /**
  12533. * Creates a sub emitter
  12534. * @param particleSystem the particle system to be used by the sub emitter
  12535. */
  12536. constructor(
  12537. /**
  12538. * the particle system to be used by the sub emitter
  12539. */
  12540. particleSystem: ParticleSystem);
  12541. /**
  12542. * Clones the sub emitter
  12543. * @returns the cloned sub emitter
  12544. */
  12545. clone(): SubEmitter;
  12546. /**
  12547. * Serialize current object to a JSON object
  12548. * @returns the serialized object
  12549. */
  12550. serialize(): any;
  12551. /** @hidden */
  12552. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  12553. /**
  12554. * Creates a new SubEmitter from a serialized JSON version
  12555. * @param serializationObject defines the JSON object to read from
  12556. * @param scene defines the hosting scene
  12557. * @param rootUrl defines the rootUrl for data loading
  12558. * @returns a new SubEmitter
  12559. */
  12560. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  12561. /** Release associated resources */
  12562. dispose(): void;
  12563. }
  12564. }
  12565. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12566. /** @hidden */
  12567. export var imageProcessingDeclaration: {
  12568. name: string;
  12569. shader: string;
  12570. };
  12571. }
  12572. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12573. /** @hidden */
  12574. export var imageProcessingFunctions: {
  12575. name: string;
  12576. shader: string;
  12577. };
  12578. }
  12579. declare module "babylonjs/Shaders/particles.fragment" {
  12580. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12581. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12582. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12583. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12584. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12585. /** @hidden */
  12586. export var particlesPixelShader: {
  12587. name: string;
  12588. shader: string;
  12589. };
  12590. }
  12591. declare module "babylonjs/Shaders/particles.vertex" {
  12592. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12593. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12594. /** @hidden */
  12595. export var particlesVertexShader: {
  12596. name: string;
  12597. shader: string;
  12598. };
  12599. }
  12600. declare module "babylonjs/Particles/particleSystem" {
  12601. import { Nullable } from "babylonjs/types";
  12602. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12603. import { Observable } from "babylonjs/Misc/observable";
  12604. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12605. import { Effect } from "babylonjs/Materials/effect";
  12606. import { Scene, IDisposable } from "babylonjs/scene";
  12607. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12608. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12609. import { Particle } from "babylonjs/Particles/particle";
  12610. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12611. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12612. import "babylonjs/Shaders/particles.fragment";
  12613. import "babylonjs/Shaders/particles.vertex";
  12614. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12615. /**
  12616. * This represents a particle system in Babylon.
  12617. * 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.
  12618. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12619. * @example https://doc.babylonjs.com/babylon101/particles
  12620. */
  12621. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12622. /**
  12623. * Billboard mode will only apply to Y axis
  12624. */
  12625. static readonly BILLBOARDMODE_Y: number;
  12626. /**
  12627. * Billboard mode will apply to all axes
  12628. */
  12629. static readonly BILLBOARDMODE_ALL: number;
  12630. /**
  12631. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12632. */
  12633. static readonly BILLBOARDMODE_STRETCHED: number;
  12634. /**
  12635. * This function can be defined to provide custom update for active particles.
  12636. * This function will be called instead of regular update (age, position, color, etc.).
  12637. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12638. */
  12639. updateFunction: (particles: Particle[]) => void;
  12640. private _emitterWorldMatrix;
  12641. /**
  12642. * This function can be defined to specify initial direction for every new particle.
  12643. * It by default use the emitterType defined function
  12644. */
  12645. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12646. /**
  12647. * This function can be defined to specify initial position for every new particle.
  12648. * It by default use the emitterType defined function
  12649. */
  12650. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12651. /**
  12652. * @hidden
  12653. */
  12654. _inheritedVelocityOffset: Vector3;
  12655. /**
  12656. * An event triggered when the system is disposed
  12657. */
  12658. onDisposeObservable: Observable<IParticleSystem>;
  12659. private _onDisposeObserver;
  12660. /**
  12661. * Sets a callback that will be triggered when the system is disposed
  12662. */
  12663. set onDispose(callback: () => void);
  12664. private _particles;
  12665. private _epsilon;
  12666. private _capacity;
  12667. private _stockParticles;
  12668. private _newPartsExcess;
  12669. private _vertexData;
  12670. private _vertexBuffer;
  12671. private _vertexBuffers;
  12672. private _spriteBuffer;
  12673. private _indexBuffer;
  12674. private _effect;
  12675. private _customEffect;
  12676. private _cachedDefines;
  12677. private _scaledColorStep;
  12678. private _colorDiff;
  12679. private _scaledDirection;
  12680. private _scaledGravity;
  12681. private _currentRenderId;
  12682. private _alive;
  12683. private _useInstancing;
  12684. private _started;
  12685. private _stopped;
  12686. private _actualFrame;
  12687. private _scaledUpdateSpeed;
  12688. private _vertexBufferSize;
  12689. /** @hidden */
  12690. _currentEmitRateGradient: Nullable<FactorGradient>;
  12691. /** @hidden */
  12692. _currentEmitRate1: number;
  12693. /** @hidden */
  12694. _currentEmitRate2: number;
  12695. /** @hidden */
  12696. _currentStartSizeGradient: Nullable<FactorGradient>;
  12697. /** @hidden */
  12698. _currentStartSize1: number;
  12699. /** @hidden */
  12700. _currentStartSize2: number;
  12701. private readonly _rawTextureWidth;
  12702. private _rampGradientsTexture;
  12703. private _useRampGradients;
  12704. /** Gets or sets a boolean indicating that ramp gradients must be used
  12705. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12706. */
  12707. get useRampGradients(): boolean;
  12708. set useRampGradients(value: boolean);
  12709. /**
  12710. * 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.
  12711. * 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: [])
  12712. */
  12713. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  12714. private _subEmitters;
  12715. /**
  12716. * @hidden
  12717. * If the particle systems emitter should be disposed when the particle system is disposed
  12718. */
  12719. _disposeEmitterOnDispose: boolean;
  12720. /**
  12721. * The current active Sub-systems, this property is used by the root particle system only.
  12722. */
  12723. activeSubSystems: Array<ParticleSystem>;
  12724. /**
  12725. * Specifies if the particles are updated in emitter local space or world space
  12726. */
  12727. isLocal: boolean;
  12728. private _rootParticleSystem;
  12729. /**
  12730. * Gets the current list of active particles
  12731. */
  12732. get particles(): Particle[];
  12733. /**
  12734. * Gets the number of particles active at the same time.
  12735. * @returns The number of active particles.
  12736. */
  12737. getActiveCount(): number;
  12738. /**
  12739. * Returns the string "ParticleSystem"
  12740. * @returns a string containing the class name
  12741. */
  12742. getClassName(): string;
  12743. /**
  12744. * Gets a boolean indicating that the system is stopping
  12745. * @returns true if the system is currently stopping
  12746. */
  12747. isStopping(): boolean;
  12748. /**
  12749. * Gets the custom effect used to render the particles
  12750. * @param blendMode Blend mode for which the effect should be retrieved
  12751. * @returns The effect
  12752. */
  12753. getCustomEffect(blendMode?: number): Nullable<Effect>;
  12754. /**
  12755. * Sets the custom effect used to render the particles
  12756. * @param effect The effect to set
  12757. * @param blendMode Blend mode for which the effect should be set
  12758. */
  12759. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  12760. /** @hidden */
  12761. private _onBeforeDrawParticlesObservable;
  12762. /**
  12763. * Observable that will be called just before the particles are drawn
  12764. */
  12765. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  12766. /**
  12767. * Gets the name of the particle vertex shader
  12768. */
  12769. get vertexShaderName(): string;
  12770. /**
  12771. * Instantiates a particle system.
  12772. * 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.
  12773. * @param name The name of the particle system
  12774. * @param capacity The max number of particles alive at the same time
  12775. * @param scene The scene the particle system belongs to
  12776. * @param customEffect a custom effect used to change the way particles are rendered by default
  12777. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  12778. * @param epsilon Offset used to render the particles
  12779. */
  12780. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  12781. private _addFactorGradient;
  12782. private _removeFactorGradient;
  12783. /**
  12784. * Adds a new life time gradient
  12785. * @param gradient defines the gradient to use (between 0 and 1)
  12786. * @param factor defines the life time factor to affect to the specified gradient
  12787. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12788. * @returns the current particle system
  12789. */
  12790. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12791. /**
  12792. * Remove a specific life time gradient
  12793. * @param gradient defines the gradient to remove
  12794. * @returns the current particle system
  12795. */
  12796. removeLifeTimeGradient(gradient: number): IParticleSystem;
  12797. /**
  12798. * Adds a new size gradient
  12799. * @param gradient defines the gradient to use (between 0 and 1)
  12800. * @param factor defines the size factor to affect to the specified gradient
  12801. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12802. * @returns the current particle system
  12803. */
  12804. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12805. /**
  12806. * Remove a specific size gradient
  12807. * @param gradient defines the gradient to remove
  12808. * @returns the current particle system
  12809. */
  12810. removeSizeGradient(gradient: number): IParticleSystem;
  12811. /**
  12812. * Adds a new color remap gradient
  12813. * @param gradient defines the gradient to use (between 0 and 1)
  12814. * @param min defines the color remap minimal range
  12815. * @param max defines the color remap maximal range
  12816. * @returns the current particle system
  12817. */
  12818. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  12819. /**
  12820. * Remove a specific color remap gradient
  12821. * @param gradient defines the gradient to remove
  12822. * @returns the current particle system
  12823. */
  12824. removeColorRemapGradient(gradient: number): IParticleSystem;
  12825. /**
  12826. * Adds a new alpha remap gradient
  12827. * @param gradient defines the gradient to use (between 0 and 1)
  12828. * @param min defines the alpha remap minimal range
  12829. * @param max defines the alpha remap maximal range
  12830. * @returns the current particle system
  12831. */
  12832. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  12833. /**
  12834. * Remove a specific alpha remap gradient
  12835. * @param gradient defines the gradient to remove
  12836. * @returns the current particle system
  12837. */
  12838. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  12839. /**
  12840. * Adds a new angular speed gradient
  12841. * @param gradient defines the gradient to use (between 0 and 1)
  12842. * @param factor defines the angular speed to affect to the specified gradient
  12843. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12844. * @returns the current particle system
  12845. */
  12846. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12847. /**
  12848. * Remove a specific angular speed gradient
  12849. * @param gradient defines the gradient to remove
  12850. * @returns the current particle system
  12851. */
  12852. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  12853. /**
  12854. * Adds a new velocity gradient
  12855. * @param gradient defines the gradient to use (between 0 and 1)
  12856. * @param factor defines the velocity to affect to the specified gradient
  12857. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12858. * @returns the current particle system
  12859. */
  12860. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12861. /**
  12862. * Remove a specific velocity gradient
  12863. * @param gradient defines the gradient to remove
  12864. * @returns the current particle system
  12865. */
  12866. removeVelocityGradient(gradient: number): IParticleSystem;
  12867. /**
  12868. * Adds a new limit velocity gradient
  12869. * @param gradient defines the gradient to use (between 0 and 1)
  12870. * @param factor defines the limit velocity value to affect to the specified gradient
  12871. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12872. * @returns the current particle system
  12873. */
  12874. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12875. /**
  12876. * Remove a specific limit velocity gradient
  12877. * @param gradient defines the gradient to remove
  12878. * @returns the current particle system
  12879. */
  12880. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  12881. /**
  12882. * Adds a new drag gradient
  12883. * @param gradient defines the gradient to use (between 0 and 1)
  12884. * @param factor defines the drag value to affect to the specified gradient
  12885. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12886. * @returns the current particle system
  12887. */
  12888. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12889. /**
  12890. * Remove a specific drag gradient
  12891. * @param gradient defines the gradient to remove
  12892. * @returns the current particle system
  12893. */
  12894. removeDragGradient(gradient: number): IParticleSystem;
  12895. /**
  12896. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  12897. * @param gradient defines the gradient to use (between 0 and 1)
  12898. * @param factor defines the emit rate value to affect to the specified gradient
  12899. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12900. * @returns the current particle system
  12901. */
  12902. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12903. /**
  12904. * Remove a specific emit rate gradient
  12905. * @param gradient defines the gradient to remove
  12906. * @returns the current particle system
  12907. */
  12908. removeEmitRateGradient(gradient: number): IParticleSystem;
  12909. /**
  12910. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  12911. * @param gradient defines the gradient to use (between 0 and 1)
  12912. * @param factor defines the start size value to affect to the specified gradient
  12913. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12914. * @returns the current particle system
  12915. */
  12916. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12917. /**
  12918. * Remove a specific start size gradient
  12919. * @param gradient defines the gradient to remove
  12920. * @returns the current particle system
  12921. */
  12922. removeStartSizeGradient(gradient: number): IParticleSystem;
  12923. private _createRampGradientTexture;
  12924. /**
  12925. * Gets the current list of ramp gradients.
  12926. * You must use addRampGradient and removeRampGradient to udpate this list
  12927. * @returns the list of ramp gradients
  12928. */
  12929. getRampGradients(): Nullable<Array<Color3Gradient>>;
  12930. /** Force the system to rebuild all gradients that need to be resync */
  12931. forceRefreshGradients(): void;
  12932. private _syncRampGradientTexture;
  12933. /**
  12934. * Adds a new ramp gradient used to remap particle colors
  12935. * @param gradient defines the gradient to use (between 0 and 1)
  12936. * @param color defines the color to affect to the specified gradient
  12937. * @returns the current particle system
  12938. */
  12939. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  12940. /**
  12941. * Remove a specific ramp gradient
  12942. * @param gradient defines the gradient to remove
  12943. * @returns the current particle system
  12944. */
  12945. removeRampGradient(gradient: number): ParticleSystem;
  12946. /**
  12947. * Adds a new color gradient
  12948. * @param gradient defines the gradient to use (between 0 and 1)
  12949. * @param color1 defines the color to affect to the specified gradient
  12950. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  12951. * @returns this particle system
  12952. */
  12953. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  12954. /**
  12955. * Remove a specific color gradient
  12956. * @param gradient defines the gradient to remove
  12957. * @returns this particle system
  12958. */
  12959. removeColorGradient(gradient: number): IParticleSystem;
  12960. private _fetchR;
  12961. protected _reset(): void;
  12962. private _resetEffect;
  12963. private _createVertexBuffers;
  12964. private _createIndexBuffer;
  12965. /**
  12966. * Gets the maximum number of particles active at the same time.
  12967. * @returns The max number of active particles.
  12968. */
  12969. getCapacity(): number;
  12970. /**
  12971. * Gets whether there are still active particles in the system.
  12972. * @returns True if it is alive, otherwise false.
  12973. */
  12974. isAlive(): boolean;
  12975. /**
  12976. * Gets if the system has been started. (Note: this will still be true after stop is called)
  12977. * @returns True if it has been started, otherwise false.
  12978. */
  12979. isStarted(): boolean;
  12980. private _prepareSubEmitterInternalArray;
  12981. /**
  12982. * Starts the particle system and begins to emit
  12983. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  12984. */
  12985. start(delay?: number): void;
  12986. /**
  12987. * Stops the particle system.
  12988. * @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.
  12989. */
  12990. stop(stopSubEmitters?: boolean): void;
  12991. /**
  12992. * Remove all active particles
  12993. */
  12994. reset(): void;
  12995. /**
  12996. * @hidden (for internal use only)
  12997. */
  12998. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  12999. /**
  13000. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13001. * Its lifetime will start back at 0.
  13002. */
  13003. recycleParticle: (particle: Particle) => void;
  13004. private _stopSubEmitters;
  13005. private _createParticle;
  13006. private _removeFromRoot;
  13007. private _emitFromParticle;
  13008. private _update;
  13009. /** @hidden */
  13010. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13011. /** @hidden */
  13012. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13013. /**
  13014. * Fill the defines array according to the current settings of the particle system
  13015. * @param defines Array to be updated
  13016. * @param blendMode blend mode to take into account when updating the array
  13017. */
  13018. fillDefines(defines: Array<string>, blendMode: number): void;
  13019. /**
  13020. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13021. * @param uniforms Uniforms array to fill
  13022. * @param attributes Attributes array to fill
  13023. * @param samplers Samplers array to fill
  13024. */
  13025. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13026. /** @hidden */
  13027. private _getEffect;
  13028. /**
  13029. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13030. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13031. */
  13032. animate(preWarmOnly?: boolean): void;
  13033. private _appendParticleVertices;
  13034. /**
  13035. * Rebuilds the particle system.
  13036. */
  13037. rebuild(): void;
  13038. /**
  13039. * Is this system ready to be used/rendered
  13040. * @return true if the system is ready
  13041. */
  13042. isReady(): boolean;
  13043. private _render;
  13044. /**
  13045. * Renders the particle system in its current state.
  13046. * @returns the current number of particles
  13047. */
  13048. render(): number;
  13049. /**
  13050. * Disposes the particle system and free the associated resources
  13051. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13052. */
  13053. dispose(disposeTexture?: boolean): void;
  13054. /**
  13055. * Clones the particle system.
  13056. * @param name The name of the cloned object
  13057. * @param newEmitter The new emitter to use
  13058. * @returns the cloned particle system
  13059. */
  13060. clone(name: string, newEmitter: any): ParticleSystem;
  13061. /**
  13062. * Serializes the particle system to a JSON object
  13063. * @param serializeTexture defines if the texture must be serialized as well
  13064. * @returns the JSON object
  13065. */
  13066. serialize(serializeTexture?: boolean): any;
  13067. /** @hidden */
  13068. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13069. /** @hidden */
  13070. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  13071. /**
  13072. * Parses a JSON object to create a particle system.
  13073. * @param parsedParticleSystem The JSON object to parse
  13074. * @param scene The scene to create the particle system in
  13075. * @param rootUrl The root url to use to load external dependencies like texture
  13076. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13077. * @returns the Parsed particle system
  13078. */
  13079. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13080. }
  13081. }
  13082. declare module "babylonjs/Particles/particle" {
  13083. import { Nullable } from "babylonjs/types";
  13084. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13085. import { Color4 } from "babylonjs/Maths/math.color";
  13086. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13087. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13088. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13089. /**
  13090. * A particle represents one of the element emitted by a particle system.
  13091. * This is mainly define by its coordinates, direction, velocity and age.
  13092. */
  13093. export class Particle {
  13094. /**
  13095. * The particle system the particle belongs to.
  13096. */
  13097. particleSystem: ParticleSystem;
  13098. private static _Count;
  13099. /**
  13100. * Unique ID of the particle
  13101. */
  13102. id: number;
  13103. /**
  13104. * The world position of the particle in the scene.
  13105. */
  13106. position: Vector3;
  13107. /**
  13108. * The world direction of the particle in the scene.
  13109. */
  13110. direction: Vector3;
  13111. /**
  13112. * The color of the particle.
  13113. */
  13114. color: Color4;
  13115. /**
  13116. * The color change of the particle per step.
  13117. */
  13118. colorStep: Color4;
  13119. /**
  13120. * Defines how long will the life of the particle be.
  13121. */
  13122. lifeTime: number;
  13123. /**
  13124. * The current age of the particle.
  13125. */
  13126. age: number;
  13127. /**
  13128. * The current size of the particle.
  13129. */
  13130. size: number;
  13131. /**
  13132. * The current scale of the particle.
  13133. */
  13134. scale: Vector2;
  13135. /**
  13136. * The current angle of the particle.
  13137. */
  13138. angle: number;
  13139. /**
  13140. * Defines how fast is the angle changing.
  13141. */
  13142. angularSpeed: number;
  13143. /**
  13144. * Defines the cell index used by the particle to be rendered from a sprite.
  13145. */
  13146. cellIndex: number;
  13147. /**
  13148. * The information required to support color remapping
  13149. */
  13150. remapData: Vector4;
  13151. /** @hidden */
  13152. _randomCellOffset?: number;
  13153. /** @hidden */
  13154. _initialDirection: Nullable<Vector3>;
  13155. /** @hidden */
  13156. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13157. /** @hidden */
  13158. _initialStartSpriteCellID: number;
  13159. /** @hidden */
  13160. _initialEndSpriteCellID: number;
  13161. /** @hidden */
  13162. _currentColorGradient: Nullable<ColorGradient>;
  13163. /** @hidden */
  13164. _currentColor1: Color4;
  13165. /** @hidden */
  13166. _currentColor2: Color4;
  13167. /** @hidden */
  13168. _currentSizeGradient: Nullable<FactorGradient>;
  13169. /** @hidden */
  13170. _currentSize1: number;
  13171. /** @hidden */
  13172. _currentSize2: number;
  13173. /** @hidden */
  13174. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13175. /** @hidden */
  13176. _currentAngularSpeed1: number;
  13177. /** @hidden */
  13178. _currentAngularSpeed2: number;
  13179. /** @hidden */
  13180. _currentVelocityGradient: Nullable<FactorGradient>;
  13181. /** @hidden */
  13182. _currentVelocity1: number;
  13183. /** @hidden */
  13184. _currentVelocity2: number;
  13185. /** @hidden */
  13186. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13187. /** @hidden */
  13188. _currentLimitVelocity1: number;
  13189. /** @hidden */
  13190. _currentLimitVelocity2: number;
  13191. /** @hidden */
  13192. _currentDragGradient: Nullable<FactorGradient>;
  13193. /** @hidden */
  13194. _currentDrag1: number;
  13195. /** @hidden */
  13196. _currentDrag2: number;
  13197. /** @hidden */
  13198. _randomNoiseCoordinates1: Vector3;
  13199. /** @hidden */
  13200. _randomNoiseCoordinates2: Vector3;
  13201. /** @hidden */
  13202. _localPosition?: Vector3;
  13203. /**
  13204. * Creates a new instance Particle
  13205. * @param particleSystem the particle system the particle belongs to
  13206. */
  13207. constructor(
  13208. /**
  13209. * The particle system the particle belongs to.
  13210. */
  13211. particleSystem: ParticleSystem);
  13212. private updateCellInfoFromSystem;
  13213. /**
  13214. * Defines how the sprite cell index is updated for the particle
  13215. */
  13216. updateCellIndex(): void;
  13217. /** @hidden */
  13218. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13219. /** @hidden */
  13220. _inheritParticleInfoToSubEmitters(): void;
  13221. /** @hidden */
  13222. _reset(): void;
  13223. /**
  13224. * Copy the properties of particle to another one.
  13225. * @param other the particle to copy the information to.
  13226. */
  13227. copyTo(other: Particle): void;
  13228. }
  13229. }
  13230. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13231. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13232. import { Effect } from "babylonjs/Materials/effect";
  13233. import { Particle } from "babylonjs/Particles/particle";
  13234. import { Scene } from "babylonjs/scene";
  13235. /**
  13236. * Particle emitter represents a volume emitting particles.
  13237. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13238. */
  13239. export interface IParticleEmitterType {
  13240. /**
  13241. * Called by the particle System when the direction is computed for the created particle.
  13242. * @param worldMatrix is the world matrix of the particle system
  13243. * @param directionToUpdate is the direction vector to update with the result
  13244. * @param particle is the particle we are computed the direction for
  13245. * @param isLocal defines if the direction should be set in local space
  13246. */
  13247. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13248. /**
  13249. * Called by the particle System when the position is computed for the created particle.
  13250. * @param worldMatrix is the world matrix of the particle system
  13251. * @param positionToUpdate is the position vector to update with the result
  13252. * @param particle is the particle we are computed the position for
  13253. * @param isLocal defines if the position should be set in local space
  13254. */
  13255. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13256. /**
  13257. * Clones the current emitter and returns a copy of it
  13258. * @returns the new emitter
  13259. */
  13260. clone(): IParticleEmitterType;
  13261. /**
  13262. * Called by the GPUParticleSystem to setup the update shader
  13263. * @param effect defines the update shader
  13264. */
  13265. applyToShader(effect: Effect): void;
  13266. /**
  13267. * Returns a string to use to update the GPU particles update shader
  13268. * @returns the effect defines string
  13269. */
  13270. getEffectDefines(): string;
  13271. /**
  13272. * Returns a string representing the class name
  13273. * @returns a string containing the class name
  13274. */
  13275. getClassName(): string;
  13276. /**
  13277. * Serializes the particle system to a JSON object.
  13278. * @returns the JSON object
  13279. */
  13280. serialize(): any;
  13281. /**
  13282. * Parse properties from a JSON object
  13283. * @param serializationObject defines the JSON object
  13284. * @param scene defines the hosting scene
  13285. */
  13286. parse(serializationObject: any, scene: Scene): void;
  13287. }
  13288. }
  13289. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13290. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13291. import { Effect } from "babylonjs/Materials/effect";
  13292. import { Particle } from "babylonjs/Particles/particle";
  13293. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13294. /**
  13295. * Particle emitter emitting particles from the inside of a box.
  13296. * It emits the particles randomly between 2 given directions.
  13297. */
  13298. export class BoxParticleEmitter implements IParticleEmitterType {
  13299. /**
  13300. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13301. */
  13302. direction1: Vector3;
  13303. /**
  13304. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13305. */
  13306. direction2: Vector3;
  13307. /**
  13308. * 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.
  13309. */
  13310. minEmitBox: Vector3;
  13311. /**
  13312. * 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.
  13313. */
  13314. maxEmitBox: Vector3;
  13315. /**
  13316. * Creates a new instance BoxParticleEmitter
  13317. */
  13318. constructor();
  13319. /**
  13320. * Called by the particle System when the direction is computed for the created particle.
  13321. * @param worldMatrix is the world matrix of the particle system
  13322. * @param directionToUpdate is the direction vector to update with the result
  13323. * @param particle is the particle we are computed the direction for
  13324. * @param isLocal defines if the direction should be set in local space
  13325. */
  13326. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13327. /**
  13328. * Called by the particle System when the position is computed for the created particle.
  13329. * @param worldMatrix is the world matrix of the particle system
  13330. * @param positionToUpdate is the position vector to update with the result
  13331. * @param particle is the particle we are computed the position for
  13332. * @param isLocal defines if the position should be set in local space
  13333. */
  13334. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13335. /**
  13336. * Clones the current emitter and returns a copy of it
  13337. * @returns the new emitter
  13338. */
  13339. clone(): BoxParticleEmitter;
  13340. /**
  13341. * Called by the GPUParticleSystem to setup the update shader
  13342. * @param effect defines the update shader
  13343. */
  13344. applyToShader(effect: Effect): void;
  13345. /**
  13346. * Returns a string to use to update the GPU particles update shader
  13347. * @returns a string containng the defines string
  13348. */
  13349. getEffectDefines(): string;
  13350. /**
  13351. * Returns the string "BoxParticleEmitter"
  13352. * @returns a string containing the class name
  13353. */
  13354. getClassName(): string;
  13355. /**
  13356. * Serializes the particle system to a JSON object.
  13357. * @returns the JSON object
  13358. */
  13359. serialize(): any;
  13360. /**
  13361. * Parse properties from a JSON object
  13362. * @param serializationObject defines the JSON object
  13363. */
  13364. parse(serializationObject: any): void;
  13365. }
  13366. }
  13367. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13368. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13369. import { Effect } from "babylonjs/Materials/effect";
  13370. import { Particle } from "babylonjs/Particles/particle";
  13371. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13372. /**
  13373. * Particle emitter emitting particles from the inside of a cone.
  13374. * It emits the particles alongside the cone volume from the base to the particle.
  13375. * The emission direction might be randomized.
  13376. */
  13377. export class ConeParticleEmitter implements IParticleEmitterType {
  13378. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13379. directionRandomizer: number;
  13380. private _radius;
  13381. private _angle;
  13382. private _height;
  13383. /**
  13384. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13385. */
  13386. radiusRange: number;
  13387. /**
  13388. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13389. */
  13390. heightRange: number;
  13391. /**
  13392. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13393. */
  13394. emitFromSpawnPointOnly: boolean;
  13395. /**
  13396. * Gets or sets the radius of the emission cone
  13397. */
  13398. get radius(): number;
  13399. set radius(value: number);
  13400. /**
  13401. * Gets or sets the angle of the emission cone
  13402. */
  13403. get angle(): number;
  13404. set angle(value: number);
  13405. private _buildHeight;
  13406. /**
  13407. * Creates a new instance ConeParticleEmitter
  13408. * @param radius the radius of the emission cone (1 by default)
  13409. * @param angle the cone base angle (PI by default)
  13410. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13411. */
  13412. constructor(radius?: number, angle?: number,
  13413. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13414. directionRandomizer?: number);
  13415. /**
  13416. * Called by the particle System when the direction is computed for the created particle.
  13417. * @param worldMatrix is the world matrix of the particle system
  13418. * @param directionToUpdate is the direction vector to update with the result
  13419. * @param particle is the particle we are computed the direction for
  13420. * @param isLocal defines if the direction should be set in local space
  13421. */
  13422. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13423. /**
  13424. * Called by the particle System when the position is computed for the created particle.
  13425. * @param worldMatrix is the world matrix of the particle system
  13426. * @param positionToUpdate is the position vector to update with the result
  13427. * @param particle is the particle we are computed the position for
  13428. * @param isLocal defines if the position should be set in local space
  13429. */
  13430. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13431. /**
  13432. * Clones the current emitter and returns a copy of it
  13433. * @returns the new emitter
  13434. */
  13435. clone(): ConeParticleEmitter;
  13436. /**
  13437. * Called by the GPUParticleSystem to setup the update shader
  13438. * @param effect defines the update shader
  13439. */
  13440. applyToShader(effect: Effect): void;
  13441. /**
  13442. * Returns a string to use to update the GPU particles update shader
  13443. * @returns a string containng the defines string
  13444. */
  13445. getEffectDefines(): string;
  13446. /**
  13447. * Returns the string "ConeParticleEmitter"
  13448. * @returns a string containing the class name
  13449. */
  13450. getClassName(): string;
  13451. /**
  13452. * Serializes the particle system to a JSON object.
  13453. * @returns the JSON object
  13454. */
  13455. serialize(): any;
  13456. /**
  13457. * Parse properties from a JSON object
  13458. * @param serializationObject defines the JSON object
  13459. */
  13460. parse(serializationObject: any): void;
  13461. }
  13462. }
  13463. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13464. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13465. import { Effect } from "babylonjs/Materials/effect";
  13466. import { Particle } from "babylonjs/Particles/particle";
  13467. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13468. /**
  13469. * Particle emitter emitting particles from the inside of a cylinder.
  13470. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13471. */
  13472. export class CylinderParticleEmitter implements IParticleEmitterType {
  13473. /**
  13474. * The radius of the emission cylinder.
  13475. */
  13476. radius: number;
  13477. /**
  13478. * The height of the emission cylinder.
  13479. */
  13480. height: number;
  13481. /**
  13482. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13483. */
  13484. radiusRange: number;
  13485. /**
  13486. * How much to randomize the particle direction [0-1].
  13487. */
  13488. directionRandomizer: number;
  13489. /**
  13490. * Creates a new instance CylinderParticleEmitter
  13491. * @param radius the radius of the emission cylinder (1 by default)
  13492. * @param height the height of the emission cylinder (1 by default)
  13493. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13494. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13495. */
  13496. constructor(
  13497. /**
  13498. * The radius of the emission cylinder.
  13499. */
  13500. radius?: number,
  13501. /**
  13502. * The height of the emission cylinder.
  13503. */
  13504. height?: number,
  13505. /**
  13506. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13507. */
  13508. radiusRange?: number,
  13509. /**
  13510. * How much to randomize the particle direction [0-1].
  13511. */
  13512. directionRandomizer?: number);
  13513. /**
  13514. * Called by the particle System when the direction is computed for the created particle.
  13515. * @param worldMatrix is the world matrix of the particle system
  13516. * @param directionToUpdate is the direction vector to update with the result
  13517. * @param particle is the particle we are computed the direction for
  13518. * @param isLocal defines if the direction should be set in local space
  13519. */
  13520. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13521. /**
  13522. * Called by the particle System when the position is computed for the created particle.
  13523. * @param worldMatrix is the world matrix of the particle system
  13524. * @param positionToUpdate is the position vector to update with the result
  13525. * @param particle is the particle we are computed the position for
  13526. * @param isLocal defines if the position should be set in local space
  13527. */
  13528. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13529. /**
  13530. * Clones the current emitter and returns a copy of it
  13531. * @returns the new emitter
  13532. */
  13533. clone(): CylinderParticleEmitter;
  13534. /**
  13535. * Called by the GPUParticleSystem to setup the update shader
  13536. * @param effect defines the update shader
  13537. */
  13538. applyToShader(effect: Effect): void;
  13539. /**
  13540. * Returns a string to use to update the GPU particles update shader
  13541. * @returns a string containng the defines string
  13542. */
  13543. getEffectDefines(): string;
  13544. /**
  13545. * Returns the string "CylinderParticleEmitter"
  13546. * @returns a string containing the class name
  13547. */
  13548. getClassName(): string;
  13549. /**
  13550. * Serializes the particle system to a JSON object.
  13551. * @returns the JSON object
  13552. */
  13553. serialize(): any;
  13554. /**
  13555. * Parse properties from a JSON object
  13556. * @param serializationObject defines the JSON object
  13557. */
  13558. parse(serializationObject: any): void;
  13559. }
  13560. /**
  13561. * Particle emitter emitting particles from the inside of a cylinder.
  13562. * It emits the particles randomly between two vectors.
  13563. */
  13564. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13565. /**
  13566. * The min limit of the emission direction.
  13567. */
  13568. direction1: Vector3;
  13569. /**
  13570. * The max limit of the emission direction.
  13571. */
  13572. direction2: Vector3;
  13573. /**
  13574. * Creates a new instance CylinderDirectedParticleEmitter
  13575. * @param radius the radius of the emission cylinder (1 by default)
  13576. * @param height the height of the emission cylinder (1 by default)
  13577. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13578. * @param direction1 the min limit of the emission direction (up vector by default)
  13579. * @param direction2 the max limit of the emission direction (up vector by default)
  13580. */
  13581. constructor(radius?: number, height?: number, radiusRange?: number,
  13582. /**
  13583. * The min limit of the emission direction.
  13584. */
  13585. direction1?: Vector3,
  13586. /**
  13587. * The max limit of the emission direction.
  13588. */
  13589. direction2?: Vector3);
  13590. /**
  13591. * Called by the particle System when the direction is computed for the created particle.
  13592. * @param worldMatrix is the world matrix of the particle system
  13593. * @param directionToUpdate is the direction vector to update with the result
  13594. * @param particle is the particle we are computed the direction for
  13595. */
  13596. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13597. /**
  13598. * Clones the current emitter and returns a copy of it
  13599. * @returns the new emitter
  13600. */
  13601. clone(): CylinderDirectedParticleEmitter;
  13602. /**
  13603. * Called by the GPUParticleSystem to setup the update shader
  13604. * @param effect defines the update shader
  13605. */
  13606. applyToShader(effect: Effect): void;
  13607. /**
  13608. * Returns a string to use to update the GPU particles update shader
  13609. * @returns a string containng the defines string
  13610. */
  13611. getEffectDefines(): string;
  13612. /**
  13613. * Returns the string "CylinderDirectedParticleEmitter"
  13614. * @returns a string containing the class name
  13615. */
  13616. getClassName(): string;
  13617. /**
  13618. * Serializes the particle system to a JSON object.
  13619. * @returns the JSON object
  13620. */
  13621. serialize(): any;
  13622. /**
  13623. * Parse properties from a JSON object
  13624. * @param serializationObject defines the JSON object
  13625. */
  13626. parse(serializationObject: any): void;
  13627. }
  13628. }
  13629. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13630. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13631. import { Effect } from "babylonjs/Materials/effect";
  13632. import { Particle } from "babylonjs/Particles/particle";
  13633. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13634. /**
  13635. * Particle emitter emitting particles from the inside of a hemisphere.
  13636. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13637. */
  13638. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13639. /**
  13640. * The radius of the emission hemisphere.
  13641. */
  13642. radius: number;
  13643. /**
  13644. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13645. */
  13646. radiusRange: number;
  13647. /**
  13648. * How much to randomize the particle direction [0-1].
  13649. */
  13650. directionRandomizer: number;
  13651. /**
  13652. * Creates a new instance HemisphericParticleEmitter
  13653. * @param radius the radius of the emission hemisphere (1 by default)
  13654. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13655. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13656. */
  13657. constructor(
  13658. /**
  13659. * The radius of the emission hemisphere.
  13660. */
  13661. radius?: number,
  13662. /**
  13663. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13664. */
  13665. radiusRange?: number,
  13666. /**
  13667. * How much to randomize the particle direction [0-1].
  13668. */
  13669. directionRandomizer?: number);
  13670. /**
  13671. * Called by the particle System when the direction is computed for the created particle.
  13672. * @param worldMatrix is the world matrix of the particle system
  13673. * @param directionToUpdate is the direction vector to update with the result
  13674. * @param particle is the particle we are computed the direction for
  13675. * @param isLocal defines if the direction should be set in local space
  13676. */
  13677. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13678. /**
  13679. * Called by the particle System when the position is computed for the created particle.
  13680. * @param worldMatrix is the world matrix of the particle system
  13681. * @param positionToUpdate is the position vector to update with the result
  13682. * @param particle is the particle we are computed the position for
  13683. * @param isLocal defines if the position should be set in local space
  13684. */
  13685. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13686. /**
  13687. * Clones the current emitter and returns a copy of it
  13688. * @returns the new emitter
  13689. */
  13690. clone(): HemisphericParticleEmitter;
  13691. /**
  13692. * Called by the GPUParticleSystem to setup the update shader
  13693. * @param effect defines the update shader
  13694. */
  13695. applyToShader(effect: Effect): void;
  13696. /**
  13697. * Returns a string to use to update the GPU particles update shader
  13698. * @returns a string containng the defines string
  13699. */
  13700. getEffectDefines(): string;
  13701. /**
  13702. * Returns the string "HemisphericParticleEmitter"
  13703. * @returns a string containing the class name
  13704. */
  13705. getClassName(): string;
  13706. /**
  13707. * Serializes the particle system to a JSON object.
  13708. * @returns the JSON object
  13709. */
  13710. serialize(): any;
  13711. /**
  13712. * Parse properties from a JSON object
  13713. * @param serializationObject defines the JSON object
  13714. */
  13715. parse(serializationObject: any): void;
  13716. }
  13717. }
  13718. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  13719. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13720. import { Effect } from "babylonjs/Materials/effect";
  13721. import { Particle } from "babylonjs/Particles/particle";
  13722. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13723. /**
  13724. * Particle emitter emitting particles from a point.
  13725. * It emits the particles randomly between 2 given directions.
  13726. */
  13727. export class PointParticleEmitter implements IParticleEmitterType {
  13728. /**
  13729. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13730. */
  13731. direction1: Vector3;
  13732. /**
  13733. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13734. */
  13735. direction2: Vector3;
  13736. /**
  13737. * Creates a new instance PointParticleEmitter
  13738. */
  13739. constructor();
  13740. /**
  13741. * Called by the particle System when the direction is computed for the created particle.
  13742. * @param worldMatrix is the world matrix of the particle system
  13743. * @param directionToUpdate is the direction vector to update with the result
  13744. * @param particle is the particle we are computed the direction for
  13745. * @param isLocal defines if the direction should be set in local space
  13746. */
  13747. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13748. /**
  13749. * Called by the particle System when the position is computed for the created particle.
  13750. * @param worldMatrix is the world matrix of the particle system
  13751. * @param positionToUpdate is the position vector to update with the result
  13752. * @param particle is the particle we are computed the position for
  13753. * @param isLocal defines if the position should be set in local space
  13754. */
  13755. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13756. /**
  13757. * Clones the current emitter and returns a copy of it
  13758. * @returns the new emitter
  13759. */
  13760. clone(): PointParticleEmitter;
  13761. /**
  13762. * Called by the GPUParticleSystem to setup the update shader
  13763. * @param effect defines the update shader
  13764. */
  13765. applyToShader(effect: Effect): void;
  13766. /**
  13767. * Returns a string to use to update the GPU particles update shader
  13768. * @returns a string containng the defines string
  13769. */
  13770. getEffectDefines(): string;
  13771. /**
  13772. * Returns the string "PointParticleEmitter"
  13773. * @returns a string containing the class name
  13774. */
  13775. getClassName(): string;
  13776. /**
  13777. * Serializes the particle system to a JSON object.
  13778. * @returns the JSON object
  13779. */
  13780. serialize(): any;
  13781. /**
  13782. * Parse properties from a JSON object
  13783. * @param serializationObject defines the JSON object
  13784. */
  13785. parse(serializationObject: any): void;
  13786. }
  13787. }
  13788. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  13789. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13790. import { Effect } from "babylonjs/Materials/effect";
  13791. import { Particle } from "babylonjs/Particles/particle";
  13792. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13793. /**
  13794. * Particle emitter emitting particles from the inside of a sphere.
  13795. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  13796. */
  13797. export class SphereParticleEmitter implements IParticleEmitterType {
  13798. /**
  13799. * The radius of the emission sphere.
  13800. */
  13801. radius: number;
  13802. /**
  13803. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13804. */
  13805. radiusRange: number;
  13806. /**
  13807. * How much to randomize the particle direction [0-1].
  13808. */
  13809. directionRandomizer: number;
  13810. /**
  13811. * Creates a new instance SphereParticleEmitter
  13812. * @param radius the radius of the emission sphere (1 by default)
  13813. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13814. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13815. */
  13816. constructor(
  13817. /**
  13818. * The radius of the emission sphere.
  13819. */
  13820. radius?: number,
  13821. /**
  13822. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13823. */
  13824. radiusRange?: number,
  13825. /**
  13826. * How much to randomize the particle direction [0-1].
  13827. */
  13828. directionRandomizer?: number);
  13829. /**
  13830. * Called by the particle System when the direction is computed for the created particle.
  13831. * @param worldMatrix is the world matrix of the particle system
  13832. * @param directionToUpdate is the direction vector to update with the result
  13833. * @param particle is the particle we are computed the direction for
  13834. * @param isLocal defines if the direction should be set in local space
  13835. */
  13836. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13837. /**
  13838. * Called by the particle System when the position is computed for the created particle.
  13839. * @param worldMatrix is the world matrix of the particle system
  13840. * @param positionToUpdate is the position vector to update with the result
  13841. * @param particle is the particle we are computed the position for
  13842. * @param isLocal defines if the position should be set in local space
  13843. */
  13844. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13845. /**
  13846. * Clones the current emitter and returns a copy of it
  13847. * @returns the new emitter
  13848. */
  13849. clone(): SphereParticleEmitter;
  13850. /**
  13851. * Called by the GPUParticleSystem to setup the update shader
  13852. * @param effect defines the update shader
  13853. */
  13854. applyToShader(effect: Effect): void;
  13855. /**
  13856. * Returns a string to use to update the GPU particles update shader
  13857. * @returns a string containng the defines string
  13858. */
  13859. getEffectDefines(): string;
  13860. /**
  13861. * Returns the string "SphereParticleEmitter"
  13862. * @returns a string containing the class name
  13863. */
  13864. getClassName(): string;
  13865. /**
  13866. * Serializes the particle system to a JSON object.
  13867. * @returns the JSON object
  13868. */
  13869. serialize(): any;
  13870. /**
  13871. * Parse properties from a JSON object
  13872. * @param serializationObject defines the JSON object
  13873. */
  13874. parse(serializationObject: any): void;
  13875. }
  13876. /**
  13877. * Particle emitter emitting particles from the inside of a sphere.
  13878. * It emits the particles randomly between two vectors.
  13879. */
  13880. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  13881. /**
  13882. * The min limit of the emission direction.
  13883. */
  13884. direction1: Vector3;
  13885. /**
  13886. * The max limit of the emission direction.
  13887. */
  13888. direction2: Vector3;
  13889. /**
  13890. * Creates a new instance SphereDirectedParticleEmitter
  13891. * @param radius the radius of the emission sphere (1 by default)
  13892. * @param direction1 the min limit of the emission direction (up vector by default)
  13893. * @param direction2 the max limit of the emission direction (up vector by default)
  13894. */
  13895. constructor(radius?: number,
  13896. /**
  13897. * The min limit of the emission direction.
  13898. */
  13899. direction1?: Vector3,
  13900. /**
  13901. * The max limit of the emission direction.
  13902. */
  13903. direction2?: Vector3);
  13904. /**
  13905. * Called by the particle System when the direction is computed for the created particle.
  13906. * @param worldMatrix is the world matrix of the particle system
  13907. * @param directionToUpdate is the direction vector to update with the result
  13908. * @param particle is the particle we are computed the direction for
  13909. */
  13910. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13911. /**
  13912. * Clones the current emitter and returns a copy of it
  13913. * @returns the new emitter
  13914. */
  13915. clone(): SphereDirectedParticleEmitter;
  13916. /**
  13917. * Called by the GPUParticleSystem to setup the update shader
  13918. * @param effect defines the update shader
  13919. */
  13920. applyToShader(effect: Effect): void;
  13921. /**
  13922. * Returns a string to use to update the GPU particles update shader
  13923. * @returns a string containng the defines string
  13924. */
  13925. getEffectDefines(): string;
  13926. /**
  13927. * Returns the string "SphereDirectedParticleEmitter"
  13928. * @returns a string containing the class name
  13929. */
  13930. getClassName(): string;
  13931. /**
  13932. * Serializes the particle system to a JSON object.
  13933. * @returns the JSON object
  13934. */
  13935. serialize(): any;
  13936. /**
  13937. * Parse properties from a JSON object
  13938. * @param serializationObject defines the JSON object
  13939. */
  13940. parse(serializationObject: any): void;
  13941. }
  13942. }
  13943. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  13944. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13945. import { Effect } from "babylonjs/Materials/effect";
  13946. import { Particle } from "babylonjs/Particles/particle";
  13947. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13948. import { Nullable } from "babylonjs/types";
  13949. /**
  13950. * Particle emitter emitting particles from a custom list of positions.
  13951. */
  13952. export class CustomParticleEmitter implements IParticleEmitterType {
  13953. /**
  13954. * Gets or sets the position generator that will create the inital position of each particle.
  13955. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  13956. */
  13957. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  13958. /**
  13959. * Gets or sets the destination generator that will create the final destination of each particle.
  13960. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  13961. */
  13962. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  13963. /**
  13964. * Creates a new instance CustomParticleEmitter
  13965. */
  13966. constructor();
  13967. /**
  13968. * Called by the particle System when the direction is computed for the created particle.
  13969. * @param worldMatrix is the world matrix of the particle system
  13970. * @param directionToUpdate is the direction vector to update with the result
  13971. * @param particle is the particle we are computed the direction for
  13972. * @param isLocal defines if the direction should be set in local space
  13973. */
  13974. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13975. /**
  13976. * Called by the particle System when the position is computed for the created particle.
  13977. * @param worldMatrix is the world matrix of the particle system
  13978. * @param positionToUpdate is the position vector to update with the result
  13979. * @param particle is the particle we are computed the position for
  13980. * @param isLocal defines if the position should be set in local space
  13981. */
  13982. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13983. /**
  13984. * Clones the current emitter and returns a copy of it
  13985. * @returns the new emitter
  13986. */
  13987. clone(): CustomParticleEmitter;
  13988. /**
  13989. * Called by the GPUParticleSystem to setup the update shader
  13990. * @param effect defines the update shader
  13991. */
  13992. applyToShader(effect: Effect): void;
  13993. /**
  13994. * Returns a string to use to update the GPU particles update shader
  13995. * @returns a string containng the defines string
  13996. */
  13997. getEffectDefines(): string;
  13998. /**
  13999. * Returns the string "PointParticleEmitter"
  14000. * @returns a string containing the class name
  14001. */
  14002. getClassName(): string;
  14003. /**
  14004. * Serializes the particle system to a JSON object.
  14005. * @returns the JSON object
  14006. */
  14007. serialize(): any;
  14008. /**
  14009. * Parse properties from a JSON object
  14010. * @param serializationObject defines the JSON object
  14011. */
  14012. parse(serializationObject: any): void;
  14013. }
  14014. }
  14015. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14016. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14017. import { Effect } from "babylonjs/Materials/effect";
  14018. import { Particle } from "babylonjs/Particles/particle";
  14019. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14020. import { Nullable } from "babylonjs/types";
  14021. import { Scene } from "babylonjs/scene";
  14022. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14023. /**
  14024. * Particle emitter emitting particles from the inside of a box.
  14025. * It emits the particles randomly between 2 given directions.
  14026. */
  14027. export class MeshParticleEmitter implements IParticleEmitterType {
  14028. private _indices;
  14029. private _positions;
  14030. private _normals;
  14031. private _storedNormal;
  14032. private _mesh;
  14033. /**
  14034. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14035. */
  14036. direction1: Vector3;
  14037. /**
  14038. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14039. */
  14040. direction2: Vector3;
  14041. /**
  14042. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14043. */
  14044. useMeshNormalsForDirection: boolean;
  14045. /** Defines the mesh to use as source */
  14046. get mesh(): Nullable<AbstractMesh>;
  14047. set mesh(value: Nullable<AbstractMesh>);
  14048. /**
  14049. * Creates a new instance MeshParticleEmitter
  14050. * @param mesh defines the mesh to use as source
  14051. */
  14052. constructor(mesh?: Nullable<AbstractMesh>);
  14053. /**
  14054. * Called by the particle System when the direction is computed for the created particle.
  14055. * @param worldMatrix is the world matrix of the particle system
  14056. * @param directionToUpdate is the direction vector to update with the result
  14057. * @param particle is the particle we are computed the direction for
  14058. * @param isLocal defines if the direction should be set in local space
  14059. */
  14060. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14061. /**
  14062. * Called by the particle System when the position is computed for the created particle.
  14063. * @param worldMatrix is the world matrix of the particle system
  14064. * @param positionToUpdate is the position vector to update with the result
  14065. * @param particle is the particle we are computed the position for
  14066. * @param isLocal defines if the position should be set in local space
  14067. */
  14068. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14069. /**
  14070. * Clones the current emitter and returns a copy of it
  14071. * @returns the new emitter
  14072. */
  14073. clone(): MeshParticleEmitter;
  14074. /**
  14075. * Called by the GPUParticleSystem to setup the update shader
  14076. * @param effect defines the update shader
  14077. */
  14078. applyToShader(effect: Effect): void;
  14079. /**
  14080. * Returns a string to use to update the GPU particles update shader
  14081. * @returns a string containng the defines string
  14082. */
  14083. getEffectDefines(): string;
  14084. /**
  14085. * Returns the string "BoxParticleEmitter"
  14086. * @returns a string containing the class name
  14087. */
  14088. getClassName(): string;
  14089. /**
  14090. * Serializes the particle system to a JSON object.
  14091. * @returns the JSON object
  14092. */
  14093. serialize(): any;
  14094. /**
  14095. * Parse properties from a JSON object
  14096. * @param serializationObject defines the JSON object
  14097. * @param scene defines the hosting scene
  14098. */
  14099. parse(serializationObject: any, scene: Scene): void;
  14100. }
  14101. }
  14102. declare module "babylonjs/Particles/EmitterTypes/index" {
  14103. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14104. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14105. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14106. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14107. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14108. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14109. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14110. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14111. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14112. }
  14113. declare module "babylonjs/Particles/IParticleSystem" {
  14114. import { Nullable } from "babylonjs/types";
  14115. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  14116. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14117. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14118. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14119. import { Texture } from "babylonjs/Materials/Textures/texture";
  14120. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14121. import { Scene } from "babylonjs/scene";
  14122. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14123. import { Effect } from "babylonjs/Materials/effect";
  14124. import { Observable } from "babylonjs/Misc/observable";
  14125. import { Animation } from "babylonjs/Animations/animation";
  14126. /**
  14127. * Interface representing a particle system in Babylon.js.
  14128. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14129. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14130. */
  14131. export interface IParticleSystem {
  14132. /**
  14133. * List of animations used by the particle system.
  14134. */
  14135. animations: Animation[];
  14136. /**
  14137. * The id of the Particle system.
  14138. */
  14139. id: string;
  14140. /**
  14141. * The name of the Particle system.
  14142. */
  14143. name: string;
  14144. /**
  14145. * The emitter represents the Mesh or position we are attaching the particle system to.
  14146. */
  14147. emitter: Nullable<AbstractMesh | Vector3>;
  14148. /**
  14149. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14150. */
  14151. isBillboardBased: boolean;
  14152. /**
  14153. * The rendering group used by the Particle system to chose when to render.
  14154. */
  14155. renderingGroupId: number;
  14156. /**
  14157. * The layer mask we are rendering the particles through.
  14158. */
  14159. layerMask: number;
  14160. /**
  14161. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14162. */
  14163. updateSpeed: number;
  14164. /**
  14165. * The amount of time the particle system is running (depends of the overall update speed).
  14166. */
  14167. targetStopDuration: number;
  14168. /**
  14169. * The texture used to render each particle. (this can be a spritesheet)
  14170. */
  14171. particleTexture: Nullable<Texture>;
  14172. /**
  14173. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14174. */
  14175. blendMode: number;
  14176. /**
  14177. * Minimum life time of emitting particles.
  14178. */
  14179. minLifeTime: number;
  14180. /**
  14181. * Maximum life time of emitting particles.
  14182. */
  14183. maxLifeTime: number;
  14184. /**
  14185. * Minimum Size of emitting particles.
  14186. */
  14187. minSize: number;
  14188. /**
  14189. * Maximum Size of emitting particles.
  14190. */
  14191. maxSize: number;
  14192. /**
  14193. * Minimum scale of emitting particles on X axis.
  14194. */
  14195. minScaleX: number;
  14196. /**
  14197. * Maximum scale of emitting particles on X axis.
  14198. */
  14199. maxScaleX: number;
  14200. /**
  14201. * Minimum scale of emitting particles on Y axis.
  14202. */
  14203. minScaleY: number;
  14204. /**
  14205. * Maximum scale of emitting particles on Y axis.
  14206. */
  14207. maxScaleY: number;
  14208. /**
  14209. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14210. */
  14211. color1: Color4;
  14212. /**
  14213. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14214. */
  14215. color2: Color4;
  14216. /**
  14217. * Color the particle will have at the end of its lifetime.
  14218. */
  14219. colorDead: Color4;
  14220. /**
  14221. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14222. */
  14223. emitRate: number;
  14224. /**
  14225. * You can use gravity if you want to give an orientation to your particles.
  14226. */
  14227. gravity: Vector3;
  14228. /**
  14229. * Minimum power of emitting particles.
  14230. */
  14231. minEmitPower: number;
  14232. /**
  14233. * Maximum power of emitting particles.
  14234. */
  14235. maxEmitPower: number;
  14236. /**
  14237. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14238. */
  14239. minAngularSpeed: number;
  14240. /**
  14241. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14242. */
  14243. maxAngularSpeed: number;
  14244. /**
  14245. * Gets or sets the minimal initial rotation in radians.
  14246. */
  14247. minInitialRotation: number;
  14248. /**
  14249. * Gets or sets the maximal initial rotation in radians.
  14250. */
  14251. maxInitialRotation: number;
  14252. /**
  14253. * The particle emitter type defines the emitter used by the particle system.
  14254. * It can be for example box, sphere, or cone...
  14255. */
  14256. particleEmitterType: Nullable<IParticleEmitterType>;
  14257. /**
  14258. * Defines the delay in milliseconds before starting the system (0 by default)
  14259. */
  14260. startDelay: number;
  14261. /**
  14262. * 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
  14263. */
  14264. preWarmCycles: number;
  14265. /**
  14266. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14267. */
  14268. preWarmStepOffset: number;
  14269. /**
  14270. * 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)
  14271. */
  14272. spriteCellChangeSpeed: number;
  14273. /**
  14274. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14275. */
  14276. startSpriteCellID: number;
  14277. /**
  14278. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14279. */
  14280. endSpriteCellID: number;
  14281. /**
  14282. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14283. */
  14284. spriteCellWidth: number;
  14285. /**
  14286. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14287. */
  14288. spriteCellHeight: number;
  14289. /**
  14290. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14291. */
  14292. spriteRandomStartCell: boolean;
  14293. /**
  14294. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14295. */
  14296. isAnimationSheetEnabled: boolean;
  14297. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14298. translationPivot: Vector2;
  14299. /**
  14300. * Gets or sets a texture used to add random noise to particle positions
  14301. */
  14302. noiseTexture: Nullable<BaseTexture>;
  14303. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14304. noiseStrength: Vector3;
  14305. /**
  14306. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14307. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14308. */
  14309. billboardMode: number;
  14310. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14311. limitVelocityDamping: number;
  14312. /**
  14313. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14314. */
  14315. beginAnimationOnStart: boolean;
  14316. /**
  14317. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14318. */
  14319. beginAnimationFrom: number;
  14320. /**
  14321. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14322. */
  14323. beginAnimationTo: number;
  14324. /**
  14325. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14326. */
  14327. beginAnimationLoop: boolean;
  14328. /**
  14329. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14330. */
  14331. disposeOnStop: boolean;
  14332. /**
  14333. * Specifies if the particles are updated in emitter local space or world space
  14334. */
  14335. isLocal: boolean;
  14336. /** Snippet ID if the particle system was created from the snippet server */
  14337. snippetId: string;
  14338. /**
  14339. * Gets the maximum number of particles active at the same time.
  14340. * @returns The max number of active particles.
  14341. */
  14342. getCapacity(): number;
  14343. /**
  14344. * Gets the number of particles active at the same time.
  14345. * @returns The number of active particles.
  14346. */
  14347. getActiveCount(): number;
  14348. /**
  14349. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14350. * @returns True if it has been started, otherwise false.
  14351. */
  14352. isStarted(): boolean;
  14353. /**
  14354. * Animates the particle system for this frame.
  14355. */
  14356. animate(): void;
  14357. /**
  14358. * Renders the particle system in its current state.
  14359. * @returns the current number of particles
  14360. */
  14361. render(): number;
  14362. /**
  14363. * Dispose the particle system and frees its associated resources.
  14364. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14365. */
  14366. dispose(disposeTexture?: boolean): void;
  14367. /**
  14368. * An event triggered when the system is disposed
  14369. */
  14370. onDisposeObservable: Observable<IParticleSystem>;
  14371. /**
  14372. * Clones the particle system.
  14373. * @param name The name of the cloned object
  14374. * @param newEmitter The new emitter to use
  14375. * @returns the cloned particle system
  14376. */
  14377. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14378. /**
  14379. * Serializes the particle system to a JSON object
  14380. * @param serializeTexture defines if the texture must be serialized as well
  14381. * @returns the JSON object
  14382. */
  14383. serialize(serializeTexture: boolean): any;
  14384. /**
  14385. * Rebuild the particle system
  14386. */
  14387. rebuild(): void;
  14388. /** Force the system to rebuild all gradients that need to be resync */
  14389. forceRefreshGradients(): void;
  14390. /**
  14391. * Starts the particle system and begins to emit
  14392. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14393. */
  14394. start(delay?: number): void;
  14395. /**
  14396. * Stops the particle system.
  14397. */
  14398. stop(): void;
  14399. /**
  14400. * Remove all active particles
  14401. */
  14402. reset(): void;
  14403. /**
  14404. * Gets a boolean indicating that the system is stopping
  14405. * @returns true if the system is currently stopping
  14406. */
  14407. isStopping(): boolean;
  14408. /**
  14409. * Is this system ready to be used/rendered
  14410. * @return true if the system is ready
  14411. */
  14412. isReady(): boolean;
  14413. /**
  14414. * Returns the string "ParticleSystem"
  14415. * @returns a string containing the class name
  14416. */
  14417. getClassName(): string;
  14418. /**
  14419. * Gets the custom effect used to render the particles
  14420. * @param blendMode Blend mode for which the effect should be retrieved
  14421. * @returns The effect
  14422. */
  14423. getCustomEffect(blendMode: number): Nullable<Effect>;
  14424. /**
  14425. * Sets the custom effect used to render the particles
  14426. * @param effect The effect to set
  14427. * @param blendMode Blend mode for which the effect should be set
  14428. */
  14429. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14430. /**
  14431. * Fill the defines array according to the current settings of the particle system
  14432. * @param defines Array to be updated
  14433. * @param blendMode blend mode to take into account when updating the array
  14434. */
  14435. fillDefines(defines: Array<string>, blendMode: number): void;
  14436. /**
  14437. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14438. * @param uniforms Uniforms array to fill
  14439. * @param attributes Attributes array to fill
  14440. * @param samplers Samplers array to fill
  14441. */
  14442. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14443. /**
  14444. * Observable that will be called just before the particles are drawn
  14445. */
  14446. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14447. /**
  14448. * Gets the name of the particle vertex shader
  14449. */
  14450. vertexShaderName: string;
  14451. /**
  14452. * Adds a new color gradient
  14453. * @param gradient defines the gradient to use (between 0 and 1)
  14454. * @param color1 defines the color to affect to the specified gradient
  14455. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14456. * @returns the current particle system
  14457. */
  14458. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14459. /**
  14460. * Remove a specific color gradient
  14461. * @param gradient defines the gradient to remove
  14462. * @returns the current particle system
  14463. */
  14464. removeColorGradient(gradient: number): IParticleSystem;
  14465. /**
  14466. * Adds a new size gradient
  14467. * @param gradient defines the gradient to use (between 0 and 1)
  14468. * @param factor defines the size factor to affect to the specified gradient
  14469. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14470. * @returns the current particle system
  14471. */
  14472. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14473. /**
  14474. * Remove a specific size gradient
  14475. * @param gradient defines the gradient to remove
  14476. * @returns the current particle system
  14477. */
  14478. removeSizeGradient(gradient: number): IParticleSystem;
  14479. /**
  14480. * Gets the current list of color gradients.
  14481. * You must use addColorGradient and removeColorGradient to udpate this list
  14482. * @returns the list of color gradients
  14483. */
  14484. getColorGradients(): Nullable<Array<ColorGradient>>;
  14485. /**
  14486. * Gets the current list of size gradients.
  14487. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14488. * @returns the list of size gradients
  14489. */
  14490. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14491. /**
  14492. * Gets the current list of angular speed gradients.
  14493. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14494. * @returns the list of angular speed gradients
  14495. */
  14496. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14497. /**
  14498. * Adds a new angular speed gradient
  14499. * @param gradient defines the gradient to use (between 0 and 1)
  14500. * @param factor defines the angular speed to affect to the specified gradient
  14501. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14502. * @returns the current particle system
  14503. */
  14504. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14505. /**
  14506. * Remove a specific angular speed gradient
  14507. * @param gradient defines the gradient to remove
  14508. * @returns the current particle system
  14509. */
  14510. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14511. /**
  14512. * Gets the current list of velocity gradients.
  14513. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14514. * @returns the list of velocity gradients
  14515. */
  14516. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14517. /**
  14518. * Adds a new velocity gradient
  14519. * @param gradient defines the gradient to use (between 0 and 1)
  14520. * @param factor defines the velocity to affect to the specified gradient
  14521. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14522. * @returns the current particle system
  14523. */
  14524. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14525. /**
  14526. * Remove a specific velocity gradient
  14527. * @param gradient defines the gradient to remove
  14528. * @returns the current particle system
  14529. */
  14530. removeVelocityGradient(gradient: number): IParticleSystem;
  14531. /**
  14532. * Gets the current list of limit velocity gradients.
  14533. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14534. * @returns the list of limit velocity gradients
  14535. */
  14536. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14537. /**
  14538. * Adds a new limit velocity gradient
  14539. * @param gradient defines the gradient to use (between 0 and 1)
  14540. * @param factor defines the limit velocity to affect to the specified gradient
  14541. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14542. * @returns the current particle system
  14543. */
  14544. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14545. /**
  14546. * Remove a specific limit velocity gradient
  14547. * @param gradient defines the gradient to remove
  14548. * @returns the current particle system
  14549. */
  14550. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14551. /**
  14552. * Adds a new drag gradient
  14553. * @param gradient defines the gradient to use (between 0 and 1)
  14554. * @param factor defines the drag to affect to the specified gradient
  14555. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14556. * @returns the current particle system
  14557. */
  14558. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14559. /**
  14560. * Remove a specific drag gradient
  14561. * @param gradient defines the gradient to remove
  14562. * @returns the current particle system
  14563. */
  14564. removeDragGradient(gradient: number): IParticleSystem;
  14565. /**
  14566. * Gets the current list of drag gradients.
  14567. * You must use addDragGradient and removeDragGradient to udpate this list
  14568. * @returns the list of drag gradients
  14569. */
  14570. getDragGradients(): Nullable<Array<FactorGradient>>;
  14571. /**
  14572. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14573. * @param gradient defines the gradient to use (between 0 and 1)
  14574. * @param factor defines the emit rate to affect to the specified gradient
  14575. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14576. * @returns the current particle system
  14577. */
  14578. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14579. /**
  14580. * Remove a specific emit rate gradient
  14581. * @param gradient defines the gradient to remove
  14582. * @returns the current particle system
  14583. */
  14584. removeEmitRateGradient(gradient: number): IParticleSystem;
  14585. /**
  14586. * Gets the current list of emit rate gradients.
  14587. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14588. * @returns the list of emit rate gradients
  14589. */
  14590. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14591. /**
  14592. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14593. * @param gradient defines the gradient to use (between 0 and 1)
  14594. * @param factor defines the start size to affect to the specified gradient
  14595. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14596. * @returns the current particle system
  14597. */
  14598. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14599. /**
  14600. * Remove a specific start size gradient
  14601. * @param gradient defines the gradient to remove
  14602. * @returns the current particle system
  14603. */
  14604. removeStartSizeGradient(gradient: number): IParticleSystem;
  14605. /**
  14606. * Gets the current list of start size gradients.
  14607. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14608. * @returns the list of start size gradients
  14609. */
  14610. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14611. /**
  14612. * Adds a new life time gradient
  14613. * @param gradient defines the gradient to use (between 0 and 1)
  14614. * @param factor defines the life time factor to affect to the specified gradient
  14615. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14616. * @returns the current particle system
  14617. */
  14618. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14619. /**
  14620. * Remove a specific life time gradient
  14621. * @param gradient defines the gradient to remove
  14622. * @returns the current particle system
  14623. */
  14624. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14625. /**
  14626. * Gets the current list of life time gradients.
  14627. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14628. * @returns the list of life time gradients
  14629. */
  14630. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14631. /**
  14632. * Gets the current list of color gradients.
  14633. * You must use addColorGradient and removeColorGradient to udpate this list
  14634. * @returns the list of color gradients
  14635. */
  14636. getColorGradients(): Nullable<Array<ColorGradient>>;
  14637. /**
  14638. * Adds a new ramp gradient used to remap particle colors
  14639. * @param gradient defines the gradient to use (between 0 and 1)
  14640. * @param color defines the color to affect to the specified gradient
  14641. * @returns the current particle system
  14642. */
  14643. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14644. /**
  14645. * Gets the current list of ramp gradients.
  14646. * You must use addRampGradient and removeRampGradient to udpate this list
  14647. * @returns the list of ramp gradients
  14648. */
  14649. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14650. /** Gets or sets a boolean indicating that ramp gradients must be used
  14651. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14652. */
  14653. useRampGradients: boolean;
  14654. /**
  14655. * Adds a new color remap gradient
  14656. * @param gradient defines the gradient to use (between 0 and 1)
  14657. * @param min defines the color remap minimal range
  14658. * @param max defines the color remap maximal range
  14659. * @returns the current particle system
  14660. */
  14661. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14662. /**
  14663. * Gets the current list of color remap gradients.
  14664. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14665. * @returns the list of color remap gradients
  14666. */
  14667. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14668. /**
  14669. * Adds a new alpha remap gradient
  14670. * @param gradient defines the gradient to use (between 0 and 1)
  14671. * @param min defines the alpha remap minimal range
  14672. * @param max defines the alpha remap maximal range
  14673. * @returns the current particle system
  14674. */
  14675. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14676. /**
  14677. * Gets the current list of alpha remap gradients.
  14678. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14679. * @returns the list of alpha remap gradients
  14680. */
  14681. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14682. /**
  14683. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14684. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14685. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14686. * @returns the emitter
  14687. */
  14688. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14689. /**
  14690. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14691. * @param radius The radius of the hemisphere to emit from
  14692. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14693. * @returns the emitter
  14694. */
  14695. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14696. /**
  14697. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14698. * @param radius The radius of the sphere to emit from
  14699. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14700. * @returns the emitter
  14701. */
  14702. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14703. /**
  14704. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14705. * @param radius The radius of the sphere to emit from
  14706. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14707. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14708. * @returns the emitter
  14709. */
  14710. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14711. /**
  14712. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14713. * @param radius The radius of the emission cylinder
  14714. * @param height The height of the emission cylinder
  14715. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14716. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14717. * @returns the emitter
  14718. */
  14719. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  14720. /**
  14721. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14722. * @param radius The radius of the cylinder to emit from
  14723. * @param height The height of the emission cylinder
  14724. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14725. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14726. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14727. * @returns the emitter
  14728. */
  14729. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14730. /**
  14731. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14732. * @param radius The radius of the cone to emit from
  14733. * @param angle The base angle of the cone
  14734. * @returns the emitter
  14735. */
  14736. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  14737. /**
  14738. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14739. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14740. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14741. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14742. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14743. * @returns the emitter
  14744. */
  14745. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14746. /**
  14747. * Get hosting scene
  14748. * @returns the scene
  14749. */
  14750. getScene(): Scene;
  14751. }
  14752. }
  14753. declare module "babylonjs/Meshes/transformNode" {
  14754. import { DeepImmutable } from "babylonjs/types";
  14755. import { Observable } from "babylonjs/Misc/observable";
  14756. import { Nullable } from "babylonjs/types";
  14757. import { Camera } from "babylonjs/Cameras/camera";
  14758. import { Scene } from "babylonjs/scene";
  14759. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14760. import { Node } from "babylonjs/node";
  14761. import { Bone } from "babylonjs/Bones/bone";
  14762. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14763. import { Space } from "babylonjs/Maths/math.axis";
  14764. /**
  14765. * 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.
  14766. * @see https://doc.babylonjs.com/how_to/transformnode
  14767. */
  14768. export class TransformNode extends Node {
  14769. /**
  14770. * Object will not rotate to face the camera
  14771. */
  14772. static BILLBOARDMODE_NONE: number;
  14773. /**
  14774. * Object will rotate to face the camera but only on the x axis
  14775. */
  14776. static BILLBOARDMODE_X: number;
  14777. /**
  14778. * Object will rotate to face the camera but only on the y axis
  14779. */
  14780. static BILLBOARDMODE_Y: number;
  14781. /**
  14782. * Object will rotate to face the camera but only on the z axis
  14783. */
  14784. static BILLBOARDMODE_Z: number;
  14785. /**
  14786. * Object will rotate to face the camera
  14787. */
  14788. static BILLBOARDMODE_ALL: number;
  14789. /**
  14790. * Object will rotate to face the camera's position instead of orientation
  14791. */
  14792. static BILLBOARDMODE_USE_POSITION: number;
  14793. private static _TmpRotation;
  14794. private static _TmpScaling;
  14795. private static _TmpTranslation;
  14796. private _forward;
  14797. private _forwardInverted;
  14798. private _up;
  14799. private _right;
  14800. private _rightInverted;
  14801. private _position;
  14802. private _rotation;
  14803. private _rotationQuaternion;
  14804. protected _scaling: Vector3;
  14805. protected _isDirty: boolean;
  14806. private _transformToBoneReferal;
  14807. private _isAbsoluteSynced;
  14808. private _billboardMode;
  14809. /**
  14810. * Gets or sets the billboard mode. Default is 0.
  14811. *
  14812. * | Value | Type | Description |
  14813. * | --- | --- | --- |
  14814. * | 0 | BILLBOARDMODE_NONE | |
  14815. * | 1 | BILLBOARDMODE_X | |
  14816. * | 2 | BILLBOARDMODE_Y | |
  14817. * | 4 | BILLBOARDMODE_Z | |
  14818. * | 7 | BILLBOARDMODE_ALL | |
  14819. *
  14820. */
  14821. get billboardMode(): number;
  14822. set billboardMode(value: number);
  14823. private _preserveParentRotationForBillboard;
  14824. /**
  14825. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  14826. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  14827. */
  14828. get preserveParentRotationForBillboard(): boolean;
  14829. set preserveParentRotationForBillboard(value: boolean);
  14830. /**
  14831. * 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
  14832. */
  14833. scalingDeterminant: number;
  14834. private _infiniteDistance;
  14835. /**
  14836. * Gets or sets the distance of the object to max, often used by skybox
  14837. */
  14838. get infiniteDistance(): boolean;
  14839. set infiniteDistance(value: boolean);
  14840. /**
  14841. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  14842. * By default the system will update normals to compensate
  14843. */
  14844. ignoreNonUniformScaling: boolean;
  14845. /**
  14846. * 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
  14847. */
  14848. reIntegrateRotationIntoRotationQuaternion: boolean;
  14849. /** @hidden */
  14850. _poseMatrix: Nullable<Matrix>;
  14851. /** @hidden */
  14852. _localMatrix: Matrix;
  14853. private _usePivotMatrix;
  14854. private _absolutePosition;
  14855. private _absoluteScaling;
  14856. private _absoluteRotationQuaternion;
  14857. private _pivotMatrix;
  14858. private _pivotMatrixInverse;
  14859. protected _postMultiplyPivotMatrix: boolean;
  14860. protected _isWorldMatrixFrozen: boolean;
  14861. /** @hidden */
  14862. _indexInSceneTransformNodesArray: number;
  14863. /**
  14864. * An event triggered after the world matrix is updated
  14865. */
  14866. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  14867. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  14868. /**
  14869. * Gets a string identifying the name of the class
  14870. * @returns "TransformNode" string
  14871. */
  14872. getClassName(): string;
  14873. /**
  14874. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  14875. */
  14876. get position(): Vector3;
  14877. set position(newPosition: Vector3);
  14878. /**
  14879. * 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)).
  14880. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  14881. */
  14882. get rotation(): Vector3;
  14883. set rotation(newRotation: Vector3);
  14884. /**
  14885. * 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)).
  14886. */
  14887. get scaling(): Vector3;
  14888. set scaling(newScaling: Vector3);
  14889. /**
  14890. * 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).
  14891. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  14892. */
  14893. get rotationQuaternion(): Nullable<Quaternion>;
  14894. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  14895. /**
  14896. * The forward direction of that transform in world space.
  14897. */
  14898. get forward(): Vector3;
  14899. /**
  14900. * The up direction of that transform in world space.
  14901. */
  14902. get up(): Vector3;
  14903. /**
  14904. * The right direction of that transform in world space.
  14905. */
  14906. get right(): Vector3;
  14907. /**
  14908. * Copies the parameter passed Matrix into the mesh Pose matrix.
  14909. * @param matrix the matrix to copy the pose from
  14910. * @returns this TransformNode.
  14911. */
  14912. updatePoseMatrix(matrix: Matrix): TransformNode;
  14913. /**
  14914. * Returns the mesh Pose matrix.
  14915. * @returns the pose matrix
  14916. */
  14917. getPoseMatrix(): Matrix;
  14918. /** @hidden */
  14919. _isSynchronized(): boolean;
  14920. /** @hidden */
  14921. _initCache(): void;
  14922. /**
  14923. * Flag the transform node as dirty (Forcing it to update everything)
  14924. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  14925. * @returns this transform node
  14926. */
  14927. markAsDirty(property: string): TransformNode;
  14928. /**
  14929. * Returns the current mesh absolute position.
  14930. * Returns a Vector3.
  14931. */
  14932. get absolutePosition(): Vector3;
  14933. /**
  14934. * Returns the current mesh absolute scaling.
  14935. * Returns a Vector3.
  14936. */
  14937. get absoluteScaling(): Vector3;
  14938. /**
  14939. * Returns the current mesh absolute rotation.
  14940. * Returns a Quaternion.
  14941. */
  14942. get absoluteRotationQuaternion(): Quaternion;
  14943. /**
  14944. * Sets a new matrix to apply before all other transformation
  14945. * @param matrix defines the transform matrix
  14946. * @returns the current TransformNode
  14947. */
  14948. setPreTransformMatrix(matrix: Matrix): TransformNode;
  14949. /**
  14950. * Sets a new pivot matrix to the current node
  14951. * @param matrix defines the new pivot matrix to use
  14952. * @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
  14953. * @returns the current TransformNode
  14954. */
  14955. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  14956. /**
  14957. * Returns the mesh pivot matrix.
  14958. * Default : Identity.
  14959. * @returns the matrix
  14960. */
  14961. getPivotMatrix(): Matrix;
  14962. /**
  14963. * Instantiate (when possible) or clone that node with its hierarchy
  14964. * @param newParent defines the new parent to use for the instance (or clone)
  14965. * @param options defines options to configure how copy is done
  14966. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  14967. * @returns an instance (or a clone) of the current node with its hiearchy
  14968. */
  14969. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  14970. doNotInstantiate: boolean;
  14971. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  14972. /**
  14973. * Prevents the World matrix to be computed any longer
  14974. * @param newWorldMatrix defines an optional matrix to use as world matrix
  14975. * @returns the TransformNode.
  14976. */
  14977. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  14978. /**
  14979. * Allows back the World matrix computation.
  14980. * @returns the TransformNode.
  14981. */
  14982. unfreezeWorldMatrix(): this;
  14983. /**
  14984. * True if the World matrix has been frozen.
  14985. */
  14986. get isWorldMatrixFrozen(): boolean;
  14987. /**
  14988. * Retuns the mesh absolute position in the World.
  14989. * @returns a Vector3.
  14990. */
  14991. getAbsolutePosition(): Vector3;
  14992. /**
  14993. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  14994. * @param absolutePosition the absolute position to set
  14995. * @returns the TransformNode.
  14996. */
  14997. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  14998. /**
  14999. * Sets the mesh position in its local space.
  15000. * @param vector3 the position to set in localspace
  15001. * @returns the TransformNode.
  15002. */
  15003. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15004. /**
  15005. * Returns the mesh position in the local space from the current World matrix values.
  15006. * @returns a new Vector3.
  15007. */
  15008. getPositionExpressedInLocalSpace(): Vector3;
  15009. /**
  15010. * Translates the mesh along the passed Vector3 in its local space.
  15011. * @param vector3 the distance to translate in localspace
  15012. * @returns the TransformNode.
  15013. */
  15014. locallyTranslate(vector3: Vector3): TransformNode;
  15015. private static _lookAtVectorCache;
  15016. /**
  15017. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15018. * @param targetPoint the position (must be in same space as current mesh) to look at
  15019. * @param yawCor optional yaw (y-axis) correction in radians
  15020. * @param pitchCor optional pitch (x-axis) correction in radians
  15021. * @param rollCor optional roll (z-axis) correction in radians
  15022. * @param space the choosen space of the target
  15023. * @returns the TransformNode.
  15024. */
  15025. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15026. /**
  15027. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15028. * This Vector3 is expressed in the World space.
  15029. * @param localAxis axis to rotate
  15030. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15031. */
  15032. getDirection(localAxis: Vector3): Vector3;
  15033. /**
  15034. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15035. * localAxis is expressed in the mesh local space.
  15036. * result is computed in the Wordl space from the mesh World matrix.
  15037. * @param localAxis axis to rotate
  15038. * @param result the resulting transformnode
  15039. * @returns this TransformNode.
  15040. */
  15041. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15042. /**
  15043. * Sets this transform node rotation to the given local axis.
  15044. * @param localAxis the axis in local space
  15045. * @param yawCor optional yaw (y-axis) correction in radians
  15046. * @param pitchCor optional pitch (x-axis) correction in radians
  15047. * @param rollCor optional roll (z-axis) correction in radians
  15048. * @returns this TransformNode
  15049. */
  15050. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15051. /**
  15052. * Sets a new pivot point to the current node
  15053. * @param point defines the new pivot point to use
  15054. * @param space defines if the point is in world or local space (local by default)
  15055. * @returns the current TransformNode
  15056. */
  15057. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15058. /**
  15059. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15060. * @returns the pivot point
  15061. */
  15062. getPivotPoint(): Vector3;
  15063. /**
  15064. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15065. * @param result the vector3 to store the result
  15066. * @returns this TransformNode.
  15067. */
  15068. getPivotPointToRef(result: Vector3): TransformNode;
  15069. /**
  15070. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15071. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15072. */
  15073. getAbsolutePivotPoint(): Vector3;
  15074. /**
  15075. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15076. * @param result vector3 to store the result
  15077. * @returns this TransformNode.
  15078. */
  15079. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15080. /**
  15081. * Defines the passed node as the parent of the current node.
  15082. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15083. * @see https://doc.babylonjs.com/how_to/parenting
  15084. * @param node the node ot set as the parent
  15085. * @returns this TransformNode.
  15086. */
  15087. setParent(node: Nullable<Node>): TransformNode;
  15088. private _nonUniformScaling;
  15089. /**
  15090. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15091. */
  15092. get nonUniformScaling(): boolean;
  15093. /** @hidden */
  15094. _updateNonUniformScalingState(value: boolean): boolean;
  15095. /**
  15096. * Attach the current TransformNode to another TransformNode associated with a bone
  15097. * @param bone Bone affecting the TransformNode
  15098. * @param affectedTransformNode TransformNode associated with the bone
  15099. * @returns this object
  15100. */
  15101. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15102. /**
  15103. * Detach the transform node if its associated with a bone
  15104. * @returns this object
  15105. */
  15106. detachFromBone(): TransformNode;
  15107. private static _rotationAxisCache;
  15108. /**
  15109. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15110. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15111. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15112. * The passed axis is also normalized.
  15113. * @param axis the axis to rotate around
  15114. * @param amount the amount to rotate in radians
  15115. * @param space Space to rotate in (Default: local)
  15116. * @returns the TransformNode.
  15117. */
  15118. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15119. /**
  15120. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15121. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15122. * The passed axis is also normalized. .
  15123. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15124. * @param point the point to rotate around
  15125. * @param axis the axis to rotate around
  15126. * @param amount the amount to rotate in radians
  15127. * @returns the TransformNode
  15128. */
  15129. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15130. /**
  15131. * Translates the mesh along the axis vector for the passed distance in the given space.
  15132. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15133. * @param axis the axis to translate in
  15134. * @param distance the distance to translate
  15135. * @param space Space to rotate in (Default: local)
  15136. * @returns the TransformNode.
  15137. */
  15138. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15139. /**
  15140. * Adds a rotation step to the mesh current rotation.
  15141. * x, y, z are Euler angles expressed in radians.
  15142. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15143. * This means this rotation is made in the mesh local space only.
  15144. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15145. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15146. * ```javascript
  15147. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15148. * ```
  15149. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15150. * 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.
  15151. * @param x Rotation to add
  15152. * @param y Rotation to add
  15153. * @param z Rotation to add
  15154. * @returns the TransformNode.
  15155. */
  15156. addRotation(x: number, y: number, z: number): TransformNode;
  15157. /**
  15158. * @hidden
  15159. */
  15160. protected _getEffectiveParent(): Nullable<Node>;
  15161. /**
  15162. * Computes the world matrix of the node
  15163. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15164. * @returns the world matrix
  15165. */
  15166. computeWorldMatrix(force?: boolean): Matrix;
  15167. /**
  15168. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15169. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15170. */
  15171. resetLocalMatrix(independentOfChildren?: boolean): void;
  15172. protected _afterComputeWorldMatrix(): void;
  15173. /**
  15174. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15175. * @param func callback function to add
  15176. *
  15177. * @returns the TransformNode.
  15178. */
  15179. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15180. /**
  15181. * Removes a registered callback function.
  15182. * @param func callback function to remove
  15183. * @returns the TransformNode.
  15184. */
  15185. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15186. /**
  15187. * Gets the position of the current mesh in camera space
  15188. * @param camera defines the camera to use
  15189. * @returns a position
  15190. */
  15191. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15192. /**
  15193. * Returns the distance from the mesh to the active camera
  15194. * @param camera defines the camera to use
  15195. * @returns the distance
  15196. */
  15197. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15198. /**
  15199. * Clone the current transform node
  15200. * @param name Name of the new clone
  15201. * @param newParent New parent for the clone
  15202. * @param doNotCloneChildren Do not clone children hierarchy
  15203. * @returns the new transform node
  15204. */
  15205. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15206. /**
  15207. * Serializes the objects information.
  15208. * @param currentSerializationObject defines the object to serialize in
  15209. * @returns the serialized object
  15210. */
  15211. serialize(currentSerializationObject?: any): any;
  15212. /**
  15213. * Returns a new TransformNode object parsed from the source provided.
  15214. * @param parsedTransformNode is the source.
  15215. * @param scene the scne the object belongs to
  15216. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15217. * @returns a new TransformNode object parsed from the source provided.
  15218. */
  15219. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15220. /**
  15221. * Get all child-transformNodes of this node
  15222. * @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
  15223. * @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
  15224. * @returns an array of TransformNode
  15225. */
  15226. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15227. /**
  15228. * Releases resources associated with this transform node.
  15229. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15230. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15231. */
  15232. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15233. /**
  15234. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15235. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15236. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15237. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15238. * @returns the current mesh
  15239. */
  15240. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15241. private _syncAbsoluteScalingAndRotation;
  15242. }
  15243. }
  15244. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15245. /**
  15246. * Class used to override all child animations of a given target
  15247. */
  15248. export class AnimationPropertiesOverride {
  15249. /**
  15250. * Gets or sets a value indicating if animation blending must be used
  15251. */
  15252. enableBlending: boolean;
  15253. /**
  15254. * Gets or sets the blending speed to use when enableBlending is true
  15255. */
  15256. blendingSpeed: number;
  15257. /**
  15258. * Gets or sets the default loop mode to use
  15259. */
  15260. loopMode: number;
  15261. }
  15262. }
  15263. declare module "babylonjs/Bones/bone" {
  15264. import { Skeleton } from "babylonjs/Bones/skeleton";
  15265. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15266. import { Nullable } from "babylonjs/types";
  15267. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15268. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15269. import { Node } from "babylonjs/node";
  15270. import { Space } from "babylonjs/Maths/math.axis";
  15271. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15272. /**
  15273. * Class used to store bone information
  15274. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15275. */
  15276. export class Bone extends Node {
  15277. /**
  15278. * defines the bone name
  15279. */
  15280. name: string;
  15281. private static _tmpVecs;
  15282. private static _tmpQuat;
  15283. private static _tmpMats;
  15284. /**
  15285. * Gets the list of child bones
  15286. */
  15287. children: Bone[];
  15288. /** Gets the animations associated with this bone */
  15289. animations: import("babylonjs/Animations/animation").Animation[];
  15290. /**
  15291. * Gets or sets bone length
  15292. */
  15293. length: number;
  15294. /**
  15295. * @hidden Internal only
  15296. * Set this value to map this bone to a different index in the transform matrices
  15297. * Set this value to -1 to exclude the bone from the transform matrices
  15298. */
  15299. _index: Nullable<number>;
  15300. private _skeleton;
  15301. private _localMatrix;
  15302. private _restPose;
  15303. private _baseMatrix;
  15304. private _absoluteTransform;
  15305. private _invertedAbsoluteTransform;
  15306. private _parent;
  15307. private _scalingDeterminant;
  15308. private _worldTransform;
  15309. private _localScaling;
  15310. private _localRotation;
  15311. private _localPosition;
  15312. private _needToDecompose;
  15313. private _needToCompose;
  15314. /** @hidden */
  15315. _linkedTransformNode: Nullable<TransformNode>;
  15316. /** @hidden */
  15317. _waitingTransformNodeId: Nullable<string>;
  15318. /** @hidden */
  15319. get _matrix(): Matrix;
  15320. /** @hidden */
  15321. set _matrix(value: Matrix);
  15322. /**
  15323. * Create a new bone
  15324. * @param name defines the bone name
  15325. * @param skeleton defines the parent skeleton
  15326. * @param parentBone defines the parent (can be null if the bone is the root)
  15327. * @param localMatrix defines the local matrix
  15328. * @param restPose defines the rest pose matrix
  15329. * @param baseMatrix defines the base matrix
  15330. * @param index defines index of the bone in the hiearchy
  15331. */
  15332. constructor(
  15333. /**
  15334. * defines the bone name
  15335. */
  15336. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15337. /**
  15338. * Gets the current object class name.
  15339. * @return the class name
  15340. */
  15341. getClassName(): string;
  15342. /**
  15343. * Gets the parent skeleton
  15344. * @returns a skeleton
  15345. */
  15346. getSkeleton(): Skeleton;
  15347. /**
  15348. * Gets parent bone
  15349. * @returns a bone or null if the bone is the root of the bone hierarchy
  15350. */
  15351. getParent(): Nullable<Bone>;
  15352. /**
  15353. * Returns an array containing the root bones
  15354. * @returns an array containing the root bones
  15355. */
  15356. getChildren(): Array<Bone>;
  15357. /**
  15358. * Gets the node index in matrix array generated for rendering
  15359. * @returns the node index
  15360. */
  15361. getIndex(): number;
  15362. /**
  15363. * Sets the parent bone
  15364. * @param parent defines the parent (can be null if the bone is the root)
  15365. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15366. */
  15367. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15368. /**
  15369. * Gets the local matrix
  15370. * @returns a matrix
  15371. */
  15372. getLocalMatrix(): Matrix;
  15373. /**
  15374. * Gets the base matrix (initial matrix which remains unchanged)
  15375. * @returns a matrix
  15376. */
  15377. getBaseMatrix(): Matrix;
  15378. /**
  15379. * Gets the rest pose matrix
  15380. * @returns a matrix
  15381. */
  15382. getRestPose(): Matrix;
  15383. /**
  15384. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15385. */
  15386. getWorldMatrix(): Matrix;
  15387. /**
  15388. * Sets the local matrix to rest pose matrix
  15389. */
  15390. returnToRest(): void;
  15391. /**
  15392. * Gets the inverse of the absolute transform matrix.
  15393. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15394. * @returns a matrix
  15395. */
  15396. getInvertedAbsoluteTransform(): Matrix;
  15397. /**
  15398. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15399. * @returns a matrix
  15400. */
  15401. getAbsoluteTransform(): Matrix;
  15402. /**
  15403. * Links with the given transform node.
  15404. * The local matrix of this bone is copied from the transform node every frame.
  15405. * @param transformNode defines the transform node to link to
  15406. */
  15407. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15408. /**
  15409. * Gets the node used to drive the bone's transformation
  15410. * @returns a transform node or null
  15411. */
  15412. getTransformNode(): Nullable<TransformNode>;
  15413. /** Gets or sets current position (in local space) */
  15414. get position(): Vector3;
  15415. set position(newPosition: Vector3);
  15416. /** Gets or sets current rotation (in local space) */
  15417. get rotation(): Vector3;
  15418. set rotation(newRotation: Vector3);
  15419. /** Gets or sets current rotation quaternion (in local space) */
  15420. get rotationQuaternion(): Quaternion;
  15421. set rotationQuaternion(newRotation: Quaternion);
  15422. /** Gets or sets current scaling (in local space) */
  15423. get scaling(): Vector3;
  15424. set scaling(newScaling: Vector3);
  15425. /**
  15426. * Gets the animation properties override
  15427. */
  15428. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15429. private _decompose;
  15430. private _compose;
  15431. /**
  15432. * Update the base and local matrices
  15433. * @param matrix defines the new base or local matrix
  15434. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15435. * @param updateLocalMatrix defines if the local matrix should be updated
  15436. */
  15437. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15438. /** @hidden */
  15439. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15440. /**
  15441. * Flag the bone as dirty (Forcing it to update everything)
  15442. */
  15443. markAsDirty(): void;
  15444. /** @hidden */
  15445. _markAsDirtyAndCompose(): void;
  15446. private _markAsDirtyAndDecompose;
  15447. /**
  15448. * Translate the bone in local or world space
  15449. * @param vec The amount to translate the bone
  15450. * @param space The space that the translation is in
  15451. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15452. */
  15453. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15454. /**
  15455. * Set the postion of the bone in local or world space
  15456. * @param position The position to set the bone
  15457. * @param space The space that the position is in
  15458. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15459. */
  15460. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15461. /**
  15462. * Set the absolute position of the bone (world space)
  15463. * @param position The position to set the bone
  15464. * @param mesh The mesh that this bone is attached to
  15465. */
  15466. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15467. /**
  15468. * Scale the bone on the x, y and z axes (in local space)
  15469. * @param x The amount to scale the bone on the x axis
  15470. * @param y The amount to scale the bone on the y axis
  15471. * @param z The amount to scale the bone on the z axis
  15472. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15473. */
  15474. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15475. /**
  15476. * Set the bone scaling in local space
  15477. * @param scale defines the scaling vector
  15478. */
  15479. setScale(scale: Vector3): void;
  15480. /**
  15481. * Gets the current scaling in local space
  15482. * @returns the current scaling vector
  15483. */
  15484. getScale(): Vector3;
  15485. /**
  15486. * Gets the current scaling in local space and stores it in a target vector
  15487. * @param result defines the target vector
  15488. */
  15489. getScaleToRef(result: Vector3): void;
  15490. /**
  15491. * Set the yaw, pitch, and roll of the bone in local or world space
  15492. * @param yaw The rotation of the bone on the y axis
  15493. * @param pitch The rotation of the bone on the x axis
  15494. * @param roll The rotation of the bone on the z axis
  15495. * @param space The space that the axes of rotation are in
  15496. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15497. */
  15498. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15499. /**
  15500. * Add a rotation to the bone on an axis in local or world space
  15501. * @param axis The axis to rotate the bone on
  15502. * @param amount The amount to rotate the bone
  15503. * @param space The space that the axis is in
  15504. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15505. */
  15506. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15507. /**
  15508. * Set the rotation of the bone to a particular axis angle in local or world space
  15509. * @param axis The axis to rotate the bone on
  15510. * @param angle The angle that the bone should be rotated to
  15511. * @param space The space that the axis is in
  15512. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15513. */
  15514. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15515. /**
  15516. * Set the euler rotation of the bone in local of world space
  15517. * @param rotation The euler rotation that the bone should be set to
  15518. * @param space The space that the rotation is in
  15519. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15520. */
  15521. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15522. /**
  15523. * Set the quaternion rotation of the bone in local of world space
  15524. * @param quat The quaternion rotation that the bone should be set to
  15525. * @param space The space that the rotation is in
  15526. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15527. */
  15528. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15529. /**
  15530. * Set the rotation matrix of the bone in local of world space
  15531. * @param rotMat The rotation matrix that the bone should be set to
  15532. * @param space The space that the rotation is in
  15533. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15534. */
  15535. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15536. private _rotateWithMatrix;
  15537. private _getNegativeRotationToRef;
  15538. /**
  15539. * Get the position of the bone in local or world space
  15540. * @param space The space that the returned position is in
  15541. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15542. * @returns The position of the bone
  15543. */
  15544. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15545. /**
  15546. * Copy the position of the bone to a vector3 in local or world space
  15547. * @param space The space that the returned position is in
  15548. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15549. * @param result The vector3 to copy the position to
  15550. */
  15551. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15552. /**
  15553. * Get the absolute position of the bone (world space)
  15554. * @param mesh The mesh that this bone is attached to
  15555. * @returns The absolute position of the bone
  15556. */
  15557. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15558. /**
  15559. * Copy the absolute position of the bone (world space) to the result param
  15560. * @param mesh The mesh that this bone is attached to
  15561. * @param result The vector3 to copy the absolute position to
  15562. */
  15563. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15564. /**
  15565. * Compute the absolute transforms of this bone and its children
  15566. */
  15567. computeAbsoluteTransforms(): void;
  15568. /**
  15569. * Get the world direction from an axis that is in the local space of the bone
  15570. * @param localAxis The local direction that is used to compute the world direction
  15571. * @param mesh The mesh that this bone is attached to
  15572. * @returns The world direction
  15573. */
  15574. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15575. /**
  15576. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15577. * @param localAxis The local direction that is used to compute the world direction
  15578. * @param mesh The mesh that this bone is attached to
  15579. * @param result The vector3 that the world direction will be copied to
  15580. */
  15581. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15582. /**
  15583. * Get the euler rotation of the bone in local or world space
  15584. * @param space The space that the rotation should be in
  15585. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15586. * @returns The euler rotation
  15587. */
  15588. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15589. /**
  15590. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15591. * @param space The space that the rotation should be in
  15592. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15593. * @param result The vector3 that the rotation should be copied to
  15594. */
  15595. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15596. /**
  15597. * Get the quaternion rotation of the bone in either local or world space
  15598. * @param space The space that the rotation should be in
  15599. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15600. * @returns The quaternion rotation
  15601. */
  15602. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15603. /**
  15604. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15605. * @param space The space that the rotation should be in
  15606. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15607. * @param result The quaternion that the rotation should be copied to
  15608. */
  15609. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15610. /**
  15611. * Get the rotation matrix of the bone in local or world space
  15612. * @param space The space that the rotation should be in
  15613. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15614. * @returns The rotation matrix
  15615. */
  15616. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15617. /**
  15618. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15619. * @param space The space that the rotation should be in
  15620. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15621. * @param result The quaternion that the rotation should be copied to
  15622. */
  15623. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15624. /**
  15625. * Get the world position of a point that is in the local space of the bone
  15626. * @param position The local position
  15627. * @param mesh The mesh that this bone is attached to
  15628. * @returns The world position
  15629. */
  15630. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15631. /**
  15632. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15633. * @param position The local position
  15634. * @param mesh The mesh that this bone is attached to
  15635. * @param result The vector3 that the world position should be copied to
  15636. */
  15637. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15638. /**
  15639. * Get the local position of a point that is in world space
  15640. * @param position The world position
  15641. * @param mesh The mesh that this bone is attached to
  15642. * @returns The local position
  15643. */
  15644. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15645. /**
  15646. * Get the local position of a point that is in world space and copy it to the result param
  15647. * @param position The world position
  15648. * @param mesh The mesh that this bone is attached to
  15649. * @param result The vector3 that the local position should be copied to
  15650. */
  15651. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15652. }
  15653. }
  15654. declare module "babylonjs/Animations/runtimeAnimation" {
  15655. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15656. import { Animatable } from "babylonjs/Animations/animatable";
  15657. import { Scene } from "babylonjs/scene";
  15658. /**
  15659. * Defines a runtime animation
  15660. */
  15661. export class RuntimeAnimation {
  15662. private _events;
  15663. /**
  15664. * The current frame of the runtime animation
  15665. */
  15666. private _currentFrame;
  15667. /**
  15668. * The animation used by the runtime animation
  15669. */
  15670. private _animation;
  15671. /**
  15672. * The target of the runtime animation
  15673. */
  15674. private _target;
  15675. /**
  15676. * The initiating animatable
  15677. */
  15678. private _host;
  15679. /**
  15680. * The original value of the runtime animation
  15681. */
  15682. private _originalValue;
  15683. /**
  15684. * The original blend value of the runtime animation
  15685. */
  15686. private _originalBlendValue;
  15687. /**
  15688. * The offsets cache of the runtime animation
  15689. */
  15690. private _offsetsCache;
  15691. /**
  15692. * The high limits cache of the runtime animation
  15693. */
  15694. private _highLimitsCache;
  15695. /**
  15696. * Specifies if the runtime animation has been stopped
  15697. */
  15698. private _stopped;
  15699. /**
  15700. * The blending factor of the runtime animation
  15701. */
  15702. private _blendingFactor;
  15703. /**
  15704. * The BabylonJS scene
  15705. */
  15706. private _scene;
  15707. /**
  15708. * The current value of the runtime animation
  15709. */
  15710. private _currentValue;
  15711. /** @hidden */
  15712. _animationState: _IAnimationState;
  15713. /**
  15714. * The active target of the runtime animation
  15715. */
  15716. private _activeTargets;
  15717. private _currentActiveTarget;
  15718. private _directTarget;
  15719. /**
  15720. * The target path of the runtime animation
  15721. */
  15722. private _targetPath;
  15723. /**
  15724. * The weight of the runtime animation
  15725. */
  15726. private _weight;
  15727. /**
  15728. * The ratio offset of the runtime animation
  15729. */
  15730. private _ratioOffset;
  15731. /**
  15732. * The previous delay of the runtime animation
  15733. */
  15734. private _previousDelay;
  15735. /**
  15736. * The previous ratio of the runtime animation
  15737. */
  15738. private _previousRatio;
  15739. private _enableBlending;
  15740. private _keys;
  15741. private _minFrame;
  15742. private _maxFrame;
  15743. private _minValue;
  15744. private _maxValue;
  15745. private _targetIsArray;
  15746. /**
  15747. * Gets the current frame of the runtime animation
  15748. */
  15749. get currentFrame(): number;
  15750. /**
  15751. * Gets the weight of the runtime animation
  15752. */
  15753. get weight(): number;
  15754. /**
  15755. * Gets the current value of the runtime animation
  15756. */
  15757. get currentValue(): any;
  15758. /**
  15759. * Gets the target path of the runtime animation
  15760. */
  15761. get targetPath(): string;
  15762. /**
  15763. * Gets the actual target of the runtime animation
  15764. */
  15765. get target(): any;
  15766. /**
  15767. * Gets the additive state of the runtime animation
  15768. */
  15769. get isAdditive(): boolean;
  15770. /** @hidden */
  15771. _onLoop: () => void;
  15772. /**
  15773. * Create a new RuntimeAnimation object
  15774. * @param target defines the target of the animation
  15775. * @param animation defines the source animation object
  15776. * @param scene defines the hosting scene
  15777. * @param host defines the initiating Animatable
  15778. */
  15779. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  15780. private _preparePath;
  15781. /**
  15782. * Gets the animation from the runtime animation
  15783. */
  15784. get animation(): Animation;
  15785. /**
  15786. * Resets the runtime animation to the beginning
  15787. * @param restoreOriginal defines whether to restore the target property to the original value
  15788. */
  15789. reset(restoreOriginal?: boolean): void;
  15790. /**
  15791. * Specifies if the runtime animation is stopped
  15792. * @returns Boolean specifying if the runtime animation is stopped
  15793. */
  15794. isStopped(): boolean;
  15795. /**
  15796. * Disposes of the runtime animation
  15797. */
  15798. dispose(): void;
  15799. /**
  15800. * Apply the interpolated value to the target
  15801. * @param currentValue defines the value computed by the animation
  15802. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  15803. */
  15804. setValue(currentValue: any, weight: number): void;
  15805. private _getOriginalValues;
  15806. private _setValue;
  15807. /**
  15808. * Gets the loop pmode of the runtime animation
  15809. * @returns Loop Mode
  15810. */
  15811. private _getCorrectLoopMode;
  15812. /**
  15813. * Move the current animation to a given frame
  15814. * @param frame defines the frame to move to
  15815. */
  15816. goToFrame(frame: number): void;
  15817. /**
  15818. * @hidden Internal use only
  15819. */
  15820. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  15821. /**
  15822. * Execute the current animation
  15823. * @param delay defines the delay to add to the current frame
  15824. * @param from defines the lower bound of the animation range
  15825. * @param to defines the upper bound of the animation range
  15826. * @param loop defines if the current animation must loop
  15827. * @param speedRatio defines the current speed ratio
  15828. * @param weight defines the weight of the animation (default is -1 so no weight)
  15829. * @param onLoop optional callback called when animation loops
  15830. * @returns a boolean indicating if the animation is running
  15831. */
  15832. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  15833. }
  15834. }
  15835. declare module "babylonjs/Animations/animatable" {
  15836. import { Animation } from "babylonjs/Animations/animation";
  15837. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  15838. import { Nullable } from "babylonjs/types";
  15839. import { Observable } from "babylonjs/Misc/observable";
  15840. import { Scene } from "babylonjs/scene";
  15841. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  15842. import { Node } from "babylonjs/node";
  15843. /**
  15844. * Class used to store an actual running animation
  15845. */
  15846. export class Animatable {
  15847. /** defines the target object */
  15848. target: any;
  15849. /** defines the starting frame number (default is 0) */
  15850. fromFrame: number;
  15851. /** defines the ending frame number (default is 100) */
  15852. toFrame: number;
  15853. /** defines if the animation must loop (default is false) */
  15854. loopAnimation: boolean;
  15855. /** defines a callback to call when animation ends if it is not looping */
  15856. onAnimationEnd?: (() => void) | null | undefined;
  15857. /** defines a callback to call when animation loops */
  15858. onAnimationLoop?: (() => void) | null | undefined;
  15859. /** defines whether the animation should be evaluated additively */
  15860. isAdditive: boolean;
  15861. private _localDelayOffset;
  15862. private _pausedDelay;
  15863. private _runtimeAnimations;
  15864. private _paused;
  15865. private _scene;
  15866. private _speedRatio;
  15867. private _weight;
  15868. private _syncRoot;
  15869. /**
  15870. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  15871. * This will only apply for non looping animation (default is true)
  15872. */
  15873. disposeOnEnd: boolean;
  15874. /**
  15875. * Gets a boolean indicating if the animation has started
  15876. */
  15877. animationStarted: boolean;
  15878. /**
  15879. * Observer raised when the animation ends
  15880. */
  15881. onAnimationEndObservable: Observable<Animatable>;
  15882. /**
  15883. * Observer raised when the animation loops
  15884. */
  15885. onAnimationLoopObservable: Observable<Animatable>;
  15886. /**
  15887. * Gets the root Animatable used to synchronize and normalize animations
  15888. */
  15889. get syncRoot(): Nullable<Animatable>;
  15890. /**
  15891. * Gets the current frame of the first RuntimeAnimation
  15892. * Used to synchronize Animatables
  15893. */
  15894. get masterFrame(): number;
  15895. /**
  15896. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  15897. */
  15898. get weight(): number;
  15899. set weight(value: number);
  15900. /**
  15901. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  15902. */
  15903. get speedRatio(): number;
  15904. set speedRatio(value: number);
  15905. /**
  15906. * Creates a new Animatable
  15907. * @param scene defines the hosting scene
  15908. * @param target defines the target object
  15909. * @param fromFrame defines the starting frame number (default is 0)
  15910. * @param toFrame defines the ending frame number (default is 100)
  15911. * @param loopAnimation defines if the animation must loop (default is false)
  15912. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  15913. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  15914. * @param animations defines a group of animation to add to the new Animatable
  15915. * @param onAnimationLoop defines a callback to call when animation loops
  15916. * @param isAdditive defines whether the animation should be evaluated additively
  15917. */
  15918. constructor(scene: Scene,
  15919. /** defines the target object */
  15920. target: any,
  15921. /** defines the starting frame number (default is 0) */
  15922. fromFrame?: number,
  15923. /** defines the ending frame number (default is 100) */
  15924. toFrame?: number,
  15925. /** defines if the animation must loop (default is false) */
  15926. loopAnimation?: boolean, speedRatio?: number,
  15927. /** defines a callback to call when animation ends if it is not looping */
  15928. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  15929. /** defines a callback to call when animation loops */
  15930. onAnimationLoop?: (() => void) | null | undefined,
  15931. /** defines whether the animation should be evaluated additively */
  15932. isAdditive?: boolean);
  15933. /**
  15934. * Synchronize and normalize current Animatable with a source Animatable
  15935. * This is useful when using animation weights and when animations are not of the same length
  15936. * @param root defines the root Animatable to synchronize with
  15937. * @returns the current Animatable
  15938. */
  15939. syncWith(root: Animatable): Animatable;
  15940. /**
  15941. * Gets the list of runtime animations
  15942. * @returns an array of RuntimeAnimation
  15943. */
  15944. getAnimations(): RuntimeAnimation[];
  15945. /**
  15946. * Adds more animations to the current animatable
  15947. * @param target defines the target of the animations
  15948. * @param animations defines the new animations to add
  15949. */
  15950. appendAnimations(target: any, animations: Animation[]): void;
  15951. /**
  15952. * Gets the source animation for a specific property
  15953. * @param property defines the propertyu to look for
  15954. * @returns null or the source animation for the given property
  15955. */
  15956. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  15957. /**
  15958. * Gets the runtime animation for a specific property
  15959. * @param property defines the propertyu to look for
  15960. * @returns null or the runtime animation for the given property
  15961. */
  15962. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  15963. /**
  15964. * Resets the animatable to its original state
  15965. */
  15966. reset(): void;
  15967. /**
  15968. * Allows the animatable to blend with current running animations
  15969. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  15970. * @param blendingSpeed defines the blending speed to use
  15971. */
  15972. enableBlending(blendingSpeed: number): void;
  15973. /**
  15974. * Disable animation blending
  15975. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  15976. */
  15977. disableBlending(): void;
  15978. /**
  15979. * Jump directly to a given frame
  15980. * @param frame defines the frame to jump to
  15981. */
  15982. goToFrame(frame: number): void;
  15983. /**
  15984. * Pause the animation
  15985. */
  15986. pause(): void;
  15987. /**
  15988. * Restart the animation
  15989. */
  15990. restart(): void;
  15991. private _raiseOnAnimationEnd;
  15992. /**
  15993. * Stop and delete the current animation
  15994. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  15995. * @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)
  15996. */
  15997. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  15998. /**
  15999. * Wait asynchronously for the animation to end
  16000. * @returns a promise which will be fullfilled when the animation ends
  16001. */
  16002. waitAsync(): Promise<Animatable>;
  16003. /** @hidden */
  16004. _animate(delay: number): boolean;
  16005. }
  16006. module "babylonjs/scene" {
  16007. interface Scene {
  16008. /** @hidden */
  16009. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16010. /** @hidden */
  16011. _processLateAnimationBindingsForMatrices(holder: {
  16012. totalWeight: number;
  16013. totalAdditiveWeight: number;
  16014. animations: RuntimeAnimation[];
  16015. additiveAnimations: RuntimeAnimation[];
  16016. originalValue: Matrix;
  16017. }): any;
  16018. /** @hidden */
  16019. _processLateAnimationBindingsForQuaternions(holder: {
  16020. totalWeight: number;
  16021. totalAdditiveWeight: number;
  16022. animations: RuntimeAnimation[];
  16023. additiveAnimations: RuntimeAnimation[];
  16024. originalValue: Quaternion;
  16025. }, refQuaternion: Quaternion): Quaternion;
  16026. /** @hidden */
  16027. _processLateAnimationBindings(): void;
  16028. /**
  16029. * Will start the animation sequence of a given target
  16030. * @param target defines the target
  16031. * @param from defines from which frame should animation start
  16032. * @param to defines until which frame should animation run.
  16033. * @param weight defines the weight to apply to the animation (1.0 by default)
  16034. * @param loop defines if the animation loops
  16035. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16036. * @param onAnimationEnd defines the function to be executed when the animation ends
  16037. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16038. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16039. * @param onAnimationLoop defines the callback to call when an animation loops
  16040. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16041. * @returns the animatable object created for this animation
  16042. */
  16043. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16044. /**
  16045. * Will start the animation sequence of a given target
  16046. * @param target defines the target
  16047. * @param from defines from which frame should animation start
  16048. * @param to defines until which frame should animation run.
  16049. * @param loop defines if the animation loops
  16050. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16051. * @param onAnimationEnd defines the function to be executed when the animation ends
  16052. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16053. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16054. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16055. * @param onAnimationLoop defines the callback to call when an animation loops
  16056. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16057. * @returns the animatable object created for this animation
  16058. */
  16059. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16060. /**
  16061. * Will start the animation sequence of a given target and its hierarchy
  16062. * @param target defines the target
  16063. * @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.
  16064. * @param from defines from which frame should animation start
  16065. * @param to defines until which frame should animation run.
  16066. * @param loop defines if the animation loops
  16067. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16068. * @param onAnimationEnd defines the function to be executed when the animation ends
  16069. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16070. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16071. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16072. * @param onAnimationLoop defines the callback to call when an animation loops
  16073. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16074. * @returns the list of created animatables
  16075. */
  16076. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16077. /**
  16078. * Begin a new animation on a given node
  16079. * @param target defines the target where the animation will take place
  16080. * @param animations defines the list of animations to start
  16081. * @param from defines the initial value
  16082. * @param to defines the final value
  16083. * @param loop defines if you want animation to loop (off by default)
  16084. * @param speedRatio defines the speed ratio to apply to all animations
  16085. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16086. * @param onAnimationLoop defines the callback to call when an animation loops
  16087. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16088. * @returns the list of created animatables
  16089. */
  16090. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16091. /**
  16092. * Begin a new animation on a given node and its hierarchy
  16093. * @param target defines the root node where the animation will take place
  16094. * @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.
  16095. * @param animations defines the list of animations to start
  16096. * @param from defines the initial value
  16097. * @param to defines the final value
  16098. * @param loop defines if you want animation to loop (off by default)
  16099. * @param speedRatio defines the speed ratio to apply to all animations
  16100. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16101. * @param onAnimationLoop defines the callback to call when an animation loops
  16102. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16103. * @returns the list of animatables created for all nodes
  16104. */
  16105. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16106. /**
  16107. * Gets the animatable associated with a specific target
  16108. * @param target defines the target of the animatable
  16109. * @returns the required animatable if found
  16110. */
  16111. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16112. /**
  16113. * Gets all animatables associated with a given target
  16114. * @param target defines the target to look animatables for
  16115. * @returns an array of Animatables
  16116. */
  16117. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16118. /**
  16119. * Stops and removes all animations that have been applied to the scene
  16120. */
  16121. stopAllAnimations(): void;
  16122. /**
  16123. * Gets the current delta time used by animation engine
  16124. */
  16125. deltaTime: number;
  16126. }
  16127. }
  16128. module "babylonjs/Bones/bone" {
  16129. interface Bone {
  16130. /**
  16131. * Copy an animation range from another bone
  16132. * @param source defines the source bone
  16133. * @param rangeName defines the range name to copy
  16134. * @param frameOffset defines the frame offset
  16135. * @param rescaleAsRequired defines if rescaling must be applied if required
  16136. * @param skelDimensionsRatio defines the scaling ratio
  16137. * @returns true if operation was successful
  16138. */
  16139. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16140. }
  16141. }
  16142. }
  16143. declare module "babylonjs/Bones/skeleton" {
  16144. import { Bone } from "babylonjs/Bones/bone";
  16145. import { Observable } from "babylonjs/Misc/observable";
  16146. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16147. import { Scene } from "babylonjs/scene";
  16148. import { Nullable } from "babylonjs/types";
  16149. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16150. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16151. import { Animatable } from "babylonjs/Animations/animatable";
  16152. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16153. import { Animation } from "babylonjs/Animations/animation";
  16154. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16155. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16156. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16157. /**
  16158. * Class used to handle skinning animations
  16159. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16160. */
  16161. export class Skeleton implements IAnimatable {
  16162. /** defines the skeleton name */
  16163. name: string;
  16164. /** defines the skeleton Id */
  16165. id: string;
  16166. /**
  16167. * Defines the list of child bones
  16168. */
  16169. bones: Bone[];
  16170. /**
  16171. * Defines an estimate of the dimension of the skeleton at rest
  16172. */
  16173. dimensionsAtRest: Vector3;
  16174. /**
  16175. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16176. */
  16177. needInitialSkinMatrix: boolean;
  16178. /**
  16179. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16180. */
  16181. overrideMesh: Nullable<AbstractMesh>;
  16182. /**
  16183. * Gets the list of animations attached to this skeleton
  16184. */
  16185. animations: Array<Animation>;
  16186. private _scene;
  16187. private _isDirty;
  16188. private _transformMatrices;
  16189. private _transformMatrixTexture;
  16190. private _meshesWithPoseMatrix;
  16191. private _animatables;
  16192. private _identity;
  16193. private _synchronizedWithMesh;
  16194. private _ranges;
  16195. private _lastAbsoluteTransformsUpdateId;
  16196. private _canUseTextureForBones;
  16197. private _uniqueId;
  16198. /** @hidden */
  16199. _numBonesWithLinkedTransformNode: number;
  16200. /** @hidden */
  16201. _hasWaitingData: Nullable<boolean>;
  16202. /**
  16203. * Specifies if the skeleton should be serialized
  16204. */
  16205. doNotSerialize: boolean;
  16206. private _useTextureToStoreBoneMatrices;
  16207. /**
  16208. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16209. * Please note that this option is not available if the hardware does not support it
  16210. */
  16211. get useTextureToStoreBoneMatrices(): boolean;
  16212. set useTextureToStoreBoneMatrices(value: boolean);
  16213. private _animationPropertiesOverride;
  16214. /**
  16215. * Gets or sets the animation properties override
  16216. */
  16217. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16218. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16219. /**
  16220. * List of inspectable custom properties (used by the Inspector)
  16221. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16222. */
  16223. inspectableCustomProperties: IInspectable[];
  16224. /**
  16225. * An observable triggered before computing the skeleton's matrices
  16226. */
  16227. onBeforeComputeObservable: Observable<Skeleton>;
  16228. /**
  16229. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16230. */
  16231. get isUsingTextureForMatrices(): boolean;
  16232. /**
  16233. * Gets the unique ID of this skeleton
  16234. */
  16235. get uniqueId(): number;
  16236. /**
  16237. * Creates a new skeleton
  16238. * @param name defines the skeleton name
  16239. * @param id defines the skeleton Id
  16240. * @param scene defines the hosting scene
  16241. */
  16242. constructor(
  16243. /** defines the skeleton name */
  16244. name: string,
  16245. /** defines the skeleton Id */
  16246. id: string, scene: Scene);
  16247. /**
  16248. * Gets the current object class name.
  16249. * @return the class name
  16250. */
  16251. getClassName(): string;
  16252. /**
  16253. * Returns an array containing the root bones
  16254. * @returns an array containing the root bones
  16255. */
  16256. getChildren(): Array<Bone>;
  16257. /**
  16258. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16259. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16260. * @returns a Float32Array containing matrices data
  16261. */
  16262. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16263. /**
  16264. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16265. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16266. * @returns a raw texture containing the data
  16267. */
  16268. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16269. /**
  16270. * Gets the current hosting scene
  16271. * @returns a scene object
  16272. */
  16273. getScene(): Scene;
  16274. /**
  16275. * Gets a string representing the current skeleton data
  16276. * @param fullDetails defines a boolean indicating if we want a verbose version
  16277. * @returns a string representing the current skeleton data
  16278. */
  16279. toString(fullDetails?: boolean): string;
  16280. /**
  16281. * Get bone's index searching by name
  16282. * @param name defines bone's name to search for
  16283. * @return the indice of the bone. Returns -1 if not found
  16284. */
  16285. getBoneIndexByName(name: string): number;
  16286. /**
  16287. * Creater a new animation range
  16288. * @param name defines the name of the range
  16289. * @param from defines the start key
  16290. * @param to defines the end key
  16291. */
  16292. createAnimationRange(name: string, from: number, to: number): void;
  16293. /**
  16294. * Delete a specific animation range
  16295. * @param name defines the name of the range
  16296. * @param deleteFrames defines if frames must be removed as well
  16297. */
  16298. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16299. /**
  16300. * Gets a specific animation range
  16301. * @param name defines the name of the range to look for
  16302. * @returns the requested animation range or null if not found
  16303. */
  16304. getAnimationRange(name: string): Nullable<AnimationRange>;
  16305. /**
  16306. * Gets the list of all animation ranges defined on this skeleton
  16307. * @returns an array
  16308. */
  16309. getAnimationRanges(): Nullable<AnimationRange>[];
  16310. /**
  16311. * Copy animation range from a source skeleton.
  16312. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16313. * @param source defines the source skeleton
  16314. * @param name defines the name of the range to copy
  16315. * @param rescaleAsRequired defines if rescaling must be applied if required
  16316. * @returns true if operation was successful
  16317. */
  16318. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16319. /**
  16320. * Forces the skeleton to go to rest pose
  16321. */
  16322. returnToRest(): void;
  16323. private _getHighestAnimationFrame;
  16324. /**
  16325. * Begin a specific animation range
  16326. * @param name defines the name of the range to start
  16327. * @param loop defines if looping must be turned on (false by default)
  16328. * @param speedRatio defines the speed ratio to apply (1 by default)
  16329. * @param onAnimationEnd defines a callback which will be called when animation will end
  16330. * @returns a new animatable
  16331. */
  16332. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16333. /**
  16334. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16335. * @param skeleton defines the Skeleton containing the animation range to convert
  16336. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16337. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16338. * @returns the original skeleton
  16339. */
  16340. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16341. /** @hidden */
  16342. _markAsDirty(): void;
  16343. /** @hidden */
  16344. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16345. /** @hidden */
  16346. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16347. private _computeTransformMatrices;
  16348. /**
  16349. * Build all resources required to render a skeleton
  16350. */
  16351. prepare(): void;
  16352. /**
  16353. * Gets the list of animatables currently running for this skeleton
  16354. * @returns an array of animatables
  16355. */
  16356. getAnimatables(): IAnimatable[];
  16357. /**
  16358. * Clone the current skeleton
  16359. * @param name defines the name of the new skeleton
  16360. * @param id defines the id of the new skeleton
  16361. * @returns the new skeleton
  16362. */
  16363. clone(name: string, id?: string): Skeleton;
  16364. /**
  16365. * Enable animation blending for this skeleton
  16366. * @param blendingSpeed defines the blending speed to apply
  16367. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  16368. */
  16369. enableBlending(blendingSpeed?: number): void;
  16370. /**
  16371. * Releases all resources associated with the current skeleton
  16372. */
  16373. dispose(): void;
  16374. /**
  16375. * Serialize the skeleton in a JSON object
  16376. * @returns a JSON object
  16377. */
  16378. serialize(): any;
  16379. /**
  16380. * Creates a new skeleton from serialized data
  16381. * @param parsedSkeleton defines the serialized data
  16382. * @param scene defines the hosting scene
  16383. * @returns a new skeleton
  16384. */
  16385. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16386. /**
  16387. * Compute all node absolute transforms
  16388. * @param forceUpdate defines if computation must be done even if cache is up to date
  16389. */
  16390. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16391. /**
  16392. * Gets the root pose matrix
  16393. * @returns a matrix
  16394. */
  16395. getPoseMatrix(): Nullable<Matrix>;
  16396. /**
  16397. * Sorts bones per internal index
  16398. */
  16399. sortBones(): void;
  16400. private _sortBones;
  16401. }
  16402. }
  16403. declare module "babylonjs/Meshes/instancedMesh" {
  16404. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16405. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16406. import { Camera } from "babylonjs/Cameras/camera";
  16407. import { Node } from "babylonjs/node";
  16408. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16409. import { Mesh } from "babylonjs/Meshes/mesh";
  16410. import { Material } from "babylonjs/Materials/material";
  16411. import { Skeleton } from "babylonjs/Bones/skeleton";
  16412. import { Light } from "babylonjs/Lights/light";
  16413. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16414. /**
  16415. * Creates an instance based on a source mesh.
  16416. */
  16417. export class InstancedMesh extends AbstractMesh {
  16418. private _sourceMesh;
  16419. private _currentLOD;
  16420. /** @hidden */
  16421. _indexInSourceMeshInstanceArray: number;
  16422. constructor(name: string, source: Mesh);
  16423. /**
  16424. * Returns the string "InstancedMesh".
  16425. */
  16426. getClassName(): string;
  16427. /** Gets the list of lights affecting that mesh */
  16428. get lightSources(): Light[];
  16429. _resyncLightSources(): void;
  16430. _resyncLightSource(light: Light): void;
  16431. _removeLightSource(light: Light, dispose: boolean): void;
  16432. /**
  16433. * If the source mesh receives shadows
  16434. */
  16435. get receiveShadows(): boolean;
  16436. /**
  16437. * The material of the source mesh
  16438. */
  16439. get material(): Nullable<Material>;
  16440. /**
  16441. * Visibility of the source mesh
  16442. */
  16443. get visibility(): number;
  16444. /**
  16445. * Skeleton of the source mesh
  16446. */
  16447. get skeleton(): Nullable<Skeleton>;
  16448. /**
  16449. * Rendering ground id of the source mesh
  16450. */
  16451. get renderingGroupId(): number;
  16452. set renderingGroupId(value: number);
  16453. /**
  16454. * Returns the total number of vertices (integer).
  16455. */
  16456. getTotalVertices(): number;
  16457. /**
  16458. * Returns a positive integer : the total number of indices in this mesh geometry.
  16459. * @returns the numner of indices or zero if the mesh has no geometry.
  16460. */
  16461. getTotalIndices(): number;
  16462. /**
  16463. * The source mesh of the instance
  16464. */
  16465. get sourceMesh(): Mesh;
  16466. /**
  16467. * Creates a new InstancedMesh object from the mesh model.
  16468. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  16469. * @param name defines the name of the new instance
  16470. * @returns a new InstancedMesh
  16471. */
  16472. createInstance(name: string): InstancedMesh;
  16473. /**
  16474. * Is this node ready to be used/rendered
  16475. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16476. * @return {boolean} is it ready
  16477. */
  16478. isReady(completeCheck?: boolean): boolean;
  16479. /**
  16480. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16481. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16482. * @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.
  16483. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16484. */
  16485. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16486. /**
  16487. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16488. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16489. * The `data` are either a numeric array either a Float32Array.
  16490. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16491. * 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).
  16492. * Note that a new underlying VertexBuffer object is created each call.
  16493. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16494. *
  16495. * Possible `kind` values :
  16496. * - VertexBuffer.PositionKind
  16497. * - VertexBuffer.UVKind
  16498. * - VertexBuffer.UV2Kind
  16499. * - VertexBuffer.UV3Kind
  16500. * - VertexBuffer.UV4Kind
  16501. * - VertexBuffer.UV5Kind
  16502. * - VertexBuffer.UV6Kind
  16503. * - VertexBuffer.ColorKind
  16504. * - VertexBuffer.MatricesIndicesKind
  16505. * - VertexBuffer.MatricesIndicesExtraKind
  16506. * - VertexBuffer.MatricesWeightsKind
  16507. * - VertexBuffer.MatricesWeightsExtraKind
  16508. *
  16509. * Returns the Mesh.
  16510. */
  16511. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16512. /**
  16513. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16514. * If the mesh has no geometry, it is simply returned as it is.
  16515. * The `data` are either a numeric array either a Float32Array.
  16516. * No new underlying VertexBuffer object is created.
  16517. * 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.
  16518. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16519. *
  16520. * Possible `kind` values :
  16521. * - VertexBuffer.PositionKind
  16522. * - VertexBuffer.UVKind
  16523. * - VertexBuffer.UV2Kind
  16524. * - VertexBuffer.UV3Kind
  16525. * - VertexBuffer.UV4Kind
  16526. * - VertexBuffer.UV5Kind
  16527. * - VertexBuffer.UV6Kind
  16528. * - VertexBuffer.ColorKind
  16529. * - VertexBuffer.MatricesIndicesKind
  16530. * - VertexBuffer.MatricesIndicesExtraKind
  16531. * - VertexBuffer.MatricesWeightsKind
  16532. * - VertexBuffer.MatricesWeightsExtraKind
  16533. *
  16534. * Returns the Mesh.
  16535. */
  16536. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16537. /**
  16538. * Sets the mesh indices.
  16539. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16540. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16541. * This method creates a new index buffer each call.
  16542. * Returns the Mesh.
  16543. */
  16544. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16545. /**
  16546. * Boolean : True if the mesh owns the requested kind of data.
  16547. */
  16548. isVerticesDataPresent(kind: string): boolean;
  16549. /**
  16550. * Returns an array of indices (IndicesArray).
  16551. */
  16552. getIndices(): Nullable<IndicesArray>;
  16553. get _positions(): Nullable<Vector3[]>;
  16554. /**
  16555. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16556. * This means the mesh underlying bounding box and sphere are recomputed.
  16557. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16558. * @returns the current mesh
  16559. */
  16560. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16561. /** @hidden */
  16562. _preActivate(): InstancedMesh;
  16563. /** @hidden */
  16564. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16565. /** @hidden */
  16566. _postActivate(): void;
  16567. getWorldMatrix(): Matrix;
  16568. get isAnInstance(): boolean;
  16569. /**
  16570. * Returns the current associated LOD AbstractMesh.
  16571. */
  16572. getLOD(camera: Camera): AbstractMesh;
  16573. /** @hidden */
  16574. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16575. /** @hidden */
  16576. _syncSubMeshes(): InstancedMesh;
  16577. /** @hidden */
  16578. _generatePointsArray(): boolean;
  16579. /**
  16580. * Creates a new InstancedMesh from the current mesh.
  16581. * - name (string) : the cloned mesh name
  16582. * - newParent (optional Node) : the optional Node to parent the clone to.
  16583. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16584. *
  16585. * Returns the clone.
  16586. */
  16587. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16588. /**
  16589. * Disposes the InstancedMesh.
  16590. * Returns nothing.
  16591. */
  16592. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16593. }
  16594. module "babylonjs/Meshes/mesh" {
  16595. interface Mesh {
  16596. /**
  16597. * Register a custom buffer that will be instanced
  16598. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16599. * @param kind defines the buffer kind
  16600. * @param stride defines the stride in floats
  16601. */
  16602. registerInstancedBuffer(kind: string, stride: number): void;
  16603. /**
  16604. * true to use the edge renderer for all instances of this mesh
  16605. */
  16606. edgesShareWithInstances: boolean;
  16607. /** @hidden */
  16608. _userInstancedBuffersStorage: {
  16609. data: {
  16610. [key: string]: Float32Array;
  16611. };
  16612. sizes: {
  16613. [key: string]: number;
  16614. };
  16615. vertexBuffers: {
  16616. [key: string]: Nullable<VertexBuffer>;
  16617. };
  16618. strides: {
  16619. [key: string]: number;
  16620. };
  16621. };
  16622. }
  16623. }
  16624. module "babylonjs/Meshes/abstractMesh" {
  16625. interface AbstractMesh {
  16626. /**
  16627. * Object used to store instanced buffers defined by user
  16628. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16629. */
  16630. instancedBuffers: {
  16631. [key: string]: any;
  16632. };
  16633. }
  16634. }
  16635. }
  16636. declare module "babylonjs/Materials/shaderMaterial" {
  16637. import { Nullable } from "babylonjs/types";
  16638. import { Scene } from "babylonjs/scene";
  16639. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16640. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16641. import { Mesh } from "babylonjs/Meshes/mesh";
  16642. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16643. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16644. import { Effect } from "babylonjs/Materials/effect";
  16645. import { Material } from "babylonjs/Materials/material";
  16646. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16647. /**
  16648. * Defines the options associated with the creation of a shader material.
  16649. */
  16650. export interface IShaderMaterialOptions {
  16651. /**
  16652. * Does the material work in alpha blend mode
  16653. */
  16654. needAlphaBlending: boolean;
  16655. /**
  16656. * Does the material work in alpha test mode
  16657. */
  16658. needAlphaTesting: boolean;
  16659. /**
  16660. * The list of attribute names used in the shader
  16661. */
  16662. attributes: string[];
  16663. /**
  16664. * The list of unifrom names used in the shader
  16665. */
  16666. uniforms: string[];
  16667. /**
  16668. * The list of UBO names used in the shader
  16669. */
  16670. uniformBuffers: string[];
  16671. /**
  16672. * The list of sampler names used in the shader
  16673. */
  16674. samplers: string[];
  16675. /**
  16676. * The list of defines used in the shader
  16677. */
  16678. defines: string[];
  16679. }
  16680. /**
  16681. * 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.
  16682. *
  16683. * This returned material effects how the mesh will look based on the code in the shaders.
  16684. *
  16685. * @see http://doc.babylonjs.com/how_to/shader_material
  16686. */
  16687. export class ShaderMaterial extends Material {
  16688. private _shaderPath;
  16689. private _options;
  16690. private _textures;
  16691. private _textureArrays;
  16692. private _floats;
  16693. private _ints;
  16694. private _floatsArrays;
  16695. private _colors3;
  16696. private _colors3Arrays;
  16697. private _colors4;
  16698. private _colors4Arrays;
  16699. private _vectors2;
  16700. private _vectors3;
  16701. private _vectors4;
  16702. private _matrices;
  16703. private _matrixArrays;
  16704. private _matrices3x3;
  16705. private _matrices2x2;
  16706. private _vectors2Arrays;
  16707. private _vectors3Arrays;
  16708. private _vectors4Arrays;
  16709. private _cachedWorldViewMatrix;
  16710. private _cachedWorldViewProjectionMatrix;
  16711. private _renderId;
  16712. private _multiview;
  16713. private _cachedDefines;
  16714. /** Define the Url to load snippets */
  16715. static SnippetUrl: string;
  16716. /** Snippet ID if the material was created from the snippet server */
  16717. snippetId: string;
  16718. /**
  16719. * Instantiate a new shader material.
  16720. * 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.
  16721. * This returned material effects how the mesh will look based on the code in the shaders.
  16722. * @see http://doc.babylonjs.com/how_to/shader_material
  16723. * @param name Define the name of the material in the scene
  16724. * @param scene Define the scene the material belongs to
  16725. * @param shaderPath Defines the route to the shader code in one of three ways:
  16726. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16727. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16728. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16729. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16730. * @param options Define the options used to create the shader
  16731. */
  16732. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16733. /**
  16734. * Gets the shader path used to define the shader code
  16735. * It can be modified to trigger a new compilation
  16736. */
  16737. get shaderPath(): any;
  16738. /**
  16739. * Sets the shader path used to define the shader code
  16740. * It can be modified to trigger a new compilation
  16741. */
  16742. set shaderPath(shaderPath: any);
  16743. /**
  16744. * Gets the options used to compile the shader.
  16745. * They can be modified to trigger a new compilation
  16746. */
  16747. get options(): IShaderMaterialOptions;
  16748. /**
  16749. * Gets the current class name of the material e.g. "ShaderMaterial"
  16750. * Mainly use in serialization.
  16751. * @returns the class name
  16752. */
  16753. getClassName(): string;
  16754. /**
  16755. * Specifies if the material will require alpha blending
  16756. * @returns a boolean specifying if alpha blending is needed
  16757. */
  16758. needAlphaBlending(): boolean;
  16759. /**
  16760. * Specifies if this material should be rendered in alpha test mode
  16761. * @returns a boolean specifying if an alpha test is needed.
  16762. */
  16763. needAlphaTesting(): boolean;
  16764. private _checkUniform;
  16765. /**
  16766. * Set a texture in the shader.
  16767. * @param name Define the name of the uniform samplers as defined in the shader
  16768. * @param texture Define the texture to bind to this sampler
  16769. * @return the material itself allowing "fluent" like uniform updates
  16770. */
  16771. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  16772. /**
  16773. * Set a texture array in the shader.
  16774. * @param name Define the name of the uniform sampler array as defined in the shader
  16775. * @param textures Define the list of textures to bind to this sampler
  16776. * @return the material itself allowing "fluent" like uniform updates
  16777. */
  16778. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  16779. /**
  16780. * Set a float in the shader.
  16781. * @param name Define the name of the uniform as defined in the shader
  16782. * @param value Define the value to give to the uniform
  16783. * @return the material itself allowing "fluent" like uniform updates
  16784. */
  16785. setFloat(name: string, value: number): ShaderMaterial;
  16786. /**
  16787. * Set a int in the shader.
  16788. * @param name Define the name of the uniform as defined in the shader
  16789. * @param value Define the value to give to the uniform
  16790. * @return the material itself allowing "fluent" like uniform updates
  16791. */
  16792. setInt(name: string, value: number): ShaderMaterial;
  16793. /**
  16794. * Set an array of floats in the shader.
  16795. * @param name Define the name of the uniform as defined in the shader
  16796. * @param value Define the value to give to the uniform
  16797. * @return the material itself allowing "fluent" like uniform updates
  16798. */
  16799. setFloats(name: string, value: number[]): ShaderMaterial;
  16800. /**
  16801. * Set a vec3 in the shader from a Color3.
  16802. * @param name Define the name of the uniform as defined in the shader
  16803. * @param value Define the value to give to the uniform
  16804. * @return the material itself allowing "fluent" like uniform updates
  16805. */
  16806. setColor3(name: string, value: Color3): ShaderMaterial;
  16807. /**
  16808. * Set a vec3 array in the shader from a Color3 array.
  16809. * @param name Define the name of the uniform as defined in the shader
  16810. * @param value Define the value to give to the uniform
  16811. * @return the material itself allowing "fluent" like uniform updates
  16812. */
  16813. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  16814. /**
  16815. * Set a vec4 in the shader from a Color4.
  16816. * @param name Define the name of the uniform as defined in the shader
  16817. * @param value Define the value to give to the uniform
  16818. * @return the material itself allowing "fluent" like uniform updates
  16819. */
  16820. setColor4(name: string, value: Color4): ShaderMaterial;
  16821. /**
  16822. * Set a vec4 array in the shader from a Color4 array.
  16823. * @param name Define the name of the uniform as defined in the shader
  16824. * @param value Define the value to give to the uniform
  16825. * @return the material itself allowing "fluent" like uniform updates
  16826. */
  16827. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  16828. /**
  16829. * Set a vec2 in the shader from a Vector2.
  16830. * @param name Define the name of the uniform as defined in the shader
  16831. * @param value Define the value to give to the uniform
  16832. * @return the material itself allowing "fluent" like uniform updates
  16833. */
  16834. setVector2(name: string, value: Vector2): ShaderMaterial;
  16835. /**
  16836. * Set a vec3 in the shader from a Vector3.
  16837. * @param name Define the name of the uniform as defined in the shader
  16838. * @param value Define the value to give to the uniform
  16839. * @return the material itself allowing "fluent" like uniform updates
  16840. */
  16841. setVector3(name: string, value: Vector3): ShaderMaterial;
  16842. /**
  16843. * Set a vec4 in the shader from a Vector4.
  16844. * @param name Define the name of the uniform as defined in the shader
  16845. * @param value Define the value to give to the uniform
  16846. * @return the material itself allowing "fluent" like uniform updates
  16847. */
  16848. setVector4(name: string, value: Vector4): ShaderMaterial;
  16849. /**
  16850. * Set a mat4 in the shader from a Matrix.
  16851. * @param name Define the name of the uniform as defined in the shader
  16852. * @param value Define the value to give to the uniform
  16853. * @return the material itself allowing "fluent" like uniform updates
  16854. */
  16855. setMatrix(name: string, value: Matrix): ShaderMaterial;
  16856. /**
  16857. * Set a float32Array in the shader from a matrix array.
  16858. * @param name Define the name of the uniform as defined in the shader
  16859. * @param value Define the value to give to the uniform
  16860. * @return the material itself allowing "fluent" like uniform updates
  16861. */
  16862. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  16863. /**
  16864. * Set a mat3 in the shader from a Float32Array.
  16865. * @param name Define the name of the uniform as defined in the shader
  16866. * @param value Define the value to give to the uniform
  16867. * @return the material itself allowing "fluent" like uniform updates
  16868. */
  16869. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  16870. /**
  16871. * Set a mat2 in the shader from a Float32Array.
  16872. * @param name Define the name of the uniform as defined in the shader
  16873. * @param value Define the value to give to the uniform
  16874. * @return the material itself allowing "fluent" like uniform updates
  16875. */
  16876. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  16877. /**
  16878. * Set a vec2 array in the shader from a number array.
  16879. * @param name Define the name of the uniform as defined in the shader
  16880. * @param value Define the value to give to the uniform
  16881. * @return the material itself allowing "fluent" like uniform updates
  16882. */
  16883. setArray2(name: string, value: number[]): ShaderMaterial;
  16884. /**
  16885. * Set a vec3 array in the shader from a number array.
  16886. * @param name Define the name of the uniform as defined in the shader
  16887. * @param value Define the value to give to the uniform
  16888. * @return the material itself allowing "fluent" like uniform updates
  16889. */
  16890. setArray3(name: string, value: number[]): ShaderMaterial;
  16891. /**
  16892. * Set a vec4 array in the shader from a number array.
  16893. * @param name Define the name of the uniform as defined in the shader
  16894. * @param value Define the value to give to the uniform
  16895. * @return the material itself allowing "fluent" like uniform updates
  16896. */
  16897. setArray4(name: string, value: number[]): ShaderMaterial;
  16898. private _checkCache;
  16899. /**
  16900. * Specifies that the submesh is ready to be used
  16901. * @param mesh defines the mesh to check
  16902. * @param subMesh defines which submesh to check
  16903. * @param useInstances specifies that instances should be used
  16904. * @returns a boolean indicating that the submesh is ready or not
  16905. */
  16906. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  16907. /**
  16908. * Checks if the material is ready to render the requested mesh
  16909. * @param mesh Define the mesh to render
  16910. * @param useInstances Define whether or not the material is used with instances
  16911. * @returns true if ready, otherwise false
  16912. */
  16913. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  16914. /**
  16915. * Binds the world matrix to the material
  16916. * @param world defines the world transformation matrix
  16917. * @param effectOverride - If provided, use this effect instead of internal effect
  16918. */
  16919. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  16920. /**
  16921. * Binds the submesh to this material by preparing the effect and shader to draw
  16922. * @param world defines the world transformation matrix
  16923. * @param mesh defines the mesh containing the submesh
  16924. * @param subMesh defines the submesh to bind the material to
  16925. */
  16926. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  16927. /**
  16928. * Binds the material to the mesh
  16929. * @param world defines the world transformation matrix
  16930. * @param mesh defines the mesh to bind the material to
  16931. * @param effectOverride - If provided, use this effect instead of internal effect
  16932. */
  16933. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  16934. protected _afterBind(mesh?: Mesh): void;
  16935. /**
  16936. * Gets the active textures from the material
  16937. * @returns an array of textures
  16938. */
  16939. getActiveTextures(): BaseTexture[];
  16940. /**
  16941. * Specifies if the material uses a texture
  16942. * @param texture defines the texture to check against the material
  16943. * @returns a boolean specifying if the material uses the texture
  16944. */
  16945. hasTexture(texture: BaseTexture): boolean;
  16946. /**
  16947. * Makes a duplicate of the material, and gives it a new name
  16948. * @param name defines the new name for the duplicated material
  16949. * @returns the cloned material
  16950. */
  16951. clone(name: string): ShaderMaterial;
  16952. /**
  16953. * Disposes the material
  16954. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  16955. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  16956. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  16957. */
  16958. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  16959. /**
  16960. * Serializes this material in a JSON representation
  16961. * @returns the serialized material object
  16962. */
  16963. serialize(): any;
  16964. /**
  16965. * Creates a shader material from parsed shader material data
  16966. * @param source defines the JSON represnetation of the material
  16967. * @param scene defines the hosting scene
  16968. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  16969. * @returns a new material
  16970. */
  16971. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  16972. /**
  16973. * Creates a new ShaderMaterial from a snippet saved in a remote file
  16974. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  16975. * @param url defines the url to load from
  16976. * @param scene defines the hosting scene
  16977. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  16978. * @returns a promise that will resolve to the new ShaderMaterial
  16979. */
  16980. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  16981. /**
  16982. * Creates a ShaderMaterial from a snippet saved by the Inspector
  16983. * @param snippetId defines the snippet to load
  16984. * @param scene defines the hosting scene
  16985. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  16986. * @returns a promise that will resolve to the new ShaderMaterial
  16987. */
  16988. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  16989. }
  16990. }
  16991. declare module "babylonjs/Shaders/color.fragment" {
  16992. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  16993. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  16994. /** @hidden */
  16995. export var colorPixelShader: {
  16996. name: string;
  16997. shader: string;
  16998. };
  16999. }
  17000. declare module "babylonjs/Shaders/color.vertex" {
  17001. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17002. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17003. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17004. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17005. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17006. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17007. /** @hidden */
  17008. export var colorVertexShader: {
  17009. name: string;
  17010. shader: string;
  17011. };
  17012. }
  17013. declare module "babylonjs/Meshes/linesMesh" {
  17014. import { Nullable } from "babylonjs/types";
  17015. import { Scene } from "babylonjs/scene";
  17016. import { Color3 } from "babylonjs/Maths/math.color";
  17017. import { Node } from "babylonjs/node";
  17018. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17019. import { Mesh } from "babylonjs/Meshes/mesh";
  17020. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17021. import { Effect } from "babylonjs/Materials/effect";
  17022. import { Material } from "babylonjs/Materials/material";
  17023. import "babylonjs/Shaders/color.fragment";
  17024. import "babylonjs/Shaders/color.vertex";
  17025. /**
  17026. * Line mesh
  17027. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17028. */
  17029. export class LinesMesh extends Mesh {
  17030. /**
  17031. * If vertex color should be applied to the mesh
  17032. */
  17033. readonly useVertexColor?: boolean | undefined;
  17034. /**
  17035. * If vertex alpha should be applied to the mesh
  17036. */
  17037. readonly useVertexAlpha?: boolean | undefined;
  17038. /**
  17039. * Color of the line (Default: White)
  17040. */
  17041. color: Color3;
  17042. /**
  17043. * Alpha of the line (Default: 1)
  17044. */
  17045. alpha: number;
  17046. /**
  17047. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17048. * This margin is expressed in world space coordinates, so its value may vary.
  17049. * Default value is 0.1
  17050. */
  17051. intersectionThreshold: number;
  17052. private _colorShader;
  17053. private color4;
  17054. /**
  17055. * Creates a new LinesMesh
  17056. * @param name defines the name
  17057. * @param scene defines the hosting scene
  17058. * @param parent defines the parent mesh if any
  17059. * @param source defines the optional source LinesMesh used to clone data from
  17060. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17061. * When false, achieved by calling a clone(), also passing False.
  17062. * This will make creation of children, recursive.
  17063. * @param useVertexColor defines if this LinesMesh supports vertex color
  17064. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17065. */
  17066. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17067. /**
  17068. * If vertex color should be applied to the mesh
  17069. */
  17070. useVertexColor?: boolean | undefined,
  17071. /**
  17072. * If vertex alpha should be applied to the mesh
  17073. */
  17074. useVertexAlpha?: boolean | undefined);
  17075. private _addClipPlaneDefine;
  17076. private _removeClipPlaneDefine;
  17077. isReady(): boolean;
  17078. /**
  17079. * Returns the string "LineMesh"
  17080. */
  17081. getClassName(): string;
  17082. /**
  17083. * @hidden
  17084. */
  17085. get material(): Material;
  17086. /**
  17087. * @hidden
  17088. */
  17089. set material(value: Material);
  17090. /**
  17091. * @hidden
  17092. */
  17093. get checkCollisions(): boolean;
  17094. /** @hidden */
  17095. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17096. /** @hidden */
  17097. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17098. /**
  17099. * Disposes of the line mesh
  17100. * @param doNotRecurse If children should be disposed
  17101. */
  17102. dispose(doNotRecurse?: boolean): void;
  17103. /**
  17104. * Returns a new LineMesh object cloned from the current one.
  17105. */
  17106. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17107. /**
  17108. * Creates a new InstancedLinesMesh object from the mesh model.
  17109. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  17110. * @param name defines the name of the new instance
  17111. * @returns a new InstancedLinesMesh
  17112. */
  17113. createInstance(name: string): InstancedLinesMesh;
  17114. }
  17115. /**
  17116. * Creates an instance based on a source LinesMesh
  17117. */
  17118. export class InstancedLinesMesh extends InstancedMesh {
  17119. /**
  17120. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17121. * This margin is expressed in world space coordinates, so its value may vary.
  17122. * Initilized with the intersectionThreshold value of the source LinesMesh
  17123. */
  17124. intersectionThreshold: number;
  17125. constructor(name: string, source: LinesMesh);
  17126. /**
  17127. * Returns the string "InstancedLinesMesh".
  17128. */
  17129. getClassName(): string;
  17130. }
  17131. }
  17132. declare module "babylonjs/Shaders/line.fragment" {
  17133. /** @hidden */
  17134. export var linePixelShader: {
  17135. name: string;
  17136. shader: string;
  17137. };
  17138. }
  17139. declare module "babylonjs/Shaders/line.vertex" {
  17140. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17141. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17142. /** @hidden */
  17143. export var lineVertexShader: {
  17144. name: string;
  17145. shader: string;
  17146. };
  17147. }
  17148. declare module "babylonjs/Rendering/edgesRenderer" {
  17149. import { Nullable } from "babylonjs/types";
  17150. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17151. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17152. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17153. import { IDisposable } from "babylonjs/scene";
  17154. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17155. import "babylonjs/Shaders/line.fragment";
  17156. import "babylonjs/Shaders/line.vertex";
  17157. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17158. import { SmartArray } from "babylonjs/Misc/smartArray";
  17159. module "babylonjs/scene" {
  17160. interface Scene {
  17161. /** @hidden */
  17162. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17163. }
  17164. }
  17165. module "babylonjs/Meshes/abstractMesh" {
  17166. interface AbstractMesh {
  17167. /**
  17168. * Gets the edgesRenderer associated with the mesh
  17169. */
  17170. edgesRenderer: Nullable<EdgesRenderer>;
  17171. }
  17172. }
  17173. module "babylonjs/Meshes/linesMesh" {
  17174. interface LinesMesh {
  17175. /**
  17176. * Enables the edge rendering mode on the mesh.
  17177. * This mode makes the mesh edges visible
  17178. * @param epsilon defines the maximal distance between two angles to detect a face
  17179. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17180. * @returns the currentAbstractMesh
  17181. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17182. */
  17183. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17184. }
  17185. }
  17186. module "babylonjs/Meshes/linesMesh" {
  17187. interface InstancedLinesMesh {
  17188. /**
  17189. * Enables the edge rendering mode on the mesh.
  17190. * This mode makes the mesh edges visible
  17191. * @param epsilon defines the maximal distance between two angles to detect a face
  17192. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17193. * @returns the current InstancedLinesMesh
  17194. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17195. */
  17196. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17197. }
  17198. }
  17199. /**
  17200. * Defines the minimum contract an Edges renderer should follow.
  17201. */
  17202. export interface IEdgesRenderer extends IDisposable {
  17203. /**
  17204. * Gets or sets a boolean indicating if the edgesRenderer is active
  17205. */
  17206. isEnabled: boolean;
  17207. /**
  17208. * Renders the edges of the attached mesh,
  17209. */
  17210. render(): void;
  17211. /**
  17212. * Checks wether or not the edges renderer is ready to render.
  17213. * @return true if ready, otherwise false.
  17214. */
  17215. isReady(): boolean;
  17216. /**
  17217. * List of instances to render in case the source mesh has instances
  17218. */
  17219. customInstances: SmartArray<Matrix>;
  17220. }
  17221. /**
  17222. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17223. */
  17224. export class EdgesRenderer implements IEdgesRenderer {
  17225. /**
  17226. * Define the size of the edges with an orthographic camera
  17227. */
  17228. edgesWidthScalerForOrthographic: number;
  17229. /**
  17230. * Define the size of the edges with a perspective camera
  17231. */
  17232. edgesWidthScalerForPerspective: number;
  17233. protected _source: AbstractMesh;
  17234. protected _linesPositions: number[];
  17235. protected _linesNormals: number[];
  17236. protected _linesIndices: number[];
  17237. protected _epsilon: number;
  17238. protected _indicesCount: number;
  17239. protected _lineShader: ShaderMaterial;
  17240. protected _ib: DataBuffer;
  17241. protected _buffers: {
  17242. [key: string]: Nullable<VertexBuffer>;
  17243. };
  17244. protected _buffersForInstances: {
  17245. [key: string]: Nullable<VertexBuffer>;
  17246. };
  17247. protected _checkVerticesInsteadOfIndices: boolean;
  17248. private _meshRebuildObserver;
  17249. private _meshDisposeObserver;
  17250. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17251. isEnabled: boolean;
  17252. /**
  17253. * List of instances to render in case the source mesh has instances
  17254. */
  17255. customInstances: SmartArray<Matrix>;
  17256. private static GetShader;
  17257. /**
  17258. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17259. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17260. * @param source Mesh used to create edges
  17261. * @param epsilon sum of angles in adjacency to check for edge
  17262. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  17263. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17264. */
  17265. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  17266. protected _prepareRessources(): void;
  17267. /** @hidden */
  17268. _rebuild(): void;
  17269. /**
  17270. * Releases the required resources for the edges renderer
  17271. */
  17272. dispose(): void;
  17273. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17274. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17275. /**
  17276. * Checks if the pair of p0 and p1 is en edge
  17277. * @param faceIndex
  17278. * @param edge
  17279. * @param faceNormals
  17280. * @param p0
  17281. * @param p1
  17282. * @private
  17283. */
  17284. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17285. /**
  17286. * push line into the position, normal and index buffer
  17287. * @protected
  17288. */
  17289. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17290. /**
  17291. * Generates lines edges from adjacencjes
  17292. * @private
  17293. */
  17294. _generateEdgesLines(): void;
  17295. /**
  17296. * Checks wether or not the edges renderer is ready to render.
  17297. * @return true if ready, otherwise false.
  17298. */
  17299. isReady(): boolean;
  17300. /**
  17301. * Renders the edges of the attached mesh,
  17302. */
  17303. render(): void;
  17304. }
  17305. /**
  17306. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17307. */
  17308. export class LineEdgesRenderer extends EdgesRenderer {
  17309. /**
  17310. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17311. * @param source LineMesh used to generate edges
  17312. * @param epsilon not important (specified angle for edge detection)
  17313. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17314. */
  17315. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17316. /**
  17317. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17318. */
  17319. _generateEdgesLines(): void;
  17320. }
  17321. }
  17322. declare module "babylonjs/Rendering/renderingGroup" {
  17323. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17324. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17325. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17326. import { Nullable } from "babylonjs/types";
  17327. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17328. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17329. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17330. import { Material } from "babylonjs/Materials/material";
  17331. import { Scene } from "babylonjs/scene";
  17332. /**
  17333. * This represents the object necessary to create a rendering group.
  17334. * This is exclusively used and created by the rendering manager.
  17335. * To modify the behavior, you use the available helpers in your scene or meshes.
  17336. * @hidden
  17337. */
  17338. export class RenderingGroup {
  17339. index: number;
  17340. private static _zeroVector;
  17341. private _scene;
  17342. private _opaqueSubMeshes;
  17343. private _transparentSubMeshes;
  17344. private _alphaTestSubMeshes;
  17345. private _depthOnlySubMeshes;
  17346. private _particleSystems;
  17347. private _spriteManagers;
  17348. private _opaqueSortCompareFn;
  17349. private _alphaTestSortCompareFn;
  17350. private _transparentSortCompareFn;
  17351. private _renderOpaque;
  17352. private _renderAlphaTest;
  17353. private _renderTransparent;
  17354. /** @hidden */
  17355. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17356. onBeforeTransparentRendering: () => void;
  17357. /**
  17358. * Set the opaque sort comparison function.
  17359. * If null the sub meshes will be render in the order they were created
  17360. */
  17361. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17362. /**
  17363. * Set the alpha test sort comparison function.
  17364. * If null the sub meshes will be render in the order they were created
  17365. */
  17366. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17367. /**
  17368. * Set the transparent sort comparison function.
  17369. * If null the sub meshes will be render in the order they were created
  17370. */
  17371. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17372. /**
  17373. * Creates a new rendering group.
  17374. * @param index The rendering group index
  17375. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17376. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17377. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17378. */
  17379. 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>);
  17380. /**
  17381. * Render all the sub meshes contained in the group.
  17382. * @param customRenderFunction Used to override the default render behaviour of the group.
  17383. * @returns true if rendered some submeshes.
  17384. */
  17385. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17386. /**
  17387. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17388. * @param subMeshes The submeshes to render
  17389. */
  17390. private renderOpaqueSorted;
  17391. /**
  17392. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17393. * @param subMeshes The submeshes to render
  17394. */
  17395. private renderAlphaTestSorted;
  17396. /**
  17397. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17398. * @param subMeshes The submeshes to render
  17399. */
  17400. private renderTransparentSorted;
  17401. /**
  17402. * Renders the submeshes in a specified order.
  17403. * @param subMeshes The submeshes to sort before render
  17404. * @param sortCompareFn The comparison function use to sort
  17405. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17406. * @param transparent Specifies to activate blending if true
  17407. */
  17408. private static renderSorted;
  17409. /**
  17410. * Renders the submeshes in the order they were dispatched (no sort applied).
  17411. * @param subMeshes The submeshes to render
  17412. */
  17413. private static renderUnsorted;
  17414. /**
  17415. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17416. * are rendered back to front if in the same alpha index.
  17417. *
  17418. * @param a The first submesh
  17419. * @param b The second submesh
  17420. * @returns The result of the comparison
  17421. */
  17422. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17423. /**
  17424. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17425. * are rendered back to front.
  17426. *
  17427. * @param a The first submesh
  17428. * @param b The second submesh
  17429. * @returns The result of the comparison
  17430. */
  17431. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17432. /**
  17433. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17434. * are rendered front to back (prevent overdraw).
  17435. *
  17436. * @param a The first submesh
  17437. * @param b The second submesh
  17438. * @returns The result of the comparison
  17439. */
  17440. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17441. /**
  17442. * Resets the different lists of submeshes to prepare a new frame.
  17443. */
  17444. prepare(): void;
  17445. dispose(): void;
  17446. /**
  17447. * Inserts the submesh in its correct queue depending on its material.
  17448. * @param subMesh The submesh to dispatch
  17449. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17450. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17451. */
  17452. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17453. dispatchSprites(spriteManager: ISpriteManager): void;
  17454. dispatchParticles(particleSystem: IParticleSystem): void;
  17455. private _renderParticles;
  17456. private _renderSprites;
  17457. }
  17458. }
  17459. declare module "babylonjs/Rendering/renderingManager" {
  17460. import { Nullable } from "babylonjs/types";
  17461. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17462. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17463. import { SmartArray } from "babylonjs/Misc/smartArray";
  17464. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17465. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17466. import { Material } from "babylonjs/Materials/material";
  17467. import { Scene } from "babylonjs/scene";
  17468. import { Camera } from "babylonjs/Cameras/camera";
  17469. /**
  17470. * Interface describing the different options available in the rendering manager
  17471. * regarding Auto Clear between groups.
  17472. */
  17473. export interface IRenderingManagerAutoClearSetup {
  17474. /**
  17475. * Defines whether or not autoclear is enable.
  17476. */
  17477. autoClear: boolean;
  17478. /**
  17479. * Defines whether or not to autoclear the depth buffer.
  17480. */
  17481. depth: boolean;
  17482. /**
  17483. * Defines whether or not to autoclear the stencil buffer.
  17484. */
  17485. stencil: boolean;
  17486. }
  17487. /**
  17488. * This class is used by the onRenderingGroupObservable
  17489. */
  17490. export class RenderingGroupInfo {
  17491. /**
  17492. * The Scene that being rendered
  17493. */
  17494. scene: Scene;
  17495. /**
  17496. * The camera currently used for the rendering pass
  17497. */
  17498. camera: Nullable<Camera>;
  17499. /**
  17500. * The ID of the renderingGroup being processed
  17501. */
  17502. renderingGroupId: number;
  17503. }
  17504. /**
  17505. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17506. * It is enable to manage the different groups as well as the different necessary sort functions.
  17507. * This should not be used directly aside of the few static configurations
  17508. */
  17509. export class RenderingManager {
  17510. /**
  17511. * The max id used for rendering groups (not included)
  17512. */
  17513. static MAX_RENDERINGGROUPS: number;
  17514. /**
  17515. * The min id used for rendering groups (included)
  17516. */
  17517. static MIN_RENDERINGGROUPS: number;
  17518. /**
  17519. * Used to globally prevent autoclearing scenes.
  17520. */
  17521. static AUTOCLEAR: boolean;
  17522. /**
  17523. * @hidden
  17524. */
  17525. _useSceneAutoClearSetup: boolean;
  17526. private _scene;
  17527. private _renderingGroups;
  17528. private _depthStencilBufferAlreadyCleaned;
  17529. private _autoClearDepthStencil;
  17530. private _customOpaqueSortCompareFn;
  17531. private _customAlphaTestSortCompareFn;
  17532. private _customTransparentSortCompareFn;
  17533. private _renderingGroupInfo;
  17534. /**
  17535. * Instantiates a new rendering group for a particular scene
  17536. * @param scene Defines the scene the groups belongs to
  17537. */
  17538. constructor(scene: Scene);
  17539. private _clearDepthStencilBuffer;
  17540. /**
  17541. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17542. * @hidden
  17543. */
  17544. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17545. /**
  17546. * Resets the different information of the group to prepare a new frame
  17547. * @hidden
  17548. */
  17549. reset(): void;
  17550. /**
  17551. * Dispose and release the group and its associated resources.
  17552. * @hidden
  17553. */
  17554. dispose(): void;
  17555. /**
  17556. * Clear the info related to rendering groups preventing retention points during dispose.
  17557. */
  17558. freeRenderingGroups(): void;
  17559. private _prepareRenderingGroup;
  17560. /**
  17561. * Add a sprite manager to the rendering manager in order to render it this frame.
  17562. * @param spriteManager Define the sprite manager to render
  17563. */
  17564. dispatchSprites(spriteManager: ISpriteManager): void;
  17565. /**
  17566. * Add a particle system to the rendering manager in order to render it this frame.
  17567. * @param particleSystem Define the particle system to render
  17568. */
  17569. dispatchParticles(particleSystem: IParticleSystem): void;
  17570. /**
  17571. * Add a submesh to the manager in order to render it this frame
  17572. * @param subMesh The submesh to dispatch
  17573. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17574. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17575. */
  17576. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17577. /**
  17578. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17579. * This allowed control for front to back rendering or reversly depending of the special needs.
  17580. *
  17581. * @param renderingGroupId The rendering group id corresponding to its index
  17582. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17583. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17584. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17585. */
  17586. 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;
  17587. /**
  17588. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17589. *
  17590. * @param renderingGroupId The rendering group id corresponding to its index
  17591. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17592. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17593. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17594. */
  17595. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17596. /**
  17597. * Gets the current auto clear configuration for one rendering group of the rendering
  17598. * manager.
  17599. * @param index the rendering group index to get the information for
  17600. * @returns The auto clear setup for the requested rendering group
  17601. */
  17602. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17603. }
  17604. }
  17605. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17606. import { SmartArray } from "babylonjs/Misc/smartArray";
  17607. import { Nullable } from "babylonjs/types";
  17608. import { Scene } from "babylonjs/scene";
  17609. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17610. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17611. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17612. import { Mesh } from "babylonjs/Meshes/mesh";
  17613. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17614. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17615. import { Effect } from "babylonjs/Materials/effect";
  17616. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17617. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17618. import "babylonjs/Shaders/shadowMap.fragment";
  17619. import "babylonjs/Shaders/shadowMap.vertex";
  17620. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17621. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17622. import { Observable } from "babylonjs/Misc/observable";
  17623. /**
  17624. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17625. */
  17626. export interface ICustomShaderOptions {
  17627. /**
  17628. * Gets or sets the custom shader name to use
  17629. */
  17630. shaderName: string;
  17631. /**
  17632. * The list of attribute names used in the shader
  17633. */
  17634. attributes?: string[];
  17635. /**
  17636. * The list of unifrom names used in the shader
  17637. */
  17638. uniforms?: string[];
  17639. /**
  17640. * The list of sampler names used in the shader
  17641. */
  17642. samplers?: string[];
  17643. /**
  17644. * The list of defines used in the shader
  17645. */
  17646. defines?: string[];
  17647. }
  17648. /**
  17649. * Interface to implement to create a shadow generator compatible with BJS.
  17650. */
  17651. export interface IShadowGenerator {
  17652. /**
  17653. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17654. * @returns The render target texture if present otherwise, null
  17655. */
  17656. getShadowMap(): Nullable<RenderTargetTexture>;
  17657. /**
  17658. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17659. * @param subMesh The submesh we want to render in the shadow map
  17660. * @param useInstances Defines wether will draw in the map using instances
  17661. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17662. * @returns true if ready otherwise, false
  17663. */
  17664. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17665. /**
  17666. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17667. * @param defines Defines of the material we want to update
  17668. * @param lightIndex Index of the light in the enabled light list of the material
  17669. */
  17670. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17671. /**
  17672. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17673. * defined in the generator but impacting the effect).
  17674. * It implies the unifroms available on the materials are the standard BJS ones.
  17675. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17676. * @param effect The effect we are binfing the information for
  17677. */
  17678. bindShadowLight(lightIndex: string, effect: Effect): void;
  17679. /**
  17680. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17681. * (eq to shadow prjection matrix * light transform matrix)
  17682. * @returns The transform matrix used to create the shadow map
  17683. */
  17684. getTransformMatrix(): Matrix;
  17685. /**
  17686. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17687. * Cube and 2D textures for instance.
  17688. */
  17689. recreateShadowMap(): void;
  17690. /**
  17691. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17692. * @param onCompiled Callback triggered at the and of the effects compilation
  17693. * @param options Sets of optional options forcing the compilation with different modes
  17694. */
  17695. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17696. useInstances: boolean;
  17697. }>): void;
  17698. /**
  17699. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17700. * @param options Sets of optional options forcing the compilation with different modes
  17701. * @returns A promise that resolves when the compilation completes
  17702. */
  17703. forceCompilationAsync(options?: Partial<{
  17704. useInstances: boolean;
  17705. }>): Promise<void>;
  17706. /**
  17707. * Serializes the shadow generator setup to a json object.
  17708. * @returns The serialized JSON object
  17709. */
  17710. serialize(): any;
  17711. /**
  17712. * Disposes the Shadow map and related Textures and effects.
  17713. */
  17714. dispose(): void;
  17715. }
  17716. /**
  17717. * Default implementation IShadowGenerator.
  17718. * This is the main object responsible of generating shadows in the framework.
  17719. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  17720. */
  17721. export class ShadowGenerator implements IShadowGenerator {
  17722. /**
  17723. * Name of the shadow generator class
  17724. */
  17725. static CLASSNAME: string;
  17726. /**
  17727. * Shadow generator mode None: no filtering applied.
  17728. */
  17729. static readonly FILTER_NONE: number;
  17730. /**
  17731. * Shadow generator mode ESM: Exponential Shadow Mapping.
  17732. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17733. */
  17734. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  17735. /**
  17736. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  17737. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  17738. */
  17739. static readonly FILTER_POISSONSAMPLING: number;
  17740. /**
  17741. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  17742. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17743. */
  17744. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  17745. /**
  17746. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  17747. * edge artifacts on steep falloff.
  17748. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17749. */
  17750. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  17751. /**
  17752. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  17753. * edge artifacts on steep falloff.
  17754. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17755. */
  17756. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  17757. /**
  17758. * Shadow generator mode PCF: Percentage Closer Filtering
  17759. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  17760. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  17761. */
  17762. static readonly FILTER_PCF: number;
  17763. /**
  17764. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  17765. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  17766. * Contact Hardening
  17767. */
  17768. static readonly FILTER_PCSS: number;
  17769. /**
  17770. * Reserved for PCF and PCSS
  17771. * Highest Quality.
  17772. *
  17773. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  17774. *
  17775. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  17776. */
  17777. static readonly QUALITY_HIGH: number;
  17778. /**
  17779. * Reserved for PCF and PCSS
  17780. * Good tradeoff for quality/perf cross devices
  17781. *
  17782. * Execute PCF on a 3*3 kernel.
  17783. *
  17784. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  17785. */
  17786. static readonly QUALITY_MEDIUM: number;
  17787. /**
  17788. * Reserved for PCF and PCSS
  17789. * The lowest quality but the fastest.
  17790. *
  17791. * Execute PCF on a 1*1 kernel.
  17792. *
  17793. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  17794. */
  17795. static readonly QUALITY_LOW: number;
  17796. /** Gets or sets the custom shader name to use */
  17797. customShaderOptions: ICustomShaderOptions;
  17798. /**
  17799. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  17800. */
  17801. onBeforeShadowMapRenderObservable: Observable<Effect>;
  17802. /**
  17803. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  17804. */
  17805. onAfterShadowMapRenderObservable: Observable<Effect>;
  17806. /**
  17807. * Observable triggered before a mesh is rendered in the shadow map.
  17808. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  17809. */
  17810. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  17811. /**
  17812. * Observable triggered after a mesh is rendered in the shadow map.
  17813. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  17814. */
  17815. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  17816. protected _bias: number;
  17817. /**
  17818. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  17819. */
  17820. get bias(): number;
  17821. /**
  17822. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  17823. */
  17824. set bias(bias: number);
  17825. protected _normalBias: number;
  17826. /**
  17827. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  17828. */
  17829. get normalBias(): number;
  17830. /**
  17831. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  17832. */
  17833. set normalBias(normalBias: number);
  17834. protected _blurBoxOffset: number;
  17835. /**
  17836. * Gets the blur box offset: offset applied during the blur pass.
  17837. * Only useful if useKernelBlur = false
  17838. */
  17839. get blurBoxOffset(): number;
  17840. /**
  17841. * Sets the blur box offset: offset applied during the blur pass.
  17842. * Only useful if useKernelBlur = false
  17843. */
  17844. set blurBoxOffset(value: number);
  17845. protected _blurScale: number;
  17846. /**
  17847. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  17848. * 2 means half of the size.
  17849. */
  17850. get blurScale(): number;
  17851. /**
  17852. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  17853. * 2 means half of the size.
  17854. */
  17855. set blurScale(value: number);
  17856. protected _blurKernel: number;
  17857. /**
  17858. * Gets the blur kernel: kernel size of the blur pass.
  17859. * Only useful if useKernelBlur = true
  17860. */
  17861. get blurKernel(): number;
  17862. /**
  17863. * Sets the blur kernel: kernel size of the blur pass.
  17864. * Only useful if useKernelBlur = true
  17865. */
  17866. set blurKernel(value: number);
  17867. protected _useKernelBlur: boolean;
  17868. /**
  17869. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  17870. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  17871. */
  17872. get useKernelBlur(): boolean;
  17873. /**
  17874. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  17875. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  17876. */
  17877. set useKernelBlur(value: boolean);
  17878. protected _depthScale: number;
  17879. /**
  17880. * Gets the depth scale used in ESM mode.
  17881. */
  17882. get depthScale(): number;
  17883. /**
  17884. * Sets the depth scale used in ESM mode.
  17885. * This can override the scale stored on the light.
  17886. */
  17887. set depthScale(value: number);
  17888. protected _validateFilter(filter: number): number;
  17889. protected _filter: number;
  17890. /**
  17891. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  17892. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  17893. */
  17894. get filter(): number;
  17895. /**
  17896. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  17897. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  17898. */
  17899. set filter(value: number);
  17900. /**
  17901. * Gets if the current filter is set to Poisson Sampling.
  17902. */
  17903. get usePoissonSampling(): boolean;
  17904. /**
  17905. * Sets the current filter to Poisson Sampling.
  17906. */
  17907. set usePoissonSampling(value: boolean);
  17908. /**
  17909. * Gets if the current filter is set to ESM.
  17910. */
  17911. get useExponentialShadowMap(): boolean;
  17912. /**
  17913. * Sets the current filter is to ESM.
  17914. */
  17915. set useExponentialShadowMap(value: boolean);
  17916. /**
  17917. * Gets if the current filter is set to filtered ESM.
  17918. */
  17919. get useBlurExponentialShadowMap(): boolean;
  17920. /**
  17921. * Gets if the current filter is set to filtered ESM.
  17922. */
  17923. set useBlurExponentialShadowMap(value: boolean);
  17924. /**
  17925. * Gets if the current filter is set to "close ESM" (using the inverse of the
  17926. * exponential to prevent steep falloff artifacts).
  17927. */
  17928. get useCloseExponentialShadowMap(): boolean;
  17929. /**
  17930. * Sets the current filter to "close ESM" (using the inverse of the
  17931. * exponential to prevent steep falloff artifacts).
  17932. */
  17933. set useCloseExponentialShadowMap(value: boolean);
  17934. /**
  17935. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  17936. * exponential to prevent steep falloff artifacts).
  17937. */
  17938. get useBlurCloseExponentialShadowMap(): boolean;
  17939. /**
  17940. * Sets the current filter to filtered "close ESM" (using the inverse of the
  17941. * exponential to prevent steep falloff artifacts).
  17942. */
  17943. set useBlurCloseExponentialShadowMap(value: boolean);
  17944. /**
  17945. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  17946. */
  17947. get usePercentageCloserFiltering(): boolean;
  17948. /**
  17949. * Sets the current filter to "PCF" (percentage closer filtering).
  17950. */
  17951. set usePercentageCloserFiltering(value: boolean);
  17952. protected _filteringQuality: number;
  17953. /**
  17954. * Gets the PCF or PCSS Quality.
  17955. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  17956. */
  17957. get filteringQuality(): number;
  17958. /**
  17959. * Sets the PCF or PCSS Quality.
  17960. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  17961. */
  17962. set filteringQuality(filteringQuality: number);
  17963. /**
  17964. * Gets if the current filter is set to "PCSS" (contact hardening).
  17965. */
  17966. get useContactHardeningShadow(): boolean;
  17967. /**
  17968. * Sets the current filter to "PCSS" (contact hardening).
  17969. */
  17970. set useContactHardeningShadow(value: boolean);
  17971. protected _contactHardeningLightSizeUVRatio: number;
  17972. /**
  17973. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  17974. * Using a ratio helps keeping shape stability independently of the map size.
  17975. *
  17976. * It does not account for the light projection as it was having too much
  17977. * instability during the light setup or during light position changes.
  17978. *
  17979. * Only valid if useContactHardeningShadow is true.
  17980. */
  17981. get contactHardeningLightSizeUVRatio(): number;
  17982. /**
  17983. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  17984. * Using a ratio helps keeping shape stability independently of the map size.
  17985. *
  17986. * It does not account for the light projection as it was having too much
  17987. * instability during the light setup or during light position changes.
  17988. *
  17989. * Only valid if useContactHardeningShadow is true.
  17990. */
  17991. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  17992. protected _darkness: number;
  17993. /** Gets or sets the actual darkness of a shadow */
  17994. get darkness(): number;
  17995. set darkness(value: number);
  17996. /**
  17997. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  17998. * 0 means strongest and 1 would means no shadow.
  17999. * @returns the darkness.
  18000. */
  18001. getDarkness(): number;
  18002. /**
  18003. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18004. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18005. * @returns the shadow generator allowing fluent coding.
  18006. */
  18007. setDarkness(darkness: number): ShadowGenerator;
  18008. protected _transparencyShadow: boolean;
  18009. /** Gets or sets the ability to have transparent shadow */
  18010. get transparencyShadow(): boolean;
  18011. set transparencyShadow(value: boolean);
  18012. /**
  18013. * Sets the ability to have transparent shadow (boolean).
  18014. * @param transparent True if transparent else False
  18015. * @returns the shadow generator allowing fluent coding
  18016. */
  18017. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18018. /**
  18019. * Enables or disables shadows with varying strength based on the transparency
  18020. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18021. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18022. * mesh.visibility * alphaTexture.a
  18023. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18024. */
  18025. enableSoftTransparentShadow: boolean;
  18026. protected _shadowMap: Nullable<RenderTargetTexture>;
  18027. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18028. /**
  18029. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18030. * @returns The render target texture if present otherwise, null
  18031. */
  18032. getShadowMap(): Nullable<RenderTargetTexture>;
  18033. /**
  18034. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18035. * @returns The render target texture if the shadow map is present otherwise, null
  18036. */
  18037. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18038. /**
  18039. * Gets the class name of that object
  18040. * @returns "ShadowGenerator"
  18041. */
  18042. getClassName(): string;
  18043. /**
  18044. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18045. * @param mesh Mesh to add
  18046. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18047. * @returns the Shadow Generator itself
  18048. */
  18049. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18050. /**
  18051. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18052. * @param mesh Mesh to remove
  18053. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18054. * @returns the Shadow Generator itself
  18055. */
  18056. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18057. /**
  18058. * Controls the extent to which the shadows fade out at the edge of the frustum
  18059. */
  18060. frustumEdgeFalloff: number;
  18061. protected _light: IShadowLight;
  18062. /**
  18063. * Returns the associated light object.
  18064. * @returns the light generating the shadow
  18065. */
  18066. getLight(): IShadowLight;
  18067. /**
  18068. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18069. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18070. * It might on the other hand introduce peter panning.
  18071. */
  18072. forceBackFacesOnly: boolean;
  18073. protected _scene: Scene;
  18074. protected _lightDirection: Vector3;
  18075. protected _effect: Effect;
  18076. protected _viewMatrix: Matrix;
  18077. protected _projectionMatrix: Matrix;
  18078. protected _transformMatrix: Matrix;
  18079. protected _cachedPosition: Vector3;
  18080. protected _cachedDirection: Vector3;
  18081. protected _cachedDefines: string;
  18082. protected _currentRenderID: number;
  18083. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18084. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18085. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18086. protected _blurPostProcesses: PostProcess[];
  18087. protected _mapSize: number;
  18088. protected _currentFaceIndex: number;
  18089. protected _currentFaceIndexCache: number;
  18090. protected _textureType: number;
  18091. protected _defaultTextureMatrix: Matrix;
  18092. protected _storedUniqueId: Nullable<number>;
  18093. /** @hidden */
  18094. static _SceneComponentInitialization: (scene: Scene) => void;
  18095. /**
  18096. * Creates a ShadowGenerator object.
  18097. * A ShadowGenerator is the required tool to use the shadows.
  18098. * Each light casting shadows needs to use its own ShadowGenerator.
  18099. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18100. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18101. * @param light The light object generating the shadows.
  18102. * @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.
  18103. */
  18104. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18105. protected _initializeGenerator(): void;
  18106. protected _createTargetRenderTexture(): void;
  18107. protected _initializeShadowMap(): void;
  18108. protected _initializeBlurRTTAndPostProcesses(): void;
  18109. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18110. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18111. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18112. protected _applyFilterValues(): void;
  18113. /**
  18114. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18115. * @param onCompiled Callback triggered at the and of the effects compilation
  18116. * @param options Sets of optional options forcing the compilation with different modes
  18117. */
  18118. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18119. useInstances: boolean;
  18120. }>): void;
  18121. /**
  18122. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18123. * @param options Sets of optional options forcing the compilation with different modes
  18124. * @returns A promise that resolves when the compilation completes
  18125. */
  18126. forceCompilationAsync(options?: Partial<{
  18127. useInstances: boolean;
  18128. }>): Promise<void>;
  18129. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18130. private _prepareShadowDefines;
  18131. /**
  18132. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18133. * @param subMesh The submesh we want to render in the shadow map
  18134. * @param useInstances Defines wether will draw in the map using instances
  18135. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18136. * @returns true if ready otherwise, false
  18137. */
  18138. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18139. /**
  18140. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18141. * @param defines Defines of the material we want to update
  18142. * @param lightIndex Index of the light in the enabled light list of the material
  18143. */
  18144. prepareDefines(defines: any, lightIndex: number): void;
  18145. /**
  18146. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18147. * defined in the generator but impacting the effect).
  18148. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18149. * @param effect The effect we are binfing the information for
  18150. */
  18151. bindShadowLight(lightIndex: string, effect: Effect): void;
  18152. /**
  18153. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18154. * (eq to shadow prjection matrix * light transform matrix)
  18155. * @returns The transform matrix used to create the shadow map
  18156. */
  18157. getTransformMatrix(): Matrix;
  18158. /**
  18159. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18160. * Cube and 2D textures for instance.
  18161. */
  18162. recreateShadowMap(): void;
  18163. protected _disposeBlurPostProcesses(): void;
  18164. protected _disposeRTTandPostProcesses(): void;
  18165. /**
  18166. * Disposes the ShadowGenerator.
  18167. * Returns nothing.
  18168. */
  18169. dispose(): void;
  18170. /**
  18171. * Serializes the shadow generator setup to a json object.
  18172. * @returns The serialized JSON object
  18173. */
  18174. serialize(): any;
  18175. /**
  18176. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18177. * @param parsedShadowGenerator The JSON object to parse
  18178. * @param scene The scene to create the shadow map for
  18179. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18180. * @returns The parsed shadow generator
  18181. */
  18182. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18183. }
  18184. }
  18185. declare module "babylonjs/Lights/light" {
  18186. import { Nullable } from "babylonjs/types";
  18187. import { Scene } from "babylonjs/scene";
  18188. import { Vector3 } from "babylonjs/Maths/math.vector";
  18189. import { Color3 } from "babylonjs/Maths/math.color";
  18190. import { Node } from "babylonjs/node";
  18191. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18192. import { Effect } from "babylonjs/Materials/effect";
  18193. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18194. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18195. /**
  18196. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18197. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18198. * 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.
  18199. */
  18200. export abstract class Light extends Node {
  18201. /**
  18202. * Falloff Default: light is falling off following the material specification:
  18203. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18204. */
  18205. static readonly FALLOFF_DEFAULT: number;
  18206. /**
  18207. * Falloff Physical: light is falling off following the inverse squared distance law.
  18208. */
  18209. static readonly FALLOFF_PHYSICAL: number;
  18210. /**
  18211. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18212. * to enhance interoperability with other engines.
  18213. */
  18214. static readonly FALLOFF_GLTF: number;
  18215. /**
  18216. * Falloff Standard: light is falling off like in the standard material
  18217. * to enhance interoperability with other materials.
  18218. */
  18219. static readonly FALLOFF_STANDARD: number;
  18220. /**
  18221. * If every light affecting the material is in this lightmapMode,
  18222. * material.lightmapTexture adds or multiplies
  18223. * (depends on material.useLightmapAsShadowmap)
  18224. * after every other light calculations.
  18225. */
  18226. static readonly LIGHTMAP_DEFAULT: number;
  18227. /**
  18228. * material.lightmapTexture as only diffuse lighting from this light
  18229. * adds only specular lighting from this light
  18230. * adds dynamic shadows
  18231. */
  18232. static readonly LIGHTMAP_SPECULAR: number;
  18233. /**
  18234. * material.lightmapTexture as only lighting
  18235. * no light calculation from this light
  18236. * only adds dynamic shadows from this light
  18237. */
  18238. static readonly LIGHTMAP_SHADOWSONLY: number;
  18239. /**
  18240. * Each light type uses the default quantity according to its type:
  18241. * point/spot lights use luminous intensity
  18242. * directional lights use illuminance
  18243. */
  18244. static readonly INTENSITYMODE_AUTOMATIC: number;
  18245. /**
  18246. * lumen (lm)
  18247. */
  18248. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18249. /**
  18250. * candela (lm/sr)
  18251. */
  18252. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18253. /**
  18254. * lux (lm/m^2)
  18255. */
  18256. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18257. /**
  18258. * nit (cd/m^2)
  18259. */
  18260. static readonly INTENSITYMODE_LUMINANCE: number;
  18261. /**
  18262. * Light type const id of the point light.
  18263. */
  18264. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18265. /**
  18266. * Light type const id of the directional light.
  18267. */
  18268. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18269. /**
  18270. * Light type const id of the spot light.
  18271. */
  18272. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18273. /**
  18274. * Light type const id of the hemispheric light.
  18275. */
  18276. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18277. /**
  18278. * Diffuse gives the basic color to an object.
  18279. */
  18280. diffuse: Color3;
  18281. /**
  18282. * Specular produces a highlight color on an object.
  18283. * Note: This is note affecting PBR materials.
  18284. */
  18285. specular: Color3;
  18286. /**
  18287. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18288. * falling off base on range or angle.
  18289. * This can be set to any values in Light.FALLOFF_x.
  18290. *
  18291. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18292. * other types of materials.
  18293. */
  18294. falloffType: number;
  18295. /**
  18296. * Strength of the light.
  18297. * Note: By default it is define in the framework own unit.
  18298. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18299. */
  18300. intensity: number;
  18301. private _range;
  18302. protected _inverseSquaredRange: number;
  18303. /**
  18304. * Defines how far from the source the light is impacting in scene units.
  18305. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18306. */
  18307. get range(): number;
  18308. /**
  18309. * Defines how far from the source the light is impacting in scene units.
  18310. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18311. */
  18312. set range(value: number);
  18313. /**
  18314. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18315. * of light.
  18316. */
  18317. private _photometricScale;
  18318. private _intensityMode;
  18319. /**
  18320. * Gets the photometric scale used to interpret the intensity.
  18321. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18322. */
  18323. get intensityMode(): number;
  18324. /**
  18325. * Sets the photometric scale used to interpret the intensity.
  18326. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18327. */
  18328. set intensityMode(value: number);
  18329. private _radius;
  18330. /**
  18331. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18332. */
  18333. get radius(): number;
  18334. /**
  18335. * sets the light radius used by PBR Materials to simulate soft area lights.
  18336. */
  18337. set radius(value: number);
  18338. private _renderPriority;
  18339. /**
  18340. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18341. * exceeding the number allowed of the materials.
  18342. */
  18343. renderPriority: number;
  18344. private _shadowEnabled;
  18345. /**
  18346. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18347. * the current shadow generator.
  18348. */
  18349. get shadowEnabled(): boolean;
  18350. /**
  18351. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18352. * the current shadow generator.
  18353. */
  18354. set shadowEnabled(value: boolean);
  18355. private _includedOnlyMeshes;
  18356. /**
  18357. * Gets the only meshes impacted by this light.
  18358. */
  18359. get includedOnlyMeshes(): AbstractMesh[];
  18360. /**
  18361. * Sets the only meshes impacted by this light.
  18362. */
  18363. set includedOnlyMeshes(value: AbstractMesh[]);
  18364. private _excludedMeshes;
  18365. /**
  18366. * Gets the meshes not impacted by this light.
  18367. */
  18368. get excludedMeshes(): AbstractMesh[];
  18369. /**
  18370. * Sets the meshes not impacted by this light.
  18371. */
  18372. set excludedMeshes(value: AbstractMesh[]);
  18373. private _excludeWithLayerMask;
  18374. /**
  18375. * Gets the layer id use to find what meshes are not impacted by the light.
  18376. * Inactive if 0
  18377. */
  18378. get excludeWithLayerMask(): number;
  18379. /**
  18380. * Sets the layer id use to find what meshes are not impacted by the light.
  18381. * Inactive if 0
  18382. */
  18383. set excludeWithLayerMask(value: number);
  18384. private _includeOnlyWithLayerMask;
  18385. /**
  18386. * Gets the layer id use to find what meshes are impacted by the light.
  18387. * Inactive if 0
  18388. */
  18389. get includeOnlyWithLayerMask(): number;
  18390. /**
  18391. * Sets the layer id use to find what meshes are impacted by the light.
  18392. * Inactive if 0
  18393. */
  18394. set includeOnlyWithLayerMask(value: number);
  18395. private _lightmapMode;
  18396. /**
  18397. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18398. */
  18399. get lightmapMode(): number;
  18400. /**
  18401. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18402. */
  18403. set lightmapMode(value: number);
  18404. /**
  18405. * Shadow generator associted to the light.
  18406. * @hidden Internal use only.
  18407. */
  18408. _shadowGenerator: Nullable<IShadowGenerator>;
  18409. /**
  18410. * @hidden Internal use only.
  18411. */
  18412. _excludedMeshesIds: string[];
  18413. /**
  18414. * @hidden Internal use only.
  18415. */
  18416. _includedOnlyMeshesIds: string[];
  18417. /**
  18418. * The current light unifom buffer.
  18419. * @hidden Internal use only.
  18420. */
  18421. _uniformBuffer: UniformBuffer;
  18422. /** @hidden */
  18423. _renderId: number;
  18424. /**
  18425. * Creates a Light object in the scene.
  18426. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18427. * @param name The firendly name of the light
  18428. * @param scene The scene the light belongs too
  18429. */
  18430. constructor(name: string, scene: Scene);
  18431. protected abstract _buildUniformLayout(): void;
  18432. /**
  18433. * Sets the passed Effect "effect" with the Light information.
  18434. * @param effect The effect to update
  18435. * @param lightIndex The index of the light in the effect to update
  18436. * @returns The light
  18437. */
  18438. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18439. /**
  18440. * Sets the passed Effect "effect" with the Light textures.
  18441. * @param effect The effect to update
  18442. * @param lightIndex The index of the light in the effect to update
  18443. * @returns The light
  18444. */
  18445. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18446. /**
  18447. * Binds the lights information from the scene to the effect for the given mesh.
  18448. * @param lightIndex Light index
  18449. * @param scene The scene where the light belongs to
  18450. * @param effect The effect we are binding the data to
  18451. * @param useSpecular Defines if specular is supported
  18452. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18453. */
  18454. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18455. /**
  18456. * Sets the passed Effect "effect" with the Light information.
  18457. * @param effect The effect to update
  18458. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18459. * @returns The light
  18460. */
  18461. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18462. /**
  18463. * Returns the string "Light".
  18464. * @returns the class name
  18465. */
  18466. getClassName(): string;
  18467. /** @hidden */
  18468. readonly _isLight: boolean;
  18469. /**
  18470. * Converts the light information to a readable string for debug purpose.
  18471. * @param fullDetails Supports for multiple levels of logging within scene loading
  18472. * @returns the human readable light info
  18473. */
  18474. toString(fullDetails?: boolean): string;
  18475. /** @hidden */
  18476. protected _syncParentEnabledState(): void;
  18477. /**
  18478. * Set the enabled state of this node.
  18479. * @param value - the new enabled state
  18480. */
  18481. setEnabled(value: boolean): void;
  18482. /**
  18483. * Returns the Light associated shadow generator if any.
  18484. * @return the associated shadow generator.
  18485. */
  18486. getShadowGenerator(): Nullable<IShadowGenerator>;
  18487. /**
  18488. * Returns a Vector3, the absolute light position in the World.
  18489. * @returns the world space position of the light
  18490. */
  18491. getAbsolutePosition(): Vector3;
  18492. /**
  18493. * Specifies if the light will affect the passed mesh.
  18494. * @param mesh The mesh to test against the light
  18495. * @return true the mesh is affected otherwise, false.
  18496. */
  18497. canAffectMesh(mesh: AbstractMesh): boolean;
  18498. /**
  18499. * Sort function to order lights for rendering.
  18500. * @param a First Light object to compare to second.
  18501. * @param b Second Light object to compare first.
  18502. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18503. */
  18504. static CompareLightsPriority(a: Light, b: Light): number;
  18505. /**
  18506. * Releases resources associated with this node.
  18507. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18508. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18509. */
  18510. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18511. /**
  18512. * Returns the light type ID (integer).
  18513. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18514. */
  18515. getTypeID(): number;
  18516. /**
  18517. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18518. * @returns the scaled intensity in intensity mode unit
  18519. */
  18520. getScaledIntensity(): number;
  18521. /**
  18522. * Returns a new Light object, named "name", from the current one.
  18523. * @param name The name of the cloned light
  18524. * @param newParent The parent of this light, if it has one
  18525. * @returns the new created light
  18526. */
  18527. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18528. /**
  18529. * Serializes the current light into a Serialization object.
  18530. * @returns the serialized object.
  18531. */
  18532. serialize(): any;
  18533. /**
  18534. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18535. * This new light is named "name" and added to the passed scene.
  18536. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18537. * @param name The friendly name of the light
  18538. * @param scene The scene the new light will belong to
  18539. * @returns the constructor function
  18540. */
  18541. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18542. /**
  18543. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18544. * @param parsedLight The JSON representation of the light
  18545. * @param scene The scene to create the parsed light in
  18546. * @returns the created light after parsing
  18547. */
  18548. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18549. private _hookArrayForExcluded;
  18550. private _hookArrayForIncludedOnly;
  18551. private _resyncMeshes;
  18552. /**
  18553. * Forces the meshes to update their light related information in their rendering used effects
  18554. * @hidden Internal Use Only
  18555. */
  18556. _markMeshesAsLightDirty(): void;
  18557. /**
  18558. * Recomputes the cached photometric scale if needed.
  18559. */
  18560. private _computePhotometricScale;
  18561. /**
  18562. * Returns the Photometric Scale according to the light type and intensity mode.
  18563. */
  18564. private _getPhotometricScale;
  18565. /**
  18566. * Reorder the light in the scene according to their defined priority.
  18567. * @hidden Internal Use Only
  18568. */
  18569. _reorderLightsInScene(): void;
  18570. /**
  18571. * Prepares the list of defines specific to the light type.
  18572. * @param defines the list of defines
  18573. * @param lightIndex defines the index of the light for the effect
  18574. */
  18575. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18576. }
  18577. }
  18578. declare module "babylonjs/Cameras/targetCamera" {
  18579. import { Nullable } from "babylonjs/types";
  18580. import { Camera } from "babylonjs/Cameras/camera";
  18581. import { Scene } from "babylonjs/scene";
  18582. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18583. /**
  18584. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18585. * This is the base of the follow, arc rotate cameras and Free camera
  18586. * @see http://doc.babylonjs.com/features/cameras
  18587. */
  18588. export class TargetCamera extends Camera {
  18589. private static _RigCamTransformMatrix;
  18590. private static _TargetTransformMatrix;
  18591. private static _TargetFocalPoint;
  18592. private _tmpUpVector;
  18593. private _tmpTargetVector;
  18594. /**
  18595. * Define the current direction the camera is moving to
  18596. */
  18597. cameraDirection: Vector3;
  18598. /**
  18599. * Define the current rotation the camera is rotating to
  18600. */
  18601. cameraRotation: Vector2;
  18602. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18603. ignoreParentScaling: boolean;
  18604. /**
  18605. * When set, the up vector of the camera will be updated by the rotation of the camera
  18606. */
  18607. updateUpVectorFromRotation: boolean;
  18608. private _tmpQuaternion;
  18609. /**
  18610. * Define the current rotation of the camera
  18611. */
  18612. rotation: Vector3;
  18613. /**
  18614. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18615. */
  18616. rotationQuaternion: Quaternion;
  18617. /**
  18618. * Define the current speed of the camera
  18619. */
  18620. speed: number;
  18621. /**
  18622. * Add constraint to the camera to prevent it to move freely in all directions and
  18623. * around all axis.
  18624. */
  18625. noRotationConstraint: boolean;
  18626. /**
  18627. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18628. * panning
  18629. */
  18630. invertRotation: boolean;
  18631. /**
  18632. * Speed multiplier for inverse camera panning
  18633. */
  18634. inverseRotationSpeed: number;
  18635. /**
  18636. * Define the current target of the camera as an object or a position.
  18637. */
  18638. lockedTarget: any;
  18639. /** @hidden */
  18640. _currentTarget: Vector3;
  18641. /** @hidden */
  18642. _initialFocalDistance: number;
  18643. /** @hidden */
  18644. _viewMatrix: Matrix;
  18645. /** @hidden */
  18646. _camMatrix: Matrix;
  18647. /** @hidden */
  18648. _cameraTransformMatrix: Matrix;
  18649. /** @hidden */
  18650. _cameraRotationMatrix: Matrix;
  18651. /** @hidden */
  18652. _referencePoint: Vector3;
  18653. /** @hidden */
  18654. _transformedReferencePoint: Vector3;
  18655. /** @hidden */
  18656. _reset: () => void;
  18657. private _defaultUp;
  18658. /**
  18659. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18660. * This is the base of the follow, arc rotate cameras and Free camera
  18661. * @see http://doc.babylonjs.com/features/cameras
  18662. * @param name Defines the name of the camera in the scene
  18663. * @param position Defines the start position of the camera in the scene
  18664. * @param scene Defines the scene the camera belongs to
  18665. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18666. */
  18667. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18668. /**
  18669. * Gets the position in front of the camera at a given distance.
  18670. * @param distance The distance from the camera we want the position to be
  18671. * @returns the position
  18672. */
  18673. getFrontPosition(distance: number): Vector3;
  18674. /** @hidden */
  18675. _getLockedTargetPosition(): Nullable<Vector3>;
  18676. private _storedPosition;
  18677. private _storedRotation;
  18678. private _storedRotationQuaternion;
  18679. /**
  18680. * Store current camera state of the camera (fov, position, rotation, etc..)
  18681. * @returns the camera
  18682. */
  18683. storeState(): Camera;
  18684. /**
  18685. * Restored camera state. You must call storeState() first
  18686. * @returns whether it was successful or not
  18687. * @hidden
  18688. */
  18689. _restoreStateValues(): boolean;
  18690. /** @hidden */
  18691. _initCache(): void;
  18692. /** @hidden */
  18693. _updateCache(ignoreParentClass?: boolean): void;
  18694. /** @hidden */
  18695. _isSynchronizedViewMatrix(): boolean;
  18696. /** @hidden */
  18697. _computeLocalCameraSpeed(): number;
  18698. /**
  18699. * Defines the target the camera should look at.
  18700. * @param target Defines the new target as a Vector or a mesh
  18701. */
  18702. setTarget(target: Vector3): void;
  18703. /**
  18704. * Return the current target position of the camera. This value is expressed in local space.
  18705. * @returns the target position
  18706. */
  18707. getTarget(): Vector3;
  18708. /** @hidden */
  18709. _decideIfNeedsToMove(): boolean;
  18710. /** @hidden */
  18711. _updatePosition(): void;
  18712. /** @hidden */
  18713. _checkInputs(): void;
  18714. protected _updateCameraRotationMatrix(): void;
  18715. /**
  18716. * 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)
  18717. * @returns the current camera
  18718. */
  18719. private _rotateUpVectorWithCameraRotationMatrix;
  18720. private _cachedRotationZ;
  18721. private _cachedQuaternionRotationZ;
  18722. /** @hidden */
  18723. _getViewMatrix(): Matrix;
  18724. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  18725. /**
  18726. * @hidden
  18727. */
  18728. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  18729. /**
  18730. * @hidden
  18731. */
  18732. _updateRigCameras(): void;
  18733. private _getRigCamPositionAndTarget;
  18734. /**
  18735. * Gets the current object class name.
  18736. * @return the class name
  18737. */
  18738. getClassName(): string;
  18739. }
  18740. }
  18741. declare module "babylonjs/Events/keyboardEvents" {
  18742. /**
  18743. * Gather the list of keyboard event types as constants.
  18744. */
  18745. export class KeyboardEventTypes {
  18746. /**
  18747. * The keydown event is fired when a key becomes active (pressed).
  18748. */
  18749. static readonly KEYDOWN: number;
  18750. /**
  18751. * The keyup event is fired when a key has been released.
  18752. */
  18753. static readonly KEYUP: number;
  18754. }
  18755. /**
  18756. * This class is used to store keyboard related info for the onKeyboardObservable event.
  18757. */
  18758. export class KeyboardInfo {
  18759. /**
  18760. * Defines the type of event (KeyboardEventTypes)
  18761. */
  18762. type: number;
  18763. /**
  18764. * Defines the related dom event
  18765. */
  18766. event: KeyboardEvent;
  18767. /**
  18768. * Instantiates a new keyboard info.
  18769. * This class is used to store keyboard related info for the onKeyboardObservable event.
  18770. * @param type Defines the type of event (KeyboardEventTypes)
  18771. * @param event Defines the related dom event
  18772. */
  18773. constructor(
  18774. /**
  18775. * Defines the type of event (KeyboardEventTypes)
  18776. */
  18777. type: number,
  18778. /**
  18779. * Defines the related dom event
  18780. */
  18781. event: KeyboardEvent);
  18782. }
  18783. /**
  18784. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  18785. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  18786. */
  18787. export class KeyboardInfoPre extends KeyboardInfo {
  18788. /**
  18789. * Defines the type of event (KeyboardEventTypes)
  18790. */
  18791. type: number;
  18792. /**
  18793. * Defines the related dom event
  18794. */
  18795. event: KeyboardEvent;
  18796. /**
  18797. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  18798. */
  18799. skipOnPointerObservable: boolean;
  18800. /**
  18801. * Instantiates a new keyboard pre info.
  18802. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  18803. * @param type Defines the type of event (KeyboardEventTypes)
  18804. * @param event Defines the related dom event
  18805. */
  18806. constructor(
  18807. /**
  18808. * Defines the type of event (KeyboardEventTypes)
  18809. */
  18810. type: number,
  18811. /**
  18812. * Defines the related dom event
  18813. */
  18814. event: KeyboardEvent);
  18815. }
  18816. }
  18817. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  18818. import { Nullable } from "babylonjs/types";
  18819. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  18820. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  18821. /**
  18822. * Manage the keyboard inputs to control the movement of a free camera.
  18823. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  18824. */
  18825. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  18826. /**
  18827. * Defines the camera the input is attached to.
  18828. */
  18829. camera: FreeCamera;
  18830. /**
  18831. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  18832. */
  18833. keysUp: number[];
  18834. /**
  18835. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  18836. */
  18837. keysUpward: number[];
  18838. /**
  18839. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  18840. */
  18841. keysDown: number[];
  18842. /**
  18843. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  18844. */
  18845. keysDownward: number[];
  18846. /**
  18847. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  18848. */
  18849. keysLeft: number[];
  18850. /**
  18851. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  18852. */
  18853. keysRight: number[];
  18854. private _keys;
  18855. private _onCanvasBlurObserver;
  18856. private _onKeyboardObserver;
  18857. private _engine;
  18858. private _scene;
  18859. /**
  18860. * Attach the input controls to a specific dom element to get the input from.
  18861. * @param element Defines the element the controls should be listened from
  18862. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  18863. */
  18864. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  18865. /**
  18866. * Detach the current controls from the specified dom element.
  18867. * @param element Defines the element to stop listening the inputs from
  18868. */
  18869. detachControl(element: Nullable<HTMLElement>): void;
  18870. /**
  18871. * Update the current camera state depending on the inputs that have been used this frame.
  18872. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  18873. */
  18874. checkInputs(): void;
  18875. /**
  18876. * Gets the class name of the current intput.
  18877. * @returns the class name
  18878. */
  18879. getClassName(): string;
  18880. /** @hidden */
  18881. _onLostFocus(): void;
  18882. /**
  18883. * Get the friendly name associated with the input class.
  18884. * @returns the input friendly name
  18885. */
  18886. getSimpleName(): string;
  18887. }
  18888. }
  18889. declare module "babylonjs/Events/pointerEvents" {
  18890. import { Nullable } from "babylonjs/types";
  18891. import { Vector2 } from "babylonjs/Maths/math.vector";
  18892. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  18893. import { Ray } from "babylonjs/Culling/ray";
  18894. /**
  18895. * Gather the list of pointer event types as constants.
  18896. */
  18897. export class PointerEventTypes {
  18898. /**
  18899. * 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.
  18900. */
  18901. static readonly POINTERDOWN: number;
  18902. /**
  18903. * The pointerup event is fired when a pointer is no longer active.
  18904. */
  18905. static readonly POINTERUP: number;
  18906. /**
  18907. * The pointermove event is fired when a pointer changes coordinates.
  18908. */
  18909. static readonly POINTERMOVE: number;
  18910. /**
  18911. * The pointerwheel event is fired when a mouse wheel has been rotated.
  18912. */
  18913. static readonly POINTERWHEEL: number;
  18914. /**
  18915. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  18916. */
  18917. static readonly POINTERPICK: number;
  18918. /**
  18919. * The pointertap event is fired when a the object has been touched and released without drag.
  18920. */
  18921. static readonly POINTERTAP: number;
  18922. /**
  18923. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  18924. */
  18925. static readonly POINTERDOUBLETAP: number;
  18926. }
  18927. /**
  18928. * Base class of pointer info types.
  18929. */
  18930. export class PointerInfoBase {
  18931. /**
  18932. * Defines the type of event (PointerEventTypes)
  18933. */
  18934. type: number;
  18935. /**
  18936. * Defines the related dom event
  18937. */
  18938. event: PointerEvent | MouseWheelEvent;
  18939. /**
  18940. * Instantiates the base class of pointers info.
  18941. * @param type Defines the type of event (PointerEventTypes)
  18942. * @param event Defines the related dom event
  18943. */
  18944. constructor(
  18945. /**
  18946. * Defines the type of event (PointerEventTypes)
  18947. */
  18948. type: number,
  18949. /**
  18950. * Defines the related dom event
  18951. */
  18952. event: PointerEvent | MouseWheelEvent);
  18953. }
  18954. /**
  18955. * This class is used to store pointer related info for the onPrePointerObservable event.
  18956. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  18957. */
  18958. export class PointerInfoPre extends PointerInfoBase {
  18959. /**
  18960. * Ray from a pointer if availible (eg. 6dof controller)
  18961. */
  18962. ray: Nullable<Ray>;
  18963. /**
  18964. * Defines the local position of the pointer on the canvas.
  18965. */
  18966. localPosition: Vector2;
  18967. /**
  18968. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  18969. */
  18970. skipOnPointerObservable: boolean;
  18971. /**
  18972. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  18973. * @param type Defines the type of event (PointerEventTypes)
  18974. * @param event Defines the related dom event
  18975. * @param localX Defines the local x coordinates of the pointer when the event occured
  18976. * @param localY Defines the local y coordinates of the pointer when the event occured
  18977. */
  18978. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  18979. }
  18980. /**
  18981. * This type contains all the data related to a pointer event in Babylon.js.
  18982. * 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.
  18983. */
  18984. export class PointerInfo extends PointerInfoBase {
  18985. /**
  18986. * Defines the picking info associated to the info (if any)\
  18987. */
  18988. pickInfo: Nullable<PickingInfo>;
  18989. /**
  18990. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  18991. * @param type Defines the type of event (PointerEventTypes)
  18992. * @param event Defines the related dom event
  18993. * @param pickInfo Defines the picking info associated to the info (if any)\
  18994. */
  18995. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  18996. /**
  18997. * Defines the picking info associated to the info (if any)\
  18998. */
  18999. pickInfo: Nullable<PickingInfo>);
  19000. }
  19001. /**
  19002. * Data relating to a touch event on the screen.
  19003. */
  19004. export interface PointerTouch {
  19005. /**
  19006. * X coordinate of touch.
  19007. */
  19008. x: number;
  19009. /**
  19010. * Y coordinate of touch.
  19011. */
  19012. y: number;
  19013. /**
  19014. * Id of touch. Unique for each finger.
  19015. */
  19016. pointerId: number;
  19017. /**
  19018. * Event type passed from DOM.
  19019. */
  19020. type: any;
  19021. }
  19022. }
  19023. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19024. import { Observable } from "babylonjs/Misc/observable";
  19025. import { Nullable } from "babylonjs/types";
  19026. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19027. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19028. /**
  19029. * Manage the mouse inputs to control the movement of a free camera.
  19030. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  19031. */
  19032. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19033. /**
  19034. * Define if touch is enabled in the mouse input
  19035. */
  19036. touchEnabled: boolean;
  19037. /**
  19038. * Defines the camera the input is attached to.
  19039. */
  19040. camera: FreeCamera;
  19041. /**
  19042. * Defines the buttons associated with the input to handle camera move.
  19043. */
  19044. buttons: number[];
  19045. /**
  19046. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19047. */
  19048. angularSensibility: number;
  19049. private _pointerInput;
  19050. private _onMouseMove;
  19051. private _observer;
  19052. private previousPosition;
  19053. /**
  19054. * Observable for when a pointer move event occurs containing the move offset
  19055. */
  19056. onPointerMovedObservable: Observable<{
  19057. offsetX: number;
  19058. offsetY: number;
  19059. }>;
  19060. /**
  19061. * @hidden
  19062. * If the camera should be rotated automatically based on pointer movement
  19063. */
  19064. _allowCameraRotation: boolean;
  19065. /**
  19066. * Manage the mouse inputs to control the movement of a free camera.
  19067. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  19068. * @param touchEnabled Defines if touch is enabled or not
  19069. */
  19070. constructor(
  19071. /**
  19072. * Define if touch is enabled in the mouse input
  19073. */
  19074. touchEnabled?: boolean);
  19075. /**
  19076. * Attach the input controls to a specific dom element to get the input from.
  19077. * @param element Defines the element the controls should be listened from
  19078. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19079. */
  19080. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19081. /**
  19082. * Called on JS contextmenu event.
  19083. * Override this method to provide functionality.
  19084. */
  19085. protected onContextMenu(evt: PointerEvent): void;
  19086. /**
  19087. * Detach the current controls from the specified dom element.
  19088. * @param element Defines the element to stop listening the inputs from
  19089. */
  19090. detachControl(element: Nullable<HTMLElement>): void;
  19091. /**
  19092. * Gets the class name of the current intput.
  19093. * @returns the class name
  19094. */
  19095. getClassName(): string;
  19096. /**
  19097. * Get the friendly name associated with the input class.
  19098. * @returns the input friendly name
  19099. */
  19100. getSimpleName(): string;
  19101. }
  19102. }
  19103. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19104. import { Nullable } from "babylonjs/types";
  19105. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19106. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19107. /**
  19108. * Manage the touch inputs to control the movement of a free camera.
  19109. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  19110. */
  19111. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19112. /**
  19113. * Defines the camera the input is attached to.
  19114. */
  19115. camera: FreeCamera;
  19116. /**
  19117. * Defines the touch sensibility for rotation.
  19118. * The higher the faster.
  19119. */
  19120. touchAngularSensibility: number;
  19121. /**
  19122. * Defines the touch sensibility for move.
  19123. * The higher the faster.
  19124. */
  19125. touchMoveSensibility: number;
  19126. private _offsetX;
  19127. private _offsetY;
  19128. private _pointerPressed;
  19129. private _pointerInput;
  19130. private _observer;
  19131. private _onLostFocus;
  19132. /**
  19133. * Attach the input controls to a specific dom element to get the input from.
  19134. * @param element Defines the element the controls should be listened from
  19135. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19136. */
  19137. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19138. /**
  19139. * Detach the current controls from the specified dom element.
  19140. * @param element Defines the element to stop listening the inputs from
  19141. */
  19142. detachControl(element: Nullable<HTMLElement>): void;
  19143. /**
  19144. * Update the current camera state depending on the inputs that have been used this frame.
  19145. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19146. */
  19147. checkInputs(): void;
  19148. /**
  19149. * Gets the class name of the current intput.
  19150. * @returns the class name
  19151. */
  19152. getClassName(): string;
  19153. /**
  19154. * Get the friendly name associated with the input class.
  19155. * @returns the input friendly name
  19156. */
  19157. getSimpleName(): string;
  19158. }
  19159. }
  19160. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19161. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19162. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19163. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19164. import { Nullable } from "babylonjs/types";
  19165. /**
  19166. * Default Inputs manager for the FreeCamera.
  19167. * It groups all the default supported inputs for ease of use.
  19168. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  19169. */
  19170. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19171. /**
  19172. * @hidden
  19173. */
  19174. _mouseInput: Nullable<FreeCameraMouseInput>;
  19175. /**
  19176. * Instantiates a new FreeCameraInputsManager.
  19177. * @param camera Defines the camera the inputs belong to
  19178. */
  19179. constructor(camera: FreeCamera);
  19180. /**
  19181. * Add keyboard input support to the input manager.
  19182. * @returns the current input manager
  19183. */
  19184. addKeyboard(): FreeCameraInputsManager;
  19185. /**
  19186. * Add mouse input support to the input manager.
  19187. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19188. * @returns the current input manager
  19189. */
  19190. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19191. /**
  19192. * Removes the mouse input support from the manager
  19193. * @returns the current input manager
  19194. */
  19195. removeMouse(): FreeCameraInputsManager;
  19196. /**
  19197. * Add touch input support to the input manager.
  19198. * @returns the current input manager
  19199. */
  19200. addTouch(): FreeCameraInputsManager;
  19201. /**
  19202. * Remove all attached input methods from a camera
  19203. */
  19204. clear(): void;
  19205. }
  19206. }
  19207. declare module "babylonjs/Cameras/freeCamera" {
  19208. import { Vector3 } from "babylonjs/Maths/math.vector";
  19209. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19210. import { Scene } from "babylonjs/scene";
  19211. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19212. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19213. /**
  19214. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19215. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19216. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  19217. */
  19218. export class FreeCamera extends TargetCamera {
  19219. /**
  19220. * Define the collision ellipsoid of the camera.
  19221. * This is helpful to simulate a camera body like the player body around the camera
  19222. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19223. */
  19224. ellipsoid: Vector3;
  19225. /**
  19226. * Define an offset for the position of the ellipsoid around the camera.
  19227. * This can be helpful to determine the center of the body near the gravity center of the body
  19228. * instead of its head.
  19229. */
  19230. ellipsoidOffset: Vector3;
  19231. /**
  19232. * Enable or disable collisions of the camera with the rest of the scene objects.
  19233. */
  19234. checkCollisions: boolean;
  19235. /**
  19236. * Enable or disable gravity on the camera.
  19237. */
  19238. applyGravity: boolean;
  19239. /**
  19240. * Define the input manager associated to the camera.
  19241. */
  19242. inputs: FreeCameraInputsManager;
  19243. /**
  19244. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19245. * Higher values reduce sensitivity.
  19246. */
  19247. get angularSensibility(): number;
  19248. /**
  19249. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19250. * Higher values reduce sensitivity.
  19251. */
  19252. set angularSensibility(value: number);
  19253. /**
  19254. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19255. */
  19256. get keysUp(): number[];
  19257. set keysUp(value: number[]);
  19258. /**
  19259. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19260. */
  19261. get keysUpward(): number[];
  19262. set keysUpward(value: number[]);
  19263. /**
  19264. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19265. */
  19266. get keysDown(): number[];
  19267. set keysDown(value: number[]);
  19268. /**
  19269. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19270. */
  19271. get keysDownward(): number[];
  19272. set keysDownward(value: number[]);
  19273. /**
  19274. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19275. */
  19276. get keysLeft(): number[];
  19277. set keysLeft(value: number[]);
  19278. /**
  19279. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19280. */
  19281. get keysRight(): number[];
  19282. set keysRight(value: number[]);
  19283. /**
  19284. * Event raised when the camera collide with a mesh in the scene.
  19285. */
  19286. onCollide: (collidedMesh: AbstractMesh) => void;
  19287. private _collider;
  19288. private _needMoveForGravity;
  19289. private _oldPosition;
  19290. private _diffPosition;
  19291. private _newPosition;
  19292. /** @hidden */
  19293. _localDirection: Vector3;
  19294. /** @hidden */
  19295. _transformedDirection: Vector3;
  19296. /**
  19297. * Instantiates a Free Camera.
  19298. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19299. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19300. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  19301. * @param name Define the name of the camera in the scene
  19302. * @param position Define the start position of the camera in the scene
  19303. * @param scene Define the scene the camera belongs to
  19304. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19305. */
  19306. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19307. /**
  19308. * Attached controls to the current camera.
  19309. * @param element Defines the element the controls should be listened from
  19310. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19311. */
  19312. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19313. /**
  19314. * Detach the current controls from the camera.
  19315. * The camera will stop reacting to inputs.
  19316. * @param element Defines the element to stop listening the inputs from
  19317. */
  19318. detachControl(element: HTMLElement): void;
  19319. private _collisionMask;
  19320. /**
  19321. * Define a collision mask to limit the list of object the camera can collide with
  19322. */
  19323. get collisionMask(): number;
  19324. set collisionMask(mask: number);
  19325. /** @hidden */
  19326. _collideWithWorld(displacement: Vector3): void;
  19327. private _onCollisionPositionChange;
  19328. /** @hidden */
  19329. _checkInputs(): void;
  19330. /** @hidden */
  19331. _decideIfNeedsToMove(): boolean;
  19332. /** @hidden */
  19333. _updatePosition(): void;
  19334. /**
  19335. * Destroy the camera and release the current resources hold by it.
  19336. */
  19337. dispose(): void;
  19338. /**
  19339. * Gets the current object class name.
  19340. * @return the class name
  19341. */
  19342. getClassName(): string;
  19343. }
  19344. }
  19345. declare module "babylonjs/Gamepads/gamepad" {
  19346. import { Observable } from "babylonjs/Misc/observable";
  19347. /**
  19348. * Represents a gamepad control stick position
  19349. */
  19350. export class StickValues {
  19351. /**
  19352. * The x component of the control stick
  19353. */
  19354. x: number;
  19355. /**
  19356. * The y component of the control stick
  19357. */
  19358. y: number;
  19359. /**
  19360. * Initializes the gamepad x and y control stick values
  19361. * @param x The x component of the gamepad control stick value
  19362. * @param y The y component of the gamepad control stick value
  19363. */
  19364. constructor(
  19365. /**
  19366. * The x component of the control stick
  19367. */
  19368. x: number,
  19369. /**
  19370. * The y component of the control stick
  19371. */
  19372. y: number);
  19373. }
  19374. /**
  19375. * An interface which manages callbacks for gamepad button changes
  19376. */
  19377. export interface GamepadButtonChanges {
  19378. /**
  19379. * Called when a gamepad has been changed
  19380. */
  19381. changed: boolean;
  19382. /**
  19383. * Called when a gamepad press event has been triggered
  19384. */
  19385. pressChanged: boolean;
  19386. /**
  19387. * Called when a touch event has been triggered
  19388. */
  19389. touchChanged: boolean;
  19390. /**
  19391. * Called when a value has changed
  19392. */
  19393. valueChanged: boolean;
  19394. }
  19395. /**
  19396. * Represents a gamepad
  19397. */
  19398. export class Gamepad {
  19399. /**
  19400. * The id of the gamepad
  19401. */
  19402. id: string;
  19403. /**
  19404. * The index of the gamepad
  19405. */
  19406. index: number;
  19407. /**
  19408. * The browser gamepad
  19409. */
  19410. browserGamepad: any;
  19411. /**
  19412. * Specifies what type of gamepad this represents
  19413. */
  19414. type: number;
  19415. private _leftStick;
  19416. private _rightStick;
  19417. /** @hidden */
  19418. _isConnected: boolean;
  19419. private _leftStickAxisX;
  19420. private _leftStickAxisY;
  19421. private _rightStickAxisX;
  19422. private _rightStickAxisY;
  19423. /**
  19424. * Triggered when the left control stick has been changed
  19425. */
  19426. private _onleftstickchanged;
  19427. /**
  19428. * Triggered when the right control stick has been changed
  19429. */
  19430. private _onrightstickchanged;
  19431. /**
  19432. * Represents a gamepad controller
  19433. */
  19434. static GAMEPAD: number;
  19435. /**
  19436. * Represents a generic controller
  19437. */
  19438. static GENERIC: number;
  19439. /**
  19440. * Represents an XBox controller
  19441. */
  19442. static XBOX: number;
  19443. /**
  19444. * Represents a pose-enabled controller
  19445. */
  19446. static POSE_ENABLED: number;
  19447. /**
  19448. * Represents an Dual Shock controller
  19449. */
  19450. static DUALSHOCK: number;
  19451. /**
  19452. * Specifies whether the left control stick should be Y-inverted
  19453. */
  19454. protected _invertLeftStickY: boolean;
  19455. /**
  19456. * Specifies if the gamepad has been connected
  19457. */
  19458. get isConnected(): boolean;
  19459. /**
  19460. * Initializes the gamepad
  19461. * @param id The id of the gamepad
  19462. * @param index The index of the gamepad
  19463. * @param browserGamepad The browser gamepad
  19464. * @param leftStickX The x component of the left joystick
  19465. * @param leftStickY The y component of the left joystick
  19466. * @param rightStickX The x component of the right joystick
  19467. * @param rightStickY The y component of the right joystick
  19468. */
  19469. constructor(
  19470. /**
  19471. * The id of the gamepad
  19472. */
  19473. id: string,
  19474. /**
  19475. * The index of the gamepad
  19476. */
  19477. index: number,
  19478. /**
  19479. * The browser gamepad
  19480. */
  19481. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19482. /**
  19483. * Callback triggered when the left joystick has changed
  19484. * @param callback
  19485. */
  19486. onleftstickchanged(callback: (values: StickValues) => void): void;
  19487. /**
  19488. * Callback triggered when the right joystick has changed
  19489. * @param callback
  19490. */
  19491. onrightstickchanged(callback: (values: StickValues) => void): void;
  19492. /**
  19493. * Gets the left joystick
  19494. */
  19495. get leftStick(): StickValues;
  19496. /**
  19497. * Sets the left joystick values
  19498. */
  19499. set leftStick(newValues: StickValues);
  19500. /**
  19501. * Gets the right joystick
  19502. */
  19503. get rightStick(): StickValues;
  19504. /**
  19505. * Sets the right joystick value
  19506. */
  19507. set rightStick(newValues: StickValues);
  19508. /**
  19509. * Updates the gamepad joystick positions
  19510. */
  19511. update(): void;
  19512. /**
  19513. * Disposes the gamepad
  19514. */
  19515. dispose(): void;
  19516. }
  19517. /**
  19518. * Represents a generic gamepad
  19519. */
  19520. export class GenericPad extends Gamepad {
  19521. private _buttons;
  19522. private _onbuttondown;
  19523. private _onbuttonup;
  19524. /**
  19525. * Observable triggered when a button has been pressed
  19526. */
  19527. onButtonDownObservable: Observable<number>;
  19528. /**
  19529. * Observable triggered when a button has been released
  19530. */
  19531. onButtonUpObservable: Observable<number>;
  19532. /**
  19533. * Callback triggered when a button has been pressed
  19534. * @param callback Called when a button has been pressed
  19535. */
  19536. onbuttondown(callback: (buttonPressed: number) => void): void;
  19537. /**
  19538. * Callback triggered when a button has been released
  19539. * @param callback Called when a button has been released
  19540. */
  19541. onbuttonup(callback: (buttonReleased: number) => void): void;
  19542. /**
  19543. * Initializes the generic gamepad
  19544. * @param id The id of the generic gamepad
  19545. * @param index The index of the generic gamepad
  19546. * @param browserGamepad The browser gamepad
  19547. */
  19548. constructor(id: string, index: number, browserGamepad: any);
  19549. private _setButtonValue;
  19550. /**
  19551. * Updates the generic gamepad
  19552. */
  19553. update(): void;
  19554. /**
  19555. * Disposes the generic gamepad
  19556. */
  19557. dispose(): void;
  19558. }
  19559. }
  19560. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19561. import { Observable } from "babylonjs/Misc/observable";
  19562. import { Nullable } from "babylonjs/types";
  19563. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19564. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19565. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19566. import { Ray } from "babylonjs/Culling/ray";
  19567. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19568. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19569. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19570. /**
  19571. * Defines the types of pose enabled controllers that are supported
  19572. */
  19573. export enum PoseEnabledControllerType {
  19574. /**
  19575. * HTC Vive
  19576. */
  19577. VIVE = 0,
  19578. /**
  19579. * Oculus Rift
  19580. */
  19581. OCULUS = 1,
  19582. /**
  19583. * Windows mixed reality
  19584. */
  19585. WINDOWS = 2,
  19586. /**
  19587. * Samsung gear VR
  19588. */
  19589. GEAR_VR = 3,
  19590. /**
  19591. * Google Daydream
  19592. */
  19593. DAYDREAM = 4,
  19594. /**
  19595. * Generic
  19596. */
  19597. GENERIC = 5
  19598. }
  19599. /**
  19600. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19601. */
  19602. export interface MutableGamepadButton {
  19603. /**
  19604. * Value of the button/trigger
  19605. */
  19606. value: number;
  19607. /**
  19608. * If the button/trigger is currently touched
  19609. */
  19610. touched: boolean;
  19611. /**
  19612. * If the button/trigger is currently pressed
  19613. */
  19614. pressed: boolean;
  19615. }
  19616. /**
  19617. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19618. * @hidden
  19619. */
  19620. export interface ExtendedGamepadButton extends GamepadButton {
  19621. /**
  19622. * If the button/trigger is currently pressed
  19623. */
  19624. readonly pressed: boolean;
  19625. /**
  19626. * If the button/trigger is currently touched
  19627. */
  19628. readonly touched: boolean;
  19629. /**
  19630. * Value of the button/trigger
  19631. */
  19632. readonly value: number;
  19633. }
  19634. /** @hidden */
  19635. export interface _GamePadFactory {
  19636. /**
  19637. * Returns whether or not the current gamepad can be created for this type of controller.
  19638. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19639. * @returns true if it can be created, otherwise false
  19640. */
  19641. canCreate(gamepadInfo: any): boolean;
  19642. /**
  19643. * Creates a new instance of the Gamepad.
  19644. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19645. * @returns the new gamepad instance
  19646. */
  19647. create(gamepadInfo: any): Gamepad;
  19648. }
  19649. /**
  19650. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19651. */
  19652. export class PoseEnabledControllerHelper {
  19653. /** @hidden */
  19654. static _ControllerFactories: _GamePadFactory[];
  19655. /** @hidden */
  19656. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19657. /**
  19658. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19659. * @param vrGamepad the gamepad to initialized
  19660. * @returns a vr controller of the type the gamepad identified as
  19661. */
  19662. static InitiateController(vrGamepad: any): Gamepad;
  19663. }
  19664. /**
  19665. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19666. */
  19667. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19668. /**
  19669. * If the controller is used in a webXR session
  19670. */
  19671. isXR: boolean;
  19672. private _deviceRoomPosition;
  19673. private _deviceRoomRotationQuaternion;
  19674. /**
  19675. * The device position in babylon space
  19676. */
  19677. devicePosition: Vector3;
  19678. /**
  19679. * The device rotation in babylon space
  19680. */
  19681. deviceRotationQuaternion: Quaternion;
  19682. /**
  19683. * The scale factor of the device in babylon space
  19684. */
  19685. deviceScaleFactor: number;
  19686. /**
  19687. * (Likely devicePosition should be used instead) The device position in its room space
  19688. */
  19689. position: Vector3;
  19690. /**
  19691. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  19692. */
  19693. rotationQuaternion: Quaternion;
  19694. /**
  19695. * The type of controller (Eg. Windows mixed reality)
  19696. */
  19697. controllerType: PoseEnabledControllerType;
  19698. protected _calculatedPosition: Vector3;
  19699. private _calculatedRotation;
  19700. /**
  19701. * The raw pose from the device
  19702. */
  19703. rawPose: DevicePose;
  19704. private _trackPosition;
  19705. private _maxRotationDistFromHeadset;
  19706. private _draggedRoomRotation;
  19707. /**
  19708. * @hidden
  19709. */
  19710. _disableTrackPosition(fixedPosition: Vector3): void;
  19711. /**
  19712. * Internal, the mesh attached to the controller
  19713. * @hidden
  19714. */
  19715. _mesh: Nullable<AbstractMesh>;
  19716. private _poseControlledCamera;
  19717. private _leftHandSystemQuaternion;
  19718. /**
  19719. * Internal, matrix used to convert room space to babylon space
  19720. * @hidden
  19721. */
  19722. _deviceToWorld: Matrix;
  19723. /**
  19724. * Node to be used when casting a ray from the controller
  19725. * @hidden
  19726. */
  19727. _pointingPoseNode: Nullable<TransformNode>;
  19728. /**
  19729. * Name of the child mesh that can be used to cast a ray from the controller
  19730. */
  19731. static readonly POINTING_POSE: string;
  19732. /**
  19733. * Creates a new PoseEnabledController from a gamepad
  19734. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  19735. */
  19736. constructor(browserGamepad: any);
  19737. private _workingMatrix;
  19738. /**
  19739. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  19740. */
  19741. update(): void;
  19742. /**
  19743. * Updates only the pose device and mesh without doing any button event checking
  19744. */
  19745. protected _updatePoseAndMesh(): void;
  19746. /**
  19747. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  19748. * @param poseData raw pose fromthe device
  19749. */
  19750. updateFromDevice(poseData: DevicePose): void;
  19751. /**
  19752. * @hidden
  19753. */
  19754. _meshAttachedObservable: Observable<AbstractMesh>;
  19755. /**
  19756. * Attaches a mesh to the controller
  19757. * @param mesh the mesh to be attached
  19758. */
  19759. attachToMesh(mesh: AbstractMesh): void;
  19760. /**
  19761. * Attaches the controllers mesh to a camera
  19762. * @param camera the camera the mesh should be attached to
  19763. */
  19764. attachToPoseControlledCamera(camera: TargetCamera): void;
  19765. /**
  19766. * Disposes of the controller
  19767. */
  19768. dispose(): void;
  19769. /**
  19770. * The mesh that is attached to the controller
  19771. */
  19772. get mesh(): Nullable<AbstractMesh>;
  19773. /**
  19774. * Gets the ray of the controller in the direction the controller is pointing
  19775. * @param length the length the resulting ray should be
  19776. * @returns a ray in the direction the controller is pointing
  19777. */
  19778. getForwardRay(length?: number): Ray;
  19779. }
  19780. }
  19781. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  19782. import { Observable } from "babylonjs/Misc/observable";
  19783. import { Scene } from "babylonjs/scene";
  19784. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19785. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  19786. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  19787. import { Nullable } from "babylonjs/types";
  19788. /**
  19789. * Defines the WebVRController object that represents controllers tracked in 3D space
  19790. */
  19791. export abstract class WebVRController extends PoseEnabledController {
  19792. /**
  19793. * Internal, the default controller model for the controller
  19794. */
  19795. protected _defaultModel: Nullable<AbstractMesh>;
  19796. /**
  19797. * Fired when the trigger state has changed
  19798. */
  19799. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  19800. /**
  19801. * Fired when the main button state has changed
  19802. */
  19803. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  19804. /**
  19805. * Fired when the secondary button state has changed
  19806. */
  19807. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  19808. /**
  19809. * Fired when the pad state has changed
  19810. */
  19811. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  19812. /**
  19813. * Fired when controllers stick values have changed
  19814. */
  19815. onPadValuesChangedObservable: Observable<StickValues>;
  19816. /**
  19817. * Array of button availible on the controller
  19818. */
  19819. protected _buttons: Array<MutableGamepadButton>;
  19820. private _onButtonStateChange;
  19821. /**
  19822. * Fired when a controller button's state has changed
  19823. * @param callback the callback containing the button that was modified
  19824. */
  19825. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  19826. /**
  19827. * X and Y axis corresponding to the controllers joystick
  19828. */
  19829. pad: StickValues;
  19830. /**
  19831. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  19832. */
  19833. hand: string;
  19834. /**
  19835. * The default controller model for the controller
  19836. */
  19837. get defaultModel(): Nullable<AbstractMesh>;
  19838. /**
  19839. * Creates a new WebVRController from a gamepad
  19840. * @param vrGamepad the gamepad that the WebVRController should be created from
  19841. */
  19842. constructor(vrGamepad: any);
  19843. /**
  19844. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  19845. */
  19846. update(): void;
  19847. /**
  19848. * Function to be called when a button is modified
  19849. */
  19850. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  19851. /**
  19852. * Loads a mesh and attaches it to the controller
  19853. * @param scene the scene the mesh should be added to
  19854. * @param meshLoaded callback for when the mesh has been loaded
  19855. */
  19856. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  19857. private _setButtonValue;
  19858. private _changes;
  19859. private _checkChanges;
  19860. /**
  19861. * Disposes of th webVRCOntroller
  19862. */
  19863. dispose(): void;
  19864. }
  19865. }
  19866. declare module "babylonjs/Lights/hemisphericLight" {
  19867. import { Nullable } from "babylonjs/types";
  19868. import { Scene } from "babylonjs/scene";
  19869. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19870. import { Color3 } from "babylonjs/Maths/math.color";
  19871. import { Effect } from "babylonjs/Materials/effect";
  19872. import { Light } from "babylonjs/Lights/light";
  19873. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  19874. /**
  19875. * The HemisphericLight simulates the ambient environment light,
  19876. * so the passed direction is the light reflection direction, not the incoming direction.
  19877. */
  19878. export class HemisphericLight extends Light {
  19879. /**
  19880. * The groundColor is the light in the opposite direction to the one specified during creation.
  19881. * 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.
  19882. */
  19883. groundColor: Color3;
  19884. /**
  19885. * The light reflection direction, not the incoming direction.
  19886. */
  19887. direction: Vector3;
  19888. /**
  19889. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  19890. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  19891. * The HemisphericLight can't cast shadows.
  19892. * Documentation : https://doc.babylonjs.com/babylon101/lights
  19893. * @param name The friendly name of the light
  19894. * @param direction The direction of the light reflection
  19895. * @param scene The scene the light belongs to
  19896. */
  19897. constructor(name: string, direction: Vector3, scene: Scene);
  19898. protected _buildUniformLayout(): void;
  19899. /**
  19900. * Returns the string "HemisphericLight".
  19901. * @return The class name
  19902. */
  19903. getClassName(): string;
  19904. /**
  19905. * Sets the HemisphericLight direction towards the passed target (Vector3).
  19906. * Returns the updated direction.
  19907. * @param target The target the direction should point to
  19908. * @return The computed direction
  19909. */
  19910. setDirectionToTarget(target: Vector3): Vector3;
  19911. /**
  19912. * Returns the shadow generator associated to the light.
  19913. * @returns Always null for hemispheric lights because it does not support shadows.
  19914. */
  19915. getShadowGenerator(): Nullable<IShadowGenerator>;
  19916. /**
  19917. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  19918. * @param effect The effect to update
  19919. * @param lightIndex The index of the light in the effect to update
  19920. * @returns The hemispheric light
  19921. */
  19922. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  19923. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  19924. /**
  19925. * Computes the world matrix of the node
  19926. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  19927. * @param useWasUpdatedFlag defines a reserved property
  19928. * @returns the world matrix
  19929. */
  19930. computeWorldMatrix(): Matrix;
  19931. /**
  19932. * Returns the integer 3.
  19933. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  19934. */
  19935. getTypeID(): number;
  19936. /**
  19937. * Prepares the list of defines specific to the light type.
  19938. * @param defines the list of defines
  19939. * @param lightIndex defines the index of the light for the effect
  19940. */
  19941. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  19942. }
  19943. }
  19944. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  19945. /** @hidden */
  19946. export var vrMultiviewToSingleviewPixelShader: {
  19947. name: string;
  19948. shader: string;
  19949. };
  19950. }
  19951. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  19952. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  19953. import { Scene } from "babylonjs/scene";
  19954. /**
  19955. * Renders to multiple views with a single draw call
  19956. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  19957. */
  19958. export class MultiviewRenderTarget extends RenderTargetTexture {
  19959. /**
  19960. * Creates a multiview render target
  19961. * @param scene scene used with the render target
  19962. * @param size the size of the render target (used for each view)
  19963. */
  19964. constructor(scene: Scene, size?: number | {
  19965. width: number;
  19966. height: number;
  19967. } | {
  19968. ratio: number;
  19969. });
  19970. /**
  19971. * @hidden
  19972. * @param faceIndex the face index, if its a cube texture
  19973. */
  19974. _bindFrameBuffer(faceIndex?: number): void;
  19975. /**
  19976. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  19977. * @returns the view count
  19978. */
  19979. getViewCount(): number;
  19980. }
  19981. }
  19982. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  19983. import { Camera } from "babylonjs/Cameras/camera";
  19984. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  19985. import { Nullable } from "babylonjs/types";
  19986. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  19987. import { Matrix } from "babylonjs/Maths/math.vector";
  19988. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  19989. module "babylonjs/Engines/engine" {
  19990. interface Engine {
  19991. /**
  19992. * Creates a new multiview render target
  19993. * @param width defines the width of the texture
  19994. * @param height defines the height of the texture
  19995. * @returns the created multiview texture
  19996. */
  19997. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  19998. /**
  19999. * Binds a multiview framebuffer to be drawn to
  20000. * @param multiviewTexture texture to bind
  20001. */
  20002. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20003. }
  20004. }
  20005. module "babylonjs/Cameras/camera" {
  20006. interface Camera {
  20007. /**
  20008. * @hidden
  20009. * 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)
  20010. */
  20011. _useMultiviewToSingleView: boolean;
  20012. /**
  20013. * @hidden
  20014. * 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)
  20015. */
  20016. _multiviewTexture: Nullable<RenderTargetTexture>;
  20017. /**
  20018. * @hidden
  20019. * ensures the multiview texture of the camera exists and has the specified width/height
  20020. * @param width height to set on the multiview texture
  20021. * @param height width to set on the multiview texture
  20022. */
  20023. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20024. }
  20025. }
  20026. module "babylonjs/scene" {
  20027. interface Scene {
  20028. /** @hidden */
  20029. _transformMatrixR: Matrix;
  20030. /** @hidden */
  20031. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20032. /** @hidden */
  20033. _createMultiviewUbo(): void;
  20034. /** @hidden */
  20035. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20036. /** @hidden */
  20037. _renderMultiviewToSingleView(camera: Camera): void;
  20038. }
  20039. }
  20040. }
  20041. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20042. import { Camera } from "babylonjs/Cameras/camera";
  20043. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20044. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20045. import "babylonjs/Engines/Extensions/engine.multiview";
  20046. /**
  20047. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20048. * This will not be used for webXR as it supports displaying texture arrays directly
  20049. */
  20050. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20051. /**
  20052. * Initializes a VRMultiviewToSingleview
  20053. * @param name name of the post process
  20054. * @param camera camera to be applied to
  20055. * @param scaleFactor scaling factor to the size of the output texture
  20056. */
  20057. constructor(name: string, camera: Camera, scaleFactor: number);
  20058. }
  20059. }
  20060. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20061. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20062. import { Nullable } from "babylonjs/types";
  20063. import { Size } from "babylonjs/Maths/math.size";
  20064. import { Observable } from "babylonjs/Misc/observable";
  20065. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20066. /**
  20067. * Interface used to define additional presentation attributes
  20068. */
  20069. export interface IVRPresentationAttributes {
  20070. /**
  20071. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20072. */
  20073. highRefreshRate: boolean;
  20074. /**
  20075. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20076. */
  20077. foveationLevel: number;
  20078. }
  20079. module "babylonjs/Engines/engine" {
  20080. interface Engine {
  20081. /** @hidden */
  20082. _vrDisplay: any;
  20083. /** @hidden */
  20084. _vrSupported: boolean;
  20085. /** @hidden */
  20086. _oldSize: Size;
  20087. /** @hidden */
  20088. _oldHardwareScaleFactor: number;
  20089. /** @hidden */
  20090. _vrExclusivePointerMode: boolean;
  20091. /** @hidden */
  20092. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20093. /** @hidden */
  20094. _onVRDisplayPointerRestricted: () => void;
  20095. /** @hidden */
  20096. _onVRDisplayPointerUnrestricted: () => void;
  20097. /** @hidden */
  20098. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20099. /** @hidden */
  20100. _onVrDisplayDisconnect: Nullable<() => void>;
  20101. /** @hidden */
  20102. _onVrDisplayPresentChange: Nullable<() => void>;
  20103. /**
  20104. * Observable signaled when VR display mode changes
  20105. */
  20106. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20107. /**
  20108. * Observable signaled when VR request present is complete
  20109. */
  20110. onVRRequestPresentComplete: Observable<boolean>;
  20111. /**
  20112. * Observable signaled when VR request present starts
  20113. */
  20114. onVRRequestPresentStart: Observable<Engine>;
  20115. /**
  20116. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20117. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20118. */
  20119. isInVRExclusivePointerMode: boolean;
  20120. /**
  20121. * Gets a boolean indicating if a webVR device was detected
  20122. * @returns true if a webVR device was detected
  20123. */
  20124. isVRDevicePresent(): boolean;
  20125. /**
  20126. * Gets the current webVR device
  20127. * @returns the current webVR device (or null)
  20128. */
  20129. getVRDevice(): any;
  20130. /**
  20131. * Initializes a webVR display and starts listening to display change events
  20132. * The onVRDisplayChangedObservable will be notified upon these changes
  20133. * @returns A promise containing a VRDisplay and if vr is supported
  20134. */
  20135. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20136. /** @hidden */
  20137. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20138. /**
  20139. * Gets or sets the presentation attributes used to configure VR rendering
  20140. */
  20141. vrPresentationAttributes?: IVRPresentationAttributes;
  20142. /**
  20143. * Call this function to switch to webVR mode
  20144. * Will do nothing if webVR is not supported or if there is no webVR device
  20145. * @param options the webvr options provided to the camera. mainly used for multiview
  20146. * @see http://doc.babylonjs.com/how_to/webvr_camera
  20147. */
  20148. enableVR(options: WebVROptions): void;
  20149. /** @hidden */
  20150. _onVRFullScreenTriggered(): void;
  20151. }
  20152. }
  20153. }
  20154. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20155. import { Nullable } from "babylonjs/types";
  20156. import { Observable } from "babylonjs/Misc/observable";
  20157. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20158. import { Scene } from "babylonjs/scene";
  20159. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20160. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20161. import { Node } from "babylonjs/node";
  20162. import { Ray } from "babylonjs/Culling/ray";
  20163. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20164. import "babylonjs/Engines/Extensions/engine.webVR";
  20165. /**
  20166. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20167. * IMPORTANT!! The data is right-hand data.
  20168. * @export
  20169. * @interface DevicePose
  20170. */
  20171. export interface DevicePose {
  20172. /**
  20173. * The position of the device, values in array are [x,y,z].
  20174. */
  20175. readonly position: Nullable<Float32Array>;
  20176. /**
  20177. * The linearVelocity of the device, values in array are [x,y,z].
  20178. */
  20179. readonly linearVelocity: Nullable<Float32Array>;
  20180. /**
  20181. * The linearAcceleration of the device, values in array are [x,y,z].
  20182. */
  20183. readonly linearAcceleration: Nullable<Float32Array>;
  20184. /**
  20185. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20186. */
  20187. readonly orientation: Nullable<Float32Array>;
  20188. /**
  20189. * The angularVelocity of the device, values in array are [x,y,z].
  20190. */
  20191. readonly angularVelocity: Nullable<Float32Array>;
  20192. /**
  20193. * The angularAcceleration of the device, values in array are [x,y,z].
  20194. */
  20195. readonly angularAcceleration: Nullable<Float32Array>;
  20196. }
  20197. /**
  20198. * Interface representing a pose controlled object in Babylon.
  20199. * A pose controlled object has both regular pose values as well as pose values
  20200. * from an external device such as a VR head mounted display
  20201. */
  20202. export interface PoseControlled {
  20203. /**
  20204. * The position of the object in babylon space.
  20205. */
  20206. position: Vector3;
  20207. /**
  20208. * The rotation quaternion of the object in babylon space.
  20209. */
  20210. rotationQuaternion: Quaternion;
  20211. /**
  20212. * The position of the device in babylon space.
  20213. */
  20214. devicePosition?: Vector3;
  20215. /**
  20216. * The rotation quaternion of the device in babylon space.
  20217. */
  20218. deviceRotationQuaternion: Quaternion;
  20219. /**
  20220. * The raw pose coming from the device.
  20221. */
  20222. rawPose: Nullable<DevicePose>;
  20223. /**
  20224. * The scale of the device to be used when translating from device space to babylon space.
  20225. */
  20226. deviceScaleFactor: number;
  20227. /**
  20228. * Updates the poseControlled values based on the input device pose.
  20229. * @param poseData the pose data to update the object with
  20230. */
  20231. updateFromDevice(poseData: DevicePose): void;
  20232. }
  20233. /**
  20234. * Set of options to customize the webVRCamera
  20235. */
  20236. export interface WebVROptions {
  20237. /**
  20238. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20239. */
  20240. trackPosition?: boolean;
  20241. /**
  20242. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20243. */
  20244. positionScale?: number;
  20245. /**
  20246. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20247. */
  20248. displayName?: string;
  20249. /**
  20250. * Should the native controller meshes be initialized. (default: true)
  20251. */
  20252. controllerMeshes?: boolean;
  20253. /**
  20254. * Creating a default HemiLight only on controllers. (default: true)
  20255. */
  20256. defaultLightingOnControllers?: boolean;
  20257. /**
  20258. * If you don't want to use the default VR button of the helper. (default: false)
  20259. */
  20260. useCustomVRButton?: boolean;
  20261. /**
  20262. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20263. */
  20264. customVRButton?: HTMLButtonElement;
  20265. /**
  20266. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20267. */
  20268. rayLength?: number;
  20269. /**
  20270. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20271. */
  20272. defaultHeight?: number;
  20273. /**
  20274. * If multiview should be used if availible (default: false)
  20275. */
  20276. useMultiview?: boolean;
  20277. }
  20278. /**
  20279. * This represents a WebVR camera.
  20280. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20281. * @example http://doc.babylonjs.com/how_to/webvr_camera
  20282. */
  20283. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20284. private webVROptions;
  20285. /**
  20286. * @hidden
  20287. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20288. */
  20289. _vrDevice: any;
  20290. /**
  20291. * The rawPose of the vrDevice.
  20292. */
  20293. rawPose: Nullable<DevicePose>;
  20294. private _onVREnabled;
  20295. private _specsVersion;
  20296. private _attached;
  20297. private _frameData;
  20298. protected _descendants: Array<Node>;
  20299. private _deviceRoomPosition;
  20300. /** @hidden */
  20301. _deviceRoomRotationQuaternion: Quaternion;
  20302. private _standingMatrix;
  20303. /**
  20304. * Represents device position in babylon space.
  20305. */
  20306. devicePosition: Vector3;
  20307. /**
  20308. * Represents device rotation in babylon space.
  20309. */
  20310. deviceRotationQuaternion: Quaternion;
  20311. /**
  20312. * The scale of the device to be used when translating from device space to babylon space.
  20313. */
  20314. deviceScaleFactor: number;
  20315. private _deviceToWorld;
  20316. private _worldToDevice;
  20317. /**
  20318. * References to the webVR controllers for the vrDevice.
  20319. */
  20320. controllers: Array<WebVRController>;
  20321. /**
  20322. * Emits an event when a controller is attached.
  20323. */
  20324. onControllersAttachedObservable: Observable<WebVRController[]>;
  20325. /**
  20326. * Emits an event when a controller's mesh has been loaded;
  20327. */
  20328. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20329. /**
  20330. * Emits an event when the HMD's pose has been updated.
  20331. */
  20332. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20333. private _poseSet;
  20334. /**
  20335. * If the rig cameras be used as parent instead of this camera.
  20336. */
  20337. rigParenting: boolean;
  20338. private _lightOnControllers;
  20339. private _defaultHeight?;
  20340. /**
  20341. * Instantiates a WebVRFreeCamera.
  20342. * @param name The name of the WebVRFreeCamera
  20343. * @param position The starting anchor position for the camera
  20344. * @param scene The scene the camera belongs to
  20345. * @param webVROptions a set of customizable options for the webVRCamera
  20346. */
  20347. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20348. /**
  20349. * Gets the device distance from the ground in meters.
  20350. * @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.
  20351. */
  20352. deviceDistanceToRoomGround(): number;
  20353. /**
  20354. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20355. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20356. */
  20357. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20358. /**
  20359. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20360. * @returns A promise with a boolean set to if the standing matrix is supported.
  20361. */
  20362. useStandingMatrixAsync(): Promise<boolean>;
  20363. /**
  20364. * Disposes the camera
  20365. */
  20366. dispose(): void;
  20367. /**
  20368. * Gets a vrController by name.
  20369. * @param name The name of the controller to retreive
  20370. * @returns the controller matching the name specified or null if not found
  20371. */
  20372. getControllerByName(name: string): Nullable<WebVRController>;
  20373. private _leftController;
  20374. /**
  20375. * The controller corresponding to the users left hand.
  20376. */
  20377. get leftController(): Nullable<WebVRController>;
  20378. private _rightController;
  20379. /**
  20380. * The controller corresponding to the users right hand.
  20381. */
  20382. get rightController(): Nullable<WebVRController>;
  20383. /**
  20384. * Casts a ray forward from the vrCamera's gaze.
  20385. * @param length Length of the ray (default: 100)
  20386. * @returns the ray corresponding to the gaze
  20387. */
  20388. getForwardRay(length?: number): Ray;
  20389. /**
  20390. * @hidden
  20391. * Updates the camera based on device's frame data
  20392. */
  20393. _checkInputs(): void;
  20394. /**
  20395. * Updates the poseControlled values based on the input device pose.
  20396. * @param poseData Pose coming from the device
  20397. */
  20398. updateFromDevice(poseData: DevicePose): void;
  20399. private _htmlElementAttached;
  20400. private _detachIfAttached;
  20401. /**
  20402. * WebVR's attach control will start broadcasting frames to the device.
  20403. * Note that in certain browsers (chrome for example) this function must be called
  20404. * within a user-interaction callback. Example:
  20405. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20406. *
  20407. * @param element html element to attach the vrDevice to
  20408. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20409. */
  20410. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20411. /**
  20412. * Detaches the camera from the html element and disables VR
  20413. *
  20414. * @param element html element to detach from
  20415. */
  20416. detachControl(element: HTMLElement): void;
  20417. /**
  20418. * @returns the name of this class
  20419. */
  20420. getClassName(): string;
  20421. /**
  20422. * Calls resetPose on the vrDisplay
  20423. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20424. */
  20425. resetToCurrentRotation(): void;
  20426. /**
  20427. * @hidden
  20428. * Updates the rig cameras (left and right eye)
  20429. */
  20430. _updateRigCameras(): void;
  20431. private _workingVector;
  20432. private _oneVector;
  20433. private _workingMatrix;
  20434. private updateCacheCalled;
  20435. private _correctPositionIfNotTrackPosition;
  20436. /**
  20437. * @hidden
  20438. * Updates the cached values of the camera
  20439. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20440. */
  20441. _updateCache(ignoreParentClass?: boolean): void;
  20442. /**
  20443. * @hidden
  20444. * Get current device position in babylon world
  20445. */
  20446. _computeDevicePosition(): void;
  20447. /**
  20448. * Updates the current device position and rotation in the babylon world
  20449. */
  20450. update(): void;
  20451. /**
  20452. * @hidden
  20453. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20454. * @returns an identity matrix
  20455. */
  20456. _getViewMatrix(): Matrix;
  20457. private _tmpMatrix;
  20458. /**
  20459. * This function is called by the two RIG cameras.
  20460. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20461. * @hidden
  20462. */
  20463. _getWebVRViewMatrix(): Matrix;
  20464. /** @hidden */
  20465. _getWebVRProjectionMatrix(): Matrix;
  20466. private _onGamepadConnectedObserver;
  20467. private _onGamepadDisconnectedObserver;
  20468. private _updateCacheWhenTrackingDisabledObserver;
  20469. /**
  20470. * Initializes the controllers and their meshes
  20471. */
  20472. initControllers(): void;
  20473. }
  20474. }
  20475. declare module "babylonjs/Materials/materialHelper" {
  20476. import { Nullable } from "babylonjs/types";
  20477. import { Scene } from "babylonjs/scene";
  20478. import { Engine } from "babylonjs/Engines/engine";
  20479. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20480. import { Light } from "babylonjs/Lights/light";
  20481. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20482. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20483. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20484. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20485. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20486. /**
  20487. * "Static Class" containing the most commonly used helper while dealing with material for
  20488. * rendering purpose.
  20489. *
  20490. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20491. *
  20492. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20493. */
  20494. export class MaterialHelper {
  20495. /**
  20496. * Bind the current view position to an effect.
  20497. * @param effect The effect to be bound
  20498. * @param scene The scene the eyes position is used from
  20499. * @param variableName name of the shader variable that will hold the eye position
  20500. */
  20501. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20502. /**
  20503. * Helps preparing the defines values about the UVs in used in the effect.
  20504. * UVs are shared as much as we can accross channels in the shaders.
  20505. * @param texture The texture we are preparing the UVs for
  20506. * @param defines The defines to update
  20507. * @param key The channel key "diffuse", "specular"... used in the shader
  20508. */
  20509. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20510. /**
  20511. * Binds a texture matrix value to its corrsponding uniform
  20512. * @param texture The texture to bind the matrix for
  20513. * @param uniformBuffer The uniform buffer receivin the data
  20514. * @param key The channel key "diffuse", "specular"... used in the shader
  20515. */
  20516. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20517. /**
  20518. * Gets the current status of the fog (should it be enabled?)
  20519. * @param mesh defines the mesh to evaluate for fog support
  20520. * @param scene defines the hosting scene
  20521. * @returns true if fog must be enabled
  20522. */
  20523. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20524. /**
  20525. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20526. * @param mesh defines the current mesh
  20527. * @param scene defines the current scene
  20528. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20529. * @param pointsCloud defines if point cloud rendering has to be turned on
  20530. * @param fogEnabled defines if fog has to be turned on
  20531. * @param alphaTest defines if alpha testing has to be turned on
  20532. * @param defines defines the current list of defines
  20533. */
  20534. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20535. /**
  20536. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20537. * @param scene defines the current scene
  20538. * @param engine defines the current engine
  20539. * @param defines specifies the list of active defines
  20540. * @param useInstances defines if instances have to be turned on
  20541. * @param useClipPlane defines if clip plane have to be turned on
  20542. * @param useInstances defines if instances have to be turned on
  20543. * @param useThinInstances defines if thin instances have to be turned on
  20544. */
  20545. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20546. /**
  20547. * Prepares the defines for bones
  20548. * @param mesh The mesh containing the geometry data we will draw
  20549. * @param defines The defines to update
  20550. */
  20551. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20552. /**
  20553. * Prepares the defines for morph targets
  20554. * @param mesh The mesh containing the geometry data we will draw
  20555. * @param defines The defines to update
  20556. */
  20557. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20558. /**
  20559. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20560. * @param mesh The mesh containing the geometry data we will draw
  20561. * @param defines The defines to update
  20562. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20563. * @param useBones Precise whether bones should be used or not (override mesh info)
  20564. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20565. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20566. * @returns false if defines are considered not dirty and have not been checked
  20567. */
  20568. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20569. /**
  20570. * Prepares the defines related to multiview
  20571. * @param scene The scene we are intending to draw
  20572. * @param defines The defines to update
  20573. */
  20574. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20575. /**
  20576. * Prepares the defines related to the light information passed in parameter
  20577. * @param scene The scene we are intending to draw
  20578. * @param mesh The mesh the effect is compiling for
  20579. * @param light The light the effect is compiling for
  20580. * @param lightIndex The index of the light
  20581. * @param defines The defines to update
  20582. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20583. * @param state Defines the current state regarding what is needed (normals, etc...)
  20584. */
  20585. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20586. needNormals: boolean;
  20587. needRebuild: boolean;
  20588. shadowEnabled: boolean;
  20589. specularEnabled: boolean;
  20590. lightmapMode: boolean;
  20591. }): void;
  20592. /**
  20593. * Prepares the defines related to the light information passed in parameter
  20594. * @param scene The scene we are intending to draw
  20595. * @param mesh The mesh the effect is compiling for
  20596. * @param defines The defines to update
  20597. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20598. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20599. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20600. * @returns true if normals will be required for the rest of the effect
  20601. */
  20602. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20603. /**
  20604. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20605. * @param lightIndex defines the light index
  20606. * @param uniformsList The uniform list
  20607. * @param samplersList The sampler list
  20608. * @param projectedLightTexture defines if projected texture must be used
  20609. * @param uniformBuffersList defines an optional list of uniform buffers
  20610. */
  20611. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20612. /**
  20613. * Prepares the uniforms and samplers list to be used in the effect
  20614. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20615. * @param samplersList The sampler list
  20616. * @param defines The defines helping in the list generation
  20617. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20618. */
  20619. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20620. /**
  20621. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20622. * @param defines The defines to update while falling back
  20623. * @param fallbacks The authorized effect fallbacks
  20624. * @param maxSimultaneousLights The maximum number of lights allowed
  20625. * @param rank the current rank of the Effect
  20626. * @returns The newly affected rank
  20627. */
  20628. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20629. private static _TmpMorphInfluencers;
  20630. /**
  20631. * Prepares the list of attributes required for morph targets according to the effect defines.
  20632. * @param attribs The current list of supported attribs
  20633. * @param mesh The mesh to prepare the morph targets attributes for
  20634. * @param influencers The number of influencers
  20635. */
  20636. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20637. /**
  20638. * Prepares the list of attributes required for morph targets according to the effect defines.
  20639. * @param attribs The current list of supported attribs
  20640. * @param mesh The mesh to prepare the morph targets attributes for
  20641. * @param defines The current Defines of the effect
  20642. */
  20643. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20644. /**
  20645. * Prepares the list of attributes required for bones according to the effect defines.
  20646. * @param attribs The current list of supported attribs
  20647. * @param mesh The mesh to prepare the bones attributes for
  20648. * @param defines The current Defines of the effect
  20649. * @param fallbacks The current efffect fallback strategy
  20650. */
  20651. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20652. /**
  20653. * Check and prepare the list of attributes required for instances according to the effect defines.
  20654. * @param attribs The current list of supported attribs
  20655. * @param defines The current MaterialDefines of the effect
  20656. */
  20657. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20658. /**
  20659. * Add the list of attributes required for instances to the attribs array.
  20660. * @param attribs The current list of supported attribs
  20661. */
  20662. static PushAttributesForInstances(attribs: string[]): void;
  20663. /**
  20664. * Binds the light information to the effect.
  20665. * @param light The light containing the generator
  20666. * @param effect The effect we are binding the data to
  20667. * @param lightIndex The light index in the effect used to render
  20668. */
  20669. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20670. /**
  20671. * Binds the lights information from the scene to the effect for the given mesh.
  20672. * @param light Light to bind
  20673. * @param lightIndex Light index
  20674. * @param scene The scene where the light belongs to
  20675. * @param effect The effect we are binding the data to
  20676. * @param useSpecular Defines if specular is supported
  20677. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  20678. */
  20679. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  20680. /**
  20681. * Binds the lights information from the scene to the effect for the given mesh.
  20682. * @param scene The scene the lights belongs to
  20683. * @param mesh The mesh we are binding the information to render
  20684. * @param effect The effect we are binding the data to
  20685. * @param defines The generated defines for the effect
  20686. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  20687. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  20688. */
  20689. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  20690. private static _tempFogColor;
  20691. /**
  20692. * Binds the fog information from the scene to the effect for the given mesh.
  20693. * @param scene The scene the lights belongs to
  20694. * @param mesh The mesh we are binding the information to render
  20695. * @param effect The effect we are binding the data to
  20696. * @param linearSpace Defines if the fog effect is applied in linear space
  20697. */
  20698. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  20699. /**
  20700. * Binds the bones information from the mesh to the effect.
  20701. * @param mesh The mesh we are binding the information to render
  20702. * @param effect The effect we are binding the data to
  20703. */
  20704. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  20705. /**
  20706. * Binds the morph targets information from the mesh to the effect.
  20707. * @param abstractMesh The mesh we are binding the information to render
  20708. * @param effect The effect we are binding the data to
  20709. */
  20710. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  20711. /**
  20712. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  20713. * @param defines The generated defines used in the effect
  20714. * @param effect The effect we are binding the data to
  20715. * @param scene The scene we are willing to render with logarithmic scale for
  20716. */
  20717. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  20718. /**
  20719. * Binds the clip plane information from the scene to the effect.
  20720. * @param scene The scene the clip plane information are extracted from
  20721. * @param effect The effect we are binding the data to
  20722. */
  20723. static BindClipPlane(effect: Effect, scene: Scene): void;
  20724. }
  20725. }
  20726. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  20727. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  20728. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  20729. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  20730. import { Nullable } from "babylonjs/types";
  20731. import { Effect } from "babylonjs/Materials/effect";
  20732. import { Matrix } from "babylonjs/Maths/math.vector";
  20733. import { Scene } from "babylonjs/scene";
  20734. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  20735. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  20736. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  20737. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  20738. import { Observable } from "babylonjs/Misc/observable";
  20739. /**
  20740. * Block used to expose an input value
  20741. */
  20742. export class InputBlock extends NodeMaterialBlock {
  20743. private _mode;
  20744. private _associatedVariableName;
  20745. private _storedValue;
  20746. private _valueCallback;
  20747. private _type;
  20748. private _animationType;
  20749. /** Gets or set a value used to limit the range of float values */
  20750. min: number;
  20751. /** Gets or set a value used to limit the range of float values */
  20752. max: number;
  20753. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  20754. isBoolean: boolean;
  20755. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  20756. matrixMode: number;
  20757. /** @hidden */
  20758. _systemValue: Nullable<NodeMaterialSystemValues>;
  20759. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  20760. visibleInInspector: boolean;
  20761. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  20762. isConstant: boolean;
  20763. /** Gets or sets the group to use to display this block in the Inspector */
  20764. groupInInspector: string;
  20765. /** Gets an observable raised when the value is changed */
  20766. onValueChangedObservable: Observable<InputBlock>;
  20767. /**
  20768. * Gets or sets the connection point type (default is float)
  20769. */
  20770. get type(): NodeMaterialBlockConnectionPointTypes;
  20771. /**
  20772. * Creates a new InputBlock
  20773. * @param name defines the block name
  20774. * @param target defines the target of that block (Vertex by default)
  20775. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  20776. */
  20777. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  20778. /**
  20779. * Gets the output component
  20780. */
  20781. get output(): NodeMaterialConnectionPoint;
  20782. /**
  20783. * Set the source of this connection point to a vertex attribute
  20784. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  20785. * @returns the current connection point
  20786. */
  20787. setAsAttribute(attributeName?: string): InputBlock;
  20788. /**
  20789. * Set the source of this connection point to a system value
  20790. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  20791. * @returns the current connection point
  20792. */
  20793. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  20794. /**
  20795. * Gets or sets the value of that point.
  20796. * Please note that this value will be ignored if valueCallback is defined
  20797. */
  20798. get value(): any;
  20799. set value(value: any);
  20800. /**
  20801. * Gets or sets a callback used to get the value of that point.
  20802. * Please note that setting this value will force the connection point to ignore the value property
  20803. */
  20804. get valueCallback(): () => any;
  20805. set valueCallback(value: () => any);
  20806. /**
  20807. * Gets or sets the associated variable name in the shader
  20808. */
  20809. get associatedVariableName(): string;
  20810. set associatedVariableName(value: string);
  20811. /** Gets or sets the type of animation applied to the input */
  20812. get animationType(): AnimatedInputBlockTypes;
  20813. set animationType(value: AnimatedInputBlockTypes);
  20814. /**
  20815. * Gets a boolean indicating that this connection point not defined yet
  20816. */
  20817. get isUndefined(): boolean;
  20818. /**
  20819. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  20820. * In this case the connection point name must be the name of the uniform to use.
  20821. * Can only be set on inputs
  20822. */
  20823. get isUniform(): boolean;
  20824. set isUniform(value: boolean);
  20825. /**
  20826. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  20827. * In this case the connection point name must be the name of the attribute to use
  20828. * Can only be set on inputs
  20829. */
  20830. get isAttribute(): boolean;
  20831. set isAttribute(value: boolean);
  20832. /**
  20833. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  20834. * Can only be set on exit points
  20835. */
  20836. get isVarying(): boolean;
  20837. set isVarying(value: boolean);
  20838. /**
  20839. * Gets a boolean indicating that the current connection point is a system value
  20840. */
  20841. get isSystemValue(): boolean;
  20842. /**
  20843. * Gets or sets the current well known value or null if not defined as a system value
  20844. */
  20845. get systemValue(): Nullable<NodeMaterialSystemValues>;
  20846. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  20847. /**
  20848. * Gets the current class name
  20849. * @returns the class name
  20850. */
  20851. getClassName(): string;
  20852. /**
  20853. * Animate the input if animationType !== None
  20854. * @param scene defines the rendering scene
  20855. */
  20856. animate(scene: Scene): void;
  20857. private _emitDefine;
  20858. initialize(state: NodeMaterialBuildState): void;
  20859. /**
  20860. * Set the input block to its default value (based on its type)
  20861. */
  20862. setDefaultValue(): void;
  20863. private _emitConstant;
  20864. /** @hidden */
  20865. get _noContextSwitch(): boolean;
  20866. private _emit;
  20867. /** @hidden */
  20868. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  20869. /** @hidden */
  20870. _transmit(effect: Effect, scene: Scene): void;
  20871. protected _buildBlock(state: NodeMaterialBuildState): void;
  20872. protected _dumpPropertiesCode(): string;
  20873. dispose(): void;
  20874. serialize(): any;
  20875. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  20876. }
  20877. }
  20878. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  20879. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  20880. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  20881. import { Nullable } from "babylonjs/types";
  20882. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  20883. import { Observable } from "babylonjs/Misc/observable";
  20884. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  20885. /**
  20886. * Enum used to define the compatibility state between two connection points
  20887. */
  20888. export enum NodeMaterialConnectionPointCompatibilityStates {
  20889. /** Points are compatibles */
  20890. Compatible = 0,
  20891. /** Points are incompatible because of their types */
  20892. TypeIncompatible = 1,
  20893. /** Points are incompatible because of their targets (vertex vs fragment) */
  20894. TargetIncompatible = 2
  20895. }
  20896. /**
  20897. * Defines the direction of a connection point
  20898. */
  20899. export enum NodeMaterialConnectionPointDirection {
  20900. /** Input */
  20901. Input = 0,
  20902. /** Output */
  20903. Output = 1
  20904. }
  20905. /**
  20906. * Defines a connection point for a block
  20907. */
  20908. export class NodeMaterialConnectionPoint {
  20909. /** @hidden */
  20910. _ownerBlock: NodeMaterialBlock;
  20911. /** @hidden */
  20912. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  20913. private _endpoints;
  20914. private _associatedVariableName;
  20915. private _direction;
  20916. /** @hidden */
  20917. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  20918. /** @hidden */
  20919. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  20920. private _type;
  20921. /** @hidden */
  20922. _enforceAssociatedVariableName: boolean;
  20923. /** Gets the direction of the point */
  20924. get direction(): NodeMaterialConnectionPointDirection;
  20925. /** Indicates that this connection point needs dual validation before being connected to another point */
  20926. needDualDirectionValidation: boolean;
  20927. /**
  20928. * Gets or sets the additional types supported by this connection point
  20929. */
  20930. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  20931. /**
  20932. * Gets or sets the additional types excluded by this connection point
  20933. */
  20934. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  20935. /**
  20936. * Observable triggered when this point is connected
  20937. */
  20938. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  20939. /**
  20940. * Gets or sets the associated variable name in the shader
  20941. */
  20942. get associatedVariableName(): string;
  20943. set associatedVariableName(value: string);
  20944. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  20945. get innerType(): NodeMaterialBlockConnectionPointTypes;
  20946. /**
  20947. * Gets or sets the connection point type (default is float)
  20948. */
  20949. get type(): NodeMaterialBlockConnectionPointTypes;
  20950. set type(value: NodeMaterialBlockConnectionPointTypes);
  20951. /**
  20952. * Gets or sets the connection point name
  20953. */
  20954. name: string;
  20955. /**
  20956. * Gets or sets the connection point name
  20957. */
  20958. displayName: string;
  20959. /**
  20960. * Gets or sets a boolean indicating that this connection point can be omitted
  20961. */
  20962. isOptional: boolean;
  20963. /**
  20964. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  20965. */
  20966. isExposedOnFrame: boolean;
  20967. /**
  20968. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  20969. */
  20970. define: string;
  20971. /** @hidden */
  20972. _prioritizeVertex: boolean;
  20973. private _target;
  20974. /** Gets or sets the target of that connection point */
  20975. get target(): NodeMaterialBlockTargets;
  20976. set target(value: NodeMaterialBlockTargets);
  20977. /**
  20978. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  20979. */
  20980. get isConnected(): boolean;
  20981. /**
  20982. * Gets a boolean indicating that the current point is connected to an input block
  20983. */
  20984. get isConnectedToInputBlock(): boolean;
  20985. /**
  20986. * Gets a the connected input block (if any)
  20987. */
  20988. get connectInputBlock(): Nullable<InputBlock>;
  20989. /** Get the other side of the connection (if any) */
  20990. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  20991. /** Get the block that owns this connection point */
  20992. get ownerBlock(): NodeMaterialBlock;
  20993. /** Get the block connected on the other side of this connection (if any) */
  20994. get sourceBlock(): Nullable<NodeMaterialBlock>;
  20995. /** Get the block connected on the endpoints of this connection (if any) */
  20996. get connectedBlocks(): Array<NodeMaterialBlock>;
  20997. /** Gets the list of connected endpoints */
  20998. get endpoints(): NodeMaterialConnectionPoint[];
  20999. /** Gets a boolean indicating if that output point is connected to at least one input */
  21000. get hasEndpoints(): boolean;
  21001. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21002. get isConnectedInVertexShader(): boolean;
  21003. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21004. get isConnectedInFragmentShader(): boolean;
  21005. /**
  21006. * Creates a block suitable to be used as an input for this input point.
  21007. * If null is returned, a block based on the point type will be created.
  21008. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21009. */
  21010. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21011. /**
  21012. * Creates a new connection point
  21013. * @param name defines the connection point name
  21014. * @param ownerBlock defines the block hosting this connection point
  21015. * @param direction defines the direction of the connection point
  21016. */
  21017. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21018. /**
  21019. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21020. * @returns the class name
  21021. */
  21022. getClassName(): string;
  21023. /**
  21024. * Gets a boolean indicating if the current point can be connected to another point
  21025. * @param connectionPoint defines the other connection point
  21026. * @returns a boolean
  21027. */
  21028. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21029. /**
  21030. * Gets a number indicating if the current point can be connected to another point
  21031. * @param connectionPoint defines the other connection point
  21032. * @returns a number defining the compatibility state
  21033. */
  21034. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21035. /**
  21036. * Connect this point to another connection point
  21037. * @param connectionPoint defines the other connection point
  21038. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21039. * @returns the current connection point
  21040. */
  21041. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21042. /**
  21043. * Disconnect this point from one of his endpoint
  21044. * @param endpoint defines the other connection point
  21045. * @returns the current connection point
  21046. */
  21047. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21048. /**
  21049. * Serializes this point in a JSON representation
  21050. * @param isInput defines if the connection point is an input (default is true)
  21051. * @returns the serialized point object
  21052. */
  21053. serialize(isInput?: boolean): any;
  21054. /**
  21055. * Release resources
  21056. */
  21057. dispose(): void;
  21058. }
  21059. }
  21060. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21061. /**
  21062. * Enum used to define the material modes
  21063. */
  21064. export enum NodeMaterialModes {
  21065. /** Regular material */
  21066. Material = 0,
  21067. /** For post process */
  21068. PostProcess = 1,
  21069. /** For particle system */
  21070. Particle = 2
  21071. }
  21072. }
  21073. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21074. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21075. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21076. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21077. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21078. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21079. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21080. import { Effect } from "babylonjs/Materials/effect";
  21081. import { Mesh } from "babylonjs/Meshes/mesh";
  21082. import { Nullable } from "babylonjs/types";
  21083. import { Texture } from "babylonjs/Materials/Textures/texture";
  21084. import { Scene } from "babylonjs/scene";
  21085. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21086. /**
  21087. * Block used to read a texture from a sampler
  21088. */
  21089. export class TextureBlock extends NodeMaterialBlock {
  21090. private _defineName;
  21091. private _linearDefineName;
  21092. private _gammaDefineName;
  21093. private _tempTextureRead;
  21094. private _samplerName;
  21095. private _transformedUVName;
  21096. private _textureTransformName;
  21097. private _textureInfoName;
  21098. private _mainUVName;
  21099. private _mainUVDefineName;
  21100. private _fragmentOnly;
  21101. /**
  21102. * Gets or sets the texture associated with the node
  21103. */
  21104. texture: Nullable<Texture>;
  21105. /**
  21106. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21107. */
  21108. convertToGammaSpace: boolean;
  21109. /**
  21110. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21111. */
  21112. convertToLinearSpace: boolean;
  21113. /**
  21114. * Create a new TextureBlock
  21115. * @param name defines the block name
  21116. */
  21117. constructor(name: string, fragmentOnly?: boolean);
  21118. /**
  21119. * Gets the current class name
  21120. * @returns the class name
  21121. */
  21122. getClassName(): string;
  21123. /**
  21124. * Gets the uv input component
  21125. */
  21126. get uv(): NodeMaterialConnectionPoint;
  21127. /**
  21128. * Gets the rgba output component
  21129. */
  21130. get rgba(): NodeMaterialConnectionPoint;
  21131. /**
  21132. * Gets the rgb output component
  21133. */
  21134. get rgb(): NodeMaterialConnectionPoint;
  21135. /**
  21136. * Gets the r output component
  21137. */
  21138. get r(): NodeMaterialConnectionPoint;
  21139. /**
  21140. * Gets the g output component
  21141. */
  21142. get g(): NodeMaterialConnectionPoint;
  21143. /**
  21144. * Gets the b output component
  21145. */
  21146. get b(): NodeMaterialConnectionPoint;
  21147. /**
  21148. * Gets the a output component
  21149. */
  21150. get a(): NodeMaterialConnectionPoint;
  21151. get target(): NodeMaterialBlockTargets;
  21152. autoConfigure(material: NodeMaterial): void;
  21153. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21154. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21155. isReady(): boolean;
  21156. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21157. private get _isMixed();
  21158. private _injectVertexCode;
  21159. private _writeTextureRead;
  21160. private _writeOutput;
  21161. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21162. protected _dumpPropertiesCode(): string;
  21163. serialize(): any;
  21164. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21165. }
  21166. }
  21167. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21168. /** @hidden */
  21169. export var reflectionFunction: {
  21170. name: string;
  21171. shader: string;
  21172. };
  21173. }
  21174. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21175. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21176. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21177. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21178. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21179. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21180. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21181. import { Effect } from "babylonjs/Materials/effect";
  21182. import { Mesh } from "babylonjs/Meshes/mesh";
  21183. import { Nullable } from "babylonjs/types";
  21184. import { Scene } from "babylonjs/scene";
  21185. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21186. /**
  21187. * Base block used to read a reflection texture from a sampler
  21188. */
  21189. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21190. /** @hidden */
  21191. _define3DName: string;
  21192. /** @hidden */
  21193. _defineCubicName: string;
  21194. /** @hidden */
  21195. _defineExplicitName: string;
  21196. /** @hidden */
  21197. _defineProjectionName: string;
  21198. /** @hidden */
  21199. _defineLocalCubicName: string;
  21200. /** @hidden */
  21201. _defineSphericalName: string;
  21202. /** @hidden */
  21203. _definePlanarName: string;
  21204. /** @hidden */
  21205. _defineEquirectangularName: string;
  21206. /** @hidden */
  21207. _defineMirroredEquirectangularFixedName: string;
  21208. /** @hidden */
  21209. _defineEquirectangularFixedName: string;
  21210. /** @hidden */
  21211. _defineSkyboxName: string;
  21212. /** @hidden */
  21213. _defineOppositeZ: string;
  21214. /** @hidden */
  21215. _cubeSamplerName: string;
  21216. /** @hidden */
  21217. _2DSamplerName: string;
  21218. protected _positionUVWName: string;
  21219. protected _directionWName: string;
  21220. protected _reflectionVectorName: string;
  21221. /** @hidden */
  21222. _reflectionCoordsName: string;
  21223. /** @hidden */
  21224. _reflectionMatrixName: string;
  21225. protected _reflectionColorName: string;
  21226. /**
  21227. * Gets or sets the texture associated with the node
  21228. */
  21229. texture: Nullable<BaseTexture>;
  21230. /**
  21231. * Create a new ReflectionTextureBaseBlock
  21232. * @param name defines the block name
  21233. */
  21234. constructor(name: string);
  21235. /**
  21236. * Gets the current class name
  21237. * @returns the class name
  21238. */
  21239. getClassName(): string;
  21240. /**
  21241. * Gets the world position input component
  21242. */
  21243. abstract get position(): NodeMaterialConnectionPoint;
  21244. /**
  21245. * Gets the world position input component
  21246. */
  21247. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21248. /**
  21249. * Gets the world normal input component
  21250. */
  21251. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21252. /**
  21253. * Gets the world input component
  21254. */
  21255. abstract get world(): NodeMaterialConnectionPoint;
  21256. /**
  21257. * Gets the camera (or eye) position component
  21258. */
  21259. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21260. /**
  21261. * Gets the view input component
  21262. */
  21263. abstract get view(): NodeMaterialConnectionPoint;
  21264. protected _getTexture(): Nullable<BaseTexture>;
  21265. autoConfigure(material: NodeMaterial): void;
  21266. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21267. isReady(): boolean;
  21268. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21269. /**
  21270. * Gets the code to inject in the vertex shader
  21271. * @param state current state of the node material building
  21272. * @returns the shader code
  21273. */
  21274. handleVertexSide(state: NodeMaterialBuildState): string;
  21275. /**
  21276. * Handles the inits for the fragment code path
  21277. * @param state node material build state
  21278. */
  21279. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21280. /**
  21281. * Generates the reflection coords code for the fragment code path
  21282. * @param worldNormalVarName name of the world normal variable
  21283. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21284. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21285. * @returns the shader code
  21286. */
  21287. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21288. /**
  21289. * Generates the reflection color code for the fragment code path
  21290. * @param lodVarName name of the lod variable
  21291. * @param swizzleLookupTexture swizzle to use for the final color variable
  21292. * @returns the shader code
  21293. */
  21294. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21295. /**
  21296. * Generates the code corresponding to the connected output points
  21297. * @param state node material build state
  21298. * @param varName name of the variable to output
  21299. * @returns the shader code
  21300. */
  21301. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21302. protected _buildBlock(state: NodeMaterialBuildState): this;
  21303. protected _dumpPropertiesCode(): string;
  21304. serialize(): any;
  21305. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21306. }
  21307. }
  21308. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21309. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21310. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21311. import { Nullable } from "babylonjs/types";
  21312. /**
  21313. * Defines a connection point to be used for points with a custom object type
  21314. */
  21315. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21316. private _blockType;
  21317. private _blockName;
  21318. private _nameForCheking?;
  21319. /**
  21320. * Creates a new connection point
  21321. * @param name defines the connection point name
  21322. * @param ownerBlock defines the block hosting this connection point
  21323. * @param direction defines the direction of the connection point
  21324. */
  21325. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21326. /**
  21327. * Gets a number indicating if the current point can be connected to another point
  21328. * @param connectionPoint defines the other connection point
  21329. * @returns a number defining the compatibility state
  21330. */
  21331. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21332. /**
  21333. * Creates a block suitable to be used as an input for this input point.
  21334. * If null is returned, a block based on the point type will be created.
  21335. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21336. */
  21337. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21338. }
  21339. }
  21340. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21341. /**
  21342. * Enum defining the type of properties that can be edited in the property pages in the NME
  21343. */
  21344. export enum PropertyTypeForEdition {
  21345. /** property is a boolean */
  21346. Boolean = 0,
  21347. /** property is a float */
  21348. Float = 1,
  21349. /** property is a Vector2 */
  21350. Vector2 = 2,
  21351. /** property is a list of values */
  21352. List = 3
  21353. }
  21354. /**
  21355. * Interface that defines an option in a variable of type list
  21356. */
  21357. export interface IEditablePropertyListOption {
  21358. /** label of the option */
  21359. "label": string;
  21360. /** value of the option */
  21361. "value": number;
  21362. }
  21363. /**
  21364. * Interface that defines the options available for an editable property
  21365. */
  21366. export interface IEditablePropertyOption {
  21367. /** min value */
  21368. "min"?: number;
  21369. /** max value */
  21370. "max"?: number;
  21371. /** notifiers: indicates which actions to take when the property is changed */
  21372. "notifiers"?: {
  21373. /** the material should be rebuilt */
  21374. "rebuild"?: boolean;
  21375. /** the preview should be updated */
  21376. "update"?: boolean;
  21377. };
  21378. /** list of the options for a variable of type list */
  21379. "options"?: IEditablePropertyListOption[];
  21380. }
  21381. /**
  21382. * Interface that describes an editable property
  21383. */
  21384. export interface IPropertyDescriptionForEdition {
  21385. /** name of the property */
  21386. "propertyName": string;
  21387. /** display name of the property */
  21388. "displayName": string;
  21389. /** type of the property */
  21390. "type": PropertyTypeForEdition;
  21391. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21392. "groupName": string;
  21393. /** options for the property */
  21394. "options": IEditablePropertyOption;
  21395. }
  21396. /**
  21397. * Decorator that flags a property in a node material block as being editable
  21398. */
  21399. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21400. }
  21401. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21402. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21403. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21404. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21405. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21406. import { Nullable } from "babylonjs/types";
  21407. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21408. import { Mesh } from "babylonjs/Meshes/mesh";
  21409. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21410. import { Effect } from "babylonjs/Materials/effect";
  21411. import { Scene } from "babylonjs/scene";
  21412. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21413. /**
  21414. * Block used to implement the refraction part of the sub surface module of the PBR material
  21415. */
  21416. export class RefractionBlock extends NodeMaterialBlock {
  21417. /** @hidden */
  21418. _define3DName: string;
  21419. /** @hidden */
  21420. _refractionMatrixName: string;
  21421. /** @hidden */
  21422. _defineLODRefractionAlpha: string;
  21423. /** @hidden */
  21424. _defineLinearSpecularRefraction: string;
  21425. /** @hidden */
  21426. _defineOppositeZ: string;
  21427. /** @hidden */
  21428. _cubeSamplerName: string;
  21429. /** @hidden */
  21430. _2DSamplerName: string;
  21431. /** @hidden */
  21432. _vRefractionMicrosurfaceInfosName: string;
  21433. /** @hidden */
  21434. _vRefractionInfosName: string;
  21435. private _scene;
  21436. /**
  21437. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21438. * Materials half opaque for instance using refraction could benefit from this control.
  21439. */
  21440. linkRefractionWithTransparency: boolean;
  21441. /**
  21442. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21443. */
  21444. invertRefractionY: boolean;
  21445. /**
  21446. * Gets or sets the texture associated with the node
  21447. */
  21448. texture: Nullable<BaseTexture>;
  21449. /**
  21450. * Create a new RefractionBlock
  21451. * @param name defines the block name
  21452. */
  21453. constructor(name: string);
  21454. /**
  21455. * Gets the current class name
  21456. * @returns the class name
  21457. */
  21458. getClassName(): string;
  21459. /**
  21460. * Gets the intensity input component
  21461. */
  21462. get intensity(): NodeMaterialConnectionPoint;
  21463. /**
  21464. * Gets the index of refraction input component
  21465. */
  21466. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21467. /**
  21468. * Gets the tint at distance input component
  21469. */
  21470. get tintAtDistance(): NodeMaterialConnectionPoint;
  21471. /**
  21472. * Gets the view input component
  21473. */
  21474. get view(): NodeMaterialConnectionPoint;
  21475. /**
  21476. * Gets the refraction object output component
  21477. */
  21478. get refraction(): NodeMaterialConnectionPoint;
  21479. /**
  21480. * Returns true if the block has a texture
  21481. */
  21482. get hasTexture(): boolean;
  21483. protected _getTexture(): Nullable<BaseTexture>;
  21484. autoConfigure(material: NodeMaterial): void;
  21485. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21486. isReady(): boolean;
  21487. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21488. /**
  21489. * Gets the main code of the block (fragment side)
  21490. * @param state current state of the node material building
  21491. * @returns the shader code
  21492. */
  21493. getCode(state: NodeMaterialBuildState): string;
  21494. protected _buildBlock(state: NodeMaterialBuildState): this;
  21495. protected _dumpPropertiesCode(): string;
  21496. serialize(): any;
  21497. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21498. }
  21499. }
  21500. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21501. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21502. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21503. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21504. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21505. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21506. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21507. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21508. import { Nullable } from "babylonjs/types";
  21509. import { Scene } from "babylonjs/scene";
  21510. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21511. /**
  21512. * Base block used as input for post process
  21513. */
  21514. export class CurrentScreenBlock extends NodeMaterialBlock {
  21515. private _samplerName;
  21516. private _linearDefineName;
  21517. private _gammaDefineName;
  21518. private _mainUVName;
  21519. private _tempTextureRead;
  21520. /**
  21521. * Gets or sets the texture associated with the node
  21522. */
  21523. texture: Nullable<BaseTexture>;
  21524. /**
  21525. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21526. */
  21527. convertToGammaSpace: boolean;
  21528. /**
  21529. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21530. */
  21531. convertToLinearSpace: boolean;
  21532. /**
  21533. * Create a new CurrentScreenBlock
  21534. * @param name defines the block name
  21535. */
  21536. constructor(name: string);
  21537. /**
  21538. * Gets the current class name
  21539. * @returns the class name
  21540. */
  21541. getClassName(): string;
  21542. /**
  21543. * Gets the uv input component
  21544. */
  21545. get uv(): NodeMaterialConnectionPoint;
  21546. /**
  21547. * Gets the rgba output component
  21548. */
  21549. get rgba(): NodeMaterialConnectionPoint;
  21550. /**
  21551. * Gets the rgb output component
  21552. */
  21553. get rgb(): NodeMaterialConnectionPoint;
  21554. /**
  21555. * Gets the r output component
  21556. */
  21557. get r(): NodeMaterialConnectionPoint;
  21558. /**
  21559. * Gets the g output component
  21560. */
  21561. get g(): NodeMaterialConnectionPoint;
  21562. /**
  21563. * Gets the b output component
  21564. */
  21565. get b(): NodeMaterialConnectionPoint;
  21566. /**
  21567. * Gets the a output component
  21568. */
  21569. get a(): NodeMaterialConnectionPoint;
  21570. /**
  21571. * Initialize the block and prepare the context for build
  21572. * @param state defines the state that will be used for the build
  21573. */
  21574. initialize(state: NodeMaterialBuildState): void;
  21575. get target(): NodeMaterialBlockTargets;
  21576. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21577. isReady(): boolean;
  21578. private _injectVertexCode;
  21579. private _writeTextureRead;
  21580. private _writeOutput;
  21581. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21582. serialize(): any;
  21583. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21584. }
  21585. }
  21586. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21587. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21588. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21589. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21590. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21591. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21592. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21593. import { Nullable } from "babylonjs/types";
  21594. import { Scene } from "babylonjs/scene";
  21595. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21596. /**
  21597. * Base block used for the particle texture
  21598. */
  21599. export class ParticleTextureBlock extends NodeMaterialBlock {
  21600. private _samplerName;
  21601. private _linearDefineName;
  21602. private _gammaDefineName;
  21603. private _tempTextureRead;
  21604. /**
  21605. * Gets or sets the texture associated with the node
  21606. */
  21607. texture: Nullable<BaseTexture>;
  21608. /**
  21609. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21610. */
  21611. convertToGammaSpace: boolean;
  21612. /**
  21613. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21614. */
  21615. convertToLinearSpace: boolean;
  21616. /**
  21617. * Create a new ParticleTextureBlock
  21618. * @param name defines the block name
  21619. */
  21620. constructor(name: string);
  21621. /**
  21622. * Gets the current class name
  21623. * @returns the class name
  21624. */
  21625. getClassName(): string;
  21626. /**
  21627. * Gets the uv input component
  21628. */
  21629. get uv(): NodeMaterialConnectionPoint;
  21630. /**
  21631. * Gets the rgba output component
  21632. */
  21633. get rgba(): NodeMaterialConnectionPoint;
  21634. /**
  21635. * Gets the rgb output component
  21636. */
  21637. get rgb(): NodeMaterialConnectionPoint;
  21638. /**
  21639. * Gets the r output component
  21640. */
  21641. get r(): NodeMaterialConnectionPoint;
  21642. /**
  21643. * Gets the g output component
  21644. */
  21645. get g(): NodeMaterialConnectionPoint;
  21646. /**
  21647. * Gets the b output component
  21648. */
  21649. get b(): NodeMaterialConnectionPoint;
  21650. /**
  21651. * Gets the a output component
  21652. */
  21653. get a(): NodeMaterialConnectionPoint;
  21654. /**
  21655. * Initialize the block and prepare the context for build
  21656. * @param state defines the state that will be used for the build
  21657. */
  21658. initialize(state: NodeMaterialBuildState): void;
  21659. autoConfigure(material: NodeMaterial): void;
  21660. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21661. isReady(): boolean;
  21662. private _writeOutput;
  21663. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21664. serialize(): any;
  21665. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21666. }
  21667. }
  21668. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  21669. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21670. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21671. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21672. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  21673. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  21674. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  21675. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  21676. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  21677. import { Scene } from "babylonjs/scene";
  21678. /**
  21679. * Class used to store shared data between 2 NodeMaterialBuildState
  21680. */
  21681. export class NodeMaterialBuildStateSharedData {
  21682. /**
  21683. * Gets the list of emitted varyings
  21684. */
  21685. temps: string[];
  21686. /**
  21687. * Gets the list of emitted varyings
  21688. */
  21689. varyings: string[];
  21690. /**
  21691. * Gets the varying declaration string
  21692. */
  21693. varyingDeclaration: string;
  21694. /**
  21695. * Input blocks
  21696. */
  21697. inputBlocks: InputBlock[];
  21698. /**
  21699. * Input blocks
  21700. */
  21701. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  21702. /**
  21703. * Bindable blocks (Blocks that need to set data to the effect)
  21704. */
  21705. bindableBlocks: NodeMaterialBlock[];
  21706. /**
  21707. * List of blocks that can provide a compilation fallback
  21708. */
  21709. blocksWithFallbacks: NodeMaterialBlock[];
  21710. /**
  21711. * List of blocks that can provide a define update
  21712. */
  21713. blocksWithDefines: NodeMaterialBlock[];
  21714. /**
  21715. * List of blocks that can provide a repeatable content
  21716. */
  21717. repeatableContentBlocks: NodeMaterialBlock[];
  21718. /**
  21719. * List of blocks that can provide a dynamic list of uniforms
  21720. */
  21721. dynamicUniformBlocks: NodeMaterialBlock[];
  21722. /**
  21723. * List of blocks that can block the isReady function for the material
  21724. */
  21725. blockingBlocks: NodeMaterialBlock[];
  21726. /**
  21727. * Gets the list of animated inputs
  21728. */
  21729. animatedInputs: InputBlock[];
  21730. /**
  21731. * Build Id used to avoid multiple recompilations
  21732. */
  21733. buildId: number;
  21734. /** List of emitted variables */
  21735. variableNames: {
  21736. [key: string]: number;
  21737. };
  21738. /** List of emitted defines */
  21739. defineNames: {
  21740. [key: string]: number;
  21741. };
  21742. /** Should emit comments? */
  21743. emitComments: boolean;
  21744. /** Emit build activity */
  21745. verbose: boolean;
  21746. /** Gets or sets the hosting scene */
  21747. scene: Scene;
  21748. /**
  21749. * Gets the compilation hints emitted at compilation time
  21750. */
  21751. hints: {
  21752. needWorldViewMatrix: boolean;
  21753. needWorldViewProjectionMatrix: boolean;
  21754. needAlphaBlending: boolean;
  21755. needAlphaTesting: boolean;
  21756. };
  21757. /**
  21758. * List of compilation checks
  21759. */
  21760. checks: {
  21761. emitVertex: boolean;
  21762. emitFragment: boolean;
  21763. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  21764. };
  21765. /**
  21766. * Is vertex program allowed to be empty?
  21767. */
  21768. allowEmptyVertexProgram: boolean;
  21769. /** Creates a new shared data */
  21770. constructor();
  21771. /**
  21772. * Emits console errors and exceptions if there is a failing check
  21773. */
  21774. emitErrors(): void;
  21775. }
  21776. }
  21777. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  21778. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21779. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21780. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  21781. /**
  21782. * Class used to store node based material build state
  21783. */
  21784. export class NodeMaterialBuildState {
  21785. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  21786. supportUniformBuffers: boolean;
  21787. /**
  21788. * Gets the list of emitted attributes
  21789. */
  21790. attributes: string[];
  21791. /**
  21792. * Gets the list of emitted uniforms
  21793. */
  21794. uniforms: string[];
  21795. /**
  21796. * Gets the list of emitted constants
  21797. */
  21798. constants: string[];
  21799. /**
  21800. * Gets the list of emitted samplers
  21801. */
  21802. samplers: string[];
  21803. /**
  21804. * Gets the list of emitted functions
  21805. */
  21806. functions: {
  21807. [key: string]: string;
  21808. };
  21809. /**
  21810. * Gets the list of emitted extensions
  21811. */
  21812. extensions: {
  21813. [key: string]: string;
  21814. };
  21815. /**
  21816. * Gets the target of the compilation state
  21817. */
  21818. target: NodeMaterialBlockTargets;
  21819. /**
  21820. * Gets the list of emitted counters
  21821. */
  21822. counters: {
  21823. [key: string]: number;
  21824. };
  21825. /**
  21826. * Shared data between multiple NodeMaterialBuildState instances
  21827. */
  21828. sharedData: NodeMaterialBuildStateSharedData;
  21829. /** @hidden */
  21830. _vertexState: NodeMaterialBuildState;
  21831. /** @hidden */
  21832. _attributeDeclaration: string;
  21833. /** @hidden */
  21834. _uniformDeclaration: string;
  21835. /** @hidden */
  21836. _constantDeclaration: string;
  21837. /** @hidden */
  21838. _samplerDeclaration: string;
  21839. /** @hidden */
  21840. _varyingTransfer: string;
  21841. /** @hidden */
  21842. _injectAtEnd: string;
  21843. private _repeatableContentAnchorIndex;
  21844. /** @hidden */
  21845. _builtCompilationString: string;
  21846. /**
  21847. * Gets the emitted compilation strings
  21848. */
  21849. compilationString: string;
  21850. /**
  21851. * Finalize the compilation strings
  21852. * @param state defines the current compilation state
  21853. */
  21854. finalize(state: NodeMaterialBuildState): void;
  21855. /** @hidden */
  21856. get _repeatableContentAnchor(): string;
  21857. /** @hidden */
  21858. _getFreeVariableName(prefix: string): string;
  21859. /** @hidden */
  21860. _getFreeDefineName(prefix: string): string;
  21861. /** @hidden */
  21862. _excludeVariableName(name: string): void;
  21863. /** @hidden */
  21864. _emit2DSampler(name: string): void;
  21865. /** @hidden */
  21866. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  21867. /** @hidden */
  21868. _emitExtension(name: string, extension: string, define?: string): void;
  21869. /** @hidden */
  21870. _emitFunction(name: string, code: string, comments: string): void;
  21871. /** @hidden */
  21872. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  21873. replaceStrings?: {
  21874. search: RegExp;
  21875. replace: string;
  21876. }[];
  21877. repeatKey?: string;
  21878. }): string;
  21879. /** @hidden */
  21880. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  21881. repeatKey?: string;
  21882. removeAttributes?: boolean;
  21883. removeUniforms?: boolean;
  21884. removeVaryings?: boolean;
  21885. removeIfDef?: boolean;
  21886. replaceStrings?: {
  21887. search: RegExp;
  21888. replace: string;
  21889. }[];
  21890. }, storeKey?: string): void;
  21891. /** @hidden */
  21892. _registerTempVariable(name: string): boolean;
  21893. /** @hidden */
  21894. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  21895. /** @hidden */
  21896. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  21897. /** @hidden */
  21898. _emitFloat(value: number): string;
  21899. }
  21900. }
  21901. declare module "babylonjs/Misc/uniqueIdGenerator" {
  21902. /**
  21903. * Helper class used to generate session unique ID
  21904. */
  21905. export class UniqueIdGenerator {
  21906. private static _UniqueIdCounter;
  21907. /**
  21908. * Gets an unique (relatively to the current scene) Id
  21909. */
  21910. static get UniqueId(): number;
  21911. }
  21912. }
  21913. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  21914. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21915. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21916. import { Nullable } from "babylonjs/types";
  21917. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21918. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21919. import { Effect } from "babylonjs/Materials/effect";
  21920. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21921. import { Mesh } from "babylonjs/Meshes/mesh";
  21922. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21923. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21924. import { Scene } from "babylonjs/scene";
  21925. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  21926. /**
  21927. * Defines a block that can be used inside a node based material
  21928. */
  21929. export class NodeMaterialBlock {
  21930. private _buildId;
  21931. private _buildTarget;
  21932. private _target;
  21933. private _isFinalMerger;
  21934. private _isInput;
  21935. protected _isUnique: boolean;
  21936. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  21937. inputsAreExclusive: boolean;
  21938. /** @hidden */
  21939. _codeVariableName: string;
  21940. /** @hidden */
  21941. _inputs: NodeMaterialConnectionPoint[];
  21942. /** @hidden */
  21943. _outputs: NodeMaterialConnectionPoint[];
  21944. /** @hidden */
  21945. _preparationId: number;
  21946. /**
  21947. * Gets or sets the name of the block
  21948. */
  21949. name: string;
  21950. /**
  21951. * Gets or sets the unique id of the node
  21952. */
  21953. uniqueId: number;
  21954. /**
  21955. * Gets or sets the comments associated with this block
  21956. */
  21957. comments: string;
  21958. /**
  21959. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  21960. */
  21961. get isUnique(): boolean;
  21962. /**
  21963. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  21964. */
  21965. get isFinalMerger(): boolean;
  21966. /**
  21967. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  21968. */
  21969. get isInput(): boolean;
  21970. /**
  21971. * Gets or sets the build Id
  21972. */
  21973. get buildId(): number;
  21974. set buildId(value: number);
  21975. /**
  21976. * Gets or sets the target of the block
  21977. */
  21978. get target(): NodeMaterialBlockTargets;
  21979. set target(value: NodeMaterialBlockTargets);
  21980. /**
  21981. * Gets the list of input points
  21982. */
  21983. get inputs(): NodeMaterialConnectionPoint[];
  21984. /** Gets the list of output points */
  21985. get outputs(): NodeMaterialConnectionPoint[];
  21986. /**
  21987. * Find an input by its name
  21988. * @param name defines the name of the input to look for
  21989. * @returns the input or null if not found
  21990. */
  21991. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  21992. /**
  21993. * Find an output by its name
  21994. * @param name defines the name of the outputto look for
  21995. * @returns the output or null if not found
  21996. */
  21997. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  21998. /**
  21999. * Creates a new NodeMaterialBlock
  22000. * @param name defines the block name
  22001. * @param target defines the target of that block (Vertex by default)
  22002. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22003. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22004. */
  22005. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22006. /**
  22007. * Initialize the block and prepare the context for build
  22008. * @param state defines the state that will be used for the build
  22009. */
  22010. initialize(state: NodeMaterialBuildState): void;
  22011. /**
  22012. * Bind data to effect. Will only be called for blocks with isBindable === true
  22013. * @param effect defines the effect to bind data to
  22014. * @param nodeMaterial defines the hosting NodeMaterial
  22015. * @param mesh defines the mesh that will be rendered
  22016. * @param subMesh defines the submesh that will be rendered
  22017. */
  22018. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22019. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22020. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22021. protected _writeFloat(value: number): string;
  22022. /**
  22023. * Gets the current class name e.g. "NodeMaterialBlock"
  22024. * @returns the class name
  22025. */
  22026. getClassName(): string;
  22027. /**
  22028. * Register a new input. Must be called inside a block constructor
  22029. * @param name defines the connection point name
  22030. * @param type defines the connection point type
  22031. * @param isOptional defines a boolean indicating that this input can be omitted
  22032. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22033. * @param point an already created connection point. If not provided, create a new one
  22034. * @returns the current block
  22035. */
  22036. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22037. /**
  22038. * Register a new output. Must be called inside a block constructor
  22039. * @param name defines the connection point name
  22040. * @param type defines the connection point type
  22041. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22042. * @param point an already created connection point. If not provided, create a new one
  22043. * @returns the current block
  22044. */
  22045. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22046. /**
  22047. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22048. * @param forOutput defines an optional connection point to check compatibility with
  22049. * @returns the first available input or null
  22050. */
  22051. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22052. /**
  22053. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22054. * @param forBlock defines an optional block to check compatibility with
  22055. * @returns the first available input or null
  22056. */
  22057. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22058. /**
  22059. * Gets the sibling of the given output
  22060. * @param current defines the current output
  22061. * @returns the next output in the list or null
  22062. */
  22063. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22064. /**
  22065. * Connect current block with another block
  22066. * @param other defines the block to connect with
  22067. * @param options define the various options to help pick the right connections
  22068. * @returns the current block
  22069. */
  22070. connectTo(other: NodeMaterialBlock, options?: {
  22071. input?: string;
  22072. output?: string;
  22073. outputSwizzle?: string;
  22074. }): this | undefined;
  22075. protected _buildBlock(state: NodeMaterialBuildState): void;
  22076. /**
  22077. * Add uniforms, samplers and uniform buffers at compilation time
  22078. * @param state defines the state to update
  22079. * @param nodeMaterial defines the node material requesting the update
  22080. * @param defines defines the material defines to update
  22081. * @param uniformBuffers defines the list of uniform buffer names
  22082. */
  22083. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22084. /**
  22085. * Add potential fallbacks if shader compilation fails
  22086. * @param mesh defines the mesh to be rendered
  22087. * @param fallbacks defines the current prioritized list of fallbacks
  22088. */
  22089. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22090. /**
  22091. * Initialize defines for shader compilation
  22092. * @param mesh defines the mesh to be rendered
  22093. * @param nodeMaterial defines the node material requesting the update
  22094. * @param defines defines the material defines to update
  22095. * @param useInstances specifies that instances should be used
  22096. */
  22097. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22098. /**
  22099. * Update defines for shader compilation
  22100. * @param mesh defines the mesh to be rendered
  22101. * @param nodeMaterial defines the node material requesting the update
  22102. * @param defines defines the material defines to update
  22103. * @param useInstances specifies that instances should be used
  22104. * @param subMesh defines which submesh to render
  22105. */
  22106. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22107. /**
  22108. * Lets the block try to connect some inputs automatically
  22109. * @param material defines the hosting NodeMaterial
  22110. */
  22111. autoConfigure(material: NodeMaterial): void;
  22112. /**
  22113. * Function called when a block is declared as repeatable content generator
  22114. * @param vertexShaderState defines the current compilation state for the vertex shader
  22115. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22116. * @param mesh defines the mesh to be rendered
  22117. * @param defines defines the material defines to update
  22118. */
  22119. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22120. /**
  22121. * Checks if the block is ready
  22122. * @param mesh defines the mesh to be rendered
  22123. * @param nodeMaterial defines the node material requesting the update
  22124. * @param defines defines the material defines to update
  22125. * @param useInstances specifies that instances should be used
  22126. * @returns true if the block is ready
  22127. */
  22128. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22129. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22130. private _processBuild;
  22131. /**
  22132. * Compile the current node and generate the shader code
  22133. * @param state defines the current compilation state (uniforms, samplers, current string)
  22134. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22135. * @returns true if already built
  22136. */
  22137. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22138. protected _inputRename(name: string): string;
  22139. protected _outputRename(name: string): string;
  22140. protected _dumpPropertiesCode(): string;
  22141. /** @hidden */
  22142. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22143. /** @hidden */
  22144. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22145. /**
  22146. * Clone the current block to a new identical block
  22147. * @param scene defines the hosting scene
  22148. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22149. * @returns a copy of the current block
  22150. */
  22151. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22152. /**
  22153. * Serializes this block in a JSON representation
  22154. * @returns the serialized block object
  22155. */
  22156. serialize(): any;
  22157. /** @hidden */
  22158. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22159. private _deserializePortDisplayNamesAndExposedOnFrame;
  22160. /**
  22161. * Release resources
  22162. */
  22163. dispose(): void;
  22164. }
  22165. }
  22166. declare module "babylonjs/Materials/pushMaterial" {
  22167. import { Nullable } from "babylonjs/types";
  22168. import { Scene } from "babylonjs/scene";
  22169. import { Matrix } from "babylonjs/Maths/math.vector";
  22170. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22171. import { Mesh } from "babylonjs/Meshes/mesh";
  22172. import { Material } from "babylonjs/Materials/material";
  22173. import { Effect } from "babylonjs/Materials/effect";
  22174. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22175. /**
  22176. * Base class of materials working in push mode in babylon JS
  22177. * @hidden
  22178. */
  22179. export class PushMaterial extends Material {
  22180. protected _activeEffect: Effect;
  22181. protected _normalMatrix: Matrix;
  22182. constructor(name: string, scene: Scene);
  22183. getEffect(): Effect;
  22184. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22185. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22186. /**
  22187. * Binds the given world matrix to the active effect
  22188. *
  22189. * @param world the matrix to bind
  22190. */
  22191. bindOnlyWorldMatrix(world: Matrix): void;
  22192. /**
  22193. * Binds the given normal matrix to the active effect
  22194. *
  22195. * @param normalMatrix the matrix to bind
  22196. */
  22197. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22198. bind(world: Matrix, mesh?: Mesh): void;
  22199. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22200. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22201. }
  22202. }
  22203. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22204. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22205. /**
  22206. * Root class for all node material optimizers
  22207. */
  22208. export class NodeMaterialOptimizer {
  22209. /**
  22210. * Function used to optimize a NodeMaterial graph
  22211. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22212. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22213. */
  22214. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22215. }
  22216. }
  22217. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22218. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22219. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22220. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22221. import { Scene } from "babylonjs/scene";
  22222. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22223. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22224. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22225. /**
  22226. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22227. */
  22228. export class TransformBlock extends NodeMaterialBlock {
  22229. /**
  22230. * Defines the value to use to complement W value to transform it to a Vector4
  22231. */
  22232. complementW: number;
  22233. /**
  22234. * Defines the value to use to complement z value to transform it to a Vector4
  22235. */
  22236. complementZ: number;
  22237. /**
  22238. * Creates a new TransformBlock
  22239. * @param name defines the block name
  22240. */
  22241. constructor(name: string);
  22242. /**
  22243. * Gets the current class name
  22244. * @returns the class name
  22245. */
  22246. getClassName(): string;
  22247. /**
  22248. * Gets the vector input
  22249. */
  22250. get vector(): NodeMaterialConnectionPoint;
  22251. /**
  22252. * Gets the output component
  22253. */
  22254. get output(): NodeMaterialConnectionPoint;
  22255. /**
  22256. * Gets the xyz output component
  22257. */
  22258. get xyz(): NodeMaterialConnectionPoint;
  22259. /**
  22260. * Gets the matrix transform input
  22261. */
  22262. get transform(): NodeMaterialConnectionPoint;
  22263. protected _buildBlock(state: NodeMaterialBuildState): this;
  22264. /**
  22265. * Update defines for shader compilation
  22266. * @param mesh defines the mesh to be rendered
  22267. * @param nodeMaterial defines the node material requesting the update
  22268. * @param defines defines the material defines to update
  22269. * @param useInstances specifies that instances should be used
  22270. * @param subMesh defines which submesh to render
  22271. */
  22272. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22273. serialize(): any;
  22274. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22275. protected _dumpPropertiesCode(): string;
  22276. }
  22277. }
  22278. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22279. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22280. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22281. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22282. /**
  22283. * Block used to output the vertex position
  22284. */
  22285. export class VertexOutputBlock extends NodeMaterialBlock {
  22286. /**
  22287. * Creates a new VertexOutputBlock
  22288. * @param name defines the block name
  22289. */
  22290. constructor(name: string);
  22291. /**
  22292. * Gets the current class name
  22293. * @returns the class name
  22294. */
  22295. getClassName(): string;
  22296. /**
  22297. * Gets the vector input component
  22298. */
  22299. get vector(): NodeMaterialConnectionPoint;
  22300. protected _buildBlock(state: NodeMaterialBuildState): this;
  22301. }
  22302. }
  22303. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22304. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22305. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22306. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22307. /**
  22308. * Block used to output the final color
  22309. */
  22310. export class FragmentOutputBlock extends NodeMaterialBlock {
  22311. /**
  22312. * Create a new FragmentOutputBlock
  22313. * @param name defines the block name
  22314. */
  22315. constructor(name: string);
  22316. /**
  22317. * Gets the current class name
  22318. * @returns the class name
  22319. */
  22320. getClassName(): string;
  22321. /**
  22322. * Gets the rgba input component
  22323. */
  22324. get rgba(): NodeMaterialConnectionPoint;
  22325. /**
  22326. * Gets the rgb input component
  22327. */
  22328. get rgb(): NodeMaterialConnectionPoint;
  22329. /**
  22330. * Gets the a input component
  22331. */
  22332. get a(): NodeMaterialConnectionPoint;
  22333. protected _buildBlock(state: NodeMaterialBuildState): this;
  22334. }
  22335. }
  22336. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22337. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22338. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22339. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22340. /**
  22341. * Block used for the particle ramp gradient section
  22342. */
  22343. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22344. /**
  22345. * Create a new ParticleRampGradientBlock
  22346. * @param name defines the block name
  22347. */
  22348. constructor(name: string);
  22349. /**
  22350. * Gets the current class name
  22351. * @returns the class name
  22352. */
  22353. getClassName(): string;
  22354. /**
  22355. * Gets the color input component
  22356. */
  22357. get color(): NodeMaterialConnectionPoint;
  22358. /**
  22359. * Gets the rampColor output component
  22360. */
  22361. get rampColor(): NodeMaterialConnectionPoint;
  22362. /**
  22363. * Initialize the block and prepare the context for build
  22364. * @param state defines the state that will be used for the build
  22365. */
  22366. initialize(state: NodeMaterialBuildState): void;
  22367. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22368. }
  22369. }
  22370. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22371. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22372. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22373. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22374. /**
  22375. * Block used for the particle blend multiply section
  22376. */
  22377. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22378. /**
  22379. * Create a new ParticleBlendMultiplyBlock
  22380. * @param name defines the block name
  22381. */
  22382. constructor(name: string);
  22383. /**
  22384. * Gets the current class name
  22385. * @returns the class name
  22386. */
  22387. getClassName(): string;
  22388. /**
  22389. * Gets the color input component
  22390. */
  22391. get color(): NodeMaterialConnectionPoint;
  22392. /**
  22393. * Gets the alphaTexture input component
  22394. */
  22395. get alphaTexture(): NodeMaterialConnectionPoint;
  22396. /**
  22397. * Gets the alphaColor input component
  22398. */
  22399. get alphaColor(): NodeMaterialConnectionPoint;
  22400. /**
  22401. * Gets the blendColor output component
  22402. */
  22403. get blendColor(): NodeMaterialConnectionPoint;
  22404. /**
  22405. * Initialize the block and prepare the context for build
  22406. * @param state defines the state that will be used for the build
  22407. */
  22408. initialize(state: NodeMaterialBuildState): void;
  22409. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22410. }
  22411. }
  22412. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22413. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22414. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22415. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22416. /**
  22417. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22418. */
  22419. export class VectorMergerBlock extends NodeMaterialBlock {
  22420. /**
  22421. * Create a new VectorMergerBlock
  22422. * @param name defines the block name
  22423. */
  22424. constructor(name: string);
  22425. /**
  22426. * Gets the current class name
  22427. * @returns the class name
  22428. */
  22429. getClassName(): string;
  22430. /**
  22431. * Gets the xyz component (input)
  22432. */
  22433. get xyzIn(): NodeMaterialConnectionPoint;
  22434. /**
  22435. * Gets the xy component (input)
  22436. */
  22437. get xyIn(): NodeMaterialConnectionPoint;
  22438. /**
  22439. * Gets the x component (input)
  22440. */
  22441. get x(): NodeMaterialConnectionPoint;
  22442. /**
  22443. * Gets the y component (input)
  22444. */
  22445. get y(): NodeMaterialConnectionPoint;
  22446. /**
  22447. * Gets the z component (input)
  22448. */
  22449. get z(): NodeMaterialConnectionPoint;
  22450. /**
  22451. * Gets the w component (input)
  22452. */
  22453. get w(): NodeMaterialConnectionPoint;
  22454. /**
  22455. * Gets the xyzw component (output)
  22456. */
  22457. get xyzw(): NodeMaterialConnectionPoint;
  22458. /**
  22459. * Gets the xyz component (output)
  22460. */
  22461. get xyzOut(): NodeMaterialConnectionPoint;
  22462. /**
  22463. * Gets the xy component (output)
  22464. */
  22465. get xyOut(): NodeMaterialConnectionPoint;
  22466. /**
  22467. * Gets the xy component (output)
  22468. * @deprecated Please use xyOut instead.
  22469. */
  22470. get xy(): NodeMaterialConnectionPoint;
  22471. /**
  22472. * Gets the xyz component (output)
  22473. * @deprecated Please use xyzOut instead.
  22474. */
  22475. get xyz(): NodeMaterialConnectionPoint;
  22476. protected _buildBlock(state: NodeMaterialBuildState): this;
  22477. }
  22478. }
  22479. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22480. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22481. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22482. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22483. import { Vector2 } from "babylonjs/Maths/math.vector";
  22484. import { Scene } from "babylonjs/scene";
  22485. /**
  22486. * Block used to remap a float from a range to a new one
  22487. */
  22488. export class RemapBlock extends NodeMaterialBlock {
  22489. /**
  22490. * Gets or sets the source range
  22491. */
  22492. sourceRange: Vector2;
  22493. /**
  22494. * Gets or sets the target range
  22495. */
  22496. targetRange: Vector2;
  22497. /**
  22498. * Creates a new RemapBlock
  22499. * @param name defines the block name
  22500. */
  22501. constructor(name: string);
  22502. /**
  22503. * Gets the current class name
  22504. * @returns the class name
  22505. */
  22506. getClassName(): string;
  22507. /**
  22508. * Gets the input component
  22509. */
  22510. get input(): NodeMaterialConnectionPoint;
  22511. /**
  22512. * Gets the source min input component
  22513. */
  22514. get sourceMin(): NodeMaterialConnectionPoint;
  22515. /**
  22516. * Gets the source max input component
  22517. */
  22518. get sourceMax(): NodeMaterialConnectionPoint;
  22519. /**
  22520. * Gets the target min input component
  22521. */
  22522. get targetMin(): NodeMaterialConnectionPoint;
  22523. /**
  22524. * Gets the target max input component
  22525. */
  22526. get targetMax(): NodeMaterialConnectionPoint;
  22527. /**
  22528. * Gets the output component
  22529. */
  22530. get output(): NodeMaterialConnectionPoint;
  22531. protected _buildBlock(state: NodeMaterialBuildState): this;
  22532. protected _dumpPropertiesCode(): string;
  22533. serialize(): any;
  22534. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22535. }
  22536. }
  22537. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22538. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22539. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22540. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22541. /**
  22542. * Block used to multiply 2 values
  22543. */
  22544. export class MultiplyBlock extends NodeMaterialBlock {
  22545. /**
  22546. * Creates a new MultiplyBlock
  22547. * @param name defines the block name
  22548. */
  22549. constructor(name: string);
  22550. /**
  22551. * Gets the current class name
  22552. * @returns the class name
  22553. */
  22554. getClassName(): string;
  22555. /**
  22556. * Gets the left operand input component
  22557. */
  22558. get left(): NodeMaterialConnectionPoint;
  22559. /**
  22560. * Gets the right operand input component
  22561. */
  22562. get right(): NodeMaterialConnectionPoint;
  22563. /**
  22564. * Gets the output component
  22565. */
  22566. get output(): NodeMaterialConnectionPoint;
  22567. protected _buildBlock(state: NodeMaterialBuildState): this;
  22568. }
  22569. }
  22570. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22571. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22572. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22573. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22574. /**
  22575. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22576. */
  22577. export class ColorSplitterBlock extends NodeMaterialBlock {
  22578. /**
  22579. * Create a new ColorSplitterBlock
  22580. * @param name defines the block name
  22581. */
  22582. constructor(name: string);
  22583. /**
  22584. * Gets the current class name
  22585. * @returns the class name
  22586. */
  22587. getClassName(): string;
  22588. /**
  22589. * Gets the rgba component (input)
  22590. */
  22591. get rgba(): NodeMaterialConnectionPoint;
  22592. /**
  22593. * Gets the rgb component (input)
  22594. */
  22595. get rgbIn(): NodeMaterialConnectionPoint;
  22596. /**
  22597. * Gets the rgb component (output)
  22598. */
  22599. get rgbOut(): NodeMaterialConnectionPoint;
  22600. /**
  22601. * Gets the r component (output)
  22602. */
  22603. get r(): NodeMaterialConnectionPoint;
  22604. /**
  22605. * Gets the g component (output)
  22606. */
  22607. get g(): NodeMaterialConnectionPoint;
  22608. /**
  22609. * Gets the b component (output)
  22610. */
  22611. get b(): NodeMaterialConnectionPoint;
  22612. /**
  22613. * Gets the a component (output)
  22614. */
  22615. get a(): NodeMaterialConnectionPoint;
  22616. protected _inputRename(name: string): string;
  22617. protected _outputRename(name: string): string;
  22618. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22619. }
  22620. }
  22621. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22622. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22623. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22624. import { Scene } from "babylonjs/scene";
  22625. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22626. import { Matrix } from "babylonjs/Maths/math.vector";
  22627. import { Mesh } from "babylonjs/Meshes/mesh";
  22628. import { Engine } from "babylonjs/Engines/engine";
  22629. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22630. import { Observable } from "babylonjs/Misc/observable";
  22631. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22632. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22633. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22634. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22635. import { Nullable } from "babylonjs/types";
  22636. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22637. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22638. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22639. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22640. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22641. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22642. import { Effect } from "babylonjs/Materials/effect";
  22643. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22644. import { Camera } from "babylonjs/Cameras/camera";
  22645. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22646. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22647. /**
  22648. * Interface used to configure the node material editor
  22649. */
  22650. export interface INodeMaterialEditorOptions {
  22651. /** Define the URl to load node editor script */
  22652. editorURL?: string;
  22653. }
  22654. /** @hidden */
  22655. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22656. NORMAL: boolean;
  22657. TANGENT: boolean;
  22658. UV1: boolean;
  22659. /** BONES */
  22660. NUM_BONE_INFLUENCERS: number;
  22661. BonesPerMesh: number;
  22662. BONETEXTURE: boolean;
  22663. /** MORPH TARGETS */
  22664. MORPHTARGETS: boolean;
  22665. MORPHTARGETS_NORMAL: boolean;
  22666. MORPHTARGETS_TANGENT: boolean;
  22667. MORPHTARGETS_UV: boolean;
  22668. NUM_MORPH_INFLUENCERS: number;
  22669. /** IMAGE PROCESSING */
  22670. IMAGEPROCESSING: boolean;
  22671. VIGNETTE: boolean;
  22672. VIGNETTEBLENDMODEMULTIPLY: boolean;
  22673. VIGNETTEBLENDMODEOPAQUE: boolean;
  22674. TONEMAPPING: boolean;
  22675. TONEMAPPING_ACES: boolean;
  22676. CONTRAST: boolean;
  22677. EXPOSURE: boolean;
  22678. COLORCURVES: boolean;
  22679. COLORGRADING: boolean;
  22680. COLORGRADING3D: boolean;
  22681. SAMPLER3DGREENDEPTH: boolean;
  22682. SAMPLER3DBGRMAP: boolean;
  22683. IMAGEPROCESSINGPOSTPROCESS: boolean;
  22684. /** MISC. */
  22685. BUMPDIRECTUV: number;
  22686. constructor();
  22687. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  22688. }
  22689. /**
  22690. * Class used to configure NodeMaterial
  22691. */
  22692. export interface INodeMaterialOptions {
  22693. /**
  22694. * Defines if blocks should emit comments
  22695. */
  22696. emitComments: boolean;
  22697. }
  22698. /**
  22699. * Class used to create a node based material built by assembling shader blocks
  22700. */
  22701. export class NodeMaterial extends PushMaterial {
  22702. private static _BuildIdGenerator;
  22703. private _options;
  22704. private _vertexCompilationState;
  22705. private _fragmentCompilationState;
  22706. private _sharedData;
  22707. private _buildId;
  22708. private _buildWasSuccessful;
  22709. private _cachedWorldViewMatrix;
  22710. private _cachedWorldViewProjectionMatrix;
  22711. private _optimizers;
  22712. private _animationFrame;
  22713. /** Define the Url to load node editor script */
  22714. static EditorURL: string;
  22715. /** Define the Url to load snippets */
  22716. static SnippetUrl: string;
  22717. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  22718. static IgnoreTexturesAtLoadTime: boolean;
  22719. private BJSNODEMATERIALEDITOR;
  22720. /** Get the inspector from bundle or global */
  22721. private _getGlobalNodeMaterialEditor;
  22722. /**
  22723. * Snippet ID if the material was created from the snippet server
  22724. */
  22725. snippetId: string;
  22726. /**
  22727. * Gets or sets data used by visual editor
  22728. * @see https://nme.babylonjs.com
  22729. */
  22730. editorData: any;
  22731. /**
  22732. * 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)
  22733. */
  22734. ignoreAlpha: boolean;
  22735. /**
  22736. * Defines the maximum number of lights that can be used in the material
  22737. */
  22738. maxSimultaneousLights: number;
  22739. /**
  22740. * Observable raised when the material is built
  22741. */
  22742. onBuildObservable: Observable<NodeMaterial>;
  22743. /**
  22744. * Gets or sets the root nodes of the material vertex shader
  22745. */
  22746. _vertexOutputNodes: NodeMaterialBlock[];
  22747. /**
  22748. * Gets or sets the root nodes of the material fragment (pixel) shader
  22749. */
  22750. _fragmentOutputNodes: NodeMaterialBlock[];
  22751. /** Gets or sets options to control the node material overall behavior */
  22752. get options(): INodeMaterialOptions;
  22753. set options(options: INodeMaterialOptions);
  22754. /**
  22755. * Default configuration related to image processing available in the standard Material.
  22756. */
  22757. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  22758. /**
  22759. * Gets the image processing configuration used either in this material.
  22760. */
  22761. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  22762. /**
  22763. * Sets the Default image processing configuration used either in the this material.
  22764. *
  22765. * If sets to null, the scene one is in use.
  22766. */
  22767. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  22768. /**
  22769. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  22770. */
  22771. attachedBlocks: NodeMaterialBlock[];
  22772. /**
  22773. * Specifies the mode of the node material
  22774. * @hidden
  22775. */
  22776. _mode: NodeMaterialModes;
  22777. /**
  22778. * Gets the mode property
  22779. */
  22780. get mode(): NodeMaterialModes;
  22781. /**
  22782. * Create a new node based material
  22783. * @param name defines the material name
  22784. * @param scene defines the hosting scene
  22785. * @param options defines creation option
  22786. */
  22787. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  22788. /**
  22789. * Gets the current class name of the material e.g. "NodeMaterial"
  22790. * @returns the class name
  22791. */
  22792. getClassName(): string;
  22793. /**
  22794. * Keep track of the image processing observer to allow dispose and replace.
  22795. */
  22796. private _imageProcessingObserver;
  22797. /**
  22798. * Attaches a new image processing configuration to the Standard Material.
  22799. * @param configuration
  22800. */
  22801. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  22802. /**
  22803. * Get a block by its name
  22804. * @param name defines the name of the block to retrieve
  22805. * @returns the required block or null if not found
  22806. */
  22807. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  22808. /**
  22809. * Get a block by its name
  22810. * @param predicate defines the predicate used to find the good candidate
  22811. * @returns the required block or null if not found
  22812. */
  22813. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  22814. /**
  22815. * Get an input block by its name
  22816. * @param predicate defines the predicate used to find the good candidate
  22817. * @returns the required input block or null if not found
  22818. */
  22819. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  22820. /**
  22821. * Gets the list of input blocks attached to this material
  22822. * @returns an array of InputBlocks
  22823. */
  22824. getInputBlocks(): InputBlock[];
  22825. /**
  22826. * Adds a new optimizer to the list of optimizers
  22827. * @param optimizer defines the optimizers to add
  22828. * @returns the current material
  22829. */
  22830. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  22831. /**
  22832. * Remove an optimizer from the list of optimizers
  22833. * @param optimizer defines the optimizers to remove
  22834. * @returns the current material
  22835. */
  22836. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  22837. /**
  22838. * Add a new block to the list of output nodes
  22839. * @param node defines the node to add
  22840. * @returns the current material
  22841. */
  22842. addOutputNode(node: NodeMaterialBlock): this;
  22843. /**
  22844. * Remove a block from the list of root nodes
  22845. * @param node defines the node to remove
  22846. * @returns the current material
  22847. */
  22848. removeOutputNode(node: NodeMaterialBlock): this;
  22849. private _addVertexOutputNode;
  22850. private _removeVertexOutputNode;
  22851. private _addFragmentOutputNode;
  22852. private _removeFragmentOutputNode;
  22853. /**
  22854. * Specifies if the material will require alpha blending
  22855. * @returns a boolean specifying if alpha blending is needed
  22856. */
  22857. needAlphaBlending(): boolean;
  22858. /**
  22859. * Specifies if this material should be rendered in alpha test mode
  22860. * @returns a boolean specifying if an alpha test is needed.
  22861. */
  22862. needAlphaTesting(): boolean;
  22863. private _initializeBlock;
  22864. private _resetDualBlocks;
  22865. /**
  22866. * Remove a block from the current node material
  22867. * @param block defines the block to remove
  22868. */
  22869. removeBlock(block: NodeMaterialBlock): void;
  22870. /**
  22871. * Build the material and generates the inner effect
  22872. * @param verbose defines if the build should log activity
  22873. */
  22874. build(verbose?: boolean): void;
  22875. /**
  22876. * Runs an otpimization phase to try to improve the shader code
  22877. */
  22878. optimize(): void;
  22879. private _prepareDefinesForAttributes;
  22880. /**
  22881. * Create a post process from the material
  22882. * @param camera The camera to apply the render pass to.
  22883. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  22884. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  22885. * @param engine The engine which the post process will be applied. (default: current engine)
  22886. * @param reusable If the post process can be reused on the same frame. (default: false)
  22887. * @param textureType Type of textures used when performing the post process. (default: 0)
  22888. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  22889. * @returns the post process created
  22890. */
  22891. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  22892. /**
  22893. * Create the post process effect from the material
  22894. * @param postProcess The post process to create the effect for
  22895. */
  22896. createEffectForPostProcess(postProcess: PostProcess): void;
  22897. private _createEffectOrPostProcess;
  22898. private _createEffectForParticles;
  22899. /**
  22900. * Create the effect to be used as the custom effect for a particle system
  22901. * @param particleSystem Particle system to create the effect for
  22902. * @param onCompiled defines a function to call when the effect creation is successful
  22903. * @param onError defines a function to call when the effect creation has failed
  22904. */
  22905. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  22906. private _processDefines;
  22907. /**
  22908. * Get if the submesh is ready to be used and all its information available.
  22909. * Child classes can use it to update shaders
  22910. * @param mesh defines the mesh to check
  22911. * @param subMesh defines which submesh to check
  22912. * @param useInstances specifies that instances should be used
  22913. * @returns a boolean indicating that the submesh is ready or not
  22914. */
  22915. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  22916. /**
  22917. * Get a string representing the shaders built by the current node graph
  22918. */
  22919. get compiledShaders(): string;
  22920. /**
  22921. * Binds the world matrix to the material
  22922. * @param world defines the world transformation matrix
  22923. */
  22924. bindOnlyWorldMatrix(world: Matrix): void;
  22925. /**
  22926. * Binds the submesh to this material by preparing the effect and shader to draw
  22927. * @param world defines the world transformation matrix
  22928. * @param mesh defines the mesh containing the submesh
  22929. * @param subMesh defines the submesh to bind the material to
  22930. */
  22931. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  22932. /**
  22933. * Gets the active textures from the material
  22934. * @returns an array of textures
  22935. */
  22936. getActiveTextures(): BaseTexture[];
  22937. /**
  22938. * Gets the list of texture blocks
  22939. * @returns an array of texture blocks
  22940. */
  22941. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22942. /**
  22943. * Specifies if the material uses a texture
  22944. * @param texture defines the texture to check against the material
  22945. * @returns a boolean specifying if the material uses the texture
  22946. */
  22947. hasTexture(texture: BaseTexture): boolean;
  22948. /**
  22949. * Disposes the material
  22950. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  22951. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  22952. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  22953. */
  22954. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  22955. /** Creates the node editor window. */
  22956. private _createNodeEditor;
  22957. /**
  22958. * Launch the node material editor
  22959. * @param config Define the configuration of the editor
  22960. * @return a promise fulfilled when the node editor is visible
  22961. */
  22962. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  22963. /**
  22964. * Clear the current material
  22965. */
  22966. clear(): void;
  22967. /**
  22968. * Clear the current material and set it to a default state
  22969. */
  22970. setToDefault(): void;
  22971. /**
  22972. * Clear the current material and set it to a default state for post process
  22973. */
  22974. setToDefaultPostProcess(): void;
  22975. /**
  22976. * Clear the current material and set it to a default state for particle
  22977. */
  22978. setToDefaultParticle(): void;
  22979. /**
  22980. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  22981. * @param url defines the url to load from
  22982. * @returns a promise that will fullfil when the material is fully loaded
  22983. */
  22984. loadAsync(url: string): Promise<void>;
  22985. private _gatherBlocks;
  22986. /**
  22987. * Generate a string containing the code declaration required to create an equivalent of this material
  22988. * @returns a string
  22989. */
  22990. generateCode(): string;
  22991. /**
  22992. * Serializes this material in a JSON representation
  22993. * @returns the serialized material object
  22994. */
  22995. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  22996. private _restoreConnections;
  22997. /**
  22998. * Clear the current graph and load a new one from a serialization object
  22999. * @param source defines the JSON representation of the material
  23000. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23001. * @param merge defines whether or not the source must be merged or replace the current content
  23002. */
  23003. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23004. /**
  23005. * Makes a duplicate of the current material.
  23006. * @param name - name to use for the new material.
  23007. */
  23008. clone(name: string): NodeMaterial;
  23009. /**
  23010. * Creates a node material from parsed material data
  23011. * @param source defines the JSON representation of the material
  23012. * @param scene defines the hosting scene
  23013. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23014. * @returns a new node material
  23015. */
  23016. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23017. /**
  23018. * Creates a node material from a snippet saved in a remote file
  23019. * @param name defines the name of the material to create
  23020. * @param url defines the url to load from
  23021. * @param scene defines the hosting scene
  23022. * @returns a promise that will resolve to the new node material
  23023. */
  23024. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23025. /**
  23026. * Creates a node material from a snippet saved by the node material editor
  23027. * @param snippetId defines the snippet to load
  23028. * @param scene defines the hosting scene
  23029. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23030. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23031. * @returns a promise that will resolve to the new node material
  23032. */
  23033. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23034. /**
  23035. * Creates a new node material set to default basic configuration
  23036. * @param name defines the name of the material
  23037. * @param scene defines the hosting scene
  23038. * @returns a new NodeMaterial
  23039. */
  23040. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23041. }
  23042. }
  23043. declare module "babylonjs/PostProcesses/postProcess" {
  23044. import { Nullable } from "babylonjs/types";
  23045. import { SmartArray } from "babylonjs/Misc/smartArray";
  23046. import { Observable } from "babylonjs/Misc/observable";
  23047. import { Vector2 } from "babylonjs/Maths/math.vector";
  23048. import { Camera } from "babylonjs/Cameras/camera";
  23049. import { Effect } from "babylonjs/Materials/effect";
  23050. import "babylonjs/Shaders/postprocess.vertex";
  23051. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23052. import { Engine } from "babylonjs/Engines/engine";
  23053. import { Color4 } from "babylonjs/Maths/math.color";
  23054. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23055. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23056. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23057. /**
  23058. * Size options for a post process
  23059. */
  23060. export type PostProcessOptions = {
  23061. width: number;
  23062. height: number;
  23063. };
  23064. /**
  23065. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23066. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23067. */
  23068. export class PostProcess {
  23069. /** Name of the PostProcess. */
  23070. name: string;
  23071. /**
  23072. * Gets or sets the unique id of the post process
  23073. */
  23074. uniqueId: number;
  23075. /**
  23076. * Width of the texture to apply the post process on
  23077. */
  23078. width: number;
  23079. /**
  23080. * Height of the texture to apply the post process on
  23081. */
  23082. height: number;
  23083. /**
  23084. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23085. */
  23086. nodeMaterialSource: Nullable<NodeMaterial>;
  23087. /**
  23088. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23089. * @hidden
  23090. */
  23091. _outputTexture: Nullable<InternalTexture>;
  23092. /**
  23093. * Sampling mode used by the shader
  23094. * See https://doc.babylonjs.com/classes/3.1/texture
  23095. */
  23096. renderTargetSamplingMode: number;
  23097. /**
  23098. * Clear color to use when screen clearing
  23099. */
  23100. clearColor: Color4;
  23101. /**
  23102. * If the buffer needs to be cleared before applying the post process. (default: true)
  23103. * Should be set to false if shader will overwrite all previous pixels.
  23104. */
  23105. autoClear: boolean;
  23106. /**
  23107. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23108. */
  23109. alphaMode: number;
  23110. /**
  23111. * Sets the setAlphaBlendConstants of the babylon engine
  23112. */
  23113. alphaConstants: Color4;
  23114. /**
  23115. * Animations to be used for the post processing
  23116. */
  23117. animations: import("babylonjs/Animations/animation").Animation[];
  23118. /**
  23119. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23120. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23121. */
  23122. enablePixelPerfectMode: boolean;
  23123. /**
  23124. * Force the postprocess to be applied without taking in account viewport
  23125. */
  23126. forceFullscreenViewport: boolean;
  23127. /**
  23128. * List of inspectable custom properties (used by the Inspector)
  23129. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23130. */
  23131. inspectableCustomProperties: IInspectable[];
  23132. /**
  23133. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23134. *
  23135. * | Value | Type | Description |
  23136. * | ----- | ----------------------------------- | ----------- |
  23137. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23138. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23139. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23140. *
  23141. */
  23142. scaleMode: number;
  23143. /**
  23144. * Force textures to be a power of two (default: false)
  23145. */
  23146. alwaysForcePOT: boolean;
  23147. private _samples;
  23148. /**
  23149. * Number of sample textures (default: 1)
  23150. */
  23151. get samples(): number;
  23152. set samples(n: number);
  23153. /**
  23154. * Modify the scale of the post process to be the same as the viewport (default: false)
  23155. */
  23156. adaptScaleToCurrentViewport: boolean;
  23157. private _camera;
  23158. private _scene;
  23159. private _engine;
  23160. private _options;
  23161. private _reusable;
  23162. private _textureType;
  23163. private _textureFormat;
  23164. /**
  23165. * Smart array of input and output textures for the post process.
  23166. * @hidden
  23167. */
  23168. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23169. /**
  23170. * The index in _textures that corresponds to the output texture.
  23171. * @hidden
  23172. */
  23173. _currentRenderTextureInd: number;
  23174. private _effect;
  23175. private _samplers;
  23176. private _fragmentUrl;
  23177. private _vertexUrl;
  23178. private _parameters;
  23179. private _scaleRatio;
  23180. protected _indexParameters: any;
  23181. private _shareOutputWithPostProcess;
  23182. private _texelSize;
  23183. private _forcedOutputTexture;
  23184. /**
  23185. * Returns the fragment url or shader name used in the post process.
  23186. * @returns the fragment url or name in the shader store.
  23187. */
  23188. getEffectName(): string;
  23189. /**
  23190. * An event triggered when the postprocess is activated.
  23191. */
  23192. onActivateObservable: Observable<Camera>;
  23193. private _onActivateObserver;
  23194. /**
  23195. * A function that is added to the onActivateObservable
  23196. */
  23197. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23198. /**
  23199. * An event triggered when the postprocess changes its size.
  23200. */
  23201. onSizeChangedObservable: Observable<PostProcess>;
  23202. private _onSizeChangedObserver;
  23203. /**
  23204. * A function that is added to the onSizeChangedObservable
  23205. */
  23206. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23207. /**
  23208. * An event triggered when the postprocess applies its effect.
  23209. */
  23210. onApplyObservable: Observable<Effect>;
  23211. private _onApplyObserver;
  23212. /**
  23213. * A function that is added to the onApplyObservable
  23214. */
  23215. set onApply(callback: (effect: Effect) => void);
  23216. /**
  23217. * An event triggered before rendering the postprocess
  23218. */
  23219. onBeforeRenderObservable: Observable<Effect>;
  23220. private _onBeforeRenderObserver;
  23221. /**
  23222. * A function that is added to the onBeforeRenderObservable
  23223. */
  23224. set onBeforeRender(callback: (effect: Effect) => void);
  23225. /**
  23226. * An event triggered after rendering the postprocess
  23227. */
  23228. onAfterRenderObservable: Observable<Effect>;
  23229. private _onAfterRenderObserver;
  23230. /**
  23231. * A function that is added to the onAfterRenderObservable
  23232. */
  23233. set onAfterRender(callback: (efect: Effect) => void);
  23234. /**
  23235. * 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
  23236. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23237. */
  23238. get inputTexture(): InternalTexture;
  23239. set inputTexture(value: InternalTexture);
  23240. /**
  23241. * Gets the camera which post process is applied to.
  23242. * @returns The camera the post process is applied to.
  23243. */
  23244. getCamera(): Camera;
  23245. /**
  23246. * Gets the texel size of the postprocess.
  23247. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23248. */
  23249. get texelSize(): Vector2;
  23250. /**
  23251. * Creates a new instance PostProcess
  23252. * @param name The name of the PostProcess.
  23253. * @param fragmentUrl The url of the fragment shader to be used.
  23254. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23255. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23256. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23257. * @param camera The camera to apply the render pass to.
  23258. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23259. * @param engine The engine which the post process will be applied. (default: current engine)
  23260. * @param reusable If the post process can be reused on the same frame. (default: false)
  23261. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23262. * @param textureType Type of textures used when performing the post process. (default: 0)
  23263. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23264. * @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
  23265. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23266. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23267. */
  23268. constructor(
  23269. /** Name of the PostProcess. */
  23270. name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean, textureFormat?: number);
  23271. /**
  23272. * Gets a string idenfifying the name of the class
  23273. * @returns "PostProcess" string
  23274. */
  23275. getClassName(): string;
  23276. /**
  23277. * Gets the engine which this post process belongs to.
  23278. * @returns The engine the post process was enabled with.
  23279. */
  23280. getEngine(): Engine;
  23281. /**
  23282. * The effect that is created when initializing the post process.
  23283. * @returns The created effect corresponding the the postprocess.
  23284. */
  23285. getEffect(): Effect;
  23286. /**
  23287. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23288. * @param postProcess The post process to share the output with.
  23289. * @returns This post process.
  23290. */
  23291. shareOutputWith(postProcess: PostProcess): PostProcess;
  23292. /**
  23293. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23294. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23295. */
  23296. useOwnOutput(): void;
  23297. /**
  23298. * Updates the effect with the current post process compile time values and recompiles the shader.
  23299. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23300. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23301. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23302. * @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
  23303. * @param onCompiled Called when the shader has been compiled.
  23304. * @param onError Called if there is an error when compiling a shader.
  23305. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23306. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23307. */
  23308. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  23309. /**
  23310. * The post process is reusable if it can be used multiple times within one frame.
  23311. * @returns If the post process is reusable
  23312. */
  23313. isReusable(): boolean;
  23314. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23315. markTextureDirty(): void;
  23316. /**
  23317. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23318. * 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.
  23319. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23320. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23321. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23322. * @returns The target texture that was bound to be written to.
  23323. */
  23324. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23325. /**
  23326. * If the post process is supported.
  23327. */
  23328. get isSupported(): boolean;
  23329. /**
  23330. * The aspect ratio of the output texture.
  23331. */
  23332. get aspectRatio(): number;
  23333. /**
  23334. * Get a value indicating if the post-process is ready to be used
  23335. * @returns true if the post-process is ready (shader is compiled)
  23336. */
  23337. isReady(): boolean;
  23338. /**
  23339. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23340. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23341. */
  23342. apply(): Nullable<Effect>;
  23343. private _disposeTextures;
  23344. /**
  23345. * Disposes the post process.
  23346. * @param camera The camera to dispose the post process on.
  23347. */
  23348. dispose(camera?: Camera): void;
  23349. }
  23350. }
  23351. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23352. /** @hidden */
  23353. export var kernelBlurVaryingDeclaration: {
  23354. name: string;
  23355. shader: string;
  23356. };
  23357. }
  23358. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23359. /** @hidden */
  23360. export var kernelBlurFragment: {
  23361. name: string;
  23362. shader: string;
  23363. };
  23364. }
  23365. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23366. /** @hidden */
  23367. export var kernelBlurFragment2: {
  23368. name: string;
  23369. shader: string;
  23370. };
  23371. }
  23372. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23373. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23374. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23375. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23376. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23377. /** @hidden */
  23378. export var kernelBlurPixelShader: {
  23379. name: string;
  23380. shader: string;
  23381. };
  23382. }
  23383. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23384. /** @hidden */
  23385. export var kernelBlurVertex: {
  23386. name: string;
  23387. shader: string;
  23388. };
  23389. }
  23390. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23391. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23392. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23393. /** @hidden */
  23394. export var kernelBlurVertexShader: {
  23395. name: string;
  23396. shader: string;
  23397. };
  23398. }
  23399. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23400. import { Vector2 } from "babylonjs/Maths/math.vector";
  23401. import { Nullable } from "babylonjs/types";
  23402. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23403. import { Camera } from "babylonjs/Cameras/camera";
  23404. import { Effect } from "babylonjs/Materials/effect";
  23405. import { Engine } from "babylonjs/Engines/engine";
  23406. import "babylonjs/Shaders/kernelBlur.fragment";
  23407. import "babylonjs/Shaders/kernelBlur.vertex";
  23408. /**
  23409. * The Blur Post Process which blurs an image based on a kernel and direction.
  23410. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23411. */
  23412. export class BlurPostProcess extends PostProcess {
  23413. /** The direction in which to blur the image. */
  23414. direction: Vector2;
  23415. private blockCompilation;
  23416. protected _kernel: number;
  23417. protected _idealKernel: number;
  23418. protected _packedFloat: boolean;
  23419. private _staticDefines;
  23420. /**
  23421. * Sets the length in pixels of the blur sample region
  23422. */
  23423. set kernel(v: number);
  23424. /**
  23425. * Gets the length in pixels of the blur sample region
  23426. */
  23427. get kernel(): number;
  23428. /**
  23429. * Sets wether or not the blur needs to unpack/repack floats
  23430. */
  23431. set packedFloat(v: boolean);
  23432. /**
  23433. * Gets wether or not the blur is unpacking/repacking floats
  23434. */
  23435. get packedFloat(): boolean;
  23436. /**
  23437. * Creates a new instance BlurPostProcess
  23438. * @param name The name of the effect.
  23439. * @param direction The direction in which to blur the image.
  23440. * @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.
  23441. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23442. * @param camera The camera to apply the render pass to.
  23443. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23444. * @param engine The engine which the post process will be applied. (default: current engine)
  23445. * @param reusable If the post process can be reused on the same frame. (default: false)
  23446. * @param textureType Type of textures used when performing the post process. (default: 0)
  23447. * @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)
  23448. */
  23449. constructor(name: string,
  23450. /** The direction in which to blur the image. */
  23451. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  23452. /**
  23453. * Updates the effect with the current post process compile time values and recompiles the shader.
  23454. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23455. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23456. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23457. * @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
  23458. * @param onCompiled Called when the shader has been compiled.
  23459. * @param onError Called if there is an error when compiling a shader.
  23460. */
  23461. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23462. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23463. /**
  23464. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23465. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23466. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23467. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23468. * The gaps between physical kernels are compensated for in the weighting of the samples
  23469. * @param idealKernel Ideal blur kernel.
  23470. * @return Nearest best kernel.
  23471. */
  23472. protected _nearestBestKernel(idealKernel: number): number;
  23473. /**
  23474. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23475. * @param x The point on the Gaussian distribution to sample.
  23476. * @return the value of the Gaussian function at x.
  23477. */
  23478. protected _gaussianWeight(x: number): number;
  23479. /**
  23480. * Generates a string that can be used as a floating point number in GLSL.
  23481. * @param x Value to print.
  23482. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23483. * @return GLSL float string.
  23484. */
  23485. protected _glslFloat(x: number, decimalFigures?: number): string;
  23486. }
  23487. }
  23488. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23489. import { Scene } from "babylonjs/scene";
  23490. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23491. import { Plane } from "babylonjs/Maths/math.plane";
  23492. /**
  23493. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23494. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23495. * You can then easily use it as a reflectionTexture on a flat surface.
  23496. * In case the surface is not a plane, please consider relying on reflection probes.
  23497. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23498. */
  23499. export class MirrorTexture extends RenderTargetTexture {
  23500. private scene;
  23501. /**
  23502. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23503. * 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.
  23504. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23505. */
  23506. mirrorPlane: Plane;
  23507. /**
  23508. * Define the blur ratio used to blur the reflection if needed.
  23509. */
  23510. set blurRatio(value: number);
  23511. get blurRatio(): number;
  23512. /**
  23513. * Define the adaptive blur kernel used to blur the reflection if needed.
  23514. * This will autocompute the closest best match for the `blurKernel`
  23515. */
  23516. set adaptiveBlurKernel(value: number);
  23517. /**
  23518. * Define the blur kernel used to blur the reflection if needed.
  23519. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23520. */
  23521. set blurKernel(value: number);
  23522. /**
  23523. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23524. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23525. */
  23526. set blurKernelX(value: number);
  23527. get blurKernelX(): number;
  23528. /**
  23529. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23530. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23531. */
  23532. set blurKernelY(value: number);
  23533. get blurKernelY(): number;
  23534. private _autoComputeBlurKernel;
  23535. protected _onRatioRescale(): void;
  23536. private _updateGammaSpace;
  23537. private _imageProcessingConfigChangeObserver;
  23538. private _transformMatrix;
  23539. private _mirrorMatrix;
  23540. private _savedViewMatrix;
  23541. private _blurX;
  23542. private _blurY;
  23543. private _adaptiveBlurKernel;
  23544. private _blurKernelX;
  23545. private _blurKernelY;
  23546. private _blurRatio;
  23547. /**
  23548. * Instantiates a Mirror Texture.
  23549. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23550. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23551. * You can then easily use it as a reflectionTexture on a flat surface.
  23552. * In case the surface is not a plane, please consider relying on reflection probes.
  23553. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23554. * @param name
  23555. * @param size
  23556. * @param scene
  23557. * @param generateMipMaps
  23558. * @param type
  23559. * @param samplingMode
  23560. * @param generateDepthBuffer
  23561. */
  23562. constructor(name: string, size: number | {
  23563. width: number;
  23564. height: number;
  23565. } | {
  23566. ratio: number;
  23567. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23568. private _preparePostProcesses;
  23569. /**
  23570. * Clone the mirror texture.
  23571. * @returns the cloned texture
  23572. */
  23573. clone(): MirrorTexture;
  23574. /**
  23575. * Serialize the texture to a JSON representation you could use in Parse later on
  23576. * @returns the serialized JSON representation
  23577. */
  23578. serialize(): any;
  23579. /**
  23580. * Dispose the texture and release its associated resources.
  23581. */
  23582. dispose(): void;
  23583. }
  23584. }
  23585. declare module "babylonjs/Materials/Textures/texture" {
  23586. import { Observable } from "babylonjs/Misc/observable";
  23587. import { Nullable } from "babylonjs/types";
  23588. import { Matrix } from "babylonjs/Maths/math.vector";
  23589. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23590. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23591. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23592. import { Scene } from "babylonjs/scene";
  23593. /**
  23594. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23595. * @see http://doc.babylonjs.com/babylon101/materials#texture
  23596. */
  23597. export class Texture extends BaseTexture {
  23598. /**
  23599. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23600. */
  23601. static SerializeBuffers: boolean;
  23602. /** @hidden */
  23603. static _CubeTextureParser: (jsonTexture: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => import("babylonjs/Materials/Textures/cubeTexture").CubeTexture;
  23604. /** @hidden */
  23605. static _CreateMirror: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/mirrorTexture").MirrorTexture;
  23606. /** @hidden */
  23607. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture;
  23608. /** nearest is mag = nearest and min = nearest and mip = linear */
  23609. static readonly NEAREST_SAMPLINGMODE: number;
  23610. /** nearest is mag = nearest and min = nearest and mip = linear */
  23611. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23612. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23613. static readonly BILINEAR_SAMPLINGMODE: number;
  23614. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23615. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23616. /** Trilinear is mag = linear and min = linear and mip = linear */
  23617. static readonly TRILINEAR_SAMPLINGMODE: number;
  23618. /** Trilinear is mag = linear and min = linear and mip = linear */
  23619. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23620. /** mag = nearest and min = nearest and mip = nearest */
  23621. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23622. /** mag = nearest and min = linear and mip = nearest */
  23623. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23624. /** mag = nearest and min = linear and mip = linear */
  23625. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23626. /** mag = nearest and min = linear and mip = none */
  23627. static readonly NEAREST_LINEAR: number;
  23628. /** mag = nearest and min = nearest and mip = none */
  23629. static readonly NEAREST_NEAREST: number;
  23630. /** mag = linear and min = nearest and mip = nearest */
  23631. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  23632. /** mag = linear and min = nearest and mip = linear */
  23633. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  23634. /** mag = linear and min = linear and mip = none */
  23635. static readonly LINEAR_LINEAR: number;
  23636. /** mag = linear and min = nearest and mip = none */
  23637. static readonly LINEAR_NEAREST: number;
  23638. /** Explicit coordinates mode */
  23639. static readonly EXPLICIT_MODE: number;
  23640. /** Spherical coordinates mode */
  23641. static readonly SPHERICAL_MODE: number;
  23642. /** Planar coordinates mode */
  23643. static readonly PLANAR_MODE: number;
  23644. /** Cubic coordinates mode */
  23645. static readonly CUBIC_MODE: number;
  23646. /** Projection coordinates mode */
  23647. static readonly PROJECTION_MODE: number;
  23648. /** Inverse Cubic coordinates mode */
  23649. static readonly SKYBOX_MODE: number;
  23650. /** Inverse Cubic coordinates mode */
  23651. static readonly INVCUBIC_MODE: number;
  23652. /** Equirectangular coordinates mode */
  23653. static readonly EQUIRECTANGULAR_MODE: number;
  23654. /** Equirectangular Fixed coordinates mode */
  23655. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  23656. /** Equirectangular Fixed Mirrored coordinates mode */
  23657. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  23658. /** Texture is not repeating outside of 0..1 UVs */
  23659. static readonly CLAMP_ADDRESSMODE: number;
  23660. /** Texture is repeating outside of 0..1 UVs */
  23661. static readonly WRAP_ADDRESSMODE: number;
  23662. /** Texture is repeating and mirrored */
  23663. static readonly MIRROR_ADDRESSMODE: number;
  23664. /**
  23665. * 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
  23666. */
  23667. static UseSerializedUrlIfAny: boolean;
  23668. /**
  23669. * Define the url of the texture.
  23670. */
  23671. url: Nullable<string>;
  23672. /**
  23673. * Define an offset on the texture to offset the u coordinates of the UVs
  23674. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  23675. */
  23676. uOffset: number;
  23677. /**
  23678. * Define an offset on the texture to offset the v coordinates of the UVs
  23679. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  23680. */
  23681. vOffset: number;
  23682. /**
  23683. * Define an offset on the texture to scale the u coordinates of the UVs
  23684. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  23685. */
  23686. uScale: number;
  23687. /**
  23688. * Define an offset on the texture to scale the v coordinates of the UVs
  23689. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  23690. */
  23691. vScale: number;
  23692. /**
  23693. * Define an offset on the texture to rotate around the u coordinates of the UVs
  23694. * @see http://doc.babylonjs.com/how_to/more_materials
  23695. */
  23696. uAng: number;
  23697. /**
  23698. * Define an offset on the texture to rotate around the v coordinates of the UVs
  23699. * @see http://doc.babylonjs.com/how_to/more_materials
  23700. */
  23701. vAng: number;
  23702. /**
  23703. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  23704. * @see http://doc.babylonjs.com/how_to/more_materials
  23705. */
  23706. wAng: number;
  23707. /**
  23708. * Defines the center of rotation (U)
  23709. */
  23710. uRotationCenter: number;
  23711. /**
  23712. * Defines the center of rotation (V)
  23713. */
  23714. vRotationCenter: number;
  23715. /**
  23716. * Defines the center of rotation (W)
  23717. */
  23718. wRotationCenter: number;
  23719. /**
  23720. * Are mip maps generated for this texture or not.
  23721. */
  23722. get noMipmap(): boolean;
  23723. /**
  23724. * List of inspectable custom properties (used by the Inspector)
  23725. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23726. */
  23727. inspectableCustomProperties: Nullable<IInspectable[]>;
  23728. private _noMipmap;
  23729. /** @hidden */
  23730. _invertY: boolean;
  23731. private _rowGenerationMatrix;
  23732. private _cachedTextureMatrix;
  23733. private _projectionModeMatrix;
  23734. private _t0;
  23735. private _t1;
  23736. private _t2;
  23737. private _cachedUOffset;
  23738. private _cachedVOffset;
  23739. private _cachedUScale;
  23740. private _cachedVScale;
  23741. private _cachedUAng;
  23742. private _cachedVAng;
  23743. private _cachedWAng;
  23744. private _cachedProjectionMatrixId;
  23745. private _cachedCoordinatesMode;
  23746. /** @hidden */
  23747. protected _initialSamplingMode: number;
  23748. /** @hidden */
  23749. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  23750. private _deleteBuffer;
  23751. protected _format: Nullable<number>;
  23752. private _delayedOnLoad;
  23753. private _delayedOnError;
  23754. private _mimeType?;
  23755. /**
  23756. * Observable triggered once the texture has been loaded.
  23757. */
  23758. onLoadObservable: Observable<Texture>;
  23759. protected _isBlocking: boolean;
  23760. /**
  23761. * Is the texture preventing material to render while loading.
  23762. * If false, a default texture will be used instead of the loading one during the preparation step.
  23763. */
  23764. set isBlocking(value: boolean);
  23765. get isBlocking(): boolean;
  23766. /**
  23767. * Get the current sampling mode associated with the texture.
  23768. */
  23769. get samplingMode(): number;
  23770. /**
  23771. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  23772. */
  23773. get invertY(): boolean;
  23774. /**
  23775. * Instantiates a new texture.
  23776. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23777. * @see http://doc.babylonjs.com/babylon101/materials#texture
  23778. * @param url defines the url of the picture to load as a texture
  23779. * @param sceneOrEngine defines the scene or engine the texture will belong to
  23780. * @param noMipmap defines if the texture will require mip maps or not
  23781. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  23782. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  23783. * @param onLoad defines a callback triggered when the texture has been loaded
  23784. * @param onError defines a callback triggered when an error occurred during the loading session
  23785. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  23786. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  23787. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  23788. * @param mimeType defines an optional mime type information
  23789. */
  23790. 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);
  23791. /**
  23792. * Update the url (and optional buffer) of this texture if url was null during construction.
  23793. * @param url the url of the texture
  23794. * @param buffer the buffer of the texture (defaults to null)
  23795. * @param onLoad callback called when the texture is loaded (defaults to null)
  23796. */
  23797. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  23798. /**
  23799. * Finish the loading sequence of a texture flagged as delayed load.
  23800. * @hidden
  23801. */
  23802. delayLoad(): void;
  23803. private _prepareRowForTextureGeneration;
  23804. /**
  23805. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  23806. * @returns the transform matrix of the texture.
  23807. */
  23808. getTextureMatrix(uBase?: number): Matrix;
  23809. /**
  23810. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  23811. * @returns The reflection texture transform
  23812. */
  23813. getReflectionTextureMatrix(): Matrix;
  23814. /**
  23815. * Clones the texture.
  23816. * @returns the cloned texture
  23817. */
  23818. clone(): Texture;
  23819. /**
  23820. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  23821. * @returns The JSON representation of the texture
  23822. */
  23823. serialize(): any;
  23824. /**
  23825. * Get the current class name of the texture useful for serialization or dynamic coding.
  23826. * @returns "Texture"
  23827. */
  23828. getClassName(): string;
  23829. /**
  23830. * Dispose the texture and release its associated resources.
  23831. */
  23832. dispose(): void;
  23833. /**
  23834. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  23835. * @param parsedTexture Define the JSON representation of the texture
  23836. * @param scene Define the scene the parsed texture should be instantiated in
  23837. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  23838. * @returns The parsed texture if successful
  23839. */
  23840. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  23841. /**
  23842. * Creates a texture from its base 64 representation.
  23843. * @param data Define the base64 payload without the data: prefix
  23844. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  23845. * @param scene Define the scene the texture should belong to
  23846. * @param noMipmap Forces the texture to not create mip map information if true
  23847. * @param invertY define if the texture needs to be inverted on the y axis during loading
  23848. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  23849. * @param onLoad define a callback triggered when the texture has been loaded
  23850. * @param onError define a callback triggered when an error occurred during the loading session
  23851. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  23852. * @returns the created texture
  23853. */
  23854. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  23855. /**
  23856. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  23857. * @param data Define the base64 payload without the data: prefix
  23858. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  23859. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  23860. * @param scene Define the scene the texture should belong to
  23861. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  23862. * @param noMipmap Forces the texture to not create mip map information if true
  23863. * @param invertY define if the texture needs to be inverted on the y axis during loading
  23864. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  23865. * @param onLoad define a callback triggered when the texture has been loaded
  23866. * @param onError define a callback triggered when an error occurred during the loading session
  23867. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  23868. * @returns the created texture
  23869. */
  23870. 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;
  23871. }
  23872. }
  23873. declare module "babylonjs/PostProcesses/postProcessManager" {
  23874. import { Nullable } from "babylonjs/types";
  23875. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23876. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  23877. import { Scene } from "babylonjs/scene";
  23878. /**
  23879. * PostProcessManager is used to manage one or more post processes or post process pipelines
  23880. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23881. */
  23882. export class PostProcessManager {
  23883. private _scene;
  23884. private _indexBuffer;
  23885. private _vertexBuffers;
  23886. /**
  23887. * Creates a new instance PostProcess
  23888. * @param scene The scene that the post process is associated with.
  23889. */
  23890. constructor(scene: Scene);
  23891. private _prepareBuffers;
  23892. private _buildIndexBuffer;
  23893. /**
  23894. * Rebuilds the vertex buffers of the manager.
  23895. * @hidden
  23896. */
  23897. _rebuild(): void;
  23898. /**
  23899. * Prepares a frame to be run through a post process.
  23900. * @param sourceTexture The input texture to the post procesess. (default: null)
  23901. * @param postProcesses An array of post processes to be run. (default: null)
  23902. * @returns True if the post processes were able to be run.
  23903. * @hidden
  23904. */
  23905. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  23906. /**
  23907. * Manually render a set of post processes to a texture.
  23908. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  23909. * @param postProcesses An array of post processes to be run.
  23910. * @param targetTexture The target texture to render to.
  23911. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  23912. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  23913. * @param lodLevel defines which lod of the texture to render to
  23914. */
  23915. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  23916. /**
  23917. * Finalize the result of the output of the postprocesses.
  23918. * @param doNotPresent If true the result will not be displayed to the screen.
  23919. * @param targetTexture The target texture to render to.
  23920. * @param faceIndex The index of the face to bind the target texture to.
  23921. * @param postProcesses The array of post processes to render.
  23922. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  23923. * @hidden
  23924. */
  23925. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  23926. /**
  23927. * Disposes of the post process manager.
  23928. */
  23929. dispose(): void;
  23930. }
  23931. }
  23932. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  23933. import { Observable } from "babylonjs/Misc/observable";
  23934. import { SmartArray } from "babylonjs/Misc/smartArray";
  23935. import { Nullable, Immutable } from "babylonjs/types";
  23936. import { Camera } from "babylonjs/Cameras/camera";
  23937. import { Scene } from "babylonjs/scene";
  23938. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  23939. import { Color4 } from "babylonjs/Maths/math.color";
  23940. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  23941. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23942. import { SubMesh } from "babylonjs/Meshes/subMesh";
  23943. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23944. import { Texture } from "babylonjs/Materials/Textures/texture";
  23945. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  23946. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  23947. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23948. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  23949. import { Engine } from "babylonjs/Engines/engine";
  23950. /**
  23951. * This Helps creating a texture that will be created from a camera in your scene.
  23952. * It is basically a dynamic texture that could be used to create special effects for instance.
  23953. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  23954. */
  23955. export class RenderTargetTexture extends Texture {
  23956. isCube: boolean;
  23957. /**
  23958. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  23959. */
  23960. static readonly REFRESHRATE_RENDER_ONCE: number;
  23961. /**
  23962. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  23963. */
  23964. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  23965. /**
  23966. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  23967. * the central point of your effect and can save a lot of performances.
  23968. */
  23969. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  23970. /**
  23971. * Use this predicate to dynamically define the list of mesh you want to render.
  23972. * If set, the renderList property will be overwritten.
  23973. */
  23974. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  23975. private _renderList;
  23976. /**
  23977. * Use this list to define the list of mesh you want to render.
  23978. */
  23979. get renderList(): Nullable<Array<AbstractMesh>>;
  23980. set renderList(value: Nullable<Array<AbstractMesh>>);
  23981. /**
  23982. * Use this function to overload the renderList array at rendering time.
  23983. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  23984. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  23985. * the cube (if the RTT is a cube, else layerOrFace=0).
  23986. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  23987. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  23988. * hold dummy elements!
  23989. */
  23990. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  23991. private _hookArray;
  23992. /**
  23993. * Define if particles should be rendered in your texture.
  23994. */
  23995. renderParticles: boolean;
  23996. /**
  23997. * Define if sprites should be rendered in your texture.
  23998. */
  23999. renderSprites: boolean;
  24000. /**
  24001. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  24002. */
  24003. coordinatesMode: number;
  24004. /**
  24005. * Define the camera used to render the texture.
  24006. */
  24007. activeCamera: Nullable<Camera>;
  24008. /**
  24009. * Override the mesh isReady function with your own one.
  24010. */
  24011. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24012. /**
  24013. * Override the render function of the texture with your own one.
  24014. */
  24015. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24016. /**
  24017. * Define if camera post processes should be use while rendering the texture.
  24018. */
  24019. useCameraPostProcesses: boolean;
  24020. /**
  24021. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24022. */
  24023. ignoreCameraViewport: boolean;
  24024. private _postProcessManager;
  24025. private _postProcesses;
  24026. private _resizeObserver;
  24027. /**
  24028. * An event triggered when the texture is unbind.
  24029. */
  24030. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24031. /**
  24032. * An event triggered when the texture is unbind.
  24033. */
  24034. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24035. private _onAfterUnbindObserver;
  24036. /**
  24037. * Set a after unbind callback in the texture.
  24038. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24039. */
  24040. set onAfterUnbind(callback: () => void);
  24041. /**
  24042. * An event triggered before rendering the texture
  24043. */
  24044. onBeforeRenderObservable: Observable<number>;
  24045. private _onBeforeRenderObserver;
  24046. /**
  24047. * Set a before render callback in the texture.
  24048. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24049. */
  24050. set onBeforeRender(callback: (faceIndex: number) => void);
  24051. /**
  24052. * An event triggered after rendering the texture
  24053. */
  24054. onAfterRenderObservable: Observable<number>;
  24055. private _onAfterRenderObserver;
  24056. /**
  24057. * Set a after render callback in the texture.
  24058. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24059. */
  24060. set onAfterRender(callback: (faceIndex: number) => void);
  24061. /**
  24062. * An event triggered after the texture clear
  24063. */
  24064. onClearObservable: Observable<Engine>;
  24065. private _onClearObserver;
  24066. /**
  24067. * Set a clear callback in the texture.
  24068. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24069. */
  24070. set onClear(callback: (Engine: Engine) => void);
  24071. /**
  24072. * An event triggered when the texture is resized.
  24073. */
  24074. onResizeObservable: Observable<RenderTargetTexture>;
  24075. /**
  24076. * Define the clear color of the Render Target if it should be different from the scene.
  24077. */
  24078. clearColor: Color4;
  24079. protected _size: number | {
  24080. width: number;
  24081. height: number;
  24082. layers?: number;
  24083. };
  24084. protected _initialSizeParameter: number | {
  24085. width: number;
  24086. height: number;
  24087. } | {
  24088. ratio: number;
  24089. };
  24090. protected _sizeRatio: Nullable<number>;
  24091. /** @hidden */
  24092. _generateMipMaps: boolean;
  24093. protected _renderingManager: RenderingManager;
  24094. /** @hidden */
  24095. _waitingRenderList: string[];
  24096. protected _doNotChangeAspectRatio: boolean;
  24097. protected _currentRefreshId: number;
  24098. protected _refreshRate: number;
  24099. protected _textureMatrix: Matrix;
  24100. protected _samples: number;
  24101. protected _renderTargetOptions: RenderTargetCreationOptions;
  24102. /**
  24103. * Gets render target creation options that were used.
  24104. */
  24105. get renderTargetOptions(): RenderTargetCreationOptions;
  24106. protected _onRatioRescale(): void;
  24107. /**
  24108. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24109. * It must define where the camera used to render the texture is set
  24110. */
  24111. boundingBoxPosition: Vector3;
  24112. private _boundingBoxSize;
  24113. /**
  24114. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24115. * When defined, the cubemap will switch to local mode
  24116. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24117. * @example https://www.babylonjs-playground.com/#RNASML
  24118. */
  24119. set boundingBoxSize(value: Vector3);
  24120. get boundingBoxSize(): Vector3;
  24121. /**
  24122. * In case the RTT has been created with a depth texture, get the associated
  24123. * depth texture.
  24124. * Otherwise, return null.
  24125. */
  24126. get depthStencilTexture(): Nullable<InternalTexture>;
  24127. /**
  24128. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24129. * or used a shadow, depth texture...
  24130. * @param name The friendly name of the texture
  24131. * @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)
  24132. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24133. * @param generateMipMaps True if mip maps need to be generated after render.
  24134. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24135. * @param type The type of the buffer in the RTT (int, half float, float...)
  24136. * @param isCube True if a cube texture needs to be created
  24137. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24138. * @param generateDepthBuffer True to generate a depth buffer
  24139. * @param generateStencilBuffer True to generate a stencil buffer
  24140. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24141. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24142. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24143. */
  24144. constructor(name: string, size: number | {
  24145. width: number;
  24146. height: number;
  24147. layers?: number;
  24148. } | {
  24149. ratio: number;
  24150. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24151. /**
  24152. * Creates a depth stencil texture.
  24153. * This is only available in WebGL 2 or with the depth texture extension available.
  24154. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24155. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24156. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24157. */
  24158. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24159. private _processSizeParameter;
  24160. /**
  24161. * Define the number of samples to use in case of MSAA.
  24162. * It defaults to one meaning no MSAA has been enabled.
  24163. */
  24164. get samples(): number;
  24165. set samples(value: number);
  24166. /**
  24167. * Resets the refresh counter of the texture and start bak from scratch.
  24168. * Could be useful to regenerate the texture if it is setup to render only once.
  24169. */
  24170. resetRefreshCounter(): void;
  24171. /**
  24172. * Define the refresh rate of the texture or the rendering frequency.
  24173. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24174. */
  24175. get refreshRate(): number;
  24176. set refreshRate(value: number);
  24177. /**
  24178. * Adds a post process to the render target rendering passes.
  24179. * @param postProcess define the post process to add
  24180. */
  24181. addPostProcess(postProcess: PostProcess): void;
  24182. /**
  24183. * Clear all the post processes attached to the render target
  24184. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24185. */
  24186. clearPostProcesses(dispose?: boolean): void;
  24187. /**
  24188. * Remove one of the post process from the list of attached post processes to the texture
  24189. * @param postProcess define the post process to remove from the list
  24190. */
  24191. removePostProcess(postProcess: PostProcess): void;
  24192. /** @hidden */
  24193. _shouldRender(): boolean;
  24194. /**
  24195. * Gets the actual render size of the texture.
  24196. * @returns the width of the render size
  24197. */
  24198. getRenderSize(): number;
  24199. /**
  24200. * Gets the actual render width of the texture.
  24201. * @returns the width of the render size
  24202. */
  24203. getRenderWidth(): number;
  24204. /**
  24205. * Gets the actual render height of the texture.
  24206. * @returns the height of the render size
  24207. */
  24208. getRenderHeight(): number;
  24209. /**
  24210. * Gets the actual number of layers of the texture.
  24211. * @returns the number of layers
  24212. */
  24213. getRenderLayers(): number;
  24214. /**
  24215. * Get if the texture can be rescaled or not.
  24216. */
  24217. get canRescale(): boolean;
  24218. /**
  24219. * Resize the texture using a ratio.
  24220. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24221. */
  24222. scale(ratio: number): void;
  24223. /**
  24224. * Get the texture reflection matrix used to rotate/transform the reflection.
  24225. * @returns the reflection matrix
  24226. */
  24227. getReflectionTextureMatrix(): Matrix;
  24228. /**
  24229. * Resize the texture to a new desired size.
  24230. * Be carrefull as it will recreate all the data in the new texture.
  24231. * @param size Define the new size. It can be:
  24232. * - a number for squared texture,
  24233. * - an object containing { width: number, height: number }
  24234. * - or an object containing a ratio { ratio: number }
  24235. */
  24236. resize(size: number | {
  24237. width: number;
  24238. height: number;
  24239. } | {
  24240. ratio: number;
  24241. }): void;
  24242. private _defaultRenderListPrepared;
  24243. /**
  24244. * Renders all the objects from the render list into the texture.
  24245. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24246. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24247. */
  24248. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24249. private _bestReflectionRenderTargetDimension;
  24250. private _prepareRenderingManager;
  24251. /**
  24252. * @hidden
  24253. * @param faceIndex face index to bind to if this is a cubetexture
  24254. * @param layer defines the index of the texture to bind in the array
  24255. */
  24256. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24257. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24258. private renderToTarget;
  24259. /**
  24260. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24261. * This allowed control for front to back rendering or reversly depending of the special needs.
  24262. *
  24263. * @param renderingGroupId The rendering group id corresponding to its index
  24264. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24265. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24266. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24267. */
  24268. 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;
  24269. /**
  24270. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24271. *
  24272. * @param renderingGroupId The rendering group id corresponding to its index
  24273. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24274. */
  24275. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24276. /**
  24277. * Clones the texture.
  24278. * @returns the cloned texture
  24279. */
  24280. clone(): RenderTargetTexture;
  24281. /**
  24282. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24283. * @returns The JSON representation of the texture
  24284. */
  24285. serialize(): any;
  24286. /**
  24287. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24288. */
  24289. disposeFramebufferObjects(): void;
  24290. /**
  24291. * Dispose the texture and release its associated resources.
  24292. */
  24293. dispose(): void;
  24294. /** @hidden */
  24295. _rebuild(): void;
  24296. /**
  24297. * Clear the info related to rendering groups preventing retention point in material dispose.
  24298. */
  24299. freeRenderingGroups(): void;
  24300. /**
  24301. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24302. * @returns the view count
  24303. */
  24304. getViewCount(): number;
  24305. }
  24306. }
  24307. declare module "babylonjs/Misc/guid" {
  24308. /**
  24309. * Class used to manipulate GUIDs
  24310. */
  24311. export class GUID {
  24312. /**
  24313. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24314. * Be aware Math.random() could cause collisions, but:
  24315. * "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"
  24316. * @returns a pseudo random id
  24317. */
  24318. static RandomId(): string;
  24319. }
  24320. }
  24321. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24322. import { Nullable } from "babylonjs/types";
  24323. import { Scene } from "babylonjs/scene";
  24324. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24325. import { Material } from "babylonjs/Materials/material";
  24326. import { Effect } from "babylonjs/Materials/effect";
  24327. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24328. /**
  24329. * Options to be used when creating a shadow depth material
  24330. */
  24331. export interface IIOptionShadowDepthMaterial {
  24332. /** Variables in the vertex shader code that need to have their names remapped.
  24333. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24334. * "var_name" should be either: worldPos or vNormalW
  24335. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24336. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24337. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24338. */
  24339. remappedVariables?: string[];
  24340. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24341. standalone?: boolean;
  24342. }
  24343. /**
  24344. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24345. */
  24346. export class ShadowDepthWrapper {
  24347. private _scene;
  24348. private _options?;
  24349. private _baseMaterial;
  24350. private _onEffectCreatedObserver;
  24351. private _subMeshToEffect;
  24352. private _subMeshToDepthEffect;
  24353. private _meshes;
  24354. /** @hidden */
  24355. _matriceNames: any;
  24356. /** Gets the standalone status of the wrapper */
  24357. get standalone(): boolean;
  24358. /** Gets the base material the wrapper is built upon */
  24359. get baseMaterial(): Material;
  24360. /**
  24361. * Instantiate a new shadow depth wrapper.
  24362. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24363. * generate the shadow depth map. For more information, please refer to the documentation:
  24364. * https://doc.babylonjs.com/babylon101/shadows
  24365. * @param baseMaterial Material to wrap
  24366. * @param scene Define the scene the material belongs to
  24367. * @param options Options used to create the wrapper
  24368. */
  24369. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24370. /**
  24371. * Gets the effect to use to generate the depth map
  24372. * @param subMesh subMesh to get the effect for
  24373. * @param shadowGenerator shadow generator to get the effect for
  24374. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24375. */
  24376. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24377. /**
  24378. * Specifies that the submesh is ready to be used for depth rendering
  24379. * @param subMesh submesh to check
  24380. * @param defines the list of defines to take into account when checking the effect
  24381. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24382. * @param useInstances specifies that instances should be used
  24383. * @returns a boolean indicating that the submesh is ready or not
  24384. */
  24385. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24386. /**
  24387. * Disposes the resources
  24388. */
  24389. dispose(): void;
  24390. private _makeEffect;
  24391. }
  24392. }
  24393. declare module "babylonjs/Materials/material" {
  24394. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  24395. import { SmartArray } from "babylonjs/Misc/smartArray";
  24396. import { Observable } from "babylonjs/Misc/observable";
  24397. import { Nullable } from "babylonjs/types";
  24398. import { Scene } from "babylonjs/scene";
  24399. import { Matrix } from "babylonjs/Maths/math.vector";
  24400. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24401. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24402. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  24403. import { Effect } from "babylonjs/Materials/effect";
  24404. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24405. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24406. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  24407. import { IInspectable } from "babylonjs/Misc/iInspectable";
  24408. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  24409. import { Mesh } from "babylonjs/Meshes/mesh";
  24410. import { Animation } from "babylonjs/Animations/animation";
  24411. /**
  24412. * Options for compiling materials.
  24413. */
  24414. export interface IMaterialCompilationOptions {
  24415. /**
  24416. * Defines whether clip planes are enabled.
  24417. */
  24418. clipPlane: boolean;
  24419. /**
  24420. * Defines whether instances are enabled.
  24421. */
  24422. useInstances: boolean;
  24423. }
  24424. /**
  24425. * Options passed when calling customShaderNameResolve
  24426. */
  24427. export interface ICustomShaderNameResolveOptions {
  24428. /**
  24429. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  24430. */
  24431. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  24432. }
  24433. /**
  24434. * Base class for the main features of a material in Babylon.js
  24435. */
  24436. export class Material implements IAnimatable {
  24437. /**
  24438. * Returns the triangle fill mode
  24439. */
  24440. static readonly TriangleFillMode: number;
  24441. /**
  24442. * Returns the wireframe mode
  24443. */
  24444. static readonly WireFrameFillMode: number;
  24445. /**
  24446. * Returns the point fill mode
  24447. */
  24448. static readonly PointFillMode: number;
  24449. /**
  24450. * Returns the point list draw mode
  24451. */
  24452. static readonly PointListDrawMode: number;
  24453. /**
  24454. * Returns the line list draw mode
  24455. */
  24456. static readonly LineListDrawMode: number;
  24457. /**
  24458. * Returns the line loop draw mode
  24459. */
  24460. static readonly LineLoopDrawMode: number;
  24461. /**
  24462. * Returns the line strip draw mode
  24463. */
  24464. static readonly LineStripDrawMode: number;
  24465. /**
  24466. * Returns the triangle strip draw mode
  24467. */
  24468. static readonly TriangleStripDrawMode: number;
  24469. /**
  24470. * Returns the triangle fan draw mode
  24471. */
  24472. static readonly TriangleFanDrawMode: number;
  24473. /**
  24474. * Stores the clock-wise side orientation
  24475. */
  24476. static readonly ClockWiseSideOrientation: number;
  24477. /**
  24478. * Stores the counter clock-wise side orientation
  24479. */
  24480. static readonly CounterClockWiseSideOrientation: number;
  24481. /**
  24482. * The dirty texture flag value
  24483. */
  24484. static readonly TextureDirtyFlag: number;
  24485. /**
  24486. * The dirty light flag value
  24487. */
  24488. static readonly LightDirtyFlag: number;
  24489. /**
  24490. * The dirty fresnel flag value
  24491. */
  24492. static readonly FresnelDirtyFlag: number;
  24493. /**
  24494. * The dirty attribute flag value
  24495. */
  24496. static readonly AttributesDirtyFlag: number;
  24497. /**
  24498. * The dirty misc flag value
  24499. */
  24500. static readonly MiscDirtyFlag: number;
  24501. /**
  24502. * The all dirty flag value
  24503. */
  24504. static readonly AllDirtyFlag: number;
  24505. /**
  24506. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  24507. */
  24508. static readonly MATERIAL_OPAQUE: number;
  24509. /**
  24510. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  24511. */
  24512. static readonly MATERIAL_ALPHATEST: number;
  24513. /**
  24514. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  24515. */
  24516. static readonly MATERIAL_ALPHABLEND: number;
  24517. /**
  24518. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  24519. * They are also discarded below the alpha cutoff threshold to improve performances.
  24520. */
  24521. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  24522. /**
  24523. * The Whiteout method is used to blend normals.
  24524. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  24525. */
  24526. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  24527. /**
  24528. * The Reoriented Normal Mapping method is used to blend normals.
  24529. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  24530. */
  24531. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  24532. /**
  24533. * Custom callback helping to override the default shader used in the material.
  24534. */
  24535. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  24536. /**
  24537. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  24538. */
  24539. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  24540. /**
  24541. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  24542. * This means that the material can keep using a previous shader while a new one is being compiled.
  24543. * This is mostly used when shader parallel compilation is supported (true by default)
  24544. */
  24545. allowShaderHotSwapping: boolean;
  24546. /**
  24547. * The ID of the material
  24548. */
  24549. id: string;
  24550. /**
  24551. * Gets or sets the unique id of the material
  24552. */
  24553. uniqueId: number;
  24554. /**
  24555. * The name of the material
  24556. */
  24557. name: string;
  24558. /**
  24559. * Gets or sets user defined metadata
  24560. */
  24561. metadata: any;
  24562. /**
  24563. * For internal use only. Please do not use.
  24564. */
  24565. reservedDataStore: any;
  24566. /**
  24567. * Specifies if the ready state should be checked on each call
  24568. */
  24569. checkReadyOnEveryCall: boolean;
  24570. /**
  24571. * Specifies if the ready state should be checked once
  24572. */
  24573. checkReadyOnlyOnce: boolean;
  24574. /**
  24575. * The state of the material
  24576. */
  24577. state: string;
  24578. /**
  24579. * The alpha value of the material
  24580. */
  24581. protected _alpha: number;
  24582. /**
  24583. * List of inspectable custom properties (used by the Inspector)
  24584. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24585. */
  24586. inspectableCustomProperties: IInspectable[];
  24587. /**
  24588. * Sets the alpha value of the material
  24589. */
  24590. set alpha(value: number);
  24591. /**
  24592. * Gets the alpha value of the material
  24593. */
  24594. get alpha(): number;
  24595. /**
  24596. * Specifies if back face culling is enabled
  24597. */
  24598. protected _backFaceCulling: boolean;
  24599. /**
  24600. * Sets the back-face culling state
  24601. */
  24602. set backFaceCulling(value: boolean);
  24603. /**
  24604. * Gets the back-face culling state
  24605. */
  24606. get backFaceCulling(): boolean;
  24607. /**
  24608. * Stores the value for side orientation
  24609. */
  24610. sideOrientation: number;
  24611. /**
  24612. * Callback triggered when the material is compiled
  24613. */
  24614. onCompiled: Nullable<(effect: Effect) => void>;
  24615. /**
  24616. * Callback triggered when an error occurs
  24617. */
  24618. onError: Nullable<(effect: Effect, errors: string) => void>;
  24619. /**
  24620. * Callback triggered to get the render target textures
  24621. */
  24622. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  24623. /**
  24624. * Gets a boolean indicating that current material needs to register RTT
  24625. */
  24626. get hasRenderTargetTextures(): boolean;
  24627. /**
  24628. * Specifies if the material should be serialized
  24629. */
  24630. doNotSerialize: boolean;
  24631. /**
  24632. * @hidden
  24633. */
  24634. _storeEffectOnSubMeshes: boolean;
  24635. /**
  24636. * Stores the animations for the material
  24637. */
  24638. animations: Nullable<Array<Animation>>;
  24639. /**
  24640. * An event triggered when the material is disposed
  24641. */
  24642. onDisposeObservable: Observable<Material>;
  24643. /**
  24644. * An observer which watches for dispose events
  24645. */
  24646. private _onDisposeObserver;
  24647. private _onUnBindObservable;
  24648. /**
  24649. * Called during a dispose event
  24650. */
  24651. set onDispose(callback: () => void);
  24652. private _onBindObservable;
  24653. /**
  24654. * An event triggered when the material is bound
  24655. */
  24656. get onBindObservable(): Observable<AbstractMesh>;
  24657. /**
  24658. * An observer which watches for bind events
  24659. */
  24660. private _onBindObserver;
  24661. /**
  24662. * Called during a bind event
  24663. */
  24664. set onBind(callback: (Mesh: AbstractMesh) => void);
  24665. /**
  24666. * An event triggered when the material is unbound
  24667. */
  24668. get onUnBindObservable(): Observable<Material>;
  24669. protected _onEffectCreatedObservable: Nullable<Observable<{
  24670. effect: Effect;
  24671. subMesh: Nullable<SubMesh>;
  24672. }>>;
  24673. /**
  24674. * An event triggered when the effect is (re)created
  24675. */
  24676. get onEffectCreatedObservable(): Observable<{
  24677. effect: Effect;
  24678. subMesh: Nullable<SubMesh>;
  24679. }>;
  24680. /**
  24681. * Stores the value of the alpha mode
  24682. */
  24683. private _alphaMode;
  24684. /**
  24685. * Sets the value of the alpha mode.
  24686. *
  24687. * | Value | Type | Description |
  24688. * | --- | --- | --- |
  24689. * | 0 | ALPHA_DISABLE | |
  24690. * | 1 | ALPHA_ADD | |
  24691. * | 2 | ALPHA_COMBINE | |
  24692. * | 3 | ALPHA_SUBTRACT | |
  24693. * | 4 | ALPHA_MULTIPLY | |
  24694. * | 5 | ALPHA_MAXIMIZED | |
  24695. * | 6 | ALPHA_ONEONE | |
  24696. * | 7 | ALPHA_PREMULTIPLIED | |
  24697. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  24698. * | 9 | ALPHA_INTERPOLATE | |
  24699. * | 10 | ALPHA_SCREENMODE | |
  24700. *
  24701. */
  24702. set alphaMode(value: number);
  24703. /**
  24704. * Gets the value of the alpha mode
  24705. */
  24706. get alphaMode(): number;
  24707. /**
  24708. * Stores the state of the need depth pre-pass value
  24709. */
  24710. private _needDepthPrePass;
  24711. /**
  24712. * Sets the need depth pre-pass value
  24713. */
  24714. set needDepthPrePass(value: boolean);
  24715. /**
  24716. * Gets the depth pre-pass value
  24717. */
  24718. get needDepthPrePass(): boolean;
  24719. /**
  24720. * Specifies if depth writing should be disabled
  24721. */
  24722. disableDepthWrite: boolean;
  24723. /**
  24724. * Specifies if color writing should be disabled
  24725. */
  24726. disableColorWrite: boolean;
  24727. /**
  24728. * Specifies if depth writing should be forced
  24729. */
  24730. forceDepthWrite: boolean;
  24731. /**
  24732. * Specifies the depth function that should be used. 0 means the default engine function
  24733. */
  24734. depthFunction: number;
  24735. /**
  24736. * Specifies if there should be a separate pass for culling
  24737. */
  24738. separateCullingPass: boolean;
  24739. /**
  24740. * Stores the state specifing if fog should be enabled
  24741. */
  24742. private _fogEnabled;
  24743. /**
  24744. * Sets the state for enabling fog
  24745. */
  24746. set fogEnabled(value: boolean);
  24747. /**
  24748. * Gets the value of the fog enabled state
  24749. */
  24750. get fogEnabled(): boolean;
  24751. /**
  24752. * Stores the size of points
  24753. */
  24754. pointSize: number;
  24755. /**
  24756. * Stores the z offset value
  24757. */
  24758. zOffset: number;
  24759. get wireframe(): boolean;
  24760. /**
  24761. * Sets the state of wireframe mode
  24762. */
  24763. set wireframe(value: boolean);
  24764. /**
  24765. * Gets the value specifying if point clouds are enabled
  24766. */
  24767. get pointsCloud(): boolean;
  24768. /**
  24769. * Sets the state of point cloud mode
  24770. */
  24771. set pointsCloud(value: boolean);
  24772. /**
  24773. * Gets the material fill mode
  24774. */
  24775. get fillMode(): number;
  24776. /**
  24777. * Sets the material fill mode
  24778. */
  24779. set fillMode(value: number);
  24780. /**
  24781. * @hidden
  24782. * Stores the effects for the material
  24783. */
  24784. _effect: Nullable<Effect>;
  24785. /**
  24786. * Specifies if uniform buffers should be used
  24787. */
  24788. private _useUBO;
  24789. /**
  24790. * Stores a reference to the scene
  24791. */
  24792. private _scene;
  24793. /**
  24794. * Stores the fill mode state
  24795. */
  24796. private _fillMode;
  24797. /**
  24798. * Specifies if the depth write state should be cached
  24799. */
  24800. private _cachedDepthWriteState;
  24801. /**
  24802. * Specifies if the color write state should be cached
  24803. */
  24804. private _cachedColorWriteState;
  24805. /**
  24806. * Specifies if the depth function state should be cached
  24807. */
  24808. private _cachedDepthFunctionState;
  24809. /**
  24810. * Stores the uniform buffer
  24811. */
  24812. protected _uniformBuffer: UniformBuffer;
  24813. /** @hidden */
  24814. _indexInSceneMaterialArray: number;
  24815. /** @hidden */
  24816. meshMap: Nullable<{
  24817. [id: string]: AbstractMesh | undefined;
  24818. }>;
  24819. /**
  24820. * Creates a material instance
  24821. * @param name defines the name of the material
  24822. * @param scene defines the scene to reference
  24823. * @param doNotAdd specifies if the material should be added to the scene
  24824. */
  24825. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  24826. /**
  24827. * Returns a string representation of the current material
  24828. * @param fullDetails defines a boolean indicating which levels of logging is desired
  24829. * @returns a string with material information
  24830. */
  24831. toString(fullDetails?: boolean): string;
  24832. /**
  24833. * Gets the class name of the material
  24834. * @returns a string with the class name of the material
  24835. */
  24836. getClassName(): string;
  24837. /**
  24838. * Specifies if updates for the material been locked
  24839. */
  24840. get isFrozen(): boolean;
  24841. /**
  24842. * Locks updates for the material
  24843. */
  24844. freeze(): void;
  24845. /**
  24846. * Unlocks updates for the material
  24847. */
  24848. unfreeze(): void;
  24849. /**
  24850. * Specifies if the material is ready to be used
  24851. * @param mesh defines the mesh to check
  24852. * @param useInstances specifies if instances should be used
  24853. * @returns a boolean indicating if the material is ready to be used
  24854. */
  24855. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  24856. /**
  24857. * Specifies that the submesh is ready to be used
  24858. * @param mesh defines the mesh to check
  24859. * @param subMesh defines which submesh to check
  24860. * @param useInstances specifies that instances should be used
  24861. * @returns a boolean indicating that the submesh is ready or not
  24862. */
  24863. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  24864. /**
  24865. * Returns the material effect
  24866. * @returns the effect associated with the material
  24867. */
  24868. getEffect(): Nullable<Effect>;
  24869. /**
  24870. * Returns the current scene
  24871. * @returns a Scene
  24872. */
  24873. getScene(): Scene;
  24874. /**
  24875. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  24876. */
  24877. protected _forceAlphaTest: boolean;
  24878. /**
  24879. * The transparency mode of the material.
  24880. */
  24881. protected _transparencyMode: Nullable<number>;
  24882. /**
  24883. * Gets the current transparency mode.
  24884. */
  24885. get transparencyMode(): Nullable<number>;
  24886. /**
  24887. * Sets the transparency mode of the material.
  24888. *
  24889. * | Value | Type | Description |
  24890. * | ----- | ----------------------------------- | ----------- |
  24891. * | 0 | OPAQUE | |
  24892. * | 1 | ALPHATEST | |
  24893. * | 2 | ALPHABLEND | |
  24894. * | 3 | ALPHATESTANDBLEND | |
  24895. *
  24896. */
  24897. set transparencyMode(value: Nullable<number>);
  24898. /**
  24899. * Returns true if alpha blending should be disabled.
  24900. */
  24901. protected get _disableAlphaBlending(): boolean;
  24902. /**
  24903. * Specifies whether or not this material should be rendered in alpha blend mode.
  24904. * @returns a boolean specifying if alpha blending is needed
  24905. */
  24906. needAlphaBlending(): boolean;
  24907. /**
  24908. * Specifies if the mesh will require alpha blending
  24909. * @param mesh defines the mesh to check
  24910. * @returns a boolean specifying if alpha blending is needed for the mesh
  24911. */
  24912. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  24913. /**
  24914. * Specifies whether or not this material should be rendered in alpha test mode.
  24915. * @returns a boolean specifying if an alpha test is needed.
  24916. */
  24917. needAlphaTesting(): boolean;
  24918. /**
  24919. * Specifies if material alpha testing should be turned on for the mesh
  24920. * @param mesh defines the mesh to check
  24921. */
  24922. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  24923. /**
  24924. * Gets the texture used for the alpha test
  24925. * @returns the texture to use for alpha testing
  24926. */
  24927. getAlphaTestTexture(): Nullable<BaseTexture>;
  24928. /**
  24929. * Marks the material to indicate that it needs to be re-calculated
  24930. */
  24931. markDirty(): void;
  24932. /** @hidden */
  24933. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  24934. /**
  24935. * Binds the material to the mesh
  24936. * @param world defines the world transformation matrix
  24937. * @param mesh defines the mesh to bind the material to
  24938. */
  24939. bind(world: Matrix, mesh?: Mesh): void;
  24940. /**
  24941. * Binds the submesh to the material
  24942. * @param world defines the world transformation matrix
  24943. * @param mesh defines the mesh containing the submesh
  24944. * @param subMesh defines the submesh to bind the material to
  24945. */
  24946. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  24947. /**
  24948. * Binds the world matrix to the material
  24949. * @param world defines the world transformation matrix
  24950. */
  24951. bindOnlyWorldMatrix(world: Matrix): void;
  24952. /**
  24953. * Binds the scene's uniform buffer to the effect.
  24954. * @param effect defines the effect to bind to the scene uniform buffer
  24955. * @param sceneUbo defines the uniform buffer storing scene data
  24956. */
  24957. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  24958. /**
  24959. * Binds the view matrix to the effect
  24960. * @param effect defines the effect to bind the view matrix to
  24961. */
  24962. bindView(effect: Effect): void;
  24963. /**
  24964. * Binds the view projection matrix to the effect
  24965. * @param effect defines the effect to bind the view projection matrix to
  24966. */
  24967. bindViewProjection(effect: Effect): void;
  24968. /**
  24969. * Processes to execute after binding the material to a mesh
  24970. * @param mesh defines the rendered mesh
  24971. */
  24972. protected _afterBind(mesh?: Mesh): void;
  24973. /**
  24974. * Unbinds the material from the mesh
  24975. */
  24976. unbind(): void;
  24977. /**
  24978. * Gets the active textures from the material
  24979. * @returns an array of textures
  24980. */
  24981. getActiveTextures(): BaseTexture[];
  24982. /**
  24983. * Specifies if the material uses a texture
  24984. * @param texture defines the texture to check against the material
  24985. * @returns a boolean specifying if the material uses the texture
  24986. */
  24987. hasTexture(texture: BaseTexture): boolean;
  24988. /**
  24989. * Makes a duplicate of the material, and gives it a new name
  24990. * @param name defines the new name for the duplicated material
  24991. * @returns the cloned material
  24992. */
  24993. clone(name: string): Nullable<Material>;
  24994. /**
  24995. * Gets the meshes bound to the material
  24996. * @returns an array of meshes bound to the material
  24997. */
  24998. getBindedMeshes(): AbstractMesh[];
  24999. /**
  25000. * Force shader compilation
  25001. * @param mesh defines the mesh associated with this material
  25002. * @param onCompiled defines a function to execute once the material is compiled
  25003. * @param options defines the options to configure the compilation
  25004. * @param onError defines a function to execute if the material fails compiling
  25005. */
  25006. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  25007. /**
  25008. * Force shader compilation
  25009. * @param mesh defines the mesh that will use this material
  25010. * @param options defines additional options for compiling the shaders
  25011. * @returns a promise that resolves when the compilation completes
  25012. */
  25013. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  25014. private static readonly _AllDirtyCallBack;
  25015. private static readonly _ImageProcessingDirtyCallBack;
  25016. private static readonly _TextureDirtyCallBack;
  25017. private static readonly _FresnelDirtyCallBack;
  25018. private static readonly _MiscDirtyCallBack;
  25019. private static readonly _LightsDirtyCallBack;
  25020. private static readonly _AttributeDirtyCallBack;
  25021. private static _FresnelAndMiscDirtyCallBack;
  25022. private static _TextureAndMiscDirtyCallBack;
  25023. private static readonly _DirtyCallbackArray;
  25024. private static readonly _RunDirtyCallBacks;
  25025. /**
  25026. * Marks a define in the material to indicate that it needs to be re-computed
  25027. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  25028. */
  25029. markAsDirty(flag: number): void;
  25030. /**
  25031. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  25032. * @param func defines a function which checks material defines against the submeshes
  25033. */
  25034. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  25035. /**
  25036. * Indicates that we need to re-calculated for all submeshes
  25037. */
  25038. protected _markAllSubMeshesAsAllDirty(): void;
  25039. /**
  25040. * Indicates that image processing needs to be re-calculated for all submeshes
  25041. */
  25042. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  25043. /**
  25044. * Indicates that textures need to be re-calculated for all submeshes
  25045. */
  25046. protected _markAllSubMeshesAsTexturesDirty(): void;
  25047. /**
  25048. * Indicates that fresnel needs to be re-calculated for all submeshes
  25049. */
  25050. protected _markAllSubMeshesAsFresnelDirty(): void;
  25051. /**
  25052. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  25053. */
  25054. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  25055. /**
  25056. * Indicates that lights need to be re-calculated for all submeshes
  25057. */
  25058. protected _markAllSubMeshesAsLightsDirty(): void;
  25059. /**
  25060. * Indicates that attributes need to be re-calculated for all submeshes
  25061. */
  25062. protected _markAllSubMeshesAsAttributesDirty(): void;
  25063. /**
  25064. * Indicates that misc needs to be re-calculated for all submeshes
  25065. */
  25066. protected _markAllSubMeshesAsMiscDirty(): void;
  25067. /**
  25068. * Indicates that textures and misc need to be re-calculated for all submeshes
  25069. */
  25070. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  25071. /**
  25072. * Disposes the material
  25073. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  25074. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  25075. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  25076. */
  25077. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  25078. /** @hidden */
  25079. private releaseVertexArrayObject;
  25080. /**
  25081. * Serializes this material
  25082. * @returns the serialized material object
  25083. */
  25084. serialize(): any;
  25085. /**
  25086. * Creates a material from parsed material data
  25087. * @param parsedMaterial defines parsed material data
  25088. * @param scene defines the hosting scene
  25089. * @param rootUrl defines the root URL to use to load textures
  25090. * @returns a new material
  25091. */
  25092. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  25093. }
  25094. }
  25095. declare module "babylonjs/Materials/multiMaterial" {
  25096. import { Nullable } from "babylonjs/types";
  25097. import { Scene } from "babylonjs/scene";
  25098. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25099. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25100. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25101. import { Material } from "babylonjs/Materials/material";
  25102. /**
  25103. * A multi-material is used to apply different materials to different parts of the same object without the need of
  25104. * separate meshes. This can be use to improve performances.
  25105. * @see http://doc.babylonjs.com/how_to/multi_materials
  25106. */
  25107. export class MultiMaterial extends Material {
  25108. private _subMaterials;
  25109. /**
  25110. * Gets or Sets the list of Materials used within the multi material.
  25111. * They need to be ordered according to the submeshes order in the associated mesh
  25112. */
  25113. get subMaterials(): Nullable<Material>[];
  25114. set subMaterials(value: Nullable<Material>[]);
  25115. /**
  25116. * Function used to align with Node.getChildren()
  25117. * @returns the list of Materials used within the multi material
  25118. */
  25119. getChildren(): Nullable<Material>[];
  25120. /**
  25121. * Instantiates a new Multi Material
  25122. * A multi-material is used to apply different materials to different parts of the same object without the need of
  25123. * separate meshes. This can be use to improve performances.
  25124. * @see http://doc.babylonjs.com/how_to/multi_materials
  25125. * @param name Define the name in the scene
  25126. * @param scene Define the scene the material belongs to
  25127. */
  25128. constructor(name: string, scene: Scene);
  25129. private _hookArray;
  25130. /**
  25131. * Get one of the submaterial by its index in the submaterials array
  25132. * @param index The index to look the sub material at
  25133. * @returns The Material if the index has been defined
  25134. */
  25135. getSubMaterial(index: number): Nullable<Material>;
  25136. /**
  25137. * Get the list of active textures for the whole sub materials list.
  25138. * @returns All the textures that will be used during the rendering
  25139. */
  25140. getActiveTextures(): BaseTexture[];
  25141. /**
  25142. * Gets the current class name of the material e.g. "MultiMaterial"
  25143. * Mainly use in serialization.
  25144. * @returns the class name
  25145. */
  25146. getClassName(): string;
  25147. /**
  25148. * Checks if the material is ready to render the requested sub mesh
  25149. * @param mesh Define the mesh the submesh belongs to
  25150. * @param subMesh Define the sub mesh to look readyness for
  25151. * @param useInstances Define whether or not the material is used with instances
  25152. * @returns true if ready, otherwise false
  25153. */
  25154. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25155. /**
  25156. * Clones the current material and its related sub materials
  25157. * @param name Define the name of the newly cloned material
  25158. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  25159. * @returns the cloned material
  25160. */
  25161. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  25162. /**
  25163. * Serializes the materials into a JSON representation.
  25164. * @returns the JSON representation
  25165. */
  25166. serialize(): any;
  25167. /**
  25168. * Dispose the material and release its associated resources
  25169. * @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)
  25170. * @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)
  25171. * @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)
  25172. */
  25173. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  25174. /**
  25175. * Creates a MultiMaterial from parsed MultiMaterial data.
  25176. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  25177. * @param scene defines the hosting scene
  25178. * @returns a new MultiMaterial
  25179. */
  25180. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  25181. }
  25182. }
  25183. declare module "babylonjs/Meshes/subMesh" {
  25184. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  25185. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  25186. import { Engine } from "babylonjs/Engines/engine";
  25187. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  25188. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  25189. import { Effect } from "babylonjs/Materials/effect";
  25190. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  25191. import { Plane } from "babylonjs/Maths/math.plane";
  25192. import { Collider } from "babylonjs/Collisions/collider";
  25193. import { Material } from "babylonjs/Materials/material";
  25194. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25195. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25196. import { Mesh } from "babylonjs/Meshes/mesh";
  25197. import { Ray } from "babylonjs/Culling/ray";
  25198. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  25199. /**
  25200. * Defines a subdivision inside a mesh
  25201. */
  25202. export class SubMesh implements ICullable {
  25203. /** the material index to use */
  25204. materialIndex: number;
  25205. /** vertex index start */
  25206. verticesStart: number;
  25207. /** vertices count */
  25208. verticesCount: number;
  25209. /** index start */
  25210. indexStart: number;
  25211. /** indices count */
  25212. indexCount: number;
  25213. /** @hidden */
  25214. _materialDefines: Nullable<MaterialDefines>;
  25215. /** @hidden */
  25216. _materialEffect: Nullable<Effect>;
  25217. /** @hidden */
  25218. _effectOverride: Nullable<Effect>;
  25219. /**
  25220. * Gets material defines used by the effect associated to the sub mesh
  25221. */
  25222. get materialDefines(): Nullable<MaterialDefines>;
  25223. /**
  25224. * Sets material defines used by the effect associated to the sub mesh
  25225. */
  25226. set materialDefines(defines: Nullable<MaterialDefines>);
  25227. /**
  25228. * Gets associated effect
  25229. */
  25230. get effect(): Nullable<Effect>;
  25231. /**
  25232. * Sets associated effect (effect used to render this submesh)
  25233. * @param effect defines the effect to associate with
  25234. * @param defines defines the set of defines used to compile this effect
  25235. */
  25236. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  25237. /** @hidden */
  25238. _linesIndexCount: number;
  25239. private _mesh;
  25240. private _renderingMesh;
  25241. private _boundingInfo;
  25242. private _linesIndexBuffer;
  25243. /** @hidden */
  25244. _lastColliderWorldVertices: Nullable<Vector3[]>;
  25245. /** @hidden */
  25246. _trianglePlanes: Plane[];
  25247. /** @hidden */
  25248. _lastColliderTransformMatrix: Nullable<Matrix>;
  25249. /** @hidden */
  25250. _renderId: number;
  25251. /** @hidden */
  25252. _alphaIndex: number;
  25253. /** @hidden */
  25254. _distanceToCamera: number;
  25255. /** @hidden */
  25256. _id: number;
  25257. private _currentMaterial;
  25258. /**
  25259. * Add a new submesh to a mesh
  25260. * @param materialIndex defines the material index to use
  25261. * @param verticesStart defines vertex index start
  25262. * @param verticesCount defines vertices count
  25263. * @param indexStart defines index start
  25264. * @param indexCount defines indices count
  25265. * @param mesh defines the parent mesh
  25266. * @param renderingMesh defines an optional rendering mesh
  25267. * @param createBoundingBox defines if bounding box should be created for this submesh
  25268. * @returns the new submesh
  25269. */
  25270. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  25271. /**
  25272. * Creates a new submesh
  25273. * @param materialIndex defines the material index to use
  25274. * @param verticesStart defines vertex index start
  25275. * @param verticesCount defines vertices count
  25276. * @param indexStart defines index start
  25277. * @param indexCount defines indices count
  25278. * @param mesh defines the parent mesh
  25279. * @param renderingMesh defines an optional rendering mesh
  25280. * @param createBoundingBox defines if bounding box should be created for this submesh
  25281. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  25282. */
  25283. constructor(
  25284. /** the material index to use */
  25285. materialIndex: number,
  25286. /** vertex index start */
  25287. verticesStart: number,
  25288. /** vertices count */
  25289. verticesCount: number,
  25290. /** index start */
  25291. indexStart: number,
  25292. /** indices count */
  25293. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  25294. /**
  25295. * Returns true if this submesh covers the entire parent mesh
  25296. * @ignorenaming
  25297. */
  25298. get IsGlobal(): boolean;
  25299. /**
  25300. * Returns the submesh BoudingInfo object
  25301. * @returns current bounding info (or mesh's one if the submesh is global)
  25302. */
  25303. getBoundingInfo(): BoundingInfo;
  25304. /**
  25305. * Sets the submesh BoundingInfo
  25306. * @param boundingInfo defines the new bounding info to use
  25307. * @returns the SubMesh
  25308. */
  25309. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  25310. /**
  25311. * Returns the mesh of the current submesh
  25312. * @return the parent mesh
  25313. */
  25314. getMesh(): AbstractMesh;
  25315. /**
  25316. * Returns the rendering mesh of the submesh
  25317. * @returns the rendering mesh (could be different from parent mesh)
  25318. */
  25319. getRenderingMesh(): Mesh;
  25320. /**
  25321. * Returns the replacement mesh of the submesh
  25322. * @returns the replacement mesh (could be different from parent mesh)
  25323. */
  25324. getReplacementMesh(): Nullable<AbstractMesh>;
  25325. /**
  25326. * Returns the effective mesh of the submesh
  25327. * @returns the effective mesh (could be different from parent mesh)
  25328. */
  25329. getEffectiveMesh(): AbstractMesh;
  25330. /**
  25331. * Returns the submesh material
  25332. * @returns null or the current material
  25333. */
  25334. getMaterial(): Nullable<Material>;
  25335. private _IsMultiMaterial;
  25336. /**
  25337. * Sets a new updated BoundingInfo object to the submesh
  25338. * @param data defines an optional position array to use to determine the bounding info
  25339. * @returns the SubMesh
  25340. */
  25341. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  25342. /** @hidden */
  25343. _checkCollision(collider: Collider): boolean;
  25344. /**
  25345. * Updates the submesh BoundingInfo
  25346. * @param world defines the world matrix to use to update the bounding info
  25347. * @returns the submesh
  25348. */
  25349. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  25350. /**
  25351. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  25352. * @param frustumPlanes defines the frustum planes
  25353. * @returns true if the submesh is intersecting with the frustum
  25354. */
  25355. isInFrustum(frustumPlanes: Plane[]): boolean;
  25356. /**
  25357. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  25358. * @param frustumPlanes defines the frustum planes
  25359. * @returns true if the submesh is inside the frustum
  25360. */
  25361. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  25362. /**
  25363. * Renders the submesh
  25364. * @param enableAlphaMode defines if alpha needs to be used
  25365. * @returns the submesh
  25366. */
  25367. render(enableAlphaMode: boolean): SubMesh;
  25368. /**
  25369. * @hidden
  25370. */
  25371. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  25372. /**
  25373. * Checks if the submesh intersects with a ray
  25374. * @param ray defines the ray to test
  25375. * @returns true is the passed ray intersects the submesh bounding box
  25376. */
  25377. canIntersects(ray: Ray): boolean;
  25378. /**
  25379. * Intersects current submesh with a ray
  25380. * @param ray defines the ray to test
  25381. * @param positions defines mesh's positions array
  25382. * @param indices defines mesh's indices array
  25383. * @param fastCheck defines if the first intersection will be used (and not the closest)
  25384. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  25385. * @returns intersection info or null if no intersection
  25386. */
  25387. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  25388. /** @hidden */
  25389. private _intersectLines;
  25390. /** @hidden */
  25391. private _intersectUnIndexedLines;
  25392. /** @hidden */
  25393. private _intersectTriangles;
  25394. /** @hidden */
  25395. private _intersectUnIndexedTriangles;
  25396. /** @hidden */
  25397. _rebuild(): void;
  25398. /**
  25399. * Creates a new submesh from the passed mesh
  25400. * @param newMesh defines the new hosting mesh
  25401. * @param newRenderingMesh defines an optional rendering mesh
  25402. * @returns the new submesh
  25403. */
  25404. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  25405. /**
  25406. * Release associated resources
  25407. */
  25408. dispose(): void;
  25409. /**
  25410. * Gets the class name
  25411. * @returns the string "SubMesh".
  25412. */
  25413. getClassName(): string;
  25414. /**
  25415. * Creates a new submesh from indices data
  25416. * @param materialIndex the index of the main mesh material
  25417. * @param startIndex the index where to start the copy in the mesh indices array
  25418. * @param indexCount the number of indices to copy then from the startIndex
  25419. * @param mesh the main mesh to create the submesh from
  25420. * @param renderingMesh the optional rendering mesh
  25421. * @returns a new submesh
  25422. */
  25423. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  25424. }
  25425. }
  25426. declare module "babylonjs/Loading/sceneLoaderFlags" {
  25427. /**
  25428. * Class used to represent data loading progression
  25429. */
  25430. export class SceneLoaderFlags {
  25431. private static _ForceFullSceneLoadingForIncremental;
  25432. private static _ShowLoadingScreen;
  25433. private static _CleanBoneMatrixWeights;
  25434. private static _loggingLevel;
  25435. /**
  25436. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  25437. */
  25438. static get ForceFullSceneLoadingForIncremental(): boolean;
  25439. static set ForceFullSceneLoadingForIncremental(value: boolean);
  25440. /**
  25441. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  25442. */
  25443. static get ShowLoadingScreen(): boolean;
  25444. static set ShowLoadingScreen(value: boolean);
  25445. /**
  25446. * Defines the current logging level (while loading the scene)
  25447. * @ignorenaming
  25448. */
  25449. static get loggingLevel(): number;
  25450. static set loggingLevel(value: number);
  25451. /**
  25452. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  25453. */
  25454. static get CleanBoneMatrixWeights(): boolean;
  25455. static set CleanBoneMatrixWeights(value: boolean);
  25456. }
  25457. }
  25458. declare module "babylonjs/Meshes/geometry" {
  25459. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  25460. import { Scene } from "babylonjs/scene";
  25461. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  25462. import { Engine } from "babylonjs/Engines/engine";
  25463. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  25464. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  25465. import { Effect } from "babylonjs/Materials/effect";
  25466. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  25467. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  25468. import { Mesh } from "babylonjs/Meshes/mesh";
  25469. /**
  25470. * Class used to store geometry data (vertex buffers + index buffer)
  25471. */
  25472. export class Geometry implements IGetSetVerticesData {
  25473. /**
  25474. * Gets or sets the ID of the geometry
  25475. */
  25476. id: string;
  25477. /**
  25478. * Gets or sets the unique ID of the geometry
  25479. */
  25480. uniqueId: number;
  25481. /**
  25482. * Gets the delay loading state of the geometry (none by default which means not delayed)
  25483. */
  25484. delayLoadState: number;
  25485. /**
  25486. * Gets the file containing the data to load when running in delay load state
  25487. */
  25488. delayLoadingFile: Nullable<string>;
  25489. /**
  25490. * Callback called when the geometry is updated
  25491. */
  25492. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  25493. private _scene;
  25494. private _engine;
  25495. private _meshes;
  25496. private _totalVertices;
  25497. /** @hidden */
  25498. _indices: IndicesArray;
  25499. /** @hidden */
  25500. _vertexBuffers: {
  25501. [key: string]: VertexBuffer;
  25502. };
  25503. private _isDisposed;
  25504. private _extend;
  25505. private _boundingBias;
  25506. /** @hidden */
  25507. _delayInfo: Array<string>;
  25508. private _indexBuffer;
  25509. private _indexBufferIsUpdatable;
  25510. /** @hidden */
  25511. _boundingInfo: Nullable<BoundingInfo>;
  25512. /** @hidden */
  25513. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  25514. /** @hidden */
  25515. _softwareSkinningFrameId: number;
  25516. private _vertexArrayObjects;
  25517. private _updatable;
  25518. /** @hidden */
  25519. _positions: Nullable<Vector3[]>;
  25520. /**
  25521. * 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
  25522. */
  25523. get boundingBias(): Vector2;
  25524. /**
  25525. * 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
  25526. */
  25527. set boundingBias(value: Vector2);
  25528. /**
  25529. * Static function used to attach a new empty geometry to a mesh
  25530. * @param mesh defines the mesh to attach the geometry to
  25531. * @returns the new Geometry
  25532. */
  25533. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  25534. /** Get the list of meshes using this geometry */
  25535. get meshes(): Mesh[];
  25536. /**
  25537. * Creates a new geometry
  25538. * @param id defines the unique ID
  25539. * @param scene defines the hosting scene
  25540. * @param vertexData defines the VertexData used to get geometry data
  25541. * @param updatable defines if geometry must be updatable (false by default)
  25542. * @param mesh defines the mesh that will be associated with the geometry
  25543. */
  25544. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  25545. /**
  25546. * Gets the current extend of the geometry
  25547. */
  25548. get extend(): {
  25549. minimum: Vector3;
  25550. maximum: Vector3;
  25551. };
  25552. /**
  25553. * Gets the hosting scene
  25554. * @returns the hosting Scene
  25555. */
  25556. getScene(): Scene;
  25557. /**
  25558. * Gets the hosting engine
  25559. * @returns the hosting Engine
  25560. */
  25561. getEngine(): Engine;
  25562. /**
  25563. * Defines if the geometry is ready to use
  25564. * @returns true if the geometry is ready to be used
  25565. */
  25566. isReady(): boolean;
  25567. /**
  25568. * Gets a value indicating that the geometry should not be serialized
  25569. */
  25570. get doNotSerialize(): boolean;
  25571. /** @hidden */
  25572. _rebuild(): void;
  25573. /**
  25574. * Affects all geometry data in one call
  25575. * @param vertexData defines the geometry data
  25576. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  25577. */
  25578. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  25579. /**
  25580. * Set specific vertex data
  25581. * @param kind defines the data kind (Position, normal, etc...)
  25582. * @param data defines the vertex data to use
  25583. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  25584. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  25585. */
  25586. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  25587. /**
  25588. * Removes a specific vertex data
  25589. * @param kind defines the data kind (Position, normal, etc...)
  25590. */
  25591. removeVerticesData(kind: string): void;
  25592. /**
  25593. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  25594. * @param buffer defines the vertex buffer to use
  25595. * @param totalVertices defines the total number of vertices for position kind (could be null)
  25596. */
  25597. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  25598. /**
  25599. * Update a specific vertex buffer
  25600. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  25601. * It will do nothing if the buffer is not updatable
  25602. * @param kind defines the data kind (Position, normal, etc...)
  25603. * @param data defines the data to use
  25604. * @param offset defines the offset in the target buffer where to store the data
  25605. * @param useBytes set to true if the offset is in bytes
  25606. */
  25607. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  25608. /**
  25609. * Update a specific vertex buffer
  25610. * This function will create a new buffer if the current one is not updatable
  25611. * @param kind defines the data kind (Position, normal, etc...)
  25612. * @param data defines the data to use
  25613. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  25614. */
  25615. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  25616. private _updateBoundingInfo;
  25617. /** @hidden */
  25618. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  25619. /**
  25620. * Gets total number of vertices
  25621. * @returns the total number of vertices
  25622. */
  25623. getTotalVertices(): number;
  25624. /**
  25625. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  25626. * @param kind defines the data kind (Position, normal, etc...)
  25627. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  25628. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  25629. * @returns a float array containing vertex data
  25630. */
  25631. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  25632. /**
  25633. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  25634. * @param kind defines the data kind (Position, normal, etc...)
  25635. * @returns true if the vertex buffer with the specified kind is updatable
  25636. */
  25637. isVertexBufferUpdatable(kind: string): boolean;
  25638. /**
  25639. * Gets a specific vertex buffer
  25640. * @param kind defines the data kind (Position, normal, etc...)
  25641. * @returns a VertexBuffer
  25642. */
  25643. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  25644. /**
  25645. * Returns all vertex buffers
  25646. * @return an object holding all vertex buffers indexed by kind
  25647. */
  25648. getVertexBuffers(): Nullable<{
  25649. [key: string]: VertexBuffer;
  25650. }>;
  25651. /**
  25652. * Gets a boolean indicating if specific vertex buffer is present
  25653. * @param kind defines the data kind (Position, normal, etc...)
  25654. * @returns true if data is present
  25655. */
  25656. isVerticesDataPresent(kind: string): boolean;
  25657. /**
  25658. * Gets a list of all attached data kinds (Position, normal, etc...)
  25659. * @returns a list of string containing all kinds
  25660. */
  25661. getVerticesDataKinds(): string[];
  25662. /**
  25663. * Update index buffer
  25664. * @param indices defines the indices to store in the index buffer
  25665. * @param offset defines the offset in the target buffer where to store the data
  25666. * @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)
  25667. */
  25668. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  25669. /**
  25670. * Creates a new index buffer
  25671. * @param indices defines the indices to store in the index buffer
  25672. * @param totalVertices defines the total number of vertices (could be null)
  25673. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  25674. */
  25675. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  25676. /**
  25677. * Return the total number of indices
  25678. * @returns the total number of indices
  25679. */
  25680. getTotalIndices(): number;
  25681. /**
  25682. * Gets the index buffer array
  25683. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  25684. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  25685. * @returns the index buffer array
  25686. */
  25687. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  25688. /**
  25689. * Gets the index buffer
  25690. * @return the index buffer
  25691. */
  25692. getIndexBuffer(): Nullable<DataBuffer>;
  25693. /** @hidden */
  25694. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  25695. /**
  25696. * Release the associated resources for a specific mesh
  25697. * @param mesh defines the source mesh
  25698. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  25699. */
  25700. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  25701. /**
  25702. * Apply current geometry to a given mesh
  25703. * @param mesh defines the mesh to apply geometry to
  25704. */
  25705. applyToMesh(mesh: Mesh): void;
  25706. private _updateExtend;
  25707. private _applyToMesh;
  25708. private notifyUpdate;
  25709. /**
  25710. * Load the geometry if it was flagged as delay loaded
  25711. * @param scene defines the hosting scene
  25712. * @param onLoaded defines a callback called when the geometry is loaded
  25713. */
  25714. load(scene: Scene, onLoaded?: () => void): void;
  25715. private _queueLoad;
  25716. /**
  25717. * Invert the geometry to move from a right handed system to a left handed one.
  25718. */
  25719. toLeftHanded(): void;
  25720. /** @hidden */
  25721. _resetPointsArrayCache(): void;
  25722. /** @hidden */
  25723. _generatePointsArray(): boolean;
  25724. /**
  25725. * Gets a value indicating if the geometry is disposed
  25726. * @returns true if the geometry was disposed
  25727. */
  25728. isDisposed(): boolean;
  25729. private _disposeVertexArrayObjects;
  25730. /**
  25731. * Free all associated resources
  25732. */
  25733. dispose(): void;
  25734. /**
  25735. * Clone the current geometry into a new geometry
  25736. * @param id defines the unique ID of the new geometry
  25737. * @returns a new geometry object
  25738. */
  25739. copy(id: string): Geometry;
  25740. /**
  25741. * Serialize the current geometry info (and not the vertices data) into a JSON object
  25742. * @return a JSON representation of the current geometry data (without the vertices data)
  25743. */
  25744. serialize(): any;
  25745. private toNumberArray;
  25746. /**
  25747. * Serialize all vertices data into a JSON oject
  25748. * @returns a JSON representation of the current geometry data
  25749. */
  25750. serializeVerticeData(): any;
  25751. /**
  25752. * Extracts a clone of a mesh geometry
  25753. * @param mesh defines the source mesh
  25754. * @param id defines the unique ID of the new geometry object
  25755. * @returns the new geometry object
  25756. */
  25757. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  25758. /**
  25759. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  25760. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  25761. * Be aware Math.random() could cause collisions, but:
  25762. * "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"
  25763. * @returns a string containing a new GUID
  25764. */
  25765. static RandomId(): string;
  25766. /** @hidden */
  25767. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  25768. private static _CleanMatricesWeights;
  25769. /**
  25770. * Create a new geometry from persisted data (Using .babylon file format)
  25771. * @param parsedVertexData defines the persisted data
  25772. * @param scene defines the hosting scene
  25773. * @param rootUrl defines the root url to use to load assets (like delayed data)
  25774. * @returns the new geometry object
  25775. */
  25776. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  25777. }
  25778. }
  25779. declare module "babylonjs/Meshes/mesh.vertexData" {
  25780. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  25781. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  25782. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  25783. import { Geometry } from "babylonjs/Meshes/geometry";
  25784. import { Mesh } from "babylonjs/Meshes/mesh";
  25785. /**
  25786. * Define an interface for all classes that will get and set the data on vertices
  25787. */
  25788. export interface IGetSetVerticesData {
  25789. /**
  25790. * Gets a boolean indicating if specific vertex data is present
  25791. * @param kind defines the vertex data kind to use
  25792. * @returns true is data kind is present
  25793. */
  25794. isVerticesDataPresent(kind: string): boolean;
  25795. /**
  25796. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  25797. * @param kind defines the data kind (Position, normal, etc...)
  25798. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  25799. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  25800. * @returns a float array containing vertex data
  25801. */
  25802. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  25803. /**
  25804. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  25805. * @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.
  25806. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  25807. * @returns the indices array or an empty array if the mesh has no geometry
  25808. */
  25809. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  25810. /**
  25811. * Set specific vertex data
  25812. * @param kind defines the data kind (Position, normal, etc...)
  25813. * @param data defines the vertex data to use
  25814. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  25815. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  25816. */
  25817. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  25818. /**
  25819. * Update a specific associated vertex buffer
  25820. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  25821. * - VertexBuffer.PositionKind
  25822. * - VertexBuffer.UVKind
  25823. * - VertexBuffer.UV2Kind
  25824. * - VertexBuffer.UV3Kind
  25825. * - VertexBuffer.UV4Kind
  25826. * - VertexBuffer.UV5Kind
  25827. * - VertexBuffer.UV6Kind
  25828. * - VertexBuffer.ColorKind
  25829. * - VertexBuffer.MatricesIndicesKind
  25830. * - VertexBuffer.MatricesIndicesExtraKind
  25831. * - VertexBuffer.MatricesWeightsKind
  25832. * - VertexBuffer.MatricesWeightsExtraKind
  25833. * @param data defines the data source
  25834. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  25835. * @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)
  25836. */
  25837. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  25838. /**
  25839. * Creates a new index buffer
  25840. * @param indices defines the indices to store in the index buffer
  25841. * @param totalVertices defines the total number of vertices (could be null)
  25842. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  25843. */
  25844. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  25845. }
  25846. /**
  25847. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  25848. */
  25849. export class VertexData {
  25850. /**
  25851. * Mesh side orientation : usually the external or front surface
  25852. */
  25853. static readonly FRONTSIDE: number;
  25854. /**
  25855. * Mesh side orientation : usually the internal or back surface
  25856. */
  25857. static readonly BACKSIDE: number;
  25858. /**
  25859. * Mesh side orientation : both internal and external or front and back surfaces
  25860. */
  25861. static readonly DOUBLESIDE: number;
  25862. /**
  25863. * Mesh side orientation : by default, `FRONTSIDE`
  25864. */
  25865. static readonly DEFAULTSIDE: number;
  25866. /**
  25867. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  25868. */
  25869. positions: Nullable<FloatArray>;
  25870. /**
  25871. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  25872. */
  25873. normals: Nullable<FloatArray>;
  25874. /**
  25875. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  25876. */
  25877. tangents: Nullable<FloatArray>;
  25878. /**
  25879. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  25880. */
  25881. uvs: Nullable<FloatArray>;
  25882. /**
  25883. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  25884. */
  25885. uvs2: Nullable<FloatArray>;
  25886. /**
  25887. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  25888. */
  25889. uvs3: Nullable<FloatArray>;
  25890. /**
  25891. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  25892. */
  25893. uvs4: Nullable<FloatArray>;
  25894. /**
  25895. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  25896. */
  25897. uvs5: Nullable<FloatArray>;
  25898. /**
  25899. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  25900. */
  25901. uvs6: Nullable<FloatArray>;
  25902. /**
  25903. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  25904. */
  25905. colors: Nullable<FloatArray>;
  25906. /**
  25907. * 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).
  25908. */
  25909. matricesIndices: Nullable<FloatArray>;
  25910. /**
  25911. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  25912. */
  25913. matricesWeights: Nullable<FloatArray>;
  25914. /**
  25915. * An array extending the number of possible indices
  25916. */
  25917. matricesIndicesExtra: Nullable<FloatArray>;
  25918. /**
  25919. * An array extending the number of possible weights when the number of indices is extended
  25920. */
  25921. matricesWeightsExtra: Nullable<FloatArray>;
  25922. /**
  25923. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  25924. */
  25925. indices: Nullable<IndicesArray>;
  25926. /**
  25927. * Uses the passed data array to set the set the values for the specified kind of data
  25928. * @param data a linear array of floating numbers
  25929. * @param kind the type of data that is being set, eg positions, colors etc
  25930. */
  25931. set(data: FloatArray, kind: string): void;
  25932. /**
  25933. * Associates the vertexData to the passed Mesh.
  25934. * Sets it as updatable or not (default `false`)
  25935. * @param mesh the mesh the vertexData is applied to
  25936. * @param updatable when used and having the value true allows new data to update the vertexData
  25937. * @returns the VertexData
  25938. */
  25939. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  25940. /**
  25941. * Associates the vertexData to the passed Geometry.
  25942. * Sets it as updatable or not (default `false`)
  25943. * @param geometry the geometry the vertexData is applied to
  25944. * @param updatable when used and having the value true allows new data to update the vertexData
  25945. * @returns VertexData
  25946. */
  25947. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  25948. /**
  25949. * Updates the associated mesh
  25950. * @param mesh the mesh to be updated
  25951. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  25952. * @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
  25953. * @returns VertexData
  25954. */
  25955. updateMesh(mesh: Mesh): VertexData;
  25956. /**
  25957. * Updates the associated geometry
  25958. * @param geometry the geometry to be updated
  25959. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  25960. * @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
  25961. * @returns VertexData.
  25962. */
  25963. updateGeometry(geometry: Geometry): VertexData;
  25964. private _applyTo;
  25965. private _update;
  25966. /**
  25967. * Transforms each position and each normal of the vertexData according to the passed Matrix
  25968. * @param matrix the transforming matrix
  25969. * @returns the VertexData
  25970. */
  25971. transform(matrix: Matrix): VertexData;
  25972. /**
  25973. * Merges the passed VertexData into the current one
  25974. * @param other the VertexData to be merged into the current one
  25975. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  25976. * @returns the modified VertexData
  25977. */
  25978. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  25979. private _mergeElement;
  25980. private _validate;
  25981. /**
  25982. * Serializes the VertexData
  25983. * @returns a serialized object
  25984. */
  25985. serialize(): any;
  25986. /**
  25987. * Extracts the vertexData from a mesh
  25988. * @param mesh the mesh from which to extract the VertexData
  25989. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  25990. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  25991. * @returns the object VertexData associated to the passed mesh
  25992. */
  25993. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  25994. /**
  25995. * Extracts the vertexData from the geometry
  25996. * @param geometry the geometry from which to extract the VertexData
  25997. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  25998. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  25999. * @returns the object VertexData associated to the passed mesh
  26000. */
  26001. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  26002. private static _ExtractFrom;
  26003. /**
  26004. * Creates the VertexData for a Ribbon
  26005. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  26006. * * pathArray array of paths, each of which an array of successive Vector3
  26007. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  26008. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  26009. * * 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
  26010. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26011. * * 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)
  26012. * * 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)
  26013. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  26014. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  26015. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  26016. * @returns the VertexData of the ribbon
  26017. */
  26018. static CreateRibbon(options: {
  26019. pathArray: Vector3[][];
  26020. closeArray?: boolean;
  26021. closePath?: boolean;
  26022. offset?: number;
  26023. sideOrientation?: number;
  26024. frontUVs?: Vector4;
  26025. backUVs?: Vector4;
  26026. invertUV?: boolean;
  26027. uvs?: Vector2[];
  26028. colors?: Color4[];
  26029. }): VertexData;
  26030. /**
  26031. * Creates the VertexData for a box
  26032. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26033. * * size sets the width, height and depth of the box to the value of size, optional default 1
  26034. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  26035. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  26036. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  26037. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  26038. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  26039. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26040. * * 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)
  26041. * * 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)
  26042. * @returns the VertexData of the box
  26043. */
  26044. static CreateBox(options: {
  26045. size?: number;
  26046. width?: number;
  26047. height?: number;
  26048. depth?: number;
  26049. faceUV?: Vector4[];
  26050. faceColors?: Color4[];
  26051. sideOrientation?: number;
  26052. frontUVs?: Vector4;
  26053. backUVs?: Vector4;
  26054. }): VertexData;
  26055. /**
  26056. * Creates the VertexData for a tiled box
  26057. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26058. * * faceTiles sets the pattern, tile size and number of tiles for a face
  26059. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  26060. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  26061. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26062. * @returns the VertexData of the box
  26063. */
  26064. static CreateTiledBox(options: {
  26065. pattern?: number;
  26066. width?: number;
  26067. height?: number;
  26068. depth?: number;
  26069. tileSize?: number;
  26070. tileWidth?: number;
  26071. tileHeight?: number;
  26072. alignHorizontal?: number;
  26073. alignVertical?: number;
  26074. faceUV?: Vector4[];
  26075. faceColors?: Color4[];
  26076. sideOrientation?: number;
  26077. }): VertexData;
  26078. /**
  26079. * Creates the VertexData for a tiled plane
  26080. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26081. * * pattern a limited pattern arrangement depending on the number
  26082. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  26083. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  26084. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  26085. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26086. * * 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)
  26087. * * 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)
  26088. * @returns the VertexData of the tiled plane
  26089. */
  26090. static CreateTiledPlane(options: {
  26091. pattern?: number;
  26092. tileSize?: number;
  26093. tileWidth?: number;
  26094. tileHeight?: number;
  26095. size?: number;
  26096. width?: number;
  26097. height?: number;
  26098. alignHorizontal?: number;
  26099. alignVertical?: number;
  26100. sideOrientation?: number;
  26101. frontUVs?: Vector4;
  26102. backUVs?: Vector4;
  26103. }): VertexData;
  26104. /**
  26105. * Creates the VertexData for an ellipsoid, defaults to a sphere
  26106. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26107. * * segments sets the number of horizontal strips optional, default 32
  26108. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  26109. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  26110. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  26111. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  26112. * * 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
  26113. * * 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
  26114. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26115. * * 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)
  26116. * * 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)
  26117. * @returns the VertexData of the ellipsoid
  26118. */
  26119. static CreateSphere(options: {
  26120. segments?: number;
  26121. diameter?: number;
  26122. diameterX?: number;
  26123. diameterY?: number;
  26124. diameterZ?: number;
  26125. arc?: number;
  26126. slice?: number;
  26127. sideOrientation?: number;
  26128. frontUVs?: Vector4;
  26129. backUVs?: Vector4;
  26130. }): VertexData;
  26131. /**
  26132. * Creates the VertexData for a cylinder, cone or prism
  26133. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26134. * * height sets the height (y direction) of the cylinder, optional, default 2
  26135. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  26136. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  26137. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  26138. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  26139. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  26140. * * 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
  26141. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  26142. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  26143. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  26144. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  26145. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26146. * * 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)
  26147. * * 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)
  26148. * @returns the VertexData of the cylinder, cone or prism
  26149. */
  26150. static CreateCylinder(options: {
  26151. height?: number;
  26152. diameterTop?: number;
  26153. diameterBottom?: number;
  26154. diameter?: number;
  26155. tessellation?: number;
  26156. subdivisions?: number;
  26157. arc?: number;
  26158. faceColors?: Color4[];
  26159. faceUV?: Vector4[];
  26160. hasRings?: boolean;
  26161. enclose?: boolean;
  26162. sideOrientation?: number;
  26163. frontUVs?: Vector4;
  26164. backUVs?: Vector4;
  26165. }): VertexData;
  26166. /**
  26167. * Creates the VertexData for a torus
  26168. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26169. * * diameter the diameter of the torus, optional default 1
  26170. * * thickness the diameter of the tube forming the torus, optional default 0.5
  26171. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  26172. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26173. * * 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)
  26174. * * 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)
  26175. * @returns the VertexData of the torus
  26176. */
  26177. static CreateTorus(options: {
  26178. diameter?: number;
  26179. thickness?: number;
  26180. tessellation?: number;
  26181. sideOrientation?: number;
  26182. frontUVs?: Vector4;
  26183. backUVs?: Vector4;
  26184. }): VertexData;
  26185. /**
  26186. * Creates the VertexData of the LineSystem
  26187. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  26188. * - lines an array of lines, each line being an array of successive Vector3
  26189. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  26190. * @returns the VertexData of the LineSystem
  26191. */
  26192. static CreateLineSystem(options: {
  26193. lines: Vector3[][];
  26194. colors?: Nullable<Color4[][]>;
  26195. }): VertexData;
  26196. /**
  26197. * Create the VertexData for a DashedLines
  26198. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  26199. * - points an array successive Vector3
  26200. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  26201. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  26202. * - dashNb the intended total number of dashes, optional, default 200
  26203. * @returns the VertexData for the DashedLines
  26204. */
  26205. static CreateDashedLines(options: {
  26206. points: Vector3[];
  26207. dashSize?: number;
  26208. gapSize?: number;
  26209. dashNb?: number;
  26210. }): VertexData;
  26211. /**
  26212. * Creates the VertexData for a Ground
  26213. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  26214. * - width the width (x direction) of the ground, optional, default 1
  26215. * - height the height (z direction) of the ground, optional, default 1
  26216. * - subdivisions the number of subdivisions per side, optional, default 1
  26217. * @returns the VertexData of the Ground
  26218. */
  26219. static CreateGround(options: {
  26220. width?: number;
  26221. height?: number;
  26222. subdivisions?: number;
  26223. subdivisionsX?: number;
  26224. subdivisionsY?: number;
  26225. }): VertexData;
  26226. /**
  26227. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  26228. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  26229. * * xmin the ground minimum X coordinate, optional, default -1
  26230. * * zmin the ground minimum Z coordinate, optional, default -1
  26231. * * xmax the ground maximum X coordinate, optional, default 1
  26232. * * zmax the ground maximum Z coordinate, optional, default 1
  26233. * * 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}
  26234. * * 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}
  26235. * @returns the VertexData of the TiledGround
  26236. */
  26237. static CreateTiledGround(options: {
  26238. xmin: number;
  26239. zmin: number;
  26240. xmax: number;
  26241. zmax: number;
  26242. subdivisions?: {
  26243. w: number;
  26244. h: number;
  26245. };
  26246. precision?: {
  26247. w: number;
  26248. h: number;
  26249. };
  26250. }): VertexData;
  26251. /**
  26252. * Creates the VertexData of the Ground designed from a heightmap
  26253. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  26254. * * width the width (x direction) of the ground
  26255. * * height the height (z direction) of the ground
  26256. * * subdivisions the number of subdivisions per side
  26257. * * minHeight the minimum altitude on the ground, optional, default 0
  26258. * * maxHeight the maximum altitude on the ground, optional default 1
  26259. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  26260. * * buffer the array holding the image color data
  26261. * * bufferWidth the width of image
  26262. * * bufferHeight the height of image
  26263. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  26264. * @returns the VertexData of the Ground designed from a heightmap
  26265. */
  26266. static CreateGroundFromHeightMap(options: {
  26267. width: number;
  26268. height: number;
  26269. subdivisions: number;
  26270. minHeight: number;
  26271. maxHeight: number;
  26272. colorFilter: Color3;
  26273. buffer: Uint8Array;
  26274. bufferWidth: number;
  26275. bufferHeight: number;
  26276. alphaFilter: number;
  26277. }): VertexData;
  26278. /**
  26279. * Creates the VertexData for a Plane
  26280. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  26281. * * size sets the width and height of the plane to the value of size, optional default 1
  26282. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  26283. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  26284. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26285. * * 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)
  26286. * * 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)
  26287. * @returns the VertexData of the box
  26288. */
  26289. static CreatePlane(options: {
  26290. size?: number;
  26291. width?: number;
  26292. height?: number;
  26293. sideOrientation?: number;
  26294. frontUVs?: Vector4;
  26295. backUVs?: Vector4;
  26296. }): VertexData;
  26297. /**
  26298. * Creates the VertexData of the Disc or regular Polygon
  26299. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  26300. * * radius the radius of the disc, optional default 0.5
  26301. * * tessellation the number of polygon sides, optional, default 64
  26302. * * 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
  26303. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26304. * * 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)
  26305. * * 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)
  26306. * @returns the VertexData of the box
  26307. */
  26308. static CreateDisc(options: {
  26309. radius?: number;
  26310. tessellation?: number;
  26311. arc?: number;
  26312. sideOrientation?: number;
  26313. frontUVs?: Vector4;
  26314. backUVs?: Vector4;
  26315. }): VertexData;
  26316. /**
  26317. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  26318. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  26319. * @param polygon a mesh built from polygonTriangulation.build()
  26320. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26321. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  26322. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  26323. * @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)
  26324. * @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)
  26325. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  26326. * @returns the VertexData of the Polygon
  26327. */
  26328. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  26329. /**
  26330. * Creates the VertexData of the IcoSphere
  26331. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  26332. * * radius the radius of the IcoSphere, optional default 1
  26333. * * radiusX allows stretching in the x direction, optional, default radius
  26334. * * radiusY allows stretching in the y direction, optional, default radius
  26335. * * radiusZ allows stretching in the z direction, optional, default radius
  26336. * * flat when true creates a flat shaded mesh, optional, default true
  26337. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  26338. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26339. * * 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)
  26340. * * 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)
  26341. * @returns the VertexData of the IcoSphere
  26342. */
  26343. static CreateIcoSphere(options: {
  26344. radius?: number;
  26345. radiusX?: number;
  26346. radiusY?: number;
  26347. radiusZ?: number;
  26348. flat?: boolean;
  26349. subdivisions?: number;
  26350. sideOrientation?: number;
  26351. frontUVs?: Vector4;
  26352. backUVs?: Vector4;
  26353. }): VertexData;
  26354. /**
  26355. * Creates the VertexData for a Polyhedron
  26356. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  26357. * * type provided types are:
  26358. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  26359. * * 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)
  26360. * * size the size of the IcoSphere, optional default 1
  26361. * * sizeX allows stretching in the x direction, optional, default size
  26362. * * sizeY allows stretching in the y direction, optional, default size
  26363. * * sizeZ allows stretching in the z direction, optional, default size
  26364. * * 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
  26365. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  26366. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  26367. * * flat when true creates a flat shaded mesh, optional, default true
  26368. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  26369. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26370. * * 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)
  26371. * * 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)
  26372. * @returns the VertexData of the Polyhedron
  26373. */
  26374. static CreatePolyhedron(options: {
  26375. type?: number;
  26376. size?: number;
  26377. sizeX?: number;
  26378. sizeY?: number;
  26379. sizeZ?: number;
  26380. custom?: any;
  26381. faceUV?: Vector4[];
  26382. faceColors?: Color4[];
  26383. flat?: boolean;
  26384. sideOrientation?: number;
  26385. frontUVs?: Vector4;
  26386. backUVs?: Vector4;
  26387. }): VertexData;
  26388. /**
  26389. * Creates the VertexData for a TorusKnot
  26390. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  26391. * * radius the radius of the torus knot, optional, default 2
  26392. * * tube the thickness of the tube, optional, default 0.5
  26393. * * radialSegments the number of sides on each tube segments, optional, default 32
  26394. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  26395. * * p the number of windings around the z axis, optional, default 2
  26396. * * q the number of windings around the x axis, optional, default 3
  26397. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26398. * * 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)
  26399. * * 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)
  26400. * @returns the VertexData of the Torus Knot
  26401. */
  26402. static CreateTorusKnot(options: {
  26403. radius?: number;
  26404. tube?: number;
  26405. radialSegments?: number;
  26406. tubularSegments?: number;
  26407. p?: number;
  26408. q?: number;
  26409. sideOrientation?: number;
  26410. frontUVs?: Vector4;
  26411. backUVs?: Vector4;
  26412. }): VertexData;
  26413. /**
  26414. * Compute normals for given positions and indices
  26415. * @param positions an array of vertex positions, [...., x, y, z, ......]
  26416. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  26417. * @param normals an array of vertex normals, [...., x, y, z, ......]
  26418. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  26419. * * facetNormals : optional array of facet normals (vector3)
  26420. * * facetPositions : optional array of facet positions (vector3)
  26421. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  26422. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  26423. * * bInfo : optional bounding info, required for facetPartitioning computation
  26424. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  26425. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  26426. * * useRightHandedSystem: optional boolean to for right handed system computation
  26427. * * depthSort : optional boolean to enable the facet depth sort computation
  26428. * * distanceTo : optional Vector3 to compute the facet depth from this location
  26429. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  26430. */
  26431. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  26432. facetNormals?: any;
  26433. facetPositions?: any;
  26434. facetPartitioning?: any;
  26435. ratio?: number;
  26436. bInfo?: any;
  26437. bbSize?: Vector3;
  26438. subDiv?: any;
  26439. useRightHandedSystem?: boolean;
  26440. depthSort?: boolean;
  26441. distanceTo?: Vector3;
  26442. depthSortedFacets?: any;
  26443. }): void;
  26444. /** @hidden */
  26445. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  26446. /**
  26447. * Applies VertexData created from the imported parameters to the geometry
  26448. * @param parsedVertexData the parsed data from an imported file
  26449. * @param geometry the geometry to apply the VertexData to
  26450. */
  26451. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  26452. }
  26453. }
  26454. declare module "babylonjs/Morph/morphTarget" {
  26455. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  26456. import { Observable } from "babylonjs/Misc/observable";
  26457. import { Nullable, FloatArray } from "babylonjs/types";
  26458. import { Scene } from "babylonjs/scene";
  26459. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26460. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  26461. /**
  26462. * Defines a target to use with MorphTargetManager
  26463. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  26464. */
  26465. export class MorphTarget implements IAnimatable {
  26466. /** defines the name of the target */
  26467. name: string;
  26468. /**
  26469. * Gets or sets the list of animations
  26470. */
  26471. animations: import("babylonjs/Animations/animation").Animation[];
  26472. private _scene;
  26473. private _positions;
  26474. private _normals;
  26475. private _tangents;
  26476. private _uvs;
  26477. private _influence;
  26478. private _uniqueId;
  26479. /**
  26480. * Observable raised when the influence changes
  26481. */
  26482. onInfluenceChanged: Observable<boolean>;
  26483. /** @hidden */
  26484. _onDataLayoutChanged: Observable<void>;
  26485. /**
  26486. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  26487. */
  26488. get influence(): number;
  26489. set influence(influence: number);
  26490. /**
  26491. * Gets or sets the id of the morph Target
  26492. */
  26493. id: string;
  26494. private _animationPropertiesOverride;
  26495. /**
  26496. * Gets or sets the animation properties override
  26497. */
  26498. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  26499. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  26500. /**
  26501. * Creates a new MorphTarget
  26502. * @param name defines the name of the target
  26503. * @param influence defines the influence to use
  26504. * @param scene defines the scene the morphtarget belongs to
  26505. */
  26506. constructor(
  26507. /** defines the name of the target */
  26508. name: string, influence?: number, scene?: Nullable<Scene>);
  26509. /**
  26510. * Gets the unique ID of this manager
  26511. */
  26512. get uniqueId(): number;
  26513. /**
  26514. * Gets a boolean defining if the target contains position data
  26515. */
  26516. get hasPositions(): boolean;
  26517. /**
  26518. * Gets a boolean defining if the target contains normal data
  26519. */
  26520. get hasNormals(): boolean;
  26521. /**
  26522. * Gets a boolean defining if the target contains tangent data
  26523. */
  26524. get hasTangents(): boolean;
  26525. /**
  26526. * Gets a boolean defining if the target contains texture coordinates data
  26527. */
  26528. get hasUVs(): boolean;
  26529. /**
  26530. * Affects position data to this target
  26531. * @param data defines the position data to use
  26532. */
  26533. setPositions(data: Nullable<FloatArray>): void;
  26534. /**
  26535. * Gets the position data stored in this target
  26536. * @returns a FloatArray containing the position data (or null if not present)
  26537. */
  26538. getPositions(): Nullable<FloatArray>;
  26539. /**
  26540. * Affects normal data to this target
  26541. * @param data defines the normal data to use
  26542. */
  26543. setNormals(data: Nullable<FloatArray>): void;
  26544. /**
  26545. * Gets the normal data stored in this target
  26546. * @returns a FloatArray containing the normal data (or null if not present)
  26547. */
  26548. getNormals(): Nullable<FloatArray>;
  26549. /**
  26550. * Affects tangent data to this target
  26551. * @param data defines the tangent data to use
  26552. */
  26553. setTangents(data: Nullable<FloatArray>): void;
  26554. /**
  26555. * Gets the tangent data stored in this target
  26556. * @returns a FloatArray containing the tangent data (or null if not present)
  26557. */
  26558. getTangents(): Nullable<FloatArray>;
  26559. /**
  26560. * Affects texture coordinates data to this target
  26561. * @param data defines the texture coordinates data to use
  26562. */
  26563. setUVs(data: Nullable<FloatArray>): void;
  26564. /**
  26565. * Gets the texture coordinates data stored in this target
  26566. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  26567. */
  26568. getUVs(): Nullable<FloatArray>;
  26569. /**
  26570. * Clone the current target
  26571. * @returns a new MorphTarget
  26572. */
  26573. clone(): MorphTarget;
  26574. /**
  26575. * Serializes the current target into a Serialization object
  26576. * @returns the serialized object
  26577. */
  26578. serialize(): any;
  26579. /**
  26580. * Returns the string "MorphTarget"
  26581. * @returns "MorphTarget"
  26582. */
  26583. getClassName(): string;
  26584. /**
  26585. * Creates a new target from serialized data
  26586. * @param serializationObject defines the serialized data to use
  26587. * @returns a new MorphTarget
  26588. */
  26589. static Parse(serializationObject: any): MorphTarget;
  26590. /**
  26591. * Creates a MorphTarget from mesh data
  26592. * @param mesh defines the source mesh
  26593. * @param name defines the name to use for the new target
  26594. * @param influence defines the influence to attach to the target
  26595. * @returns a new MorphTarget
  26596. */
  26597. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  26598. }
  26599. }
  26600. declare module "babylonjs/Morph/morphTargetManager" {
  26601. import { Nullable } from "babylonjs/types";
  26602. import { Scene } from "babylonjs/scene";
  26603. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  26604. /**
  26605. * This class is used to deform meshes using morphing between different targets
  26606. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  26607. */
  26608. export class MorphTargetManager {
  26609. private _targets;
  26610. private _targetInfluenceChangedObservers;
  26611. private _targetDataLayoutChangedObservers;
  26612. private _activeTargets;
  26613. private _scene;
  26614. private _influences;
  26615. private _supportsNormals;
  26616. private _supportsTangents;
  26617. private _supportsUVs;
  26618. private _vertexCount;
  26619. private _uniqueId;
  26620. private _tempInfluences;
  26621. /**
  26622. * Gets or sets a boolean indicating if normals must be morphed
  26623. */
  26624. enableNormalMorphing: boolean;
  26625. /**
  26626. * Gets or sets a boolean indicating if tangents must be morphed
  26627. */
  26628. enableTangentMorphing: boolean;
  26629. /**
  26630. * Gets or sets a boolean indicating if UV must be morphed
  26631. */
  26632. enableUVMorphing: boolean;
  26633. /**
  26634. * Creates a new MorphTargetManager
  26635. * @param scene defines the current scene
  26636. */
  26637. constructor(scene?: Nullable<Scene>);
  26638. /**
  26639. * Gets the unique ID of this manager
  26640. */
  26641. get uniqueId(): number;
  26642. /**
  26643. * Gets the number of vertices handled by this manager
  26644. */
  26645. get vertexCount(): number;
  26646. /**
  26647. * Gets a boolean indicating if this manager supports morphing of normals
  26648. */
  26649. get supportsNormals(): boolean;
  26650. /**
  26651. * Gets a boolean indicating if this manager supports morphing of tangents
  26652. */
  26653. get supportsTangents(): boolean;
  26654. /**
  26655. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  26656. */
  26657. get supportsUVs(): boolean;
  26658. /**
  26659. * Gets the number of targets stored in this manager
  26660. */
  26661. get numTargets(): number;
  26662. /**
  26663. * Gets the number of influencers (ie. the number of targets with influences > 0)
  26664. */
  26665. get numInfluencers(): number;
  26666. /**
  26667. * Gets the list of influences (one per target)
  26668. */
  26669. get influences(): Float32Array;
  26670. /**
  26671. * Gets the active target at specified index. An active target is a target with an influence > 0
  26672. * @param index defines the index to check
  26673. * @returns the requested target
  26674. */
  26675. getActiveTarget(index: number): MorphTarget;
  26676. /**
  26677. * Gets the target at specified index
  26678. * @param index defines the index to check
  26679. * @returns the requested target
  26680. */
  26681. getTarget(index: number): MorphTarget;
  26682. /**
  26683. * Add a new target to this manager
  26684. * @param target defines the target to add
  26685. */
  26686. addTarget(target: MorphTarget): void;
  26687. /**
  26688. * Removes a target from the manager
  26689. * @param target defines the target to remove
  26690. */
  26691. removeTarget(target: MorphTarget): void;
  26692. /**
  26693. * Clone the current manager
  26694. * @returns a new MorphTargetManager
  26695. */
  26696. clone(): MorphTargetManager;
  26697. /**
  26698. * Serializes the current manager into a Serialization object
  26699. * @returns the serialized object
  26700. */
  26701. serialize(): any;
  26702. private _syncActiveTargets;
  26703. /**
  26704. * Syncrhonize the targets with all the meshes using this morph target manager
  26705. */
  26706. synchronize(): void;
  26707. /**
  26708. * Creates a new MorphTargetManager from serialized data
  26709. * @param serializationObject defines the serialized data
  26710. * @param scene defines the hosting scene
  26711. * @returns the new MorphTargetManager
  26712. */
  26713. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  26714. }
  26715. }
  26716. declare module "babylonjs/Meshes/meshLODLevel" {
  26717. import { Mesh } from "babylonjs/Meshes/mesh";
  26718. import { Nullable } from "babylonjs/types";
  26719. /**
  26720. * Class used to represent a specific level of detail of a mesh
  26721. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  26722. */
  26723. export class MeshLODLevel {
  26724. /** Defines the distance where this level should start being displayed */
  26725. distance: number;
  26726. /** Defines the mesh to use to render this level */
  26727. mesh: Nullable<Mesh>;
  26728. /**
  26729. * Creates a new LOD level
  26730. * @param distance defines the distance where this level should star being displayed
  26731. * @param mesh defines the mesh to use to render this level
  26732. */
  26733. constructor(
  26734. /** Defines the distance where this level should start being displayed */
  26735. distance: number,
  26736. /** Defines the mesh to use to render this level */
  26737. mesh: Nullable<Mesh>);
  26738. }
  26739. }
  26740. declare module "babylonjs/Misc/canvasGenerator" {
  26741. /**
  26742. * Helper class used to generate a canvas to manipulate images
  26743. */
  26744. export class CanvasGenerator {
  26745. /**
  26746. * Create a new canvas (or offscreen canvas depending on the context)
  26747. * @param width defines the expected width
  26748. * @param height defines the expected height
  26749. * @return a new canvas or offscreen canvas
  26750. */
  26751. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  26752. }
  26753. }
  26754. declare module "babylonjs/Meshes/groundMesh" {
  26755. import { Scene } from "babylonjs/scene";
  26756. import { Vector3 } from "babylonjs/Maths/math.vector";
  26757. import { Mesh } from "babylonjs/Meshes/mesh";
  26758. /**
  26759. * Mesh representing the gorund
  26760. */
  26761. export class GroundMesh extends Mesh {
  26762. /** If octree should be generated */
  26763. generateOctree: boolean;
  26764. private _heightQuads;
  26765. /** @hidden */
  26766. _subdivisionsX: number;
  26767. /** @hidden */
  26768. _subdivisionsY: number;
  26769. /** @hidden */
  26770. _width: number;
  26771. /** @hidden */
  26772. _height: number;
  26773. /** @hidden */
  26774. _minX: number;
  26775. /** @hidden */
  26776. _maxX: number;
  26777. /** @hidden */
  26778. _minZ: number;
  26779. /** @hidden */
  26780. _maxZ: number;
  26781. constructor(name: string, scene: Scene);
  26782. /**
  26783. * "GroundMesh"
  26784. * @returns "GroundMesh"
  26785. */
  26786. getClassName(): string;
  26787. /**
  26788. * The minimum of x and y subdivisions
  26789. */
  26790. get subdivisions(): number;
  26791. /**
  26792. * X subdivisions
  26793. */
  26794. get subdivisionsX(): number;
  26795. /**
  26796. * Y subdivisions
  26797. */
  26798. get subdivisionsY(): number;
  26799. /**
  26800. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  26801. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  26802. * @param chunksCount the number of subdivisions for x and y
  26803. * @param octreeBlocksSize (Default: 32)
  26804. */
  26805. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  26806. /**
  26807. * Returns a height (y) value in the Worl system :
  26808. * the ground altitude at the coordinates (x, z) expressed in the World system.
  26809. * @param x x coordinate
  26810. * @param z z coordinate
  26811. * @returns the ground y position if (x, z) are outside the ground surface.
  26812. */
  26813. getHeightAtCoordinates(x: number, z: number): number;
  26814. /**
  26815. * Returns a normalized vector (Vector3) orthogonal to the ground
  26816. * at the ground coordinates (x, z) expressed in the World system.
  26817. * @param x x coordinate
  26818. * @param z z coordinate
  26819. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  26820. */
  26821. getNormalAtCoordinates(x: number, z: number): Vector3;
  26822. /**
  26823. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  26824. * at the ground coordinates (x, z) expressed in the World system.
  26825. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  26826. * @param x x coordinate
  26827. * @param z z coordinate
  26828. * @param ref vector to store the result
  26829. * @returns the GroundMesh.
  26830. */
  26831. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  26832. /**
  26833. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  26834. * if the ground has been updated.
  26835. * This can be used in the render loop.
  26836. * @returns the GroundMesh.
  26837. */
  26838. updateCoordinateHeights(): GroundMesh;
  26839. private _getFacetAt;
  26840. private _initHeightQuads;
  26841. private _computeHeightQuads;
  26842. /**
  26843. * Serializes this ground mesh
  26844. * @param serializationObject object to write serialization to
  26845. */
  26846. serialize(serializationObject: any): void;
  26847. /**
  26848. * Parses a serialized ground mesh
  26849. * @param parsedMesh the serialized mesh
  26850. * @param scene the scene to create the ground mesh in
  26851. * @returns the created ground mesh
  26852. */
  26853. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  26854. }
  26855. }
  26856. declare module "babylonjs/Physics/physicsJoint" {
  26857. import { Vector3 } from "babylonjs/Maths/math.vector";
  26858. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  26859. /**
  26860. * Interface for Physics-Joint data
  26861. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  26862. */
  26863. export interface PhysicsJointData {
  26864. /**
  26865. * The main pivot of the joint
  26866. */
  26867. mainPivot?: Vector3;
  26868. /**
  26869. * The connected pivot of the joint
  26870. */
  26871. connectedPivot?: Vector3;
  26872. /**
  26873. * The main axis of the joint
  26874. */
  26875. mainAxis?: Vector3;
  26876. /**
  26877. * The connected axis of the joint
  26878. */
  26879. connectedAxis?: Vector3;
  26880. /**
  26881. * The collision of the joint
  26882. */
  26883. collision?: boolean;
  26884. /**
  26885. * Native Oimo/Cannon/Energy data
  26886. */
  26887. nativeParams?: any;
  26888. }
  26889. /**
  26890. * This is a holder class for the physics joint created by the physics plugin
  26891. * It holds a set of functions to control the underlying joint
  26892. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  26893. */
  26894. export class PhysicsJoint {
  26895. /**
  26896. * The type of the physics joint
  26897. */
  26898. type: number;
  26899. /**
  26900. * The data for the physics joint
  26901. */
  26902. jointData: PhysicsJointData;
  26903. private _physicsJoint;
  26904. protected _physicsPlugin: IPhysicsEnginePlugin;
  26905. /**
  26906. * Initializes the physics joint
  26907. * @param type The type of the physics joint
  26908. * @param jointData The data for the physics joint
  26909. */
  26910. constructor(
  26911. /**
  26912. * The type of the physics joint
  26913. */
  26914. type: number,
  26915. /**
  26916. * The data for the physics joint
  26917. */
  26918. jointData: PhysicsJointData);
  26919. /**
  26920. * Gets the physics joint
  26921. */
  26922. get physicsJoint(): any;
  26923. /**
  26924. * Sets the physics joint
  26925. */
  26926. set physicsJoint(newJoint: any);
  26927. /**
  26928. * Sets the physics plugin
  26929. */
  26930. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  26931. /**
  26932. * Execute a function that is physics-plugin specific.
  26933. * @param {Function} func the function that will be executed.
  26934. * It accepts two parameters: the physics world and the physics joint
  26935. */
  26936. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  26937. /**
  26938. * Distance-Joint type
  26939. */
  26940. static DistanceJoint: number;
  26941. /**
  26942. * Hinge-Joint type
  26943. */
  26944. static HingeJoint: number;
  26945. /**
  26946. * Ball-and-Socket joint type
  26947. */
  26948. static BallAndSocketJoint: number;
  26949. /**
  26950. * Wheel-Joint type
  26951. */
  26952. static WheelJoint: number;
  26953. /**
  26954. * Slider-Joint type
  26955. */
  26956. static SliderJoint: number;
  26957. /**
  26958. * Prismatic-Joint type
  26959. */
  26960. static PrismaticJoint: number;
  26961. /**
  26962. * Universal-Joint type
  26963. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  26964. */
  26965. static UniversalJoint: number;
  26966. /**
  26967. * Hinge-Joint 2 type
  26968. */
  26969. static Hinge2Joint: number;
  26970. /**
  26971. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  26972. */
  26973. static PointToPointJoint: number;
  26974. /**
  26975. * Spring-Joint type
  26976. */
  26977. static SpringJoint: number;
  26978. /**
  26979. * Lock-Joint type
  26980. */
  26981. static LockJoint: number;
  26982. }
  26983. /**
  26984. * A class representing a physics distance joint
  26985. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  26986. */
  26987. export class DistanceJoint extends PhysicsJoint {
  26988. /**
  26989. *
  26990. * @param jointData The data for the Distance-Joint
  26991. */
  26992. constructor(jointData: DistanceJointData);
  26993. /**
  26994. * Update the predefined distance.
  26995. * @param maxDistance The maximum preferred distance
  26996. * @param minDistance The minimum preferred distance
  26997. */
  26998. updateDistance(maxDistance: number, minDistance?: number): void;
  26999. }
  27000. /**
  27001. * Represents a Motor-Enabled Joint
  27002. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27003. */
  27004. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  27005. /**
  27006. * Initializes the Motor-Enabled Joint
  27007. * @param type The type of the joint
  27008. * @param jointData The physica joint data for the joint
  27009. */
  27010. constructor(type: number, jointData: PhysicsJointData);
  27011. /**
  27012. * Set the motor values.
  27013. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27014. * @param force the force to apply
  27015. * @param maxForce max force for this motor.
  27016. */
  27017. setMotor(force?: number, maxForce?: number): void;
  27018. /**
  27019. * Set the motor's limits.
  27020. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27021. * @param upperLimit The upper limit of the motor
  27022. * @param lowerLimit The lower limit of the motor
  27023. */
  27024. setLimit(upperLimit: number, lowerLimit?: number): void;
  27025. }
  27026. /**
  27027. * This class represents a single physics Hinge-Joint
  27028. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27029. */
  27030. export class HingeJoint extends MotorEnabledJoint {
  27031. /**
  27032. * Initializes the Hinge-Joint
  27033. * @param jointData The joint data for the Hinge-Joint
  27034. */
  27035. constructor(jointData: PhysicsJointData);
  27036. /**
  27037. * Set the motor values.
  27038. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27039. * @param {number} force the force to apply
  27040. * @param {number} maxForce max force for this motor.
  27041. */
  27042. setMotor(force?: number, maxForce?: number): void;
  27043. /**
  27044. * Set the motor's limits.
  27045. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27046. * @param upperLimit The upper limit of the motor
  27047. * @param lowerLimit The lower limit of the motor
  27048. */
  27049. setLimit(upperLimit: number, lowerLimit?: number): void;
  27050. }
  27051. /**
  27052. * This class represents a dual hinge physics joint (same as wheel joint)
  27053. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27054. */
  27055. export class Hinge2Joint extends MotorEnabledJoint {
  27056. /**
  27057. * Initializes the Hinge2-Joint
  27058. * @param jointData The joint data for the Hinge2-Joint
  27059. */
  27060. constructor(jointData: PhysicsJointData);
  27061. /**
  27062. * Set the motor values.
  27063. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27064. * @param {number} targetSpeed the speed the motor is to reach
  27065. * @param {number} maxForce max force for this motor.
  27066. * @param {motorIndex} the motor's index, 0 or 1.
  27067. */
  27068. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  27069. /**
  27070. * Set the motor limits.
  27071. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27072. * @param {number} upperLimit the upper limit
  27073. * @param {number} lowerLimit lower limit
  27074. * @param {motorIndex} the motor's index, 0 or 1.
  27075. */
  27076. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  27077. }
  27078. /**
  27079. * Interface for a motor enabled joint
  27080. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27081. */
  27082. export interface IMotorEnabledJoint {
  27083. /**
  27084. * Physics joint
  27085. */
  27086. physicsJoint: any;
  27087. /**
  27088. * Sets the motor of the motor-enabled joint
  27089. * @param force The force of the motor
  27090. * @param maxForce The maximum force of the motor
  27091. * @param motorIndex The index of the motor
  27092. */
  27093. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  27094. /**
  27095. * Sets the limit of the motor
  27096. * @param upperLimit The upper limit of the motor
  27097. * @param lowerLimit The lower limit of the motor
  27098. * @param motorIndex The index of the motor
  27099. */
  27100. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  27101. }
  27102. /**
  27103. * Joint data for a Distance-Joint
  27104. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27105. */
  27106. export interface DistanceJointData extends PhysicsJointData {
  27107. /**
  27108. * Max distance the 2 joint objects can be apart
  27109. */
  27110. maxDistance: number;
  27111. }
  27112. /**
  27113. * Joint data from a spring joint
  27114. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27115. */
  27116. export interface SpringJointData extends PhysicsJointData {
  27117. /**
  27118. * Length of the spring
  27119. */
  27120. length: number;
  27121. /**
  27122. * Stiffness of the spring
  27123. */
  27124. stiffness: number;
  27125. /**
  27126. * Damping of the spring
  27127. */
  27128. damping: number;
  27129. /** this callback will be called when applying the force to the impostors. */
  27130. forceApplicationCallback: () => void;
  27131. }
  27132. }
  27133. declare module "babylonjs/Physics/physicsRaycastResult" {
  27134. import { Vector3 } from "babylonjs/Maths/math.vector";
  27135. /**
  27136. * Holds the data for the raycast result
  27137. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27138. */
  27139. export class PhysicsRaycastResult {
  27140. private _hasHit;
  27141. private _hitDistance;
  27142. private _hitNormalWorld;
  27143. private _hitPointWorld;
  27144. private _rayFromWorld;
  27145. private _rayToWorld;
  27146. /**
  27147. * Gets if there was a hit
  27148. */
  27149. get hasHit(): boolean;
  27150. /**
  27151. * Gets the distance from the hit
  27152. */
  27153. get hitDistance(): number;
  27154. /**
  27155. * Gets the hit normal/direction in the world
  27156. */
  27157. get hitNormalWorld(): Vector3;
  27158. /**
  27159. * Gets the hit point in the world
  27160. */
  27161. get hitPointWorld(): Vector3;
  27162. /**
  27163. * Gets the ray "start point" of the ray in the world
  27164. */
  27165. get rayFromWorld(): Vector3;
  27166. /**
  27167. * Gets the ray "end point" of the ray in the world
  27168. */
  27169. get rayToWorld(): Vector3;
  27170. /**
  27171. * Sets the hit data (normal & point in world space)
  27172. * @param hitNormalWorld defines the normal in world space
  27173. * @param hitPointWorld defines the point in world space
  27174. */
  27175. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  27176. /**
  27177. * Sets the distance from the start point to the hit point
  27178. * @param distance
  27179. */
  27180. setHitDistance(distance: number): void;
  27181. /**
  27182. * Calculates the distance manually
  27183. */
  27184. calculateHitDistance(): void;
  27185. /**
  27186. * Resets all the values to default
  27187. * @param from The from point on world space
  27188. * @param to The to point on world space
  27189. */
  27190. reset(from?: Vector3, to?: Vector3): void;
  27191. }
  27192. /**
  27193. * Interface for the size containing width and height
  27194. */
  27195. interface IXYZ {
  27196. /**
  27197. * X
  27198. */
  27199. x: number;
  27200. /**
  27201. * Y
  27202. */
  27203. y: number;
  27204. /**
  27205. * Z
  27206. */
  27207. z: number;
  27208. }
  27209. }
  27210. declare module "babylonjs/Physics/IPhysicsEngine" {
  27211. import { Nullable } from "babylonjs/types";
  27212. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  27213. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27214. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  27215. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  27216. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  27217. /**
  27218. * Interface used to describe a physics joint
  27219. */
  27220. export interface PhysicsImpostorJoint {
  27221. /** Defines the main impostor to which the joint is linked */
  27222. mainImpostor: PhysicsImpostor;
  27223. /** Defines the impostor that is connected to the main impostor using this joint */
  27224. connectedImpostor: PhysicsImpostor;
  27225. /** Defines the joint itself */
  27226. joint: PhysicsJoint;
  27227. }
  27228. /** @hidden */
  27229. export interface IPhysicsEnginePlugin {
  27230. world: any;
  27231. name: string;
  27232. setGravity(gravity: Vector3): void;
  27233. setTimeStep(timeStep: number): void;
  27234. getTimeStep(): number;
  27235. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  27236. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  27237. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  27238. generatePhysicsBody(impostor: PhysicsImpostor): void;
  27239. removePhysicsBody(impostor: PhysicsImpostor): void;
  27240. generateJoint(joint: PhysicsImpostorJoint): void;
  27241. removeJoint(joint: PhysicsImpostorJoint): void;
  27242. isSupported(): boolean;
  27243. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  27244. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  27245. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  27246. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  27247. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  27248. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  27249. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  27250. getBodyMass(impostor: PhysicsImpostor): number;
  27251. getBodyFriction(impostor: PhysicsImpostor): number;
  27252. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  27253. getBodyRestitution(impostor: PhysicsImpostor): number;
  27254. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  27255. getBodyPressure?(impostor: PhysicsImpostor): number;
  27256. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  27257. getBodyStiffness?(impostor: PhysicsImpostor): number;
  27258. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  27259. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  27260. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  27261. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  27262. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  27263. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  27264. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  27265. sleepBody(impostor: PhysicsImpostor): void;
  27266. wakeUpBody(impostor: PhysicsImpostor): void;
  27267. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  27268. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  27269. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  27270. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  27271. getRadius(impostor: PhysicsImpostor): number;
  27272. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  27273. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  27274. dispose(): void;
  27275. }
  27276. /**
  27277. * Interface used to define a physics engine
  27278. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  27279. */
  27280. export interface IPhysicsEngine {
  27281. /**
  27282. * Gets the gravity vector used by the simulation
  27283. */
  27284. gravity: Vector3;
  27285. /**
  27286. * Sets the gravity vector used by the simulation
  27287. * @param gravity defines the gravity vector to use
  27288. */
  27289. setGravity(gravity: Vector3): void;
  27290. /**
  27291. * Set the time step of the physics engine.
  27292. * Default is 1/60.
  27293. * To slow it down, enter 1/600 for example.
  27294. * To speed it up, 1/30
  27295. * @param newTimeStep the new timestep to apply to this world.
  27296. */
  27297. setTimeStep(newTimeStep: number): void;
  27298. /**
  27299. * Get the time step of the physics engine.
  27300. * @returns the current time step
  27301. */
  27302. getTimeStep(): number;
  27303. /**
  27304. * Set the sub time step of the physics engine.
  27305. * Default is 0 meaning there is no sub steps
  27306. * To increase physics resolution precision, set a small value (like 1 ms)
  27307. * @param subTimeStep defines the new sub timestep used for physics resolution.
  27308. */
  27309. setSubTimeStep(subTimeStep: number): void;
  27310. /**
  27311. * Get the sub time step of the physics engine.
  27312. * @returns the current sub time step
  27313. */
  27314. getSubTimeStep(): number;
  27315. /**
  27316. * Release all resources
  27317. */
  27318. dispose(): void;
  27319. /**
  27320. * Gets the name of the current physics plugin
  27321. * @returns the name of the plugin
  27322. */
  27323. getPhysicsPluginName(): string;
  27324. /**
  27325. * Adding a new impostor for the impostor tracking.
  27326. * This will be done by the impostor itself.
  27327. * @param impostor the impostor to add
  27328. */
  27329. addImpostor(impostor: PhysicsImpostor): void;
  27330. /**
  27331. * Remove an impostor from the engine.
  27332. * This impostor and its mesh will not longer be updated by the physics engine.
  27333. * @param impostor the impostor to remove
  27334. */
  27335. removeImpostor(impostor: PhysicsImpostor): void;
  27336. /**
  27337. * Add a joint to the physics engine
  27338. * @param mainImpostor defines the main impostor to which the joint is added.
  27339. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  27340. * @param joint defines the joint that will connect both impostors.
  27341. */
  27342. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  27343. /**
  27344. * Removes a joint from the simulation
  27345. * @param mainImpostor defines the impostor used with the joint
  27346. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  27347. * @param joint defines the joint to remove
  27348. */
  27349. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  27350. /**
  27351. * Gets the current plugin used to run the simulation
  27352. * @returns current plugin
  27353. */
  27354. getPhysicsPlugin(): IPhysicsEnginePlugin;
  27355. /**
  27356. * Gets the list of physic impostors
  27357. * @returns an array of PhysicsImpostor
  27358. */
  27359. getImpostors(): Array<PhysicsImpostor>;
  27360. /**
  27361. * Gets the impostor for a physics enabled object
  27362. * @param object defines the object impersonated by the impostor
  27363. * @returns the PhysicsImpostor or null if not found
  27364. */
  27365. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  27366. /**
  27367. * Gets the impostor for a physics body object
  27368. * @param body defines physics body used by the impostor
  27369. * @returns the PhysicsImpostor or null if not found
  27370. */
  27371. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  27372. /**
  27373. * Does a raycast in the physics world
  27374. * @param from when should the ray start?
  27375. * @param to when should the ray end?
  27376. * @returns PhysicsRaycastResult
  27377. */
  27378. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  27379. /**
  27380. * Called by the scene. No need to call it.
  27381. * @param delta defines the timespam between frames
  27382. */
  27383. _step(delta: number): void;
  27384. }
  27385. }
  27386. declare module "babylonjs/Physics/physicsImpostor" {
  27387. import { Nullable, IndicesArray } from "babylonjs/types";
  27388. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  27389. import { TransformNode } from "babylonjs/Meshes/transformNode";
  27390. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27391. import { Scene } from "babylonjs/scene";
  27392. import { Bone } from "babylonjs/Bones/bone";
  27393. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  27394. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  27395. import { Space } from "babylonjs/Maths/math.axis";
  27396. /**
  27397. * The interface for the physics imposter parameters
  27398. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27399. */
  27400. export interface PhysicsImpostorParameters {
  27401. /**
  27402. * The mass of the physics imposter
  27403. */
  27404. mass: number;
  27405. /**
  27406. * The friction of the physics imposter
  27407. */
  27408. friction?: number;
  27409. /**
  27410. * The coefficient of restitution of the physics imposter
  27411. */
  27412. restitution?: number;
  27413. /**
  27414. * The native options of the physics imposter
  27415. */
  27416. nativeOptions?: any;
  27417. /**
  27418. * Specifies if the parent should be ignored
  27419. */
  27420. ignoreParent?: boolean;
  27421. /**
  27422. * Specifies if bi-directional transformations should be disabled
  27423. */
  27424. disableBidirectionalTransformation?: boolean;
  27425. /**
  27426. * The pressure inside the physics imposter, soft object only
  27427. */
  27428. pressure?: number;
  27429. /**
  27430. * The stiffness the physics imposter, soft object only
  27431. */
  27432. stiffness?: number;
  27433. /**
  27434. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  27435. */
  27436. velocityIterations?: number;
  27437. /**
  27438. * The number of iterations used in maintaining consistent vertex positions, soft object only
  27439. */
  27440. positionIterations?: number;
  27441. /**
  27442. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  27443. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  27444. * Add to fix multiple points
  27445. */
  27446. fixedPoints?: number;
  27447. /**
  27448. * The collision margin around a soft object
  27449. */
  27450. margin?: number;
  27451. /**
  27452. * The collision margin around a soft object
  27453. */
  27454. damping?: number;
  27455. /**
  27456. * The path for a rope based on an extrusion
  27457. */
  27458. path?: any;
  27459. /**
  27460. * The shape of an extrusion used for a rope based on an extrusion
  27461. */
  27462. shape?: any;
  27463. }
  27464. /**
  27465. * Interface for a physics-enabled object
  27466. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27467. */
  27468. export interface IPhysicsEnabledObject {
  27469. /**
  27470. * The position of the physics-enabled object
  27471. */
  27472. position: Vector3;
  27473. /**
  27474. * The rotation of the physics-enabled object
  27475. */
  27476. rotationQuaternion: Nullable<Quaternion>;
  27477. /**
  27478. * The scale of the physics-enabled object
  27479. */
  27480. scaling: Vector3;
  27481. /**
  27482. * The rotation of the physics-enabled object
  27483. */
  27484. rotation?: Vector3;
  27485. /**
  27486. * The parent of the physics-enabled object
  27487. */
  27488. parent?: any;
  27489. /**
  27490. * The bounding info of the physics-enabled object
  27491. * @returns The bounding info of the physics-enabled object
  27492. */
  27493. getBoundingInfo(): BoundingInfo;
  27494. /**
  27495. * Computes the world matrix
  27496. * @param force Specifies if the world matrix should be computed by force
  27497. * @returns A world matrix
  27498. */
  27499. computeWorldMatrix(force: boolean): Matrix;
  27500. /**
  27501. * Gets the world matrix
  27502. * @returns A world matrix
  27503. */
  27504. getWorldMatrix?(): Matrix;
  27505. /**
  27506. * Gets the child meshes
  27507. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  27508. * @returns An array of abstract meshes
  27509. */
  27510. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  27511. /**
  27512. * Gets the vertex data
  27513. * @param kind The type of vertex data
  27514. * @returns A nullable array of numbers, or a float32 array
  27515. */
  27516. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  27517. /**
  27518. * Gets the indices from the mesh
  27519. * @returns A nullable array of index arrays
  27520. */
  27521. getIndices?(): Nullable<IndicesArray>;
  27522. /**
  27523. * Gets the scene from the mesh
  27524. * @returns the indices array or null
  27525. */
  27526. getScene?(): Scene;
  27527. /**
  27528. * Gets the absolute position from the mesh
  27529. * @returns the absolute position
  27530. */
  27531. getAbsolutePosition(): Vector3;
  27532. /**
  27533. * Gets the absolute pivot point from the mesh
  27534. * @returns the absolute pivot point
  27535. */
  27536. getAbsolutePivotPoint(): Vector3;
  27537. /**
  27538. * Rotates the mesh
  27539. * @param axis The axis of rotation
  27540. * @param amount The amount of rotation
  27541. * @param space The space of the rotation
  27542. * @returns The rotation transform node
  27543. */
  27544. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  27545. /**
  27546. * Translates the mesh
  27547. * @param axis The axis of translation
  27548. * @param distance The distance of translation
  27549. * @param space The space of the translation
  27550. * @returns The transform node
  27551. */
  27552. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  27553. /**
  27554. * Sets the absolute position of the mesh
  27555. * @param absolutePosition The absolute position of the mesh
  27556. * @returns The transform node
  27557. */
  27558. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  27559. /**
  27560. * Gets the class name of the mesh
  27561. * @returns The class name
  27562. */
  27563. getClassName(): string;
  27564. }
  27565. /**
  27566. * Represents a physics imposter
  27567. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27568. */
  27569. export class PhysicsImpostor {
  27570. /**
  27571. * The physics-enabled object used as the physics imposter
  27572. */
  27573. object: IPhysicsEnabledObject;
  27574. /**
  27575. * The type of the physics imposter
  27576. */
  27577. type: number;
  27578. private _options;
  27579. private _scene?;
  27580. /**
  27581. * The default object size of the imposter
  27582. */
  27583. static DEFAULT_OBJECT_SIZE: Vector3;
  27584. /**
  27585. * The identity quaternion of the imposter
  27586. */
  27587. static IDENTITY_QUATERNION: Quaternion;
  27588. /** @hidden */
  27589. _pluginData: any;
  27590. private _physicsEngine;
  27591. private _physicsBody;
  27592. private _bodyUpdateRequired;
  27593. private _onBeforePhysicsStepCallbacks;
  27594. private _onAfterPhysicsStepCallbacks;
  27595. /** @hidden */
  27596. _onPhysicsCollideCallbacks: Array<{
  27597. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  27598. otherImpostors: Array<PhysicsImpostor>;
  27599. }>;
  27600. private _deltaPosition;
  27601. private _deltaRotation;
  27602. private _deltaRotationConjugated;
  27603. /** @hidden */
  27604. _isFromLine: boolean;
  27605. private _parent;
  27606. private _isDisposed;
  27607. private static _tmpVecs;
  27608. private static _tmpQuat;
  27609. /**
  27610. * Specifies if the physics imposter is disposed
  27611. */
  27612. get isDisposed(): boolean;
  27613. /**
  27614. * Gets the mass of the physics imposter
  27615. */
  27616. get mass(): number;
  27617. set mass(value: number);
  27618. /**
  27619. * Gets the coefficient of friction
  27620. */
  27621. get friction(): number;
  27622. /**
  27623. * Sets the coefficient of friction
  27624. */
  27625. set friction(value: number);
  27626. /**
  27627. * Gets the coefficient of restitution
  27628. */
  27629. get restitution(): number;
  27630. /**
  27631. * Sets the coefficient of restitution
  27632. */
  27633. set restitution(value: number);
  27634. /**
  27635. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  27636. */
  27637. get pressure(): number;
  27638. /**
  27639. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  27640. */
  27641. set pressure(value: number);
  27642. /**
  27643. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  27644. */
  27645. get stiffness(): number;
  27646. /**
  27647. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  27648. */
  27649. set stiffness(value: number);
  27650. /**
  27651. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  27652. */
  27653. get velocityIterations(): number;
  27654. /**
  27655. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  27656. */
  27657. set velocityIterations(value: number);
  27658. /**
  27659. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  27660. */
  27661. get positionIterations(): number;
  27662. /**
  27663. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  27664. */
  27665. set positionIterations(value: number);
  27666. /**
  27667. * The unique id of the physics imposter
  27668. * set by the physics engine when adding this impostor to the array
  27669. */
  27670. uniqueId: number;
  27671. /**
  27672. * @hidden
  27673. */
  27674. soft: boolean;
  27675. /**
  27676. * @hidden
  27677. */
  27678. segments: number;
  27679. private _joints;
  27680. /**
  27681. * Initializes the physics imposter
  27682. * @param object The physics-enabled object used as the physics imposter
  27683. * @param type The type of the physics imposter
  27684. * @param _options The options for the physics imposter
  27685. * @param _scene The Babylon scene
  27686. */
  27687. constructor(
  27688. /**
  27689. * The physics-enabled object used as the physics imposter
  27690. */
  27691. object: IPhysicsEnabledObject,
  27692. /**
  27693. * The type of the physics imposter
  27694. */
  27695. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  27696. /**
  27697. * This function will completly initialize this impostor.
  27698. * It will create a new body - but only if this mesh has no parent.
  27699. * If it has, this impostor will not be used other than to define the impostor
  27700. * of the child mesh.
  27701. * @hidden
  27702. */
  27703. _init(): void;
  27704. private _getPhysicsParent;
  27705. /**
  27706. * Should a new body be generated.
  27707. * @returns boolean specifying if body initialization is required
  27708. */
  27709. isBodyInitRequired(): boolean;
  27710. /**
  27711. * Sets the updated scaling
  27712. * @param updated Specifies if the scaling is updated
  27713. */
  27714. setScalingUpdated(): void;
  27715. /**
  27716. * Force a regeneration of this or the parent's impostor's body.
  27717. * Use under cautious - This will remove all joints already implemented.
  27718. */
  27719. forceUpdate(): void;
  27720. /**
  27721. * Gets the body that holds this impostor. Either its own, or its parent.
  27722. */
  27723. get physicsBody(): any;
  27724. /**
  27725. * Get the parent of the physics imposter
  27726. * @returns Physics imposter or null
  27727. */
  27728. get parent(): Nullable<PhysicsImpostor>;
  27729. /**
  27730. * Sets the parent of the physics imposter
  27731. */
  27732. set parent(value: Nullable<PhysicsImpostor>);
  27733. /**
  27734. * Set the physics body. Used mainly by the physics engine/plugin
  27735. */
  27736. set physicsBody(physicsBody: any);
  27737. /**
  27738. * Resets the update flags
  27739. */
  27740. resetUpdateFlags(): void;
  27741. /**
  27742. * Gets the object extend size
  27743. * @returns the object extend size
  27744. */
  27745. getObjectExtendSize(): Vector3;
  27746. /**
  27747. * Gets the object center
  27748. * @returns The object center
  27749. */
  27750. getObjectCenter(): Vector3;
  27751. /**
  27752. * Get a specific parameter from the options parameters
  27753. * @param paramName The object parameter name
  27754. * @returns The object parameter
  27755. */
  27756. getParam(paramName: string): any;
  27757. /**
  27758. * Sets a specific parameter in the options given to the physics plugin
  27759. * @param paramName The parameter name
  27760. * @param value The value of the parameter
  27761. */
  27762. setParam(paramName: string, value: number): void;
  27763. /**
  27764. * Specifically change the body's mass option. Won't recreate the physics body object
  27765. * @param mass The mass of the physics imposter
  27766. */
  27767. setMass(mass: number): void;
  27768. /**
  27769. * Gets the linear velocity
  27770. * @returns linear velocity or null
  27771. */
  27772. getLinearVelocity(): Nullable<Vector3>;
  27773. /**
  27774. * Sets the linear velocity
  27775. * @param velocity linear velocity or null
  27776. */
  27777. setLinearVelocity(velocity: Nullable<Vector3>): void;
  27778. /**
  27779. * Gets the angular velocity
  27780. * @returns angular velocity or null
  27781. */
  27782. getAngularVelocity(): Nullable<Vector3>;
  27783. /**
  27784. * Sets the angular velocity
  27785. * @param velocity The velocity or null
  27786. */
  27787. setAngularVelocity(velocity: Nullable<Vector3>): void;
  27788. /**
  27789. * Execute a function with the physics plugin native code
  27790. * Provide a function the will have two variables - the world object and the physics body object
  27791. * @param func The function to execute with the physics plugin native code
  27792. */
  27793. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  27794. /**
  27795. * Register a function that will be executed before the physics world is stepping forward
  27796. * @param func The function to execute before the physics world is stepped forward
  27797. */
  27798. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  27799. /**
  27800. * Unregister a function that will be executed before the physics world is stepping forward
  27801. * @param func The function to execute before the physics world is stepped forward
  27802. */
  27803. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  27804. /**
  27805. * Register a function that will be executed after the physics step
  27806. * @param func The function to execute after physics step
  27807. */
  27808. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  27809. /**
  27810. * Unregisters a function that will be executed after the physics step
  27811. * @param func The function to execute after physics step
  27812. */
  27813. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  27814. /**
  27815. * register a function that will be executed when this impostor collides against a different body
  27816. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  27817. * @param func Callback that is executed on collision
  27818. */
  27819. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  27820. /**
  27821. * Unregisters the physics imposter on contact
  27822. * @param collideAgainst The physics object to collide against
  27823. * @param func Callback to execute on collision
  27824. */
  27825. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  27826. private _tmpQuat;
  27827. private _tmpQuat2;
  27828. /**
  27829. * Get the parent rotation
  27830. * @returns The parent rotation
  27831. */
  27832. getParentsRotation(): Quaternion;
  27833. /**
  27834. * this function is executed by the physics engine.
  27835. */
  27836. beforeStep: () => void;
  27837. /**
  27838. * this function is executed by the physics engine
  27839. */
  27840. afterStep: () => void;
  27841. /**
  27842. * Legacy collision detection event support
  27843. */
  27844. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  27845. /**
  27846. * event and body object due to cannon's event-based architecture.
  27847. */
  27848. onCollide: (e: {
  27849. body: any;
  27850. }) => void;
  27851. /**
  27852. * Apply a force
  27853. * @param force The force to apply
  27854. * @param contactPoint The contact point for the force
  27855. * @returns The physics imposter
  27856. */
  27857. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  27858. /**
  27859. * Apply an impulse
  27860. * @param force The impulse force
  27861. * @param contactPoint The contact point for the impulse force
  27862. * @returns The physics imposter
  27863. */
  27864. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  27865. /**
  27866. * A help function to create a joint
  27867. * @param otherImpostor A physics imposter used to create a joint
  27868. * @param jointType The type of joint
  27869. * @param jointData The data for the joint
  27870. * @returns The physics imposter
  27871. */
  27872. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  27873. /**
  27874. * Add a joint to this impostor with a different impostor
  27875. * @param otherImpostor A physics imposter used to add a joint
  27876. * @param joint The joint to add
  27877. * @returns The physics imposter
  27878. */
  27879. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  27880. /**
  27881. * Add an anchor to a cloth impostor
  27882. * @param otherImpostor rigid impostor to anchor to
  27883. * @param width ratio across width from 0 to 1
  27884. * @param height ratio up height from 0 to 1
  27885. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  27886. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  27887. * @returns impostor the soft imposter
  27888. */
  27889. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  27890. /**
  27891. * Add a hook to a rope impostor
  27892. * @param otherImpostor rigid impostor to anchor to
  27893. * @param length ratio across rope from 0 to 1
  27894. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  27895. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  27896. * @returns impostor the rope imposter
  27897. */
  27898. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  27899. /**
  27900. * Will keep this body still, in a sleep mode.
  27901. * @returns the physics imposter
  27902. */
  27903. sleep(): PhysicsImpostor;
  27904. /**
  27905. * Wake the body up.
  27906. * @returns The physics imposter
  27907. */
  27908. wakeUp(): PhysicsImpostor;
  27909. /**
  27910. * Clones the physics imposter
  27911. * @param newObject The physics imposter clones to this physics-enabled object
  27912. * @returns A nullable physics imposter
  27913. */
  27914. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  27915. /**
  27916. * Disposes the physics imposter
  27917. */
  27918. dispose(): void;
  27919. /**
  27920. * Sets the delta position
  27921. * @param position The delta position amount
  27922. */
  27923. setDeltaPosition(position: Vector3): void;
  27924. /**
  27925. * Sets the delta rotation
  27926. * @param rotation The delta rotation amount
  27927. */
  27928. setDeltaRotation(rotation: Quaternion): void;
  27929. /**
  27930. * Gets the box size of the physics imposter and stores the result in the input parameter
  27931. * @param result Stores the box size
  27932. * @returns The physics imposter
  27933. */
  27934. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  27935. /**
  27936. * Gets the radius of the physics imposter
  27937. * @returns Radius of the physics imposter
  27938. */
  27939. getRadius(): number;
  27940. /**
  27941. * Sync a bone with this impostor
  27942. * @param bone The bone to sync to the impostor.
  27943. * @param boneMesh The mesh that the bone is influencing.
  27944. * @param jointPivot The pivot of the joint / bone in local space.
  27945. * @param distToJoint Optional distance from the impostor to the joint.
  27946. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  27947. */
  27948. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  27949. /**
  27950. * Sync impostor to a bone
  27951. * @param bone The bone that the impostor will be synced to.
  27952. * @param boneMesh The mesh that the bone is influencing.
  27953. * @param jointPivot The pivot of the joint / bone in local space.
  27954. * @param distToJoint Optional distance from the impostor to the joint.
  27955. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  27956. * @param boneAxis Optional vector3 axis the bone is aligned with
  27957. */
  27958. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  27959. /**
  27960. * No-Imposter type
  27961. */
  27962. static NoImpostor: number;
  27963. /**
  27964. * Sphere-Imposter type
  27965. */
  27966. static SphereImpostor: number;
  27967. /**
  27968. * Box-Imposter type
  27969. */
  27970. static BoxImpostor: number;
  27971. /**
  27972. * Plane-Imposter type
  27973. */
  27974. static PlaneImpostor: number;
  27975. /**
  27976. * Mesh-imposter type
  27977. */
  27978. static MeshImpostor: number;
  27979. /**
  27980. * Capsule-Impostor type (Ammo.js plugin only)
  27981. */
  27982. static CapsuleImpostor: number;
  27983. /**
  27984. * Cylinder-Imposter type
  27985. */
  27986. static CylinderImpostor: number;
  27987. /**
  27988. * Particle-Imposter type
  27989. */
  27990. static ParticleImpostor: number;
  27991. /**
  27992. * Heightmap-Imposter type
  27993. */
  27994. static HeightmapImpostor: number;
  27995. /**
  27996. * ConvexHull-Impostor type (Ammo.js plugin only)
  27997. */
  27998. static ConvexHullImpostor: number;
  27999. /**
  28000. * Custom-Imposter type (Ammo.js plugin only)
  28001. */
  28002. static CustomImpostor: number;
  28003. /**
  28004. * Rope-Imposter type
  28005. */
  28006. static RopeImpostor: number;
  28007. /**
  28008. * Cloth-Imposter type
  28009. */
  28010. static ClothImpostor: number;
  28011. /**
  28012. * Softbody-Imposter type
  28013. */
  28014. static SoftbodyImpostor: number;
  28015. }
  28016. }
  28017. declare module "babylonjs/Meshes/mesh" {
  28018. import { Observable } from "babylonjs/Misc/observable";
  28019. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28020. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  28021. import { Camera } from "babylonjs/Cameras/camera";
  28022. import { Scene } from "babylonjs/scene";
  28023. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  28024. import { Color4 } from "babylonjs/Maths/math.color";
  28025. import { Engine } from "babylonjs/Engines/engine";
  28026. import { Node } from "babylonjs/node";
  28027. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  28028. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  28029. import { Buffer } from "babylonjs/Meshes/buffer";
  28030. import { Geometry } from "babylonjs/Meshes/geometry";
  28031. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28032. import { SubMesh } from "babylonjs/Meshes/subMesh";
  28033. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  28034. import { Effect } from "babylonjs/Materials/effect";
  28035. import { Material } from "babylonjs/Materials/material";
  28036. import { Skeleton } from "babylonjs/Bones/skeleton";
  28037. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  28038. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  28039. import { Path3D } from "babylonjs/Maths/math.path";
  28040. import { Plane } from "babylonjs/Maths/math.plane";
  28041. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28042. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  28043. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  28044. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  28045. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28046. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  28047. /**
  28048. * @hidden
  28049. **/
  28050. export class _CreationDataStorage {
  28051. closePath?: boolean;
  28052. closeArray?: boolean;
  28053. idx: number[];
  28054. dashSize: number;
  28055. gapSize: number;
  28056. path3D: Path3D;
  28057. pathArray: Vector3[][];
  28058. arc: number;
  28059. radius: number;
  28060. cap: number;
  28061. tessellation: number;
  28062. }
  28063. /**
  28064. * @hidden
  28065. **/
  28066. class _InstanceDataStorage {
  28067. visibleInstances: any;
  28068. batchCache: _InstancesBatch;
  28069. instancesBufferSize: number;
  28070. instancesBuffer: Nullable<Buffer>;
  28071. instancesData: Float32Array;
  28072. overridenInstanceCount: number;
  28073. isFrozen: boolean;
  28074. previousBatch: Nullable<_InstancesBatch>;
  28075. hardwareInstancedRendering: boolean;
  28076. sideOrientation: number;
  28077. manualUpdate: boolean;
  28078. }
  28079. /**
  28080. * @hidden
  28081. **/
  28082. export class _InstancesBatch {
  28083. mustReturn: boolean;
  28084. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  28085. renderSelf: boolean[];
  28086. hardwareInstancedRendering: boolean[];
  28087. }
  28088. /**
  28089. * @hidden
  28090. **/
  28091. class _ThinInstanceDataStorage {
  28092. instancesCount: number;
  28093. matrixBuffer: Nullable<Buffer>;
  28094. matrixBufferSize: number;
  28095. matrixData: Nullable<Float32Array>;
  28096. boundingVectors: Array<Vector3>;
  28097. }
  28098. /**
  28099. * Class used to represent renderable models
  28100. */
  28101. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  28102. /**
  28103. * Mesh side orientation : usually the external or front surface
  28104. */
  28105. static readonly FRONTSIDE: number;
  28106. /**
  28107. * Mesh side orientation : usually the internal or back surface
  28108. */
  28109. static readonly BACKSIDE: number;
  28110. /**
  28111. * Mesh side orientation : both internal and external or front and back surfaces
  28112. */
  28113. static readonly DOUBLESIDE: number;
  28114. /**
  28115. * Mesh side orientation : by default, `FRONTSIDE`
  28116. */
  28117. static readonly DEFAULTSIDE: number;
  28118. /**
  28119. * Mesh cap setting : no cap
  28120. */
  28121. static readonly NO_CAP: number;
  28122. /**
  28123. * Mesh cap setting : one cap at the beginning of the mesh
  28124. */
  28125. static readonly CAP_START: number;
  28126. /**
  28127. * Mesh cap setting : one cap at the end of the mesh
  28128. */
  28129. static readonly CAP_END: number;
  28130. /**
  28131. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  28132. */
  28133. static readonly CAP_ALL: number;
  28134. /**
  28135. * Mesh pattern setting : no flip or rotate
  28136. */
  28137. static readonly NO_FLIP: number;
  28138. /**
  28139. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  28140. */
  28141. static readonly FLIP_TILE: number;
  28142. /**
  28143. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  28144. */
  28145. static readonly ROTATE_TILE: number;
  28146. /**
  28147. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  28148. */
  28149. static readonly FLIP_ROW: number;
  28150. /**
  28151. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  28152. */
  28153. static readonly ROTATE_ROW: number;
  28154. /**
  28155. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  28156. */
  28157. static readonly FLIP_N_ROTATE_TILE: number;
  28158. /**
  28159. * Mesh pattern setting : rotate pattern and rotate
  28160. */
  28161. static readonly FLIP_N_ROTATE_ROW: number;
  28162. /**
  28163. * Mesh tile positioning : part tiles same on left/right or top/bottom
  28164. */
  28165. static readonly CENTER: number;
  28166. /**
  28167. * Mesh tile positioning : part tiles on left
  28168. */
  28169. static readonly LEFT: number;
  28170. /**
  28171. * Mesh tile positioning : part tiles on right
  28172. */
  28173. static readonly RIGHT: number;
  28174. /**
  28175. * Mesh tile positioning : part tiles on top
  28176. */
  28177. static readonly TOP: number;
  28178. /**
  28179. * Mesh tile positioning : part tiles on bottom
  28180. */
  28181. static readonly BOTTOM: number;
  28182. /**
  28183. * Gets the default side orientation.
  28184. * @param orientation the orientation to value to attempt to get
  28185. * @returns the default orientation
  28186. * @hidden
  28187. */
  28188. static _GetDefaultSideOrientation(orientation?: number): number;
  28189. private _internalMeshDataInfo;
  28190. /**
  28191. * An event triggered before rendering the mesh
  28192. */
  28193. get onBeforeRenderObservable(): Observable<Mesh>;
  28194. /**
  28195. * An event triggered before binding the mesh
  28196. */
  28197. get onBeforeBindObservable(): Observable<Mesh>;
  28198. /**
  28199. * An event triggered after rendering the mesh
  28200. */
  28201. get onAfterRenderObservable(): Observable<Mesh>;
  28202. /**
  28203. * An event triggered before drawing the mesh
  28204. */
  28205. get onBeforeDrawObservable(): Observable<Mesh>;
  28206. private _onBeforeDrawObserver;
  28207. /**
  28208. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  28209. */
  28210. set onBeforeDraw(callback: () => void);
  28211. get hasInstances(): boolean;
  28212. get hasThinInstances(): boolean;
  28213. /**
  28214. * Gets the delay loading state of the mesh (when delay loading is turned on)
  28215. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  28216. */
  28217. delayLoadState: number;
  28218. /**
  28219. * Gets the list of instances created from this mesh
  28220. * it is not supposed to be modified manually.
  28221. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  28222. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  28223. */
  28224. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  28225. /**
  28226. * Gets the file containing delay loading data for this mesh
  28227. */
  28228. delayLoadingFile: string;
  28229. /** @hidden */
  28230. _binaryInfo: any;
  28231. /**
  28232. * User defined function used to change how LOD level selection is done
  28233. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  28234. */
  28235. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  28236. /**
  28237. * Gets or sets the morph target manager
  28238. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  28239. */
  28240. get morphTargetManager(): Nullable<MorphTargetManager>;
  28241. set morphTargetManager(value: Nullable<MorphTargetManager>);
  28242. /** @hidden */
  28243. _creationDataStorage: Nullable<_CreationDataStorage>;
  28244. /** @hidden */
  28245. _geometry: Nullable<Geometry>;
  28246. /** @hidden */
  28247. _delayInfo: Array<string>;
  28248. /** @hidden */
  28249. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  28250. /** @hidden */
  28251. _instanceDataStorage: _InstanceDataStorage;
  28252. /** @hidden */
  28253. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  28254. private _effectiveMaterial;
  28255. /** @hidden */
  28256. _shouldGenerateFlatShading: boolean;
  28257. /** @hidden */
  28258. _originalBuilderSideOrientation: number;
  28259. /**
  28260. * Use this property to change the original side orientation defined at construction time
  28261. */
  28262. overrideMaterialSideOrientation: Nullable<number>;
  28263. /**
  28264. * Gets the source mesh (the one used to clone this one from)
  28265. */
  28266. get source(): Nullable<Mesh>;
  28267. /**
  28268. * Gets or sets a boolean indicating that this mesh does not use index buffer
  28269. */
  28270. get isUnIndexed(): boolean;
  28271. set isUnIndexed(value: boolean);
  28272. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  28273. get worldMatrixInstancedBuffer(): Float32Array;
  28274. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  28275. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  28276. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  28277. /**
  28278. * @constructor
  28279. * @param name The value used by scene.getMeshByName() to do a lookup.
  28280. * @param scene The scene to add this mesh to.
  28281. * @param parent The parent of this mesh, if it has one
  28282. * @param source An optional Mesh from which geometry is shared, cloned.
  28283. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  28284. * When false, achieved by calling a clone(), also passing False.
  28285. * This will make creation of children, recursive.
  28286. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  28287. */
  28288. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  28289. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  28290. doNotInstantiate: boolean;
  28291. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  28292. /**
  28293. * Gets the class name
  28294. * @returns the string "Mesh".
  28295. */
  28296. getClassName(): string;
  28297. /** @hidden */
  28298. get _isMesh(): boolean;
  28299. /**
  28300. * Returns a description of this mesh
  28301. * @param fullDetails define if full details about this mesh must be used
  28302. * @returns a descriptive string representing this mesh
  28303. */
  28304. toString(fullDetails?: boolean): string;
  28305. /** @hidden */
  28306. _unBindEffect(): void;
  28307. /**
  28308. * Gets a boolean indicating if this mesh has LOD
  28309. */
  28310. get hasLODLevels(): boolean;
  28311. /**
  28312. * Gets the list of MeshLODLevel associated with the current mesh
  28313. * @returns an array of MeshLODLevel
  28314. */
  28315. getLODLevels(): MeshLODLevel[];
  28316. private _sortLODLevels;
  28317. /**
  28318. * Add a mesh as LOD level triggered at the given distance.
  28319. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  28320. * @param distance The distance from the center of the object to show this level
  28321. * @param mesh The mesh to be added as LOD level (can be null)
  28322. * @return This mesh (for chaining)
  28323. */
  28324. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  28325. /**
  28326. * Returns the LOD level mesh at the passed distance or null if not found.
  28327. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  28328. * @param distance The distance from the center of the object to show this level
  28329. * @returns a Mesh or `null`
  28330. */
  28331. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  28332. /**
  28333. * Remove a mesh from the LOD array
  28334. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  28335. * @param mesh defines the mesh to be removed
  28336. * @return This mesh (for chaining)
  28337. */
  28338. removeLODLevel(mesh: Mesh): Mesh;
  28339. /**
  28340. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  28341. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  28342. * @param camera defines the camera to use to compute distance
  28343. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  28344. * @return This mesh (for chaining)
  28345. */
  28346. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  28347. /**
  28348. * Gets the mesh internal Geometry object
  28349. */
  28350. get geometry(): Nullable<Geometry>;
  28351. /**
  28352. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  28353. * @returns the total number of vertices
  28354. */
  28355. getTotalVertices(): number;
  28356. /**
  28357. * Returns the content of an associated vertex buffer
  28358. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  28359. * - VertexBuffer.PositionKind
  28360. * - VertexBuffer.UVKind
  28361. * - VertexBuffer.UV2Kind
  28362. * - VertexBuffer.UV3Kind
  28363. * - VertexBuffer.UV4Kind
  28364. * - VertexBuffer.UV5Kind
  28365. * - VertexBuffer.UV6Kind
  28366. * - VertexBuffer.ColorKind
  28367. * - VertexBuffer.MatricesIndicesKind
  28368. * - VertexBuffer.MatricesIndicesExtraKind
  28369. * - VertexBuffer.MatricesWeightsKind
  28370. * - VertexBuffer.MatricesWeightsExtraKind
  28371. * @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
  28372. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  28373. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  28374. */
  28375. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  28376. /**
  28377. * Returns the mesh VertexBuffer object from the requested `kind`
  28378. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  28379. * - VertexBuffer.PositionKind
  28380. * - VertexBuffer.NormalKind
  28381. * - VertexBuffer.UVKind
  28382. * - VertexBuffer.UV2Kind
  28383. * - VertexBuffer.UV3Kind
  28384. * - VertexBuffer.UV4Kind
  28385. * - VertexBuffer.UV5Kind
  28386. * - VertexBuffer.UV6Kind
  28387. * - VertexBuffer.ColorKind
  28388. * - VertexBuffer.MatricesIndicesKind
  28389. * - VertexBuffer.MatricesIndicesExtraKind
  28390. * - VertexBuffer.MatricesWeightsKind
  28391. * - VertexBuffer.MatricesWeightsExtraKind
  28392. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  28393. */
  28394. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  28395. /**
  28396. * Tests if a specific vertex buffer is associated with this mesh
  28397. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  28398. * - VertexBuffer.PositionKind
  28399. * - VertexBuffer.NormalKind
  28400. * - VertexBuffer.UVKind
  28401. * - VertexBuffer.UV2Kind
  28402. * - VertexBuffer.UV3Kind
  28403. * - VertexBuffer.UV4Kind
  28404. * - VertexBuffer.UV5Kind
  28405. * - VertexBuffer.UV6Kind
  28406. * - VertexBuffer.ColorKind
  28407. * - VertexBuffer.MatricesIndicesKind
  28408. * - VertexBuffer.MatricesIndicesExtraKind
  28409. * - VertexBuffer.MatricesWeightsKind
  28410. * - VertexBuffer.MatricesWeightsExtraKind
  28411. * @returns a boolean
  28412. */
  28413. isVerticesDataPresent(kind: string): boolean;
  28414. /**
  28415. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  28416. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  28417. * - VertexBuffer.PositionKind
  28418. * - VertexBuffer.UVKind
  28419. * - VertexBuffer.UV2Kind
  28420. * - VertexBuffer.UV3Kind
  28421. * - VertexBuffer.UV4Kind
  28422. * - VertexBuffer.UV5Kind
  28423. * - VertexBuffer.UV6Kind
  28424. * - VertexBuffer.ColorKind
  28425. * - VertexBuffer.MatricesIndicesKind
  28426. * - VertexBuffer.MatricesIndicesExtraKind
  28427. * - VertexBuffer.MatricesWeightsKind
  28428. * - VertexBuffer.MatricesWeightsExtraKind
  28429. * @returns a boolean
  28430. */
  28431. isVertexBufferUpdatable(kind: string): boolean;
  28432. /**
  28433. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  28434. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  28435. * - VertexBuffer.PositionKind
  28436. * - VertexBuffer.NormalKind
  28437. * - VertexBuffer.UVKind
  28438. * - VertexBuffer.UV2Kind
  28439. * - VertexBuffer.UV3Kind
  28440. * - VertexBuffer.UV4Kind
  28441. * - VertexBuffer.UV5Kind
  28442. * - VertexBuffer.UV6Kind
  28443. * - VertexBuffer.ColorKind
  28444. * - VertexBuffer.MatricesIndicesKind
  28445. * - VertexBuffer.MatricesIndicesExtraKind
  28446. * - VertexBuffer.MatricesWeightsKind
  28447. * - VertexBuffer.MatricesWeightsExtraKind
  28448. * @returns an array of strings
  28449. */
  28450. getVerticesDataKinds(): string[];
  28451. /**
  28452. * Returns a positive integer : the total number of indices in this mesh geometry.
  28453. * @returns the numner of indices or zero if the mesh has no geometry.
  28454. */
  28455. getTotalIndices(): number;
  28456. /**
  28457. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  28458. * @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.
  28459. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  28460. * @returns the indices array or an empty array if the mesh has no geometry
  28461. */
  28462. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  28463. get isBlocked(): boolean;
  28464. /**
  28465. * Determine if the current mesh is ready to be rendered
  28466. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  28467. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  28468. * @returns true if all associated assets are ready (material, textures, shaders)
  28469. */
  28470. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  28471. /**
  28472. * 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.
  28473. */
  28474. get areNormalsFrozen(): boolean;
  28475. /**
  28476. * 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.
  28477. * @returns the current mesh
  28478. */
  28479. freezeNormals(): Mesh;
  28480. /**
  28481. * 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
  28482. * @returns the current mesh
  28483. */
  28484. unfreezeNormals(): Mesh;
  28485. /**
  28486. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  28487. */
  28488. set overridenInstanceCount(count: number);
  28489. /** @hidden */
  28490. _preActivate(): Mesh;
  28491. /** @hidden */
  28492. _preActivateForIntermediateRendering(renderId: number): Mesh;
  28493. /** @hidden */
  28494. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  28495. protected _afterComputeWorldMatrix(): void;
  28496. /** @hidden */
  28497. _postActivate(): void;
  28498. /**
  28499. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  28500. * This means the mesh underlying bounding box and sphere are recomputed.
  28501. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  28502. * @returns the current mesh
  28503. */
  28504. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  28505. /** @hidden */
  28506. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  28507. /**
  28508. * This function will subdivide the mesh into multiple submeshes
  28509. * @param count defines the expected number of submeshes
  28510. */
  28511. subdivide(count: number): void;
  28512. /**
  28513. * Copy a FloatArray into a specific associated vertex buffer
  28514. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  28515. * - VertexBuffer.PositionKind
  28516. * - VertexBuffer.UVKind
  28517. * - VertexBuffer.UV2Kind
  28518. * - VertexBuffer.UV3Kind
  28519. * - VertexBuffer.UV4Kind
  28520. * - VertexBuffer.UV5Kind
  28521. * - VertexBuffer.UV6Kind
  28522. * - VertexBuffer.ColorKind
  28523. * - VertexBuffer.MatricesIndicesKind
  28524. * - VertexBuffer.MatricesIndicesExtraKind
  28525. * - VertexBuffer.MatricesWeightsKind
  28526. * - VertexBuffer.MatricesWeightsExtraKind
  28527. * @param data defines the data source
  28528. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  28529. * @param stride defines the data stride size (can be null)
  28530. * @returns the current mesh
  28531. */
  28532. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  28533. /**
  28534. * Delete a vertex buffer associated with this mesh
  28535. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  28536. * - VertexBuffer.PositionKind
  28537. * - VertexBuffer.UVKind
  28538. * - VertexBuffer.UV2Kind
  28539. * - VertexBuffer.UV3Kind
  28540. * - VertexBuffer.UV4Kind
  28541. * - VertexBuffer.UV5Kind
  28542. * - VertexBuffer.UV6Kind
  28543. * - VertexBuffer.ColorKind
  28544. * - VertexBuffer.MatricesIndicesKind
  28545. * - VertexBuffer.MatricesIndicesExtraKind
  28546. * - VertexBuffer.MatricesWeightsKind
  28547. * - VertexBuffer.MatricesWeightsExtraKind
  28548. */
  28549. removeVerticesData(kind: string): void;
  28550. /**
  28551. * Flags an associated vertex buffer as updatable
  28552. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  28553. * - VertexBuffer.PositionKind
  28554. * - VertexBuffer.UVKind
  28555. * - VertexBuffer.UV2Kind
  28556. * - VertexBuffer.UV3Kind
  28557. * - VertexBuffer.UV4Kind
  28558. * - VertexBuffer.UV5Kind
  28559. * - VertexBuffer.UV6Kind
  28560. * - VertexBuffer.ColorKind
  28561. * - VertexBuffer.MatricesIndicesKind
  28562. * - VertexBuffer.MatricesIndicesExtraKind
  28563. * - VertexBuffer.MatricesWeightsKind
  28564. * - VertexBuffer.MatricesWeightsExtraKind
  28565. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  28566. */
  28567. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  28568. /**
  28569. * Sets the mesh global Vertex Buffer
  28570. * @param buffer defines the buffer to use
  28571. * @returns the current mesh
  28572. */
  28573. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  28574. /**
  28575. * Update a specific associated vertex buffer
  28576. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  28577. * - VertexBuffer.PositionKind
  28578. * - VertexBuffer.UVKind
  28579. * - VertexBuffer.UV2Kind
  28580. * - VertexBuffer.UV3Kind
  28581. * - VertexBuffer.UV4Kind
  28582. * - VertexBuffer.UV5Kind
  28583. * - VertexBuffer.UV6Kind
  28584. * - VertexBuffer.ColorKind
  28585. * - VertexBuffer.MatricesIndicesKind
  28586. * - VertexBuffer.MatricesIndicesExtraKind
  28587. * - VertexBuffer.MatricesWeightsKind
  28588. * - VertexBuffer.MatricesWeightsExtraKind
  28589. * @param data defines the data source
  28590. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  28591. * @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)
  28592. * @returns the current mesh
  28593. */
  28594. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  28595. /**
  28596. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  28597. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  28598. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  28599. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  28600. * @returns the current mesh
  28601. */
  28602. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  28603. /**
  28604. * Creates a un-shared specific occurence of the geometry for the mesh.
  28605. * @returns the current mesh
  28606. */
  28607. makeGeometryUnique(): Mesh;
  28608. /**
  28609. * Set the index buffer of this mesh
  28610. * @param indices defines the source data
  28611. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  28612. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  28613. * @returns the current mesh
  28614. */
  28615. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  28616. /**
  28617. * Update the current index buffer
  28618. * @param indices defines the source data
  28619. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  28620. * @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)
  28621. * @returns the current mesh
  28622. */
  28623. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  28624. /**
  28625. * Invert the geometry to move from a right handed system to a left handed one.
  28626. * @returns the current mesh
  28627. */
  28628. toLeftHanded(): Mesh;
  28629. /** @hidden */
  28630. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  28631. /** @hidden */
  28632. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  28633. /**
  28634. * Registers for this mesh a javascript function called just before the rendering process
  28635. * @param func defines the function to call before rendering this mesh
  28636. * @returns the current mesh
  28637. */
  28638. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  28639. /**
  28640. * Disposes a previously registered javascript function called before the rendering
  28641. * @param func defines the function to remove
  28642. * @returns the current mesh
  28643. */
  28644. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  28645. /**
  28646. * Registers for this mesh a javascript function called just after the rendering is complete
  28647. * @param func defines the function to call after rendering this mesh
  28648. * @returns the current mesh
  28649. */
  28650. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  28651. /**
  28652. * Disposes a previously registered javascript function called after the rendering.
  28653. * @param func defines the function to remove
  28654. * @returns the current mesh
  28655. */
  28656. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  28657. /** @hidden */
  28658. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  28659. /** @hidden */
  28660. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  28661. /** @hidden */
  28662. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  28663. /** @hidden */
  28664. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  28665. /** @hidden */
  28666. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  28667. /** @hidden */
  28668. _rebuild(): void;
  28669. /** @hidden */
  28670. _freeze(): void;
  28671. /** @hidden */
  28672. _unFreeze(): void;
  28673. /**
  28674. * 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
  28675. * @param subMesh defines the subMesh to render
  28676. * @param enableAlphaMode defines if alpha mode can be changed
  28677. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  28678. * @returns the current mesh
  28679. */
  28680. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  28681. private _onBeforeDraw;
  28682. /**
  28683. * Renormalize the mesh and patch it up if there are no weights
  28684. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  28685. * However in the case of zero weights then we set just a single influence to 1.
  28686. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  28687. */
  28688. cleanMatrixWeights(): void;
  28689. private normalizeSkinFourWeights;
  28690. private normalizeSkinWeightsAndExtra;
  28691. /**
  28692. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  28693. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  28694. * the user know there was an issue with importing the mesh
  28695. * @returns a validation object with skinned, valid and report string
  28696. */
  28697. validateSkinning(): {
  28698. skinned: boolean;
  28699. valid: boolean;
  28700. report: string;
  28701. };
  28702. /** @hidden */
  28703. _checkDelayState(): Mesh;
  28704. private _queueLoad;
  28705. /**
  28706. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  28707. * A mesh is in the frustum if its bounding box intersects the frustum
  28708. * @param frustumPlanes defines the frustum to test
  28709. * @returns true if the mesh is in the frustum planes
  28710. */
  28711. isInFrustum(frustumPlanes: Plane[]): boolean;
  28712. /**
  28713. * Sets the mesh material by the material or multiMaterial `id` property
  28714. * @param id is a string identifying the material or the multiMaterial
  28715. * @returns the current mesh
  28716. */
  28717. setMaterialByID(id: string): Mesh;
  28718. /**
  28719. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  28720. * @returns an array of IAnimatable
  28721. */
  28722. getAnimatables(): IAnimatable[];
  28723. /**
  28724. * Modifies the mesh geometry according to the passed transformation matrix.
  28725. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  28726. * The mesh normals are modified using the same transformation.
  28727. * Note that, under the hood, this method sets a new VertexBuffer each call.
  28728. * @param transform defines the transform matrix to use
  28729. * @see http://doc.babylonjs.com/resources/baking_transformations
  28730. * @returns the current mesh
  28731. */
  28732. bakeTransformIntoVertices(transform: Matrix): Mesh;
  28733. /**
  28734. * Modifies the mesh geometry according to its own current World Matrix.
  28735. * The mesh World Matrix is then reset.
  28736. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  28737. * Note that, under the hood, this method sets a new VertexBuffer each call.
  28738. * @see http://doc.babylonjs.com/resources/baking_transformations
  28739. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  28740. * @returns the current mesh
  28741. */
  28742. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  28743. /** @hidden */
  28744. get _positions(): Nullable<Vector3[]>;
  28745. /** @hidden */
  28746. _resetPointsArrayCache(): Mesh;
  28747. /** @hidden */
  28748. _generatePointsArray(): boolean;
  28749. /**
  28750. * Returns a new Mesh object generated from the current mesh properties.
  28751. * This method must not get confused with createInstance()
  28752. * @param name is a string, the name given to the new mesh
  28753. * @param newParent can be any Node object (default `null`)
  28754. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  28755. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  28756. * @returns a new mesh
  28757. */
  28758. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  28759. /**
  28760. * Releases resources associated with this mesh.
  28761. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  28762. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  28763. */
  28764. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  28765. /** @hidden */
  28766. _disposeInstanceSpecificData(): void;
  28767. /** @hidden */
  28768. _disposeThinInstanceSpecificData(): void;
  28769. /**
  28770. * Modifies the mesh geometry according to a displacement map.
  28771. * 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.
  28772. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  28773. * @param url is a string, the URL from the image file is to be downloaded.
  28774. * @param minHeight is the lower limit of the displacement.
  28775. * @param maxHeight is the upper limit of the displacement.
  28776. * @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.
  28777. * @param uvOffset is an optional vector2 used to offset UV.
  28778. * @param uvScale is an optional vector2 used to scale UV.
  28779. * @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.
  28780. * @returns the Mesh.
  28781. */
  28782. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  28783. /**
  28784. * Modifies the mesh geometry according to a displacementMap buffer.
  28785. * 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.
  28786. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  28787. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  28788. * @param heightMapWidth is the width of the buffer image.
  28789. * @param heightMapHeight is the height of the buffer image.
  28790. * @param minHeight is the lower limit of the displacement.
  28791. * @param maxHeight is the upper limit of the displacement.
  28792. * @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.
  28793. * @param uvOffset is an optional vector2 used to offset UV.
  28794. * @param uvScale is an optional vector2 used to scale UV.
  28795. * @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.
  28796. * @returns the Mesh.
  28797. */
  28798. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  28799. /**
  28800. * Modify the mesh to get a flat shading rendering.
  28801. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  28802. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  28803. * @returns current mesh
  28804. */
  28805. convertToFlatShadedMesh(): Mesh;
  28806. /**
  28807. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  28808. * In other words, more vertices, no more indices and a single bigger VBO.
  28809. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  28810. * @returns current mesh
  28811. */
  28812. convertToUnIndexedMesh(): Mesh;
  28813. /**
  28814. * Inverses facet orientations.
  28815. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  28816. * @param flipNormals will also inverts the normals
  28817. * @returns current mesh
  28818. */
  28819. flipFaces(flipNormals?: boolean): Mesh;
  28820. /**
  28821. * Increase the number of facets and hence vertices in a mesh
  28822. * Vertex normals are interpolated from existing vertex normals
  28823. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  28824. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  28825. */
  28826. increaseVertices(numberPerEdge: number): void;
  28827. /**
  28828. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  28829. * This will undo any application of covertToFlatShadedMesh
  28830. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  28831. */
  28832. forceSharedVertices(): void;
  28833. /** @hidden */
  28834. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  28835. /** @hidden */
  28836. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  28837. /**
  28838. * Creates a new InstancedMesh object from the mesh model.
  28839. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  28840. * @param name defines the name of the new instance
  28841. * @returns a new InstancedMesh
  28842. */
  28843. createInstance(name: string): InstancedMesh;
  28844. /**
  28845. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  28846. * After this call, all the mesh instances have the same submeshes than the current mesh.
  28847. * @returns the current mesh
  28848. */
  28849. synchronizeInstances(): Mesh;
  28850. /**
  28851. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  28852. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  28853. * This should be used together with the simplification to avoid disappearing triangles.
  28854. * @param successCallback an optional success callback to be called after the optimization finished.
  28855. * @returns the current mesh
  28856. */
  28857. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  28858. /**
  28859. * Serialize current mesh
  28860. * @param serializationObject defines the object which will receive the serialization data
  28861. */
  28862. serialize(serializationObject: any): void;
  28863. /** @hidden */
  28864. _syncGeometryWithMorphTargetManager(): void;
  28865. /** @hidden */
  28866. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  28867. /**
  28868. * Returns a new Mesh object parsed from the source provided.
  28869. * @param parsedMesh is the source
  28870. * @param scene defines the hosting scene
  28871. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  28872. * @returns a new Mesh
  28873. */
  28874. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  28875. /**
  28876. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  28877. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  28878. * @param name defines the name of the mesh to create
  28879. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  28880. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  28881. * @param closePath creates a seam between the first and the last points of each path of the path array
  28882. * @param offset is taken in account only if the `pathArray` is containing a single path
  28883. * @param scene defines the hosting scene
  28884. * @param updatable defines if the mesh must be flagged as updatable
  28885. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  28886. * @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)
  28887. * @returns a new Mesh
  28888. */
  28889. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  28890. /**
  28891. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  28892. * @param name defines the name of the mesh to create
  28893. * @param radius sets the radius size (float) of the polygon (default 0.5)
  28894. * @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
  28895. * @param scene defines the hosting scene
  28896. * @param updatable defines if the mesh must be flagged as updatable
  28897. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  28898. * @returns a new Mesh
  28899. */
  28900. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  28901. /**
  28902. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  28903. * @param name defines the name of the mesh to create
  28904. * @param size sets the size (float) of each box side (default 1)
  28905. * @param scene defines the hosting scene
  28906. * @param updatable defines if the mesh must be flagged as updatable
  28907. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  28908. * @returns a new Mesh
  28909. */
  28910. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  28911. /**
  28912. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  28913. * @param name defines the name of the mesh to create
  28914. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  28915. * @param diameter sets the diameter size (float) of the sphere (default 1)
  28916. * @param scene defines the hosting scene
  28917. * @param updatable defines if the mesh must be flagged as updatable
  28918. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  28919. * @returns a new Mesh
  28920. */
  28921. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  28922. /**
  28923. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  28924. * @param name defines the name of the mesh to create
  28925. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  28926. * @param diameter sets the diameter size (float) of the sphere (default 1)
  28927. * @param scene defines the hosting scene
  28928. * @returns a new Mesh
  28929. */
  28930. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  28931. /**
  28932. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  28933. * @param name defines the name of the mesh to create
  28934. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  28935. * @param diameterTop set the top cap diameter (floats, default 1)
  28936. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  28937. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  28938. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  28939. * @param scene defines the hosting scene
  28940. * @param updatable defines if the mesh must be flagged as updatable
  28941. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  28942. * @returns a new Mesh
  28943. */
  28944. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  28945. /**
  28946. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  28947. * @param name defines the name of the mesh to create
  28948. * @param diameter sets the diameter size (float) of the torus (default 1)
  28949. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  28950. * @param tessellation sets the number of torus sides (postive integer, default 16)
  28951. * @param scene defines the hosting scene
  28952. * @param updatable defines if the mesh must be flagged as updatable
  28953. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  28954. * @returns a new Mesh
  28955. */
  28956. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  28957. /**
  28958. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  28959. * @param name defines the name of the mesh to create
  28960. * @param radius sets the global radius size (float) of the torus knot (default 2)
  28961. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  28962. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  28963. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  28964. * @param p the number of windings on X axis (positive integers, default 2)
  28965. * @param q the number of windings on Y axis (positive integers, default 3)
  28966. * @param scene defines the hosting scene
  28967. * @param updatable defines if the mesh must be flagged as updatable
  28968. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  28969. * @returns a new Mesh
  28970. */
  28971. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  28972. /**
  28973. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  28974. * @param name defines the name of the mesh to create
  28975. * @param points is an array successive Vector3
  28976. * @param scene defines the hosting scene
  28977. * @param updatable defines if the mesh must be flagged as updatable
  28978. * @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).
  28979. * @returns a new Mesh
  28980. */
  28981. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  28982. /**
  28983. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  28984. * @param name defines the name of the mesh to create
  28985. * @param points is an array successive Vector3
  28986. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  28987. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  28988. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  28989. * @param scene defines the hosting scene
  28990. * @param updatable defines if the mesh must be flagged as updatable
  28991. * @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)
  28992. * @returns a new Mesh
  28993. */
  28994. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  28995. /**
  28996. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  28997. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  28998. * 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.
  28999. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  29000. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  29001. * Remember you can only change the shape positions, not their number when updating a polygon.
  29002. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  29003. * @param name defines the name of the mesh to create
  29004. * @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
  29005. * @param scene defines the hosting scene
  29006. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  29007. * @param updatable defines if the mesh must be flagged as updatable
  29008. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29009. * @param earcutInjection can be used to inject your own earcut reference
  29010. * @returns a new Mesh
  29011. */
  29012. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  29013. /**
  29014. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  29015. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  29016. * @param name defines the name of the mesh to create
  29017. * @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
  29018. * @param depth defines the height of extrusion
  29019. * @param scene defines the hosting scene
  29020. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  29021. * @param updatable defines if the mesh must be flagged as updatable
  29022. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29023. * @param earcutInjection can be used to inject your own earcut reference
  29024. * @returns a new Mesh
  29025. */
  29026. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  29027. /**
  29028. * Creates an extruded shape mesh.
  29029. * 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
  29030. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  29031. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  29032. * @param name defines the name of the mesh to create
  29033. * @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
  29034. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  29035. * @param scale is the value to scale the shape
  29036. * @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
  29037. * @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
  29038. * @param scene defines the hosting scene
  29039. * @param updatable defines if the mesh must be flagged as updatable
  29040. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29041. * @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)
  29042. * @returns a new Mesh
  29043. */
  29044. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29045. /**
  29046. * Creates an custom extruded shape mesh.
  29047. * The custom extrusion is a parametric shape.
  29048. * It has no predefined shape. Its final shape will depend on the input parameters.
  29049. * Please consider using the same method from the MeshBuilder class instead
  29050. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  29051. * @param name defines the name of the mesh to create
  29052. * @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
  29053. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  29054. * @param scaleFunction is a custom Javascript function called on each path point
  29055. * @param rotationFunction is a custom Javascript function called on each path point
  29056. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  29057. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  29058. * @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
  29059. * @param scene defines the hosting scene
  29060. * @param updatable defines if the mesh must be flagged as updatable
  29061. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29062. * @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)
  29063. * @returns a new Mesh
  29064. */
  29065. 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;
  29066. /**
  29067. * Creates lathe mesh.
  29068. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  29069. * Please consider using the same method from the MeshBuilder class instead
  29070. * @param name defines the name of the mesh to create
  29071. * @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
  29072. * @param radius is the radius value of the lathe
  29073. * @param tessellation is the side number of the lathe.
  29074. * @param scene defines the hosting scene
  29075. * @param updatable defines if the mesh must be flagged as updatable
  29076. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29077. * @returns a new Mesh
  29078. */
  29079. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29080. /**
  29081. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  29082. * @param name defines the name of the mesh to create
  29083. * @param size sets the size (float) of both sides of the plane at once (default 1)
  29084. * @param scene defines the hosting scene
  29085. * @param updatable defines if the mesh must be flagged as updatable
  29086. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29087. * @returns a new Mesh
  29088. */
  29089. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29090. /**
  29091. * Creates a ground mesh.
  29092. * Please consider using the same method from the MeshBuilder class instead
  29093. * @param name defines the name of the mesh to create
  29094. * @param width set the width of the ground
  29095. * @param height set the height of the ground
  29096. * @param subdivisions sets the number of subdivisions per side
  29097. * @param scene defines the hosting scene
  29098. * @param updatable defines if the mesh must be flagged as updatable
  29099. * @returns a new Mesh
  29100. */
  29101. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  29102. /**
  29103. * Creates a tiled ground mesh.
  29104. * Please consider using the same method from the MeshBuilder class instead
  29105. * @param name defines the name of the mesh to create
  29106. * @param xmin set the ground minimum X coordinate
  29107. * @param zmin set the ground minimum Y coordinate
  29108. * @param xmax set the ground maximum X coordinate
  29109. * @param zmax set the ground maximum Z coordinate
  29110. * @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
  29111. * @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
  29112. * @param scene defines the hosting scene
  29113. * @param updatable defines if the mesh must be flagged as updatable
  29114. * @returns a new Mesh
  29115. */
  29116. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  29117. w: number;
  29118. h: number;
  29119. }, precision: {
  29120. w: number;
  29121. h: number;
  29122. }, scene: Scene, updatable?: boolean): Mesh;
  29123. /**
  29124. * Creates a ground mesh from a height map.
  29125. * Please consider using the same method from the MeshBuilder class instead
  29126. * @see http://doc.babylonjs.com/babylon101/height_map
  29127. * @param name defines the name of the mesh to create
  29128. * @param url sets the URL of the height map image resource
  29129. * @param width set the ground width size
  29130. * @param height set the ground height size
  29131. * @param subdivisions sets the number of subdivision per side
  29132. * @param minHeight is the minimum altitude on the ground
  29133. * @param maxHeight is the maximum altitude on the ground
  29134. * @param scene defines the hosting scene
  29135. * @param updatable defines if the mesh must be flagged as updatable
  29136. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  29137. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  29138. * @returns a new Mesh
  29139. */
  29140. 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;
  29141. /**
  29142. * Creates a tube mesh.
  29143. * The tube is a parametric shape.
  29144. * It has no predefined shape. Its final shape will depend on the input parameters.
  29145. * Please consider using the same method from the MeshBuilder class instead
  29146. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  29147. * @param name defines the name of the mesh to create
  29148. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  29149. * @param radius sets the tube radius size
  29150. * @param tessellation is the number of sides on the tubular surface
  29151. * @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
  29152. * @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
  29153. * @param scene defines the hosting scene
  29154. * @param updatable defines if the mesh must be flagged as updatable
  29155. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29156. * @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)
  29157. * @returns a new Mesh
  29158. */
  29159. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  29160. (i: number, distance: number): number;
  29161. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29162. /**
  29163. * Creates a polyhedron mesh.
  29164. * Please consider using the same method from the MeshBuilder class instead.
  29165. * * 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
  29166. * * The parameter `size` (positive float, default 1) sets the polygon size
  29167. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  29168. * * 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`
  29169. * * 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
  29170. * * 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)`)
  29171. * * 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
  29172. * * 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
  29173. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  29174. * * If you create a double-sided mesh, you can choose what parts of 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
  29175. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  29176. * @param name defines the name of the mesh to create
  29177. * @param options defines the options used to create the mesh
  29178. * @param scene defines the hosting scene
  29179. * @returns a new Mesh
  29180. */
  29181. static CreatePolyhedron(name: string, options: {
  29182. type?: number;
  29183. size?: number;
  29184. sizeX?: number;
  29185. sizeY?: number;
  29186. sizeZ?: number;
  29187. custom?: any;
  29188. faceUV?: Vector4[];
  29189. faceColors?: Color4[];
  29190. updatable?: boolean;
  29191. sideOrientation?: number;
  29192. }, scene: Scene): Mesh;
  29193. /**
  29194. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  29195. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  29196. * * 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`)
  29197. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  29198. * * 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
  29199. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  29200. * * If you create a double-sided mesh, you can choose what parts of 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
  29201. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  29202. * @param name defines the name of the mesh
  29203. * @param options defines the options used to create the mesh
  29204. * @param scene defines the hosting scene
  29205. * @returns a new Mesh
  29206. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  29207. */
  29208. static CreateIcoSphere(name: string, options: {
  29209. radius?: number;
  29210. flat?: boolean;
  29211. subdivisions?: number;
  29212. sideOrientation?: number;
  29213. updatable?: boolean;
  29214. }, scene: Scene): Mesh;
  29215. /**
  29216. * Creates a decal mesh.
  29217. * Please consider using the same method from the MeshBuilder class instead.
  29218. * A decal is a mesh usually applied as a model onto the surface of another mesh
  29219. * @param name defines the name of the mesh
  29220. * @param sourceMesh defines the mesh receiving the decal
  29221. * @param position sets the position of the decal in world coordinates
  29222. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  29223. * @param size sets the decal scaling
  29224. * @param angle sets the angle to rotate the decal
  29225. * @returns a new Mesh
  29226. */
  29227. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  29228. /**
  29229. * Prepare internal position array for software CPU skinning
  29230. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  29231. */
  29232. setPositionsForCPUSkinning(): Float32Array;
  29233. /**
  29234. * Prepare internal normal array for software CPU skinning
  29235. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  29236. */
  29237. setNormalsForCPUSkinning(): Float32Array;
  29238. /**
  29239. * Updates the vertex buffer by applying transformation from the bones
  29240. * @param skeleton defines the skeleton to apply to current mesh
  29241. * @returns the current mesh
  29242. */
  29243. applySkeleton(skeleton: Skeleton): Mesh;
  29244. /**
  29245. * 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
  29246. * @param meshes defines the list of meshes to scan
  29247. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  29248. */
  29249. static MinMax(meshes: AbstractMesh[]): {
  29250. min: Vector3;
  29251. max: Vector3;
  29252. };
  29253. /**
  29254. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  29255. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  29256. * @returns a vector3
  29257. */
  29258. static Center(meshesOrMinMaxVector: {
  29259. min: Vector3;
  29260. max: Vector3;
  29261. } | AbstractMesh[]): Vector3;
  29262. /**
  29263. * Merge the array of meshes into a single mesh for performance reasons.
  29264. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  29265. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  29266. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  29267. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  29268. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  29269. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  29270. * @returns a new mesh
  29271. */
  29272. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  29273. /** @hidden */
  29274. addInstance(instance: InstancedMesh): void;
  29275. /** @hidden */
  29276. removeInstance(instance: InstancedMesh): void;
  29277. }
  29278. }
  29279. declare module "babylonjs/Cameras/camera" {
  29280. import { SmartArray } from "babylonjs/Misc/smartArray";
  29281. import { Observable } from "babylonjs/Misc/observable";
  29282. import { Nullable } from "babylonjs/types";
  29283. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  29284. import { Scene } from "babylonjs/scene";
  29285. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  29286. import { Node } from "babylonjs/node";
  29287. import { Mesh } from "babylonjs/Meshes/mesh";
  29288. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29289. import { ICullable } from "babylonjs/Culling/boundingInfo";
  29290. import { Viewport } from "babylonjs/Maths/math.viewport";
  29291. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  29292. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  29293. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  29294. import { Ray } from "babylonjs/Culling/ray";
  29295. /**
  29296. * This is the base class of all the camera used in the application.
  29297. * @see http://doc.babylonjs.com/features/cameras
  29298. */
  29299. export class Camera extends Node {
  29300. /** @hidden */
  29301. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  29302. /**
  29303. * This is the default projection mode used by the cameras.
  29304. * It helps recreating a feeling of perspective and better appreciate depth.
  29305. * This is the best way to simulate real life cameras.
  29306. */
  29307. static readonly PERSPECTIVE_CAMERA: number;
  29308. /**
  29309. * This helps creating camera with an orthographic mode.
  29310. * 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.
  29311. */
  29312. static readonly ORTHOGRAPHIC_CAMERA: number;
  29313. /**
  29314. * This is the default FOV mode for perspective cameras.
  29315. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  29316. */
  29317. static readonly FOVMODE_VERTICAL_FIXED: number;
  29318. /**
  29319. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  29320. */
  29321. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  29322. /**
  29323. * This specifies ther is no need for a camera rig.
  29324. * Basically only one eye is rendered corresponding to the camera.
  29325. */
  29326. static readonly RIG_MODE_NONE: number;
  29327. /**
  29328. * Simulates a camera Rig with one blue eye and one red eye.
  29329. * This can be use with 3d blue and red glasses.
  29330. */
  29331. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  29332. /**
  29333. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  29334. */
  29335. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  29336. /**
  29337. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  29338. */
  29339. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  29340. /**
  29341. * Defines that both eyes of the camera will be rendered over under each other.
  29342. */
  29343. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  29344. /**
  29345. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  29346. */
  29347. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  29348. /**
  29349. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  29350. */
  29351. static readonly RIG_MODE_VR: number;
  29352. /**
  29353. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  29354. */
  29355. static readonly RIG_MODE_WEBVR: number;
  29356. /**
  29357. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  29358. */
  29359. static readonly RIG_MODE_CUSTOM: number;
  29360. /**
  29361. * Defines if by default attaching controls should prevent the default javascript event to continue.
  29362. */
  29363. static ForceAttachControlToAlwaysPreventDefault: boolean;
  29364. /**
  29365. * Define the input manager associated with the camera.
  29366. */
  29367. inputs: CameraInputsManager<Camera>;
  29368. /** @hidden */
  29369. _position: Vector3;
  29370. /**
  29371. * Define the current local position of the camera in the scene
  29372. */
  29373. get position(): Vector3;
  29374. set position(newPosition: Vector3);
  29375. /**
  29376. * The vector the camera should consider as up.
  29377. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  29378. */
  29379. upVector: Vector3;
  29380. /**
  29381. * Define the current limit on the left side for an orthographic camera
  29382. * In scene unit
  29383. */
  29384. orthoLeft: Nullable<number>;
  29385. /**
  29386. * Define the current limit on the right side for an orthographic camera
  29387. * In scene unit
  29388. */
  29389. orthoRight: Nullable<number>;
  29390. /**
  29391. * Define the current limit on the bottom side for an orthographic camera
  29392. * In scene unit
  29393. */
  29394. orthoBottom: Nullable<number>;
  29395. /**
  29396. * Define the current limit on the top side for an orthographic camera
  29397. * In scene unit
  29398. */
  29399. orthoTop: Nullable<number>;
  29400. /**
  29401. * Field Of View is set in Radians. (default is 0.8)
  29402. */
  29403. fov: number;
  29404. /**
  29405. * Define the minimum distance the camera can see from.
  29406. * This is important to note that the depth buffer are not infinite and the closer it starts
  29407. * the more your scene might encounter depth fighting issue.
  29408. */
  29409. minZ: number;
  29410. /**
  29411. * Define the maximum distance the camera can see to.
  29412. * This is important to note that the depth buffer are not infinite and the further it end
  29413. * the more your scene might encounter depth fighting issue.
  29414. */
  29415. maxZ: number;
  29416. /**
  29417. * Define the default inertia of the camera.
  29418. * This helps giving a smooth feeling to the camera movement.
  29419. */
  29420. inertia: number;
  29421. /**
  29422. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  29423. */
  29424. mode: number;
  29425. /**
  29426. * Define whether the camera is intermediate.
  29427. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  29428. */
  29429. isIntermediate: boolean;
  29430. /**
  29431. * Define the viewport of the camera.
  29432. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  29433. */
  29434. viewport: Viewport;
  29435. /**
  29436. * Restricts the camera to viewing objects with the same layerMask.
  29437. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  29438. */
  29439. layerMask: number;
  29440. /**
  29441. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  29442. */
  29443. fovMode: number;
  29444. /**
  29445. * Rig mode of the camera.
  29446. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  29447. * This is normally controlled byt the camera themselves as internal use.
  29448. */
  29449. cameraRigMode: number;
  29450. /**
  29451. * Defines the distance between both "eyes" in case of a RIG
  29452. */
  29453. interaxialDistance: number;
  29454. /**
  29455. * Defines if stereoscopic rendering is done side by side or over under.
  29456. */
  29457. isStereoscopicSideBySide: boolean;
  29458. /**
  29459. * 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
  29460. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  29461. * else in the scene. (Eg. security camera)
  29462. *
  29463. * 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)
  29464. */
  29465. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  29466. /**
  29467. * When set, the camera will render to this render target instead of the default canvas
  29468. *
  29469. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  29470. */
  29471. outputRenderTarget: Nullable<RenderTargetTexture>;
  29472. /**
  29473. * Observable triggered when the camera view matrix has changed.
  29474. */
  29475. onViewMatrixChangedObservable: Observable<Camera>;
  29476. /**
  29477. * Observable triggered when the camera Projection matrix has changed.
  29478. */
  29479. onProjectionMatrixChangedObservable: Observable<Camera>;
  29480. /**
  29481. * Observable triggered when the inputs have been processed.
  29482. */
  29483. onAfterCheckInputsObservable: Observable<Camera>;
  29484. /**
  29485. * Observable triggered when reset has been called and applied to the camera.
  29486. */
  29487. onRestoreStateObservable: Observable<Camera>;
  29488. /**
  29489. * Is this camera a part of a rig system?
  29490. */
  29491. isRigCamera: boolean;
  29492. /**
  29493. * If isRigCamera set to true this will be set with the parent camera.
  29494. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  29495. */
  29496. rigParent?: Camera;
  29497. /** @hidden */
  29498. _cameraRigParams: any;
  29499. /** @hidden */
  29500. _rigCameras: Camera[];
  29501. /** @hidden */
  29502. _rigPostProcess: Nullable<PostProcess>;
  29503. protected _webvrViewMatrix: Matrix;
  29504. /** @hidden */
  29505. _skipRendering: boolean;
  29506. /** @hidden */
  29507. _projectionMatrix: Matrix;
  29508. /** @hidden */
  29509. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  29510. /** @hidden */
  29511. _activeMeshes: SmartArray<AbstractMesh>;
  29512. protected _globalPosition: Vector3;
  29513. /** @hidden */
  29514. _computedViewMatrix: Matrix;
  29515. private _doNotComputeProjectionMatrix;
  29516. private _transformMatrix;
  29517. private _frustumPlanes;
  29518. private _refreshFrustumPlanes;
  29519. private _storedFov;
  29520. private _stateStored;
  29521. /**
  29522. * Instantiates a new camera object.
  29523. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  29524. * @see http://doc.babylonjs.com/features/cameras
  29525. * @param name Defines the name of the camera in the scene
  29526. * @param position Defines the position of the camera
  29527. * @param scene Defines the scene the camera belongs too
  29528. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  29529. */
  29530. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  29531. /**
  29532. * Store current camera state (fov, position, etc..)
  29533. * @returns the camera
  29534. */
  29535. storeState(): Camera;
  29536. /**
  29537. * Restores the camera state values if it has been stored. You must call storeState() first
  29538. */
  29539. protected _restoreStateValues(): boolean;
  29540. /**
  29541. * Restored camera state. You must call storeState() first.
  29542. * @returns true if restored and false otherwise
  29543. */
  29544. restoreState(): boolean;
  29545. /**
  29546. * Gets the class name of the camera.
  29547. * @returns the class name
  29548. */
  29549. getClassName(): string;
  29550. /** @hidden */
  29551. readonly _isCamera: boolean;
  29552. /**
  29553. * Gets a string representation of the camera useful for debug purpose.
  29554. * @param fullDetails Defines that a more verboe level of logging is required
  29555. * @returns the string representation
  29556. */
  29557. toString(fullDetails?: boolean): string;
  29558. /**
  29559. * Gets the current world space position of the camera.
  29560. */
  29561. get globalPosition(): Vector3;
  29562. /**
  29563. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  29564. * @returns the active meshe list
  29565. */
  29566. getActiveMeshes(): SmartArray<AbstractMesh>;
  29567. /**
  29568. * Check whether a mesh is part of the current active mesh list of the camera
  29569. * @param mesh Defines the mesh to check
  29570. * @returns true if active, false otherwise
  29571. */
  29572. isActiveMesh(mesh: Mesh): boolean;
  29573. /**
  29574. * Is this camera ready to be used/rendered
  29575. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  29576. * @return true if the camera is ready
  29577. */
  29578. isReady(completeCheck?: boolean): boolean;
  29579. /** @hidden */
  29580. _initCache(): void;
  29581. /** @hidden */
  29582. _updateCache(ignoreParentClass?: boolean): void;
  29583. /** @hidden */
  29584. _isSynchronized(): boolean;
  29585. /** @hidden */
  29586. _isSynchronizedViewMatrix(): boolean;
  29587. /** @hidden */
  29588. _isSynchronizedProjectionMatrix(): boolean;
  29589. /**
  29590. * Attach the input controls to a specific dom element to get the input from.
  29591. * @param element Defines the element the controls should be listened from
  29592. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  29593. */
  29594. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  29595. /**
  29596. * Detach the current controls from the specified dom element.
  29597. * @param element Defines the element to stop listening the inputs from
  29598. */
  29599. detachControl(element: HTMLElement): void;
  29600. /**
  29601. * Update the camera state according to the different inputs gathered during the frame.
  29602. */
  29603. update(): void;
  29604. /** @hidden */
  29605. _checkInputs(): void;
  29606. /** @hidden */
  29607. get rigCameras(): Camera[];
  29608. /**
  29609. * Gets the post process used by the rig cameras
  29610. */
  29611. get rigPostProcess(): Nullable<PostProcess>;
  29612. /**
  29613. * Internal, gets the first post proces.
  29614. * @returns the first post process to be run on this camera.
  29615. */
  29616. _getFirstPostProcess(): Nullable<PostProcess>;
  29617. private _cascadePostProcessesToRigCams;
  29618. /**
  29619. * Attach a post process to the camera.
  29620. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  29621. * @param postProcess The post process to attach to the camera
  29622. * @param insertAt The position of the post process in case several of them are in use in the scene
  29623. * @returns the position the post process has been inserted at
  29624. */
  29625. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  29626. /**
  29627. * Detach a post process to the camera.
  29628. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  29629. * @param postProcess The post process to detach from the camera
  29630. */
  29631. detachPostProcess(postProcess: PostProcess): void;
  29632. /**
  29633. * Gets the current world matrix of the camera
  29634. */
  29635. getWorldMatrix(): Matrix;
  29636. /** @hidden */
  29637. _getViewMatrix(): Matrix;
  29638. /**
  29639. * Gets the current view matrix of the camera.
  29640. * @param force forces the camera to recompute the matrix without looking at the cached state
  29641. * @returns the view matrix
  29642. */
  29643. getViewMatrix(force?: boolean): Matrix;
  29644. /**
  29645. * Freeze the projection matrix.
  29646. * It will prevent the cache check of the camera projection compute and can speed up perf
  29647. * if no parameter of the camera are meant to change
  29648. * @param projection Defines manually a projection if necessary
  29649. */
  29650. freezeProjectionMatrix(projection?: Matrix): void;
  29651. /**
  29652. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  29653. */
  29654. unfreezeProjectionMatrix(): void;
  29655. /**
  29656. * Gets the current projection matrix of the camera.
  29657. * @param force forces the camera to recompute the matrix without looking at the cached state
  29658. * @returns the projection matrix
  29659. */
  29660. getProjectionMatrix(force?: boolean): Matrix;
  29661. /**
  29662. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  29663. * @returns a Matrix
  29664. */
  29665. getTransformationMatrix(): Matrix;
  29666. private _updateFrustumPlanes;
  29667. /**
  29668. * Checks if a cullable object (mesh...) is in the camera frustum
  29669. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  29670. * @param target The object to check
  29671. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  29672. * @returns true if the object is in frustum otherwise false
  29673. */
  29674. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  29675. /**
  29676. * Checks if a cullable object (mesh...) is in the camera frustum
  29677. * Unlike isInFrustum this cheks the full bounding box
  29678. * @param target The object to check
  29679. * @returns true if the object is in frustum otherwise false
  29680. */
  29681. isCompletelyInFrustum(target: ICullable): boolean;
  29682. /**
  29683. * Gets a ray in the forward direction from the camera.
  29684. * @param length Defines the length of the ray to create
  29685. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  29686. * @param origin Defines the start point of the ray which defaults to the camera position
  29687. * @returns the forward ray
  29688. */
  29689. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  29690. /**
  29691. * Releases resources associated with this node.
  29692. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29693. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29694. */
  29695. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29696. /** @hidden */
  29697. _isLeftCamera: boolean;
  29698. /**
  29699. * Gets the left camera of a rig setup in case of Rigged Camera
  29700. */
  29701. get isLeftCamera(): boolean;
  29702. /** @hidden */
  29703. _isRightCamera: boolean;
  29704. /**
  29705. * Gets the right camera of a rig setup in case of Rigged Camera
  29706. */
  29707. get isRightCamera(): boolean;
  29708. /**
  29709. * Gets the left camera of a rig setup in case of Rigged Camera
  29710. */
  29711. get leftCamera(): Nullable<FreeCamera>;
  29712. /**
  29713. * Gets the right camera of a rig setup in case of Rigged Camera
  29714. */
  29715. get rightCamera(): Nullable<FreeCamera>;
  29716. /**
  29717. * Gets the left camera target of a rig setup in case of Rigged Camera
  29718. * @returns the target position
  29719. */
  29720. getLeftTarget(): Nullable<Vector3>;
  29721. /**
  29722. * Gets the right camera target of a rig setup in case of Rigged Camera
  29723. * @returns the target position
  29724. */
  29725. getRightTarget(): Nullable<Vector3>;
  29726. /**
  29727. * @hidden
  29728. */
  29729. setCameraRigMode(mode: number, rigParams: any): void;
  29730. /** @hidden */
  29731. static _setStereoscopicRigMode(camera: Camera): void;
  29732. /** @hidden */
  29733. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  29734. /** @hidden */
  29735. static _setVRRigMode(camera: Camera, rigParams: any): void;
  29736. /** @hidden */
  29737. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  29738. /** @hidden */
  29739. _getVRProjectionMatrix(): Matrix;
  29740. protected _updateCameraRotationMatrix(): void;
  29741. protected _updateWebVRCameraRotationMatrix(): void;
  29742. /**
  29743. * This function MUST be overwritten by the different WebVR cameras available.
  29744. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  29745. * @hidden
  29746. */
  29747. _getWebVRProjectionMatrix(): Matrix;
  29748. /**
  29749. * This function MUST be overwritten by the different WebVR cameras available.
  29750. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  29751. * @hidden
  29752. */
  29753. _getWebVRViewMatrix(): Matrix;
  29754. /** @hidden */
  29755. setCameraRigParameter(name: string, value: any): void;
  29756. /**
  29757. * needs to be overridden by children so sub has required properties to be copied
  29758. * @hidden
  29759. */
  29760. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  29761. /**
  29762. * May need to be overridden by children
  29763. * @hidden
  29764. */
  29765. _updateRigCameras(): void;
  29766. /** @hidden */
  29767. _setupInputs(): void;
  29768. /**
  29769. * Serialiaze the camera setup to a json represention
  29770. * @returns the JSON representation
  29771. */
  29772. serialize(): any;
  29773. /**
  29774. * Clones the current camera.
  29775. * @param name The cloned camera name
  29776. * @returns the cloned camera
  29777. */
  29778. clone(name: string): Camera;
  29779. /**
  29780. * Gets the direction of the camera relative to a given local axis.
  29781. * @param localAxis Defines the reference axis to provide a relative direction.
  29782. * @return the direction
  29783. */
  29784. getDirection(localAxis: Vector3): Vector3;
  29785. /**
  29786. * Returns the current camera absolute rotation
  29787. */
  29788. get absoluteRotation(): Quaternion;
  29789. /**
  29790. * Gets the direction of the camera relative to a given local axis into a passed vector.
  29791. * @param localAxis Defines the reference axis to provide a relative direction.
  29792. * @param result Defines the vector to store the result in
  29793. */
  29794. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  29795. /**
  29796. * Gets a camera constructor for a given camera type
  29797. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  29798. * @param name The name of the camera the result will be able to instantiate
  29799. * @param scene The scene the result will construct the camera in
  29800. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  29801. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  29802. * @returns a factory method to construc the camera
  29803. */
  29804. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  29805. /**
  29806. * Compute the world matrix of the camera.
  29807. * @returns the camera world matrix
  29808. */
  29809. computeWorldMatrix(): Matrix;
  29810. /**
  29811. * Parse a JSON and creates the camera from the parsed information
  29812. * @param parsedCamera The JSON to parse
  29813. * @param scene The scene to instantiate the camera in
  29814. * @returns the newly constructed camera
  29815. */
  29816. static Parse(parsedCamera: any, scene: Scene): Camera;
  29817. }
  29818. }
  29819. declare module "babylonjs/Meshes/Builders/discBuilder" {
  29820. import { Nullable } from "babylonjs/types";
  29821. import { Scene } from "babylonjs/scene";
  29822. import { Vector4 } from "babylonjs/Maths/math.vector";
  29823. import { Mesh } from "babylonjs/Meshes/mesh";
  29824. /**
  29825. * Class containing static functions to help procedurally build meshes
  29826. */
  29827. export class DiscBuilder {
  29828. /**
  29829. * Creates a plane polygonal mesh. By default, this is a disc
  29830. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  29831. * * 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
  29832. * * 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
  29833. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  29834. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  29835. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  29836. * @param name defines the name of the mesh
  29837. * @param options defines the options used to create the mesh
  29838. * @param scene defines the hosting scene
  29839. * @returns the plane polygonal mesh
  29840. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  29841. */
  29842. static CreateDisc(name: string, options: {
  29843. radius?: number;
  29844. tessellation?: number;
  29845. arc?: number;
  29846. updatable?: boolean;
  29847. sideOrientation?: number;
  29848. frontUVs?: Vector4;
  29849. backUVs?: Vector4;
  29850. }, scene?: Nullable<Scene>): Mesh;
  29851. }
  29852. }
  29853. declare module "babylonjs/Materials/fresnelParameters" {
  29854. import { DeepImmutable } from "babylonjs/types";
  29855. import { Color3 } from "babylonjs/Maths/math.color";
  29856. /**
  29857. * Options to be used when creating a FresnelParameters.
  29858. */
  29859. export type IFresnelParametersCreationOptions = {
  29860. /**
  29861. * Define the color used on edges (grazing angle)
  29862. */
  29863. leftColor?: Color3;
  29864. /**
  29865. * Define the color used on center
  29866. */
  29867. rightColor?: Color3;
  29868. /**
  29869. * Define bias applied to computed fresnel term
  29870. */
  29871. bias?: number;
  29872. /**
  29873. * Defined the power exponent applied to fresnel term
  29874. */
  29875. power?: number;
  29876. /**
  29877. * Define if the fresnel effect is enable or not.
  29878. */
  29879. isEnabled?: boolean;
  29880. };
  29881. /**
  29882. * Serialized format for FresnelParameters.
  29883. */
  29884. export type IFresnelParametersSerialized = {
  29885. /**
  29886. * Define the color used on edges (grazing angle) [as an array]
  29887. */
  29888. leftColor: number[];
  29889. /**
  29890. * Define the color used on center [as an array]
  29891. */
  29892. rightColor: number[];
  29893. /**
  29894. * Define bias applied to computed fresnel term
  29895. */
  29896. bias: number;
  29897. /**
  29898. * Defined the power exponent applied to fresnel term
  29899. */
  29900. power?: number;
  29901. /**
  29902. * Define if the fresnel effect is enable or not.
  29903. */
  29904. isEnabled: boolean;
  29905. };
  29906. /**
  29907. * This represents all the required information to add a fresnel effect on a material:
  29908. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  29909. */
  29910. export class FresnelParameters {
  29911. private _isEnabled;
  29912. /**
  29913. * Define if the fresnel effect is enable or not.
  29914. */
  29915. get isEnabled(): boolean;
  29916. set isEnabled(value: boolean);
  29917. /**
  29918. * Define the color used on edges (grazing angle)
  29919. */
  29920. leftColor: Color3;
  29921. /**
  29922. * Define the color used on center
  29923. */
  29924. rightColor: Color3;
  29925. /**
  29926. * Define bias applied to computed fresnel term
  29927. */
  29928. bias: number;
  29929. /**
  29930. * Defined the power exponent applied to fresnel term
  29931. */
  29932. power: number;
  29933. /**
  29934. * Creates a new FresnelParameters object.
  29935. *
  29936. * @param options provide your own settings to optionally to override defaults
  29937. */
  29938. constructor(options?: IFresnelParametersCreationOptions);
  29939. /**
  29940. * Clones the current fresnel and its valuues
  29941. * @returns a clone fresnel configuration
  29942. */
  29943. clone(): FresnelParameters;
  29944. /**
  29945. * Determines equality between FresnelParameters objects
  29946. * @param otherFresnelParameters defines the second operand
  29947. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  29948. */
  29949. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  29950. /**
  29951. * Serializes the current fresnel parameters to a JSON representation.
  29952. * @return the JSON serialization
  29953. */
  29954. serialize(): IFresnelParametersSerialized;
  29955. /**
  29956. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  29957. * @param parsedFresnelParameters Define the JSON representation
  29958. * @returns the parsed parameters
  29959. */
  29960. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  29961. }
  29962. }
  29963. declare module "babylonjs/Materials/materialFlags" {
  29964. /**
  29965. * This groups all the flags used to control the materials channel.
  29966. */
  29967. export class MaterialFlags {
  29968. private static _DiffuseTextureEnabled;
  29969. /**
  29970. * Are diffuse textures enabled in the application.
  29971. */
  29972. static get DiffuseTextureEnabled(): boolean;
  29973. static set DiffuseTextureEnabled(value: boolean);
  29974. private static _DetailTextureEnabled;
  29975. /**
  29976. * Are detail textures enabled in the application.
  29977. */
  29978. static get DetailTextureEnabled(): boolean;
  29979. static set DetailTextureEnabled(value: boolean);
  29980. private static _AmbientTextureEnabled;
  29981. /**
  29982. * Are ambient textures enabled in the application.
  29983. */
  29984. static get AmbientTextureEnabled(): boolean;
  29985. static set AmbientTextureEnabled(value: boolean);
  29986. private static _OpacityTextureEnabled;
  29987. /**
  29988. * Are opacity textures enabled in the application.
  29989. */
  29990. static get OpacityTextureEnabled(): boolean;
  29991. static set OpacityTextureEnabled(value: boolean);
  29992. private static _ReflectionTextureEnabled;
  29993. /**
  29994. * Are reflection textures enabled in the application.
  29995. */
  29996. static get ReflectionTextureEnabled(): boolean;
  29997. static set ReflectionTextureEnabled(value: boolean);
  29998. private static _EmissiveTextureEnabled;
  29999. /**
  30000. * Are emissive textures enabled in the application.
  30001. */
  30002. static get EmissiveTextureEnabled(): boolean;
  30003. static set EmissiveTextureEnabled(value: boolean);
  30004. private static _SpecularTextureEnabled;
  30005. /**
  30006. * Are specular textures enabled in the application.
  30007. */
  30008. static get SpecularTextureEnabled(): boolean;
  30009. static set SpecularTextureEnabled(value: boolean);
  30010. private static _BumpTextureEnabled;
  30011. /**
  30012. * Are bump textures enabled in the application.
  30013. */
  30014. static get BumpTextureEnabled(): boolean;
  30015. static set BumpTextureEnabled(value: boolean);
  30016. private static _LightmapTextureEnabled;
  30017. /**
  30018. * Are lightmap textures enabled in the application.
  30019. */
  30020. static get LightmapTextureEnabled(): boolean;
  30021. static set LightmapTextureEnabled(value: boolean);
  30022. private static _RefractionTextureEnabled;
  30023. /**
  30024. * Are refraction textures enabled in the application.
  30025. */
  30026. static get RefractionTextureEnabled(): boolean;
  30027. static set RefractionTextureEnabled(value: boolean);
  30028. private static _ColorGradingTextureEnabled;
  30029. /**
  30030. * Are color grading textures enabled in the application.
  30031. */
  30032. static get ColorGradingTextureEnabled(): boolean;
  30033. static set ColorGradingTextureEnabled(value: boolean);
  30034. private static _FresnelEnabled;
  30035. /**
  30036. * Are fresnels enabled in the application.
  30037. */
  30038. static get FresnelEnabled(): boolean;
  30039. static set FresnelEnabled(value: boolean);
  30040. private static _ClearCoatTextureEnabled;
  30041. /**
  30042. * Are clear coat textures enabled in the application.
  30043. */
  30044. static get ClearCoatTextureEnabled(): boolean;
  30045. static set ClearCoatTextureEnabled(value: boolean);
  30046. private static _ClearCoatBumpTextureEnabled;
  30047. /**
  30048. * Are clear coat bump textures enabled in the application.
  30049. */
  30050. static get ClearCoatBumpTextureEnabled(): boolean;
  30051. static set ClearCoatBumpTextureEnabled(value: boolean);
  30052. private static _ClearCoatTintTextureEnabled;
  30053. /**
  30054. * Are clear coat tint textures enabled in the application.
  30055. */
  30056. static get ClearCoatTintTextureEnabled(): boolean;
  30057. static set ClearCoatTintTextureEnabled(value: boolean);
  30058. private static _SheenTextureEnabled;
  30059. /**
  30060. * Are sheen textures enabled in the application.
  30061. */
  30062. static get SheenTextureEnabled(): boolean;
  30063. static set SheenTextureEnabled(value: boolean);
  30064. private static _AnisotropicTextureEnabled;
  30065. /**
  30066. * Are anisotropic textures enabled in the application.
  30067. */
  30068. static get AnisotropicTextureEnabled(): boolean;
  30069. static set AnisotropicTextureEnabled(value: boolean);
  30070. private static _ThicknessTextureEnabled;
  30071. /**
  30072. * Are thickness textures enabled in the application.
  30073. */
  30074. static get ThicknessTextureEnabled(): boolean;
  30075. static set ThicknessTextureEnabled(value: boolean);
  30076. }
  30077. }
  30078. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  30079. /** @hidden */
  30080. export var defaultFragmentDeclaration: {
  30081. name: string;
  30082. shader: string;
  30083. };
  30084. }
  30085. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  30086. /** @hidden */
  30087. export var defaultUboDeclaration: {
  30088. name: string;
  30089. shader: string;
  30090. };
  30091. }
  30092. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  30093. /** @hidden */
  30094. export var lightFragmentDeclaration: {
  30095. name: string;
  30096. shader: string;
  30097. };
  30098. }
  30099. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  30100. /** @hidden */
  30101. export var lightUboDeclaration: {
  30102. name: string;
  30103. shader: string;
  30104. };
  30105. }
  30106. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  30107. /** @hidden */
  30108. export var lightsFragmentFunctions: {
  30109. name: string;
  30110. shader: string;
  30111. };
  30112. }
  30113. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  30114. /** @hidden */
  30115. export var shadowsFragmentFunctions: {
  30116. name: string;
  30117. shader: string;
  30118. };
  30119. }
  30120. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  30121. /** @hidden */
  30122. export var fresnelFunction: {
  30123. name: string;
  30124. shader: string;
  30125. };
  30126. }
  30127. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  30128. /** @hidden */
  30129. export var bumpFragmentMainFunctions: {
  30130. name: string;
  30131. shader: string;
  30132. };
  30133. }
  30134. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  30135. /** @hidden */
  30136. export var bumpFragmentFunctions: {
  30137. name: string;
  30138. shader: string;
  30139. };
  30140. }
  30141. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  30142. /** @hidden */
  30143. export var logDepthDeclaration: {
  30144. name: string;
  30145. shader: string;
  30146. };
  30147. }
  30148. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  30149. /** @hidden */
  30150. export var bumpFragment: {
  30151. name: string;
  30152. shader: string;
  30153. };
  30154. }
  30155. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  30156. /** @hidden */
  30157. export var depthPrePass: {
  30158. name: string;
  30159. shader: string;
  30160. };
  30161. }
  30162. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  30163. /** @hidden */
  30164. export var lightFragment: {
  30165. name: string;
  30166. shader: string;
  30167. };
  30168. }
  30169. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  30170. /** @hidden */
  30171. export var logDepthFragment: {
  30172. name: string;
  30173. shader: string;
  30174. };
  30175. }
  30176. declare module "babylonjs/Shaders/default.fragment" {
  30177. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  30178. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  30179. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  30180. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  30181. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  30182. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  30183. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  30184. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  30185. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  30186. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  30187. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  30188. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  30189. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  30190. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  30191. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  30192. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  30193. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  30194. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  30195. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  30196. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  30197. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  30198. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  30199. /** @hidden */
  30200. export var defaultPixelShader: {
  30201. name: string;
  30202. shader: string;
  30203. };
  30204. }
  30205. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  30206. /** @hidden */
  30207. export var defaultVertexDeclaration: {
  30208. name: string;
  30209. shader: string;
  30210. };
  30211. }
  30212. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  30213. /** @hidden */
  30214. export var bumpVertexDeclaration: {
  30215. name: string;
  30216. shader: string;
  30217. };
  30218. }
  30219. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  30220. /** @hidden */
  30221. export var bumpVertex: {
  30222. name: string;
  30223. shader: string;
  30224. };
  30225. }
  30226. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  30227. /** @hidden */
  30228. export var fogVertex: {
  30229. name: string;
  30230. shader: string;
  30231. };
  30232. }
  30233. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  30234. /** @hidden */
  30235. export var shadowsVertex: {
  30236. name: string;
  30237. shader: string;
  30238. };
  30239. }
  30240. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  30241. /** @hidden */
  30242. export var pointCloudVertex: {
  30243. name: string;
  30244. shader: string;
  30245. };
  30246. }
  30247. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  30248. /** @hidden */
  30249. export var logDepthVertex: {
  30250. name: string;
  30251. shader: string;
  30252. };
  30253. }
  30254. declare module "babylonjs/Shaders/default.vertex" {
  30255. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  30256. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  30257. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  30258. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  30259. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  30260. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  30261. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  30262. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  30263. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  30264. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  30265. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  30266. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  30267. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  30268. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  30269. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  30270. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  30271. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  30272. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  30273. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  30274. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  30275. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  30276. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  30277. /** @hidden */
  30278. export var defaultVertexShader: {
  30279. name: string;
  30280. shader: string;
  30281. };
  30282. }
  30283. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  30284. import { Nullable } from "babylonjs/types";
  30285. import { Scene } from "babylonjs/scene";
  30286. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  30287. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  30288. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  30289. /**
  30290. * @hidden
  30291. */
  30292. export interface IMaterialDetailMapDefines {
  30293. DETAIL: boolean;
  30294. DETAILDIRECTUV: number;
  30295. DETAIL_NORMALBLENDMETHOD: number;
  30296. /** @hidden */
  30297. _areTexturesDirty: boolean;
  30298. }
  30299. /**
  30300. * Define the code related to the detail map parameters of a material
  30301. *
  30302. * Inspired from:
  30303. * Unity: https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@9.0/manual/Mask-Map-and-Detail-Map.html and https://docs.unity3d.com/Manual/StandardShaderMaterialParameterDetail.html
  30304. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  30305. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  30306. */
  30307. export class DetailMapConfiguration {
  30308. private _texture;
  30309. /**
  30310. * The detail texture of the material.
  30311. */
  30312. texture: Nullable<BaseTexture>;
  30313. /**
  30314. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  30315. * Bigger values mean stronger blending
  30316. */
  30317. diffuseBlendLevel: number;
  30318. /**
  30319. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  30320. * Bigger values mean stronger blending. Only used with PBR materials
  30321. */
  30322. roughnessBlendLevel: number;
  30323. /**
  30324. * Defines how strong the bump effect from the detail map is
  30325. * Bigger values mean stronger effect
  30326. */
  30327. bumpLevel: number;
  30328. private _normalBlendMethod;
  30329. /**
  30330. * The method used to blend the bump and detail normals together
  30331. */
  30332. normalBlendMethod: number;
  30333. private _isEnabled;
  30334. /**
  30335. * Enable or disable the detail map on this material
  30336. */
  30337. isEnabled: boolean;
  30338. /** @hidden */
  30339. private _internalMarkAllSubMeshesAsTexturesDirty;
  30340. /** @hidden */
  30341. _markAllSubMeshesAsTexturesDirty(): void;
  30342. /**
  30343. * Instantiate a new detail map
  30344. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  30345. */
  30346. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  30347. /**
  30348. * Gets whether the submesh is ready to be used or not.
  30349. * @param defines the list of "defines" to update.
  30350. * @param scene defines the scene the material belongs to.
  30351. * @returns - boolean indicating that the submesh is ready or not.
  30352. */
  30353. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  30354. /**
  30355. * Update the defines for detail map usage
  30356. * @param defines the list of "defines" to update.
  30357. * @param scene defines the scene the material belongs to.
  30358. */
  30359. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  30360. /**
  30361. * Binds the material data.
  30362. * @param uniformBuffer defines the Uniform buffer to fill in.
  30363. * @param scene defines the scene the material belongs to.
  30364. * @param isFrozen defines whether the material is frozen or not.
  30365. */
  30366. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  30367. /**
  30368. * Checks to see if a texture is used in the material.
  30369. * @param texture - Base texture to use.
  30370. * @returns - Boolean specifying if a texture is used in the material.
  30371. */
  30372. hasTexture(texture: BaseTexture): boolean;
  30373. /**
  30374. * Returns an array of the actively used textures.
  30375. * @param activeTextures Array of BaseTextures
  30376. */
  30377. getActiveTextures(activeTextures: BaseTexture[]): void;
  30378. /**
  30379. * Returns the animatable textures.
  30380. * @param animatables Array of animatable textures.
  30381. */
  30382. getAnimatables(animatables: IAnimatable[]): void;
  30383. /**
  30384. * Disposes the resources of the material.
  30385. * @param forceDisposeTextures - Forces the disposal of all textures.
  30386. */
  30387. dispose(forceDisposeTextures?: boolean): void;
  30388. /**
  30389. * Get the current class name useful for serialization or dynamic coding.
  30390. * @returns "DetailMap"
  30391. */
  30392. getClassName(): string;
  30393. /**
  30394. * Add the required uniforms to the current list.
  30395. * @param uniforms defines the current uniform list.
  30396. */
  30397. static AddUniforms(uniforms: string[]): void;
  30398. /**
  30399. * Add the required samplers to the current list.
  30400. * @param samplers defines the current sampler list.
  30401. */
  30402. static AddSamplers(samplers: string[]): void;
  30403. /**
  30404. * Add the required uniforms to the current buffer.
  30405. * @param uniformBuffer defines the current uniform buffer.
  30406. */
  30407. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  30408. /**
  30409. * Makes a duplicate of the current instance into another one.
  30410. * @param detailMap define the instance where to copy the info
  30411. */
  30412. copyTo(detailMap: DetailMapConfiguration): void;
  30413. /**
  30414. * Serializes this detail map instance
  30415. * @returns - An object with the serialized instance.
  30416. */
  30417. serialize(): any;
  30418. /**
  30419. * Parses a detail map setting from a serialized object.
  30420. * @param source - Serialized object.
  30421. * @param scene Defines the scene we are parsing for
  30422. * @param rootUrl Defines the rootUrl to load from
  30423. */
  30424. parse(source: any, scene: Scene, rootUrl: string): void;
  30425. }
  30426. }
  30427. declare module "babylonjs/Materials/standardMaterial" {
  30428. import { SmartArray } from "babylonjs/Misc/smartArray";
  30429. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  30430. import { Nullable } from "babylonjs/types";
  30431. import { Scene } from "babylonjs/scene";
  30432. import { Matrix } from "babylonjs/Maths/math.vector";
  30433. import { Color3 } from "babylonjs/Maths/math.color";
  30434. import { SubMesh } from "babylonjs/Meshes/subMesh";
  30435. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30436. import { Mesh } from "babylonjs/Meshes/mesh";
  30437. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  30438. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  30439. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  30440. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  30441. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  30442. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  30443. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30444. import "babylonjs/Shaders/default.fragment";
  30445. import "babylonjs/Shaders/default.vertex";
  30446. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  30447. /** @hidden */
  30448. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  30449. MAINUV1: boolean;
  30450. MAINUV2: boolean;
  30451. DIFFUSE: boolean;
  30452. DIFFUSEDIRECTUV: number;
  30453. DETAIL: boolean;
  30454. DETAILDIRECTUV: number;
  30455. DETAIL_NORMALBLENDMETHOD: number;
  30456. AMBIENT: boolean;
  30457. AMBIENTDIRECTUV: number;
  30458. OPACITY: boolean;
  30459. OPACITYDIRECTUV: number;
  30460. OPACITYRGB: boolean;
  30461. REFLECTION: boolean;
  30462. EMISSIVE: boolean;
  30463. EMISSIVEDIRECTUV: number;
  30464. SPECULAR: boolean;
  30465. SPECULARDIRECTUV: number;
  30466. BUMP: boolean;
  30467. BUMPDIRECTUV: number;
  30468. PARALLAX: boolean;
  30469. PARALLAXOCCLUSION: boolean;
  30470. SPECULAROVERALPHA: boolean;
  30471. CLIPPLANE: boolean;
  30472. CLIPPLANE2: boolean;
  30473. CLIPPLANE3: boolean;
  30474. CLIPPLANE4: boolean;
  30475. CLIPPLANE5: boolean;
  30476. CLIPPLANE6: boolean;
  30477. ALPHATEST: boolean;
  30478. DEPTHPREPASS: boolean;
  30479. ALPHAFROMDIFFUSE: boolean;
  30480. POINTSIZE: boolean;
  30481. FOG: boolean;
  30482. SPECULARTERM: boolean;
  30483. DIFFUSEFRESNEL: boolean;
  30484. OPACITYFRESNEL: boolean;
  30485. REFLECTIONFRESNEL: boolean;
  30486. REFRACTIONFRESNEL: boolean;
  30487. EMISSIVEFRESNEL: boolean;
  30488. FRESNEL: boolean;
  30489. NORMAL: boolean;
  30490. UV1: boolean;
  30491. UV2: boolean;
  30492. VERTEXCOLOR: boolean;
  30493. VERTEXALPHA: boolean;
  30494. NUM_BONE_INFLUENCERS: number;
  30495. BonesPerMesh: number;
  30496. BONETEXTURE: boolean;
  30497. INSTANCES: boolean;
  30498. THIN_INSTANCES: boolean;
  30499. GLOSSINESS: boolean;
  30500. ROUGHNESS: boolean;
  30501. EMISSIVEASILLUMINATION: boolean;
  30502. LINKEMISSIVEWITHDIFFUSE: boolean;
  30503. REFLECTIONFRESNELFROMSPECULAR: boolean;
  30504. LIGHTMAP: boolean;
  30505. LIGHTMAPDIRECTUV: number;
  30506. OBJECTSPACE_NORMALMAP: boolean;
  30507. USELIGHTMAPASSHADOWMAP: boolean;
  30508. REFLECTIONMAP_3D: boolean;
  30509. REFLECTIONMAP_SPHERICAL: boolean;
  30510. REFLECTIONMAP_PLANAR: boolean;
  30511. REFLECTIONMAP_CUBIC: boolean;
  30512. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  30513. REFLECTIONMAP_PROJECTION: boolean;
  30514. REFLECTIONMAP_SKYBOX: boolean;
  30515. REFLECTIONMAP_EXPLICIT: boolean;
  30516. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  30517. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  30518. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  30519. INVERTCUBICMAP: boolean;
  30520. LOGARITHMICDEPTH: boolean;
  30521. REFRACTION: boolean;
  30522. REFRACTIONMAP_3D: boolean;
  30523. REFLECTIONOVERALPHA: boolean;
  30524. TWOSIDEDLIGHTING: boolean;
  30525. SHADOWFLOAT: boolean;
  30526. MORPHTARGETS: boolean;
  30527. MORPHTARGETS_NORMAL: boolean;
  30528. MORPHTARGETS_TANGENT: boolean;
  30529. MORPHTARGETS_UV: boolean;
  30530. NUM_MORPH_INFLUENCERS: number;
  30531. NONUNIFORMSCALING: boolean;
  30532. PREMULTIPLYALPHA: boolean;
  30533. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  30534. ALPHABLEND: boolean;
  30535. RGBDLIGHTMAP: boolean;
  30536. RGBDREFLECTION: boolean;
  30537. RGBDREFRACTION: boolean;
  30538. IMAGEPROCESSING: boolean;
  30539. VIGNETTE: boolean;
  30540. VIGNETTEBLENDMODEMULTIPLY: boolean;
  30541. VIGNETTEBLENDMODEOPAQUE: boolean;
  30542. TONEMAPPING: boolean;
  30543. TONEMAPPING_ACES: boolean;
  30544. CONTRAST: boolean;
  30545. COLORCURVES: boolean;
  30546. COLORGRADING: boolean;
  30547. COLORGRADING3D: boolean;
  30548. SAMPLER3DGREENDEPTH: boolean;
  30549. SAMPLER3DBGRMAP: boolean;
  30550. IMAGEPROCESSINGPOSTPROCESS: boolean;
  30551. MULTIVIEW: boolean;
  30552. /**
  30553. * If the reflection texture on this material is in linear color space
  30554. * @hidden
  30555. */
  30556. IS_REFLECTION_LINEAR: boolean;
  30557. /**
  30558. * If the refraction texture on this material is in linear color space
  30559. * @hidden
  30560. */
  30561. IS_REFRACTION_LINEAR: boolean;
  30562. EXPOSURE: boolean;
  30563. constructor();
  30564. setReflectionMode(modeToEnable: string): void;
  30565. }
  30566. /**
  30567. * This is the default material used in Babylon. It is the best trade off between quality
  30568. * and performances.
  30569. * @see http://doc.babylonjs.com/babylon101/materials
  30570. */
  30571. export class StandardMaterial extends PushMaterial {
  30572. private _diffuseTexture;
  30573. /**
  30574. * The basic texture of the material as viewed under a light.
  30575. */
  30576. diffuseTexture: Nullable<BaseTexture>;
  30577. private _ambientTexture;
  30578. /**
  30579. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  30580. */
  30581. ambientTexture: Nullable<BaseTexture>;
  30582. private _opacityTexture;
  30583. /**
  30584. * Define the transparency of the material from a texture.
  30585. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  30586. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  30587. */
  30588. opacityTexture: Nullable<BaseTexture>;
  30589. private _reflectionTexture;
  30590. /**
  30591. * Define the texture used to display the reflection.
  30592. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  30593. */
  30594. reflectionTexture: Nullable<BaseTexture>;
  30595. private _emissiveTexture;
  30596. /**
  30597. * Define texture of the material as if self lit.
  30598. * This will be mixed in the final result even in the absence of light.
  30599. */
  30600. emissiveTexture: Nullable<BaseTexture>;
  30601. private _specularTexture;
  30602. /**
  30603. * Define how the color and intensity of the highlight given by the light in the material.
  30604. */
  30605. specularTexture: Nullable<BaseTexture>;
  30606. private _bumpTexture;
  30607. /**
  30608. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  30609. * 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.
  30610. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  30611. */
  30612. bumpTexture: Nullable<BaseTexture>;
  30613. private _lightmapTexture;
  30614. /**
  30615. * Complex lighting can be computationally expensive to compute at runtime.
  30616. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  30617. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  30618. */
  30619. lightmapTexture: Nullable<BaseTexture>;
  30620. private _refractionTexture;
  30621. /**
  30622. * Define the texture used to display the refraction.
  30623. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  30624. */
  30625. refractionTexture: Nullable<BaseTexture>;
  30626. /**
  30627. * The color of the material lit by the environmental background lighting.
  30628. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  30629. */
  30630. ambientColor: Color3;
  30631. /**
  30632. * The basic color of the material as viewed under a light.
  30633. */
  30634. diffuseColor: Color3;
  30635. /**
  30636. * Define how the color and intensity of the highlight given by the light in the material.
  30637. */
  30638. specularColor: Color3;
  30639. /**
  30640. * Define the color of the material as if self lit.
  30641. * This will be mixed in the final result even in the absence of light.
  30642. */
  30643. emissiveColor: Color3;
  30644. /**
  30645. * Defines how sharp are the highlights in the material.
  30646. * The bigger the value the sharper giving a more glossy feeling to the result.
  30647. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  30648. */
  30649. specularPower: number;
  30650. private _useAlphaFromDiffuseTexture;
  30651. /**
  30652. * Does the transparency come from the diffuse texture alpha channel.
  30653. */
  30654. useAlphaFromDiffuseTexture: boolean;
  30655. private _useEmissiveAsIllumination;
  30656. /**
  30657. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  30658. */
  30659. useEmissiveAsIllumination: boolean;
  30660. private _linkEmissiveWithDiffuse;
  30661. /**
  30662. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  30663. * the emissive level when the final color is close to one.
  30664. */
  30665. linkEmissiveWithDiffuse: boolean;
  30666. private _useSpecularOverAlpha;
  30667. /**
  30668. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  30669. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  30670. */
  30671. useSpecularOverAlpha: boolean;
  30672. private _useReflectionOverAlpha;
  30673. /**
  30674. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  30675. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  30676. */
  30677. useReflectionOverAlpha: boolean;
  30678. private _disableLighting;
  30679. /**
  30680. * Does lights from the scene impacts this material.
  30681. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  30682. */
  30683. disableLighting: boolean;
  30684. private _useObjectSpaceNormalMap;
  30685. /**
  30686. * Allows using an object space normal map (instead of tangent space).
  30687. */
  30688. useObjectSpaceNormalMap: boolean;
  30689. private _useParallax;
  30690. /**
  30691. * Is parallax enabled or not.
  30692. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  30693. */
  30694. useParallax: boolean;
  30695. private _useParallaxOcclusion;
  30696. /**
  30697. * Is parallax occlusion enabled or not.
  30698. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  30699. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  30700. */
  30701. useParallaxOcclusion: boolean;
  30702. /**
  30703. * 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.
  30704. */
  30705. parallaxScaleBias: number;
  30706. private _roughness;
  30707. /**
  30708. * Helps to define how blurry the reflections should appears in the material.
  30709. */
  30710. roughness: number;
  30711. /**
  30712. * In case of refraction, define the value of the index of refraction.
  30713. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  30714. */
  30715. indexOfRefraction: number;
  30716. /**
  30717. * Invert the refraction texture alongside the y axis.
  30718. * It can be useful with procedural textures or probe for instance.
  30719. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  30720. */
  30721. invertRefractionY: boolean;
  30722. /**
  30723. * Defines the alpha limits in alpha test mode.
  30724. */
  30725. alphaCutOff: number;
  30726. private _useLightmapAsShadowmap;
  30727. /**
  30728. * In case of light mapping, define whether the map contains light or shadow informations.
  30729. */
  30730. useLightmapAsShadowmap: boolean;
  30731. private _diffuseFresnelParameters;
  30732. /**
  30733. * Define the diffuse fresnel parameters of the material.
  30734. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30735. */
  30736. diffuseFresnelParameters: FresnelParameters;
  30737. private _opacityFresnelParameters;
  30738. /**
  30739. * Define the opacity fresnel parameters of the material.
  30740. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30741. */
  30742. opacityFresnelParameters: FresnelParameters;
  30743. private _reflectionFresnelParameters;
  30744. /**
  30745. * Define the reflection fresnel parameters of the material.
  30746. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30747. */
  30748. reflectionFresnelParameters: FresnelParameters;
  30749. private _refractionFresnelParameters;
  30750. /**
  30751. * Define the refraction fresnel parameters of the material.
  30752. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30753. */
  30754. refractionFresnelParameters: FresnelParameters;
  30755. private _emissiveFresnelParameters;
  30756. /**
  30757. * Define the emissive fresnel parameters of the material.
  30758. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30759. */
  30760. emissiveFresnelParameters: FresnelParameters;
  30761. private _useReflectionFresnelFromSpecular;
  30762. /**
  30763. * If true automatically deducts the fresnels values from the material specularity.
  30764. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30765. */
  30766. useReflectionFresnelFromSpecular: boolean;
  30767. private _useGlossinessFromSpecularMapAlpha;
  30768. /**
  30769. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  30770. */
  30771. useGlossinessFromSpecularMapAlpha: boolean;
  30772. private _maxSimultaneousLights;
  30773. /**
  30774. * Defines the maximum number of lights that can be used in the material
  30775. */
  30776. maxSimultaneousLights: number;
  30777. private _invertNormalMapX;
  30778. /**
  30779. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  30780. */
  30781. invertNormalMapX: boolean;
  30782. private _invertNormalMapY;
  30783. /**
  30784. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  30785. */
  30786. invertNormalMapY: boolean;
  30787. private _twoSidedLighting;
  30788. /**
  30789. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  30790. */
  30791. twoSidedLighting: boolean;
  30792. /**
  30793. * Default configuration related to image processing available in the standard Material.
  30794. */
  30795. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  30796. /**
  30797. * Gets the image processing configuration used either in this material.
  30798. */
  30799. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  30800. /**
  30801. * Sets the Default image processing configuration used either in the this material.
  30802. *
  30803. * If sets to null, the scene one is in use.
  30804. */
  30805. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  30806. /**
  30807. * Keep track of the image processing observer to allow dispose and replace.
  30808. */
  30809. private _imageProcessingObserver;
  30810. /**
  30811. * Attaches a new image processing configuration to the Standard Material.
  30812. * @param configuration
  30813. */
  30814. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  30815. /**
  30816. * Gets wether the color curves effect is enabled.
  30817. */
  30818. get cameraColorCurvesEnabled(): boolean;
  30819. /**
  30820. * Sets wether the color curves effect is enabled.
  30821. */
  30822. set cameraColorCurvesEnabled(value: boolean);
  30823. /**
  30824. * Gets wether the color grading effect is enabled.
  30825. */
  30826. get cameraColorGradingEnabled(): boolean;
  30827. /**
  30828. * Gets wether the color grading effect is enabled.
  30829. */
  30830. set cameraColorGradingEnabled(value: boolean);
  30831. /**
  30832. * Gets wether tonemapping is enabled or not.
  30833. */
  30834. get cameraToneMappingEnabled(): boolean;
  30835. /**
  30836. * Sets wether tonemapping is enabled or not
  30837. */
  30838. set cameraToneMappingEnabled(value: boolean);
  30839. /**
  30840. * The camera exposure used on this material.
  30841. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  30842. * This corresponds to a photographic exposure.
  30843. */
  30844. get cameraExposure(): number;
  30845. /**
  30846. * The camera exposure used on this material.
  30847. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  30848. * This corresponds to a photographic exposure.
  30849. */
  30850. set cameraExposure(value: number);
  30851. /**
  30852. * Gets The camera contrast used on this material.
  30853. */
  30854. get cameraContrast(): number;
  30855. /**
  30856. * Sets The camera contrast used on this material.
  30857. */
  30858. set cameraContrast(value: number);
  30859. /**
  30860. * Gets the Color Grading 2D Lookup Texture.
  30861. */
  30862. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  30863. /**
  30864. * Sets the Color Grading 2D Lookup Texture.
  30865. */
  30866. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  30867. /**
  30868. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  30869. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  30870. * 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;
  30871. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  30872. */
  30873. get cameraColorCurves(): Nullable<ColorCurves>;
  30874. /**
  30875. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  30876. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  30877. * 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;
  30878. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  30879. */
  30880. set cameraColorCurves(value: Nullable<ColorCurves>);
  30881. /**
  30882. * Defines the detail map parameters for the material.
  30883. */
  30884. readonly detailMap: DetailMapConfiguration;
  30885. protected _renderTargets: SmartArray<RenderTargetTexture>;
  30886. protected _worldViewProjectionMatrix: Matrix;
  30887. protected _globalAmbientColor: Color3;
  30888. protected _useLogarithmicDepth: boolean;
  30889. protected _rebuildInParallel: boolean;
  30890. /**
  30891. * Instantiates a new standard material.
  30892. * This is the default material used in Babylon. It is the best trade off between quality
  30893. * and performances.
  30894. * @see http://doc.babylonjs.com/babylon101/materials
  30895. * @param name Define the name of the material in the scene
  30896. * @param scene Define the scene the material belong to
  30897. */
  30898. constructor(name: string, scene: Scene);
  30899. /**
  30900. * Gets a boolean indicating that current material needs to register RTT
  30901. */
  30902. get hasRenderTargetTextures(): boolean;
  30903. /**
  30904. * Gets the current class name of the material e.g. "StandardMaterial"
  30905. * Mainly use in serialization.
  30906. * @returns the class name
  30907. */
  30908. getClassName(): string;
  30909. /**
  30910. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  30911. * You can try switching to logarithmic depth.
  30912. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  30913. */
  30914. get useLogarithmicDepth(): boolean;
  30915. set useLogarithmicDepth(value: boolean);
  30916. /**
  30917. * Specifies if the material will require alpha blending
  30918. * @returns a boolean specifying if alpha blending is needed
  30919. */
  30920. needAlphaBlending(): boolean;
  30921. /**
  30922. * Specifies if this material should be rendered in alpha test mode
  30923. * @returns a boolean specifying if an alpha test is needed.
  30924. */
  30925. needAlphaTesting(): boolean;
  30926. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  30927. /**
  30928. * Get the texture used for alpha test purpose.
  30929. * @returns the diffuse texture in case of the standard material.
  30930. */
  30931. getAlphaTestTexture(): Nullable<BaseTexture>;
  30932. /**
  30933. * Get if the submesh is ready to be used and all its information available.
  30934. * Child classes can use it to update shaders
  30935. * @param mesh defines the mesh to check
  30936. * @param subMesh defines which submesh to check
  30937. * @param useInstances specifies that instances should be used
  30938. * @returns a boolean indicating that the submesh is ready or not
  30939. */
  30940. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  30941. /**
  30942. * Builds the material UBO layouts.
  30943. * Used internally during the effect preparation.
  30944. */
  30945. buildUniformLayout(): void;
  30946. /**
  30947. * Unbinds the material from the mesh
  30948. */
  30949. unbind(): void;
  30950. /**
  30951. * Binds the submesh to this material by preparing the effect and shader to draw
  30952. * @param world defines the world transformation matrix
  30953. * @param mesh defines the mesh containing the submesh
  30954. * @param subMesh defines the submesh to bind the material to
  30955. */
  30956. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  30957. /**
  30958. * Get the list of animatables in the material.
  30959. * @returns the list of animatables object used in the material
  30960. */
  30961. getAnimatables(): IAnimatable[];
  30962. /**
  30963. * Gets the active textures from the material
  30964. * @returns an array of textures
  30965. */
  30966. getActiveTextures(): BaseTexture[];
  30967. /**
  30968. * Specifies if the material uses a texture
  30969. * @param texture defines the texture to check against the material
  30970. * @returns a boolean specifying if the material uses the texture
  30971. */
  30972. hasTexture(texture: BaseTexture): boolean;
  30973. /**
  30974. * Disposes the material
  30975. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  30976. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  30977. */
  30978. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  30979. /**
  30980. * Makes a duplicate of the material, and gives it a new name
  30981. * @param name defines the new name for the duplicated material
  30982. * @returns the cloned material
  30983. */
  30984. clone(name: string): StandardMaterial;
  30985. /**
  30986. * Serializes this material in a JSON representation
  30987. * @returns the serialized material object
  30988. */
  30989. serialize(): any;
  30990. /**
  30991. * Creates a standard material from parsed material data
  30992. * @param source defines the JSON representation of the material
  30993. * @param scene defines the hosting scene
  30994. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  30995. * @returns a new standard material
  30996. */
  30997. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  30998. /**
  30999. * Are diffuse textures enabled in the application.
  31000. */
  31001. static get DiffuseTextureEnabled(): boolean;
  31002. static set DiffuseTextureEnabled(value: boolean);
  31003. /**
  31004. * Are detail textures enabled in the application.
  31005. */
  31006. static get DetailTextureEnabled(): boolean;
  31007. static set DetailTextureEnabled(value: boolean);
  31008. /**
  31009. * Are ambient textures enabled in the application.
  31010. */
  31011. static get AmbientTextureEnabled(): boolean;
  31012. static set AmbientTextureEnabled(value: boolean);
  31013. /**
  31014. * Are opacity textures enabled in the application.
  31015. */
  31016. static get OpacityTextureEnabled(): boolean;
  31017. static set OpacityTextureEnabled(value: boolean);
  31018. /**
  31019. * Are reflection textures enabled in the application.
  31020. */
  31021. static get ReflectionTextureEnabled(): boolean;
  31022. static set ReflectionTextureEnabled(value: boolean);
  31023. /**
  31024. * Are emissive textures enabled in the application.
  31025. */
  31026. static get EmissiveTextureEnabled(): boolean;
  31027. static set EmissiveTextureEnabled(value: boolean);
  31028. /**
  31029. * Are specular textures enabled in the application.
  31030. */
  31031. static get SpecularTextureEnabled(): boolean;
  31032. static set SpecularTextureEnabled(value: boolean);
  31033. /**
  31034. * Are bump textures enabled in the application.
  31035. */
  31036. static get BumpTextureEnabled(): boolean;
  31037. static set BumpTextureEnabled(value: boolean);
  31038. /**
  31039. * Are lightmap textures enabled in the application.
  31040. */
  31041. static get LightmapTextureEnabled(): boolean;
  31042. static set LightmapTextureEnabled(value: boolean);
  31043. /**
  31044. * Are refraction textures enabled in the application.
  31045. */
  31046. static get RefractionTextureEnabled(): boolean;
  31047. static set RefractionTextureEnabled(value: boolean);
  31048. /**
  31049. * Are color grading textures enabled in the application.
  31050. */
  31051. static get ColorGradingTextureEnabled(): boolean;
  31052. static set ColorGradingTextureEnabled(value: boolean);
  31053. /**
  31054. * Are fresnels enabled in the application.
  31055. */
  31056. static get FresnelEnabled(): boolean;
  31057. static set FresnelEnabled(value: boolean);
  31058. }
  31059. }
  31060. declare module "babylonjs/Particles/solidParticleSystem" {
  31061. import { Nullable } from "babylonjs/types";
  31062. import { Mesh } from "babylonjs/Meshes/mesh";
  31063. import { Scene, IDisposable } from "babylonjs/scene";
  31064. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  31065. import { Material } from "babylonjs/Materials/material";
  31066. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  31067. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  31068. /**
  31069. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  31070. *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.
  31071. * The SPS is also a particle system. It provides some methods to manage the particles.
  31072. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  31073. *
  31074. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  31075. */
  31076. export class SolidParticleSystem implements IDisposable {
  31077. /**
  31078. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  31079. * Example : var p = SPS.particles[i];
  31080. */
  31081. particles: SolidParticle[];
  31082. /**
  31083. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  31084. */
  31085. nbParticles: number;
  31086. /**
  31087. * If the particles must ever face the camera (default false). Useful for planar particles.
  31088. */
  31089. billboard: boolean;
  31090. /**
  31091. * Recompute normals when adding a shape
  31092. */
  31093. recomputeNormals: boolean;
  31094. /**
  31095. * This a counter ofr your own usage. It's not set by any SPS functions.
  31096. */
  31097. counter: number;
  31098. /**
  31099. * The SPS name. This name is also given to the underlying mesh.
  31100. */
  31101. name: string;
  31102. /**
  31103. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  31104. */
  31105. mesh: Mesh;
  31106. /**
  31107. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  31108. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  31109. */
  31110. vars: any;
  31111. /**
  31112. * This array is populated when the SPS is set as 'pickable'.
  31113. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  31114. * Each element of this array is an object `{idx: int, faceId: int}`.
  31115. * `idx` is the picked particle index in the `SPS.particles` array
  31116. * `faceId` is the picked face index counted within this particle.
  31117. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  31118. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  31119. * Use the method SPS.pickedParticle(pickingInfo) instead.
  31120. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  31121. */
  31122. pickedParticles: {
  31123. idx: number;
  31124. faceId: number;
  31125. }[];
  31126. /**
  31127. * This array is populated when the SPS is set as 'pickable'
  31128. * Each key of this array is a submesh index.
  31129. * Each element of this array is a second array defined like this :
  31130. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  31131. * Each element of this second array is an object `{idx: int, faceId: int}`.
  31132. * `idx` is the picked particle index in the `SPS.particles` array
  31133. * `faceId` is the picked face index counted within this particle.
  31134. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  31135. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  31136. */
  31137. pickedBySubMesh: {
  31138. idx: number;
  31139. faceId: number;
  31140. }[][];
  31141. /**
  31142. * This array is populated when `enableDepthSort` is set to true.
  31143. * Each element of this array is an instance of the class DepthSortedParticle.
  31144. */
  31145. depthSortedParticles: DepthSortedParticle[];
  31146. /**
  31147. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  31148. * @hidden
  31149. */
  31150. _bSphereOnly: boolean;
  31151. /**
  31152. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  31153. * @hidden
  31154. */
  31155. _bSphereRadiusFactor: number;
  31156. private _scene;
  31157. private _positions;
  31158. private _indices;
  31159. private _normals;
  31160. private _colors;
  31161. private _uvs;
  31162. private _indices32;
  31163. private _positions32;
  31164. private _normals32;
  31165. private _fixedNormal32;
  31166. private _colors32;
  31167. private _uvs32;
  31168. private _index;
  31169. private _updatable;
  31170. private _pickable;
  31171. private _isVisibilityBoxLocked;
  31172. private _alwaysVisible;
  31173. private _depthSort;
  31174. private _expandable;
  31175. private _shapeCounter;
  31176. private _copy;
  31177. private _color;
  31178. private _computeParticleColor;
  31179. private _computeParticleTexture;
  31180. private _computeParticleRotation;
  31181. private _computeParticleVertex;
  31182. private _computeBoundingBox;
  31183. private _depthSortParticles;
  31184. private _camera;
  31185. private _mustUnrotateFixedNormals;
  31186. private _particlesIntersect;
  31187. private _needs32Bits;
  31188. private _isNotBuilt;
  31189. private _lastParticleId;
  31190. private _idxOfId;
  31191. private _multimaterialEnabled;
  31192. private _useModelMaterial;
  31193. private _indicesByMaterial;
  31194. private _materialIndexes;
  31195. private _depthSortFunction;
  31196. private _materialSortFunction;
  31197. private _materials;
  31198. private _multimaterial;
  31199. private _materialIndexesById;
  31200. private _defaultMaterial;
  31201. private _autoUpdateSubMeshes;
  31202. private _tmpVertex;
  31203. /**
  31204. * Creates a SPS (Solid Particle System) object.
  31205. * @param name (String) is the SPS name, this will be the underlying mesh name.
  31206. * @param scene (Scene) is the scene in which the SPS is added.
  31207. * @param options defines the options of the sps e.g.
  31208. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  31209. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  31210. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  31211. * * useModelMaterial (optional boolean, defaut false) : if the model materials must be used to create the SPS multimaterial. This enables the multimaterial supports of the SPS.
  31212. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  31213. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  31214. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  31215. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  31216. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  31217. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  31218. */
  31219. constructor(name: string, scene: Scene, options?: {
  31220. updatable?: boolean;
  31221. isPickable?: boolean;
  31222. enableDepthSort?: boolean;
  31223. particleIntersection?: boolean;
  31224. boundingSphereOnly?: boolean;
  31225. bSphereRadiusFactor?: number;
  31226. expandable?: boolean;
  31227. useModelMaterial?: boolean;
  31228. enableMultiMaterial?: boolean;
  31229. });
  31230. /**
  31231. * Builds the SPS underlying mesh. Returns a standard Mesh.
  31232. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  31233. * @returns the created mesh
  31234. */
  31235. buildMesh(): Mesh;
  31236. /**
  31237. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  31238. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  31239. * Thus the particles generated from `digest()` have their property `position` set yet.
  31240. * @param mesh ( Mesh ) is the mesh to be digested
  31241. * @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
  31242. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  31243. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  31244. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  31245. * @returns the current SPS
  31246. */
  31247. digest(mesh: Mesh, options?: {
  31248. facetNb?: number;
  31249. number?: number;
  31250. delta?: number;
  31251. storage?: [];
  31252. }): SolidParticleSystem;
  31253. /**
  31254. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  31255. * @hidden
  31256. */
  31257. private _unrotateFixedNormals;
  31258. /**
  31259. * Resets the temporary working copy particle
  31260. * @hidden
  31261. */
  31262. private _resetCopy;
  31263. /**
  31264. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  31265. * @param p the current index in the positions array to be updated
  31266. * @param ind the current index in the indices array
  31267. * @param shape a Vector3 array, the shape geometry
  31268. * @param positions the positions array to be updated
  31269. * @param meshInd the shape indices array
  31270. * @param indices the indices array to be updated
  31271. * @param meshUV the shape uv array
  31272. * @param uvs the uv array to be updated
  31273. * @param meshCol the shape color array
  31274. * @param colors the color array to be updated
  31275. * @param meshNor the shape normals array
  31276. * @param normals the normals array to be updated
  31277. * @param idx the particle index
  31278. * @param idxInShape the particle index in its shape
  31279. * @param options the addShape() method passed options
  31280. * @model the particle model
  31281. * @hidden
  31282. */
  31283. private _meshBuilder;
  31284. /**
  31285. * Returns a shape Vector3 array from positions float array
  31286. * @param positions float array
  31287. * @returns a vector3 array
  31288. * @hidden
  31289. */
  31290. private _posToShape;
  31291. /**
  31292. * Returns a shapeUV array from a float uvs (array deep copy)
  31293. * @param uvs as a float array
  31294. * @returns a shapeUV array
  31295. * @hidden
  31296. */
  31297. private _uvsToShapeUV;
  31298. /**
  31299. * Adds a new particle object in the particles array
  31300. * @param idx particle index in particles array
  31301. * @param id particle id
  31302. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  31303. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  31304. * @param model particle ModelShape object
  31305. * @param shapeId model shape identifier
  31306. * @param idxInShape index of the particle in the current model
  31307. * @param bInfo model bounding info object
  31308. * @param storage target storage array, if any
  31309. * @hidden
  31310. */
  31311. private _addParticle;
  31312. /**
  31313. * Adds some particles to the SPS from the model shape. Returns the shape id.
  31314. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  31315. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  31316. * @param nb (positive integer) the number of particles to be created from this model
  31317. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  31318. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  31319. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  31320. * @returns the number of shapes in the system
  31321. */
  31322. addShape(mesh: Mesh, nb: number, options?: {
  31323. positionFunction?: any;
  31324. vertexFunction?: any;
  31325. storage?: [];
  31326. }): number;
  31327. /**
  31328. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  31329. * @hidden
  31330. */
  31331. private _rebuildParticle;
  31332. /**
  31333. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  31334. * @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.
  31335. * @returns the SPS.
  31336. */
  31337. rebuildMesh(reset?: boolean): SolidParticleSystem;
  31338. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  31339. * Returns an array with the removed particles.
  31340. * 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.
  31341. * The SPS can't be empty so at least one particle needs to remain in place.
  31342. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  31343. * @param start index of the first particle to remove
  31344. * @param end index of the last particle to remove (included)
  31345. * @returns an array populated with the removed particles
  31346. */
  31347. removeParticles(start: number, end: number): SolidParticle[];
  31348. /**
  31349. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  31350. * @param solidParticleArray an array populated with Solid Particles objects
  31351. * @returns the SPS
  31352. */
  31353. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  31354. /**
  31355. * Creates a new particle and modifies the SPS mesh geometry :
  31356. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  31357. * - calls _addParticle() to populate the particle array
  31358. * factorized code from addShape() and insertParticlesFromArray()
  31359. * @param idx particle index in the particles array
  31360. * @param i particle index in its shape
  31361. * @param modelShape particle ModelShape object
  31362. * @param shape shape vertex array
  31363. * @param meshInd shape indices array
  31364. * @param meshUV shape uv array
  31365. * @param meshCol shape color array
  31366. * @param meshNor shape normals array
  31367. * @param bbInfo shape bounding info
  31368. * @param storage target particle storage
  31369. * @options addShape() passed options
  31370. * @hidden
  31371. */
  31372. private _insertNewParticle;
  31373. /**
  31374. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  31375. * This method calls `updateParticle()` for each particle of the SPS.
  31376. * For an animated SPS, it is usually called within the render loop.
  31377. * 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.
  31378. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  31379. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  31380. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  31381. * @returns the SPS.
  31382. */
  31383. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  31384. /**
  31385. * Disposes the SPS.
  31386. */
  31387. dispose(): void;
  31388. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  31389. * idx is the particle index in the SPS
  31390. * faceId is the picked face index counted within this particle.
  31391. * Returns null if the pickInfo can't identify a picked particle.
  31392. * @param pickingInfo (PickingInfo object)
  31393. * @returns {idx: number, faceId: number} or null
  31394. */
  31395. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  31396. idx: number;
  31397. faceId: number;
  31398. }>;
  31399. /**
  31400. * Returns a SolidParticle object from its identifier : particle.id
  31401. * @param id (integer) the particle Id
  31402. * @returns the searched particle or null if not found in the SPS.
  31403. */
  31404. getParticleById(id: number): Nullable<SolidParticle>;
  31405. /**
  31406. * Returns a new array populated with the particles having the passed shapeId.
  31407. * @param shapeId (integer) the shape identifier
  31408. * @returns a new solid particle array
  31409. */
  31410. getParticlesByShapeId(shapeId: number): SolidParticle[];
  31411. /**
  31412. * Populates the passed array "ref" with the particles having the passed shapeId.
  31413. * @param shapeId the shape identifier
  31414. * @returns the SPS
  31415. * @param ref
  31416. */
  31417. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  31418. /**
  31419. * Computes the required SubMeshes according the materials assigned to the particles.
  31420. * @returns the solid particle system.
  31421. * Does nothing if called before the SPS mesh is built.
  31422. */
  31423. computeSubMeshes(): SolidParticleSystem;
  31424. /**
  31425. * Sorts the solid particles by material when MultiMaterial is enabled.
  31426. * Updates the indices32 array.
  31427. * Updates the indicesByMaterial array.
  31428. * Updates the mesh indices array.
  31429. * @returns the SPS
  31430. * @hidden
  31431. */
  31432. private _sortParticlesByMaterial;
  31433. /**
  31434. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  31435. * @hidden
  31436. */
  31437. private _setMaterialIndexesById;
  31438. /**
  31439. * Returns an array with unique values of Materials from the passed array
  31440. * @param array the material array to be checked and filtered
  31441. * @hidden
  31442. */
  31443. private _filterUniqueMaterialId;
  31444. /**
  31445. * Sets a new Standard Material as _defaultMaterial if not already set.
  31446. * @hidden
  31447. */
  31448. private _setDefaultMaterial;
  31449. /**
  31450. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  31451. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  31452. * @returns the SPS.
  31453. */
  31454. refreshVisibleSize(): SolidParticleSystem;
  31455. /**
  31456. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  31457. * @param size the size (float) of the visibility box
  31458. * note : this doesn't lock the SPS mesh bounding box.
  31459. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  31460. */
  31461. setVisibilityBox(size: number): void;
  31462. /**
  31463. * Gets whether the SPS as always visible or not
  31464. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  31465. */
  31466. get isAlwaysVisible(): boolean;
  31467. /**
  31468. * Sets the SPS as always visible or not
  31469. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  31470. */
  31471. set isAlwaysVisible(val: boolean);
  31472. /**
  31473. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  31474. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  31475. */
  31476. set isVisibilityBoxLocked(val: boolean);
  31477. /**
  31478. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  31479. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  31480. */
  31481. get isVisibilityBoxLocked(): boolean;
  31482. /**
  31483. * Tells to `setParticles()` to compute the particle rotations or not.
  31484. * Default value : true. The SPS is faster when it's set to false.
  31485. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  31486. */
  31487. set computeParticleRotation(val: boolean);
  31488. /**
  31489. * Tells to `setParticles()` to compute the particle colors or not.
  31490. * Default value : true. The SPS is faster when it's set to false.
  31491. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  31492. */
  31493. set computeParticleColor(val: boolean);
  31494. set computeParticleTexture(val: boolean);
  31495. /**
  31496. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  31497. * Default value : false. The SPS is faster when it's set to false.
  31498. * Note : the particle custom vertex positions aren't stored values.
  31499. */
  31500. set computeParticleVertex(val: boolean);
  31501. /**
  31502. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  31503. */
  31504. set computeBoundingBox(val: boolean);
  31505. /**
  31506. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  31507. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  31508. * Default : `true`
  31509. */
  31510. set depthSortParticles(val: boolean);
  31511. /**
  31512. * Gets if `setParticles()` computes the particle rotations or not.
  31513. * Default value : true. The SPS is faster when it's set to false.
  31514. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  31515. */
  31516. get computeParticleRotation(): boolean;
  31517. /**
  31518. * Gets if `setParticles()` computes the particle colors or not.
  31519. * Default value : true. The SPS is faster when it's set to false.
  31520. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  31521. */
  31522. get computeParticleColor(): boolean;
  31523. /**
  31524. * Gets if `setParticles()` computes the particle textures or not.
  31525. * Default value : true. The SPS is faster when it's set to false.
  31526. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  31527. */
  31528. get computeParticleTexture(): boolean;
  31529. /**
  31530. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  31531. * Default value : false. The SPS is faster when it's set to false.
  31532. * Note : the particle custom vertex positions aren't stored values.
  31533. */
  31534. get computeParticleVertex(): boolean;
  31535. /**
  31536. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  31537. */
  31538. get computeBoundingBox(): boolean;
  31539. /**
  31540. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  31541. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  31542. * Default : `true`
  31543. */
  31544. get depthSortParticles(): boolean;
  31545. /**
  31546. * Gets if the SPS is created as expandable at construction time.
  31547. * Default : `false`
  31548. */
  31549. get expandable(): boolean;
  31550. /**
  31551. * Gets if the SPS supports the Multi Materials
  31552. */
  31553. get multimaterialEnabled(): boolean;
  31554. /**
  31555. * Gets if the SPS uses the model materials for its own multimaterial.
  31556. */
  31557. get useModelMaterial(): boolean;
  31558. /**
  31559. * The SPS used material array.
  31560. */
  31561. get materials(): Material[];
  31562. /**
  31563. * Sets the SPS MultiMaterial from the passed materials.
  31564. * Note : the passed array is internally copied and not used then by reference.
  31565. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  31566. */
  31567. setMultiMaterial(materials: Material[]): void;
  31568. /**
  31569. * The SPS computed multimaterial object
  31570. */
  31571. get multimaterial(): MultiMaterial;
  31572. set multimaterial(mm: MultiMaterial);
  31573. /**
  31574. * If the subMeshes must be updated on the next call to setParticles()
  31575. */
  31576. get autoUpdateSubMeshes(): boolean;
  31577. set autoUpdateSubMeshes(val: boolean);
  31578. /**
  31579. * This function does nothing. It may be overwritten to set all the particle first values.
  31580. * The SPS doesn't call this function, you may have to call it by your own.
  31581. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  31582. */
  31583. initParticles(): void;
  31584. /**
  31585. * This function does nothing. It may be overwritten to recycle a particle.
  31586. * The SPS doesn't call this function, you may have to call it by your own.
  31587. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  31588. * @param particle The particle to recycle
  31589. * @returns the recycled particle
  31590. */
  31591. recycleParticle(particle: SolidParticle): SolidParticle;
  31592. /**
  31593. * Updates a particle : this function should be overwritten by the user.
  31594. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  31595. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  31596. * @example : just set a particle position or velocity and recycle conditions
  31597. * @param particle The particle to update
  31598. * @returns the updated particle
  31599. */
  31600. updateParticle(particle: SolidParticle): SolidParticle;
  31601. /**
  31602. * Updates a vertex of a particle : it can be overwritten by the user.
  31603. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  31604. * @param particle the current particle
  31605. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  31606. * @param pt the index of the current vertex in the particle shape
  31607. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  31608. * @example : just set a vertex particle position or color
  31609. * @returns the sps
  31610. */
  31611. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  31612. /**
  31613. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  31614. * This does nothing and may be overwritten by the user.
  31615. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  31616. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  31617. * @param update the boolean update value actually passed to setParticles()
  31618. */
  31619. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  31620. /**
  31621. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  31622. * This will be passed three parameters.
  31623. * This does nothing and may be overwritten by the user.
  31624. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  31625. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  31626. * @param update the boolean update value actually passed to setParticles()
  31627. */
  31628. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  31629. }
  31630. }
  31631. declare module "babylonjs/Particles/solidParticle" {
  31632. import { Nullable } from "babylonjs/types";
  31633. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  31634. import { Color4 } from "babylonjs/Maths/math.color";
  31635. import { Mesh } from "babylonjs/Meshes/mesh";
  31636. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  31637. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  31638. import { Plane } from "babylonjs/Maths/math.plane";
  31639. import { Material } from "babylonjs/Materials/material";
  31640. /**
  31641. * Represents one particle of a solid particle system.
  31642. */
  31643. export class SolidParticle {
  31644. /**
  31645. * particle global index
  31646. */
  31647. idx: number;
  31648. /**
  31649. * particle identifier
  31650. */
  31651. id: number;
  31652. /**
  31653. * The color of the particle
  31654. */
  31655. color: Nullable<Color4>;
  31656. /**
  31657. * The world space position of the particle.
  31658. */
  31659. position: Vector3;
  31660. /**
  31661. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  31662. */
  31663. rotation: Vector3;
  31664. /**
  31665. * The world space rotation quaternion of the particle.
  31666. */
  31667. rotationQuaternion: Nullable<Quaternion>;
  31668. /**
  31669. * The scaling of the particle.
  31670. */
  31671. scaling: Vector3;
  31672. /**
  31673. * The uvs of the particle.
  31674. */
  31675. uvs: Vector4;
  31676. /**
  31677. * The current speed of the particle.
  31678. */
  31679. velocity: Vector3;
  31680. /**
  31681. * The pivot point in the particle local space.
  31682. */
  31683. pivot: Vector3;
  31684. /**
  31685. * Must the particle be translated from its pivot point in its local space ?
  31686. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  31687. * Default : false
  31688. */
  31689. translateFromPivot: boolean;
  31690. /**
  31691. * Is the particle active or not ?
  31692. */
  31693. alive: boolean;
  31694. /**
  31695. * Is the particle visible or not ?
  31696. */
  31697. isVisible: boolean;
  31698. /**
  31699. * Index of this particle in the global "positions" array (Internal use)
  31700. * @hidden
  31701. */
  31702. _pos: number;
  31703. /**
  31704. * @hidden Index of this particle in the global "indices" array (Internal use)
  31705. */
  31706. _ind: number;
  31707. /**
  31708. * @hidden ModelShape of this particle (Internal use)
  31709. */
  31710. _model: ModelShape;
  31711. /**
  31712. * ModelShape id of this particle
  31713. */
  31714. shapeId: number;
  31715. /**
  31716. * Index of the particle in its shape id
  31717. */
  31718. idxInShape: number;
  31719. /**
  31720. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  31721. */
  31722. _modelBoundingInfo: BoundingInfo;
  31723. /**
  31724. * @hidden Particle BoundingInfo object (Internal use)
  31725. */
  31726. _boundingInfo: BoundingInfo;
  31727. /**
  31728. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  31729. */
  31730. _sps: SolidParticleSystem;
  31731. /**
  31732. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  31733. */
  31734. _stillInvisible: boolean;
  31735. /**
  31736. * @hidden Last computed particle rotation matrix
  31737. */
  31738. _rotationMatrix: number[];
  31739. /**
  31740. * Parent particle Id, if any.
  31741. * Default null.
  31742. */
  31743. parentId: Nullable<number>;
  31744. /**
  31745. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  31746. */
  31747. materialIndex: Nullable<number>;
  31748. /**
  31749. * Custom object or properties.
  31750. */
  31751. props: Nullable<any>;
  31752. /**
  31753. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  31754. * The possible values are :
  31755. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  31756. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  31757. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  31758. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  31759. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  31760. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  31761. * */
  31762. cullingStrategy: number;
  31763. /**
  31764. * @hidden Internal global position in the SPS.
  31765. */
  31766. _globalPosition: Vector3;
  31767. /**
  31768. * Creates a Solid Particle object.
  31769. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  31770. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  31771. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  31772. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  31773. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  31774. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  31775. * @param shapeId (integer) is the model shape identifier in the SPS.
  31776. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  31777. * @param sps defines the sps it is associated to
  31778. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  31779. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  31780. */
  31781. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  31782. /**
  31783. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  31784. * @param target the particle target
  31785. * @returns the current particle
  31786. */
  31787. copyToRef(target: SolidParticle): SolidParticle;
  31788. /**
  31789. * Legacy support, changed scale to scaling
  31790. */
  31791. get scale(): Vector3;
  31792. /**
  31793. * Legacy support, changed scale to scaling
  31794. */
  31795. set scale(scale: Vector3);
  31796. /**
  31797. * Legacy support, changed quaternion to rotationQuaternion
  31798. */
  31799. get quaternion(): Nullable<Quaternion>;
  31800. /**
  31801. * Legacy support, changed quaternion to rotationQuaternion
  31802. */
  31803. set quaternion(q: Nullable<Quaternion>);
  31804. /**
  31805. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  31806. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  31807. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  31808. * @returns true if it intersects
  31809. */
  31810. intersectsMesh(target: Mesh | SolidParticle): boolean;
  31811. /**
  31812. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  31813. * A particle is in the frustum if its bounding box intersects the frustum
  31814. * @param frustumPlanes defines the frustum to test
  31815. * @returns true if the particle is in the frustum planes
  31816. */
  31817. isInFrustum(frustumPlanes: Plane[]): boolean;
  31818. /**
  31819. * get the rotation matrix of the particle
  31820. * @hidden
  31821. */
  31822. getRotationMatrix(m: Matrix): void;
  31823. }
  31824. /**
  31825. * Represents the shape of the model used by one particle of a solid particle system.
  31826. * SPS internal tool, don't use it manually.
  31827. */
  31828. export class ModelShape {
  31829. /**
  31830. * The shape id
  31831. * @hidden
  31832. */
  31833. shapeID: number;
  31834. /**
  31835. * flat array of model positions (internal use)
  31836. * @hidden
  31837. */
  31838. _shape: Vector3[];
  31839. /**
  31840. * flat array of model UVs (internal use)
  31841. * @hidden
  31842. */
  31843. _shapeUV: number[];
  31844. /**
  31845. * color array of the model
  31846. * @hidden
  31847. */
  31848. _shapeColors: number[];
  31849. /**
  31850. * indices array of the model
  31851. * @hidden
  31852. */
  31853. _indices: number[];
  31854. /**
  31855. * normals array of the model
  31856. * @hidden
  31857. */
  31858. _normals: number[];
  31859. /**
  31860. * length of the shape in the model indices array (internal use)
  31861. * @hidden
  31862. */
  31863. _indicesLength: number;
  31864. /**
  31865. * Custom position function (internal use)
  31866. * @hidden
  31867. */
  31868. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  31869. /**
  31870. * Custom vertex function (internal use)
  31871. * @hidden
  31872. */
  31873. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  31874. /**
  31875. * Model material (internal use)
  31876. * @hidden
  31877. */
  31878. _material: Nullable<Material>;
  31879. /**
  31880. * 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.
  31881. * SPS internal tool, don't use it manually.
  31882. * @hidden
  31883. */
  31884. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>, material: Nullable<Material>);
  31885. }
  31886. /**
  31887. * Represents a Depth Sorted Particle in the solid particle system.
  31888. * @hidden
  31889. */
  31890. export class DepthSortedParticle {
  31891. /**
  31892. * Particle index
  31893. */
  31894. idx: number;
  31895. /**
  31896. * Index of the particle in the "indices" array
  31897. */
  31898. ind: number;
  31899. /**
  31900. * Length of the particle shape in the "indices" array
  31901. */
  31902. indicesLength: number;
  31903. /**
  31904. * Squared distance from the particle to the camera
  31905. */
  31906. sqDistance: number;
  31907. /**
  31908. * Material index when used with MultiMaterials
  31909. */
  31910. materialIndex: number;
  31911. /**
  31912. * Creates a new sorted particle
  31913. * @param materialIndex
  31914. */
  31915. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  31916. }
  31917. /**
  31918. * Represents a solid particle vertex
  31919. */
  31920. export class SolidParticleVertex {
  31921. /**
  31922. * Vertex position
  31923. */
  31924. position: Vector3;
  31925. /**
  31926. * Vertex color
  31927. */
  31928. color: Color4;
  31929. /**
  31930. * Vertex UV
  31931. */
  31932. uv: Vector2;
  31933. /**
  31934. * Creates a new solid particle vertex
  31935. */
  31936. constructor();
  31937. /** Vertex x coordinate */
  31938. get x(): number;
  31939. set x(val: number);
  31940. /** Vertex y coordinate */
  31941. get y(): number;
  31942. set y(val: number);
  31943. /** Vertex z coordinate */
  31944. get z(): number;
  31945. set z(val: number);
  31946. }
  31947. }
  31948. declare module "babylonjs/Collisions/meshCollisionData" {
  31949. import { Collider } from "babylonjs/Collisions/collider";
  31950. import { Vector3 } from "babylonjs/Maths/math.vector";
  31951. import { Nullable } from "babylonjs/types";
  31952. import { Observer } from "babylonjs/Misc/observable";
  31953. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31954. /**
  31955. * @hidden
  31956. */
  31957. export class _MeshCollisionData {
  31958. _checkCollisions: boolean;
  31959. _collisionMask: number;
  31960. _collisionGroup: number;
  31961. _surroundingMeshes: Nullable<AbstractMesh[]>;
  31962. _collider: Nullable<Collider>;
  31963. _oldPositionForCollisions: Vector3;
  31964. _diffPositionForCollisions: Vector3;
  31965. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  31966. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  31967. }
  31968. }
  31969. declare module "babylonjs/Meshes/abstractMesh" {
  31970. import { Observable } from "babylonjs/Misc/observable";
  31971. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  31972. import { Camera } from "babylonjs/Cameras/camera";
  31973. import { Scene, IDisposable } from "babylonjs/scene";
  31974. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  31975. import { Node } from "babylonjs/node";
  31976. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  31977. import { TransformNode } from "babylonjs/Meshes/transformNode";
  31978. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31979. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  31980. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  31981. import { Material } from "babylonjs/Materials/material";
  31982. import { Light } from "babylonjs/Lights/light";
  31983. import { Skeleton } from "babylonjs/Bones/skeleton";
  31984. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  31985. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  31986. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  31987. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  31988. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  31989. import { Plane } from "babylonjs/Maths/math.plane";
  31990. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  31991. import { Ray } from "babylonjs/Culling/ray";
  31992. import { Collider } from "babylonjs/Collisions/collider";
  31993. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  31994. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  31995. /** @hidden */
  31996. class _FacetDataStorage {
  31997. facetPositions: Vector3[];
  31998. facetNormals: Vector3[];
  31999. facetPartitioning: number[][];
  32000. facetNb: number;
  32001. partitioningSubdivisions: number;
  32002. partitioningBBoxRatio: number;
  32003. facetDataEnabled: boolean;
  32004. facetParameters: any;
  32005. bbSize: Vector3;
  32006. subDiv: {
  32007. max: number;
  32008. X: number;
  32009. Y: number;
  32010. Z: number;
  32011. };
  32012. facetDepthSort: boolean;
  32013. facetDepthSortEnabled: boolean;
  32014. depthSortedIndices: IndicesArray;
  32015. depthSortedFacets: {
  32016. ind: number;
  32017. sqDistance: number;
  32018. }[];
  32019. facetDepthSortFunction: (f1: {
  32020. ind: number;
  32021. sqDistance: number;
  32022. }, f2: {
  32023. ind: number;
  32024. sqDistance: number;
  32025. }) => number;
  32026. facetDepthSortFrom: Vector3;
  32027. facetDepthSortOrigin: Vector3;
  32028. invertedMatrix: Matrix;
  32029. }
  32030. /**
  32031. * @hidden
  32032. **/
  32033. class _InternalAbstractMeshDataInfo {
  32034. _hasVertexAlpha: boolean;
  32035. _useVertexColors: boolean;
  32036. _numBoneInfluencers: number;
  32037. _applyFog: boolean;
  32038. _receiveShadows: boolean;
  32039. _facetData: _FacetDataStorage;
  32040. _visibility: number;
  32041. _skeleton: Nullable<Skeleton>;
  32042. _layerMask: number;
  32043. _computeBonesUsingShaders: boolean;
  32044. _isActive: boolean;
  32045. _onlyForInstances: boolean;
  32046. _isActiveIntermediate: boolean;
  32047. _onlyForInstancesIntermediate: boolean;
  32048. _actAsRegularMesh: boolean;
  32049. }
  32050. /**
  32051. * Class used to store all common mesh properties
  32052. */
  32053. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  32054. /** No occlusion */
  32055. static OCCLUSION_TYPE_NONE: number;
  32056. /** Occlusion set to optimisitic */
  32057. static OCCLUSION_TYPE_OPTIMISTIC: number;
  32058. /** Occlusion set to strict */
  32059. static OCCLUSION_TYPE_STRICT: number;
  32060. /** Use an accurante occlusion algorithm */
  32061. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  32062. /** Use a conservative occlusion algorithm */
  32063. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  32064. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  32065. * Test order :
  32066. * Is the bounding sphere outside the frustum ?
  32067. * If not, are the bounding box vertices outside the frustum ?
  32068. * It not, then the cullable object is in the frustum.
  32069. */
  32070. static readonly CULLINGSTRATEGY_STANDARD: number;
  32071. /** Culling strategy : Bounding Sphere Only.
  32072. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  32073. * It's also less accurate than the standard because some not visible objects can still be selected.
  32074. * Test : is the bounding sphere outside the frustum ?
  32075. * If not, then the cullable object is in the frustum.
  32076. */
  32077. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  32078. /** Culling strategy : Optimistic Inclusion.
  32079. * This in an inclusion test first, then the standard exclusion test.
  32080. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  32081. * 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.
  32082. * Anyway, it's as accurate as the standard strategy.
  32083. * Test :
  32084. * Is the cullable object bounding sphere center in the frustum ?
  32085. * If not, apply the default culling strategy.
  32086. */
  32087. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  32088. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  32089. * This in an inclusion test first, then the bounding sphere only exclusion test.
  32090. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  32091. * 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.
  32092. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  32093. * Test :
  32094. * Is the cullable object bounding sphere center in the frustum ?
  32095. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  32096. */
  32097. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  32098. /**
  32099. * No billboard
  32100. */
  32101. static get BILLBOARDMODE_NONE(): number;
  32102. /** Billboard on X axis */
  32103. static get BILLBOARDMODE_X(): number;
  32104. /** Billboard on Y axis */
  32105. static get BILLBOARDMODE_Y(): number;
  32106. /** Billboard on Z axis */
  32107. static get BILLBOARDMODE_Z(): number;
  32108. /** Billboard on all axes */
  32109. static get BILLBOARDMODE_ALL(): number;
  32110. /** Billboard on using position instead of orientation */
  32111. static get BILLBOARDMODE_USE_POSITION(): number;
  32112. /** @hidden */
  32113. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  32114. /**
  32115. * The culling strategy to use to check whether the mesh must be rendered or not.
  32116. * This value can be changed at any time and will be used on the next render mesh selection.
  32117. * The possible values are :
  32118. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32119. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32120. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32121. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32122. * Please read each static variable documentation to get details about the culling process.
  32123. * */
  32124. cullingStrategy: number;
  32125. /**
  32126. * Gets the number of facets in the mesh
  32127. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  32128. */
  32129. get facetNb(): number;
  32130. /**
  32131. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  32132. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  32133. */
  32134. get partitioningSubdivisions(): number;
  32135. set partitioningSubdivisions(nb: number);
  32136. /**
  32137. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  32138. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  32139. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  32140. */
  32141. get partitioningBBoxRatio(): number;
  32142. set partitioningBBoxRatio(ratio: number);
  32143. /**
  32144. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  32145. * Works only for updatable meshes.
  32146. * Doesn't work with multi-materials
  32147. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  32148. */
  32149. get mustDepthSortFacets(): boolean;
  32150. set mustDepthSortFacets(sort: boolean);
  32151. /**
  32152. * The location (Vector3) where the facet depth sort must be computed from.
  32153. * By default, the active camera position.
  32154. * Used only when facet depth sort is enabled
  32155. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  32156. */
  32157. get facetDepthSortFrom(): Vector3;
  32158. set facetDepthSortFrom(location: Vector3);
  32159. /**
  32160. * gets a boolean indicating if facetData is enabled
  32161. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  32162. */
  32163. get isFacetDataEnabled(): boolean;
  32164. /** @hidden */
  32165. _updateNonUniformScalingState(value: boolean): boolean;
  32166. /**
  32167. * An event triggered when this mesh collides with another one
  32168. */
  32169. onCollideObservable: Observable<AbstractMesh>;
  32170. /** Set a function to call when this mesh collides with another one */
  32171. set onCollide(callback: () => void);
  32172. /**
  32173. * An event triggered when the collision's position changes
  32174. */
  32175. onCollisionPositionChangeObservable: Observable<Vector3>;
  32176. /** Set a function to call when the collision's position changes */
  32177. set onCollisionPositionChange(callback: () => void);
  32178. /**
  32179. * An event triggered when material is changed
  32180. */
  32181. onMaterialChangedObservable: Observable<AbstractMesh>;
  32182. /**
  32183. * Gets or sets the orientation for POV movement & rotation
  32184. */
  32185. definedFacingForward: boolean;
  32186. /** @hidden */
  32187. _occlusionQuery: Nullable<WebGLQuery>;
  32188. /** @hidden */
  32189. _renderingGroup: Nullable<RenderingGroup>;
  32190. /**
  32191. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  32192. */
  32193. get visibility(): number;
  32194. /**
  32195. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  32196. */
  32197. set visibility(value: number);
  32198. /** Gets or sets the alpha index used to sort transparent meshes
  32199. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  32200. */
  32201. alphaIndex: number;
  32202. /**
  32203. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  32204. */
  32205. isVisible: boolean;
  32206. /**
  32207. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  32208. */
  32209. isPickable: boolean;
  32210. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  32211. showSubMeshesBoundingBox: boolean;
  32212. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  32213. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  32214. */
  32215. isBlocker: boolean;
  32216. /**
  32217. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  32218. */
  32219. enablePointerMoveEvents: boolean;
  32220. /**
  32221. * Specifies the rendering group id for this mesh (0 by default)
  32222. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  32223. */
  32224. renderingGroupId: number;
  32225. private _material;
  32226. /** Gets or sets current material */
  32227. get material(): Nullable<Material>;
  32228. set material(value: Nullable<Material>);
  32229. /**
  32230. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  32231. * @see http://doc.babylonjs.com/babylon101/shadows
  32232. */
  32233. get receiveShadows(): boolean;
  32234. set receiveShadows(value: boolean);
  32235. /** Defines color to use when rendering outline */
  32236. outlineColor: Color3;
  32237. /** Define width to use when rendering outline */
  32238. outlineWidth: number;
  32239. /** Defines color to use when rendering overlay */
  32240. overlayColor: Color3;
  32241. /** Defines alpha to use when rendering overlay */
  32242. overlayAlpha: number;
  32243. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  32244. get hasVertexAlpha(): boolean;
  32245. set hasVertexAlpha(value: boolean);
  32246. /** 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) */
  32247. get useVertexColors(): boolean;
  32248. set useVertexColors(value: boolean);
  32249. /**
  32250. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  32251. */
  32252. get computeBonesUsingShaders(): boolean;
  32253. set computeBonesUsingShaders(value: boolean);
  32254. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  32255. get numBoneInfluencers(): number;
  32256. set numBoneInfluencers(value: number);
  32257. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  32258. get applyFog(): boolean;
  32259. set applyFog(value: boolean);
  32260. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  32261. useOctreeForRenderingSelection: boolean;
  32262. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  32263. useOctreeForPicking: boolean;
  32264. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  32265. useOctreeForCollisions: boolean;
  32266. /**
  32267. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  32268. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  32269. */
  32270. get layerMask(): number;
  32271. set layerMask(value: number);
  32272. /**
  32273. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  32274. */
  32275. alwaysSelectAsActiveMesh: boolean;
  32276. /**
  32277. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  32278. */
  32279. doNotSyncBoundingInfo: boolean;
  32280. /**
  32281. * Gets or sets the current action manager
  32282. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  32283. */
  32284. actionManager: Nullable<AbstractActionManager>;
  32285. private _meshCollisionData;
  32286. /**
  32287. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  32288. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  32289. */
  32290. ellipsoid: Vector3;
  32291. /**
  32292. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  32293. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  32294. */
  32295. ellipsoidOffset: Vector3;
  32296. /**
  32297. * Gets or sets a collision mask used to mask collisions (default is -1).
  32298. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  32299. */
  32300. get collisionMask(): number;
  32301. set collisionMask(mask: number);
  32302. /**
  32303. * Gets or sets the current collision group mask (-1 by default).
  32304. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  32305. */
  32306. get collisionGroup(): number;
  32307. set collisionGroup(mask: number);
  32308. /**
  32309. * Gets or sets current surrounding meshes (null by default).
  32310. *
  32311. * By default collision detection is tested against every mesh in the scene.
  32312. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  32313. * meshes will be tested for the collision.
  32314. *
  32315. * Note: if set to an empty array no collision will happen when this mesh is moved.
  32316. */
  32317. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  32318. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  32319. /**
  32320. * Defines edge width used when edgesRenderer is enabled
  32321. * @see https://www.babylonjs-playground.com/#10OJSG#13
  32322. */
  32323. edgesWidth: number;
  32324. /**
  32325. * Defines edge color used when edgesRenderer is enabled
  32326. * @see https://www.babylonjs-playground.com/#10OJSG#13
  32327. */
  32328. edgesColor: Color4;
  32329. /** @hidden */
  32330. _edgesRenderer: Nullable<IEdgesRenderer>;
  32331. /** @hidden */
  32332. _masterMesh: Nullable<AbstractMesh>;
  32333. /** @hidden */
  32334. _boundingInfo: Nullable<BoundingInfo>;
  32335. /** @hidden */
  32336. _renderId: number;
  32337. /**
  32338. * Gets or sets the list of subMeshes
  32339. * @see http://doc.babylonjs.com/how_to/multi_materials
  32340. */
  32341. subMeshes: SubMesh[];
  32342. /** @hidden */
  32343. _intersectionsInProgress: AbstractMesh[];
  32344. /** @hidden */
  32345. _unIndexed: boolean;
  32346. /** @hidden */
  32347. _lightSources: Light[];
  32348. /** Gets the list of lights affecting that mesh */
  32349. get lightSources(): Light[];
  32350. /** @hidden */
  32351. get _positions(): Nullable<Vector3[]>;
  32352. /** @hidden */
  32353. _waitingData: {
  32354. lods: Nullable<any>;
  32355. actions: Nullable<any>;
  32356. freezeWorldMatrix: Nullable<boolean>;
  32357. };
  32358. /** @hidden */
  32359. _bonesTransformMatrices: Nullable<Float32Array>;
  32360. /** @hidden */
  32361. _transformMatrixTexture: Nullable<RawTexture>;
  32362. /**
  32363. * Gets or sets a skeleton to apply skining transformations
  32364. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  32365. */
  32366. set skeleton(value: Nullable<Skeleton>);
  32367. get skeleton(): Nullable<Skeleton>;
  32368. /**
  32369. * An event triggered when the mesh is rebuilt.
  32370. */
  32371. onRebuildObservable: Observable<AbstractMesh>;
  32372. /**
  32373. * Creates a new AbstractMesh
  32374. * @param name defines the name of the mesh
  32375. * @param scene defines the hosting scene
  32376. */
  32377. constructor(name: string, scene?: Nullable<Scene>);
  32378. /**
  32379. * Returns the string "AbstractMesh"
  32380. * @returns "AbstractMesh"
  32381. */
  32382. getClassName(): string;
  32383. /**
  32384. * Gets a string representation of the current mesh
  32385. * @param fullDetails defines a boolean indicating if full details must be included
  32386. * @returns a string representation of the current mesh
  32387. */
  32388. toString(fullDetails?: boolean): string;
  32389. /**
  32390. * @hidden
  32391. */
  32392. protected _getEffectiveParent(): Nullable<Node>;
  32393. /** @hidden */
  32394. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  32395. /** @hidden */
  32396. _rebuild(): void;
  32397. /** @hidden */
  32398. _resyncLightSources(): void;
  32399. /** @hidden */
  32400. _resyncLightSource(light: Light): void;
  32401. /** @hidden */
  32402. _unBindEffect(): void;
  32403. /** @hidden */
  32404. _removeLightSource(light: Light, dispose: boolean): void;
  32405. private _markSubMeshesAsDirty;
  32406. /** @hidden */
  32407. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  32408. /** @hidden */
  32409. _markSubMeshesAsAttributesDirty(): void;
  32410. /** @hidden */
  32411. _markSubMeshesAsMiscDirty(): void;
  32412. /**
  32413. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  32414. */
  32415. get scaling(): Vector3;
  32416. set scaling(newScaling: Vector3);
  32417. /**
  32418. * Returns true if the mesh is blocked. Implemented by child classes
  32419. */
  32420. get isBlocked(): boolean;
  32421. /**
  32422. * Returns the mesh itself by default. Implemented by child classes
  32423. * @param camera defines the camera to use to pick the right LOD level
  32424. * @returns the currentAbstractMesh
  32425. */
  32426. getLOD(camera: Camera): Nullable<AbstractMesh>;
  32427. /**
  32428. * Returns 0 by default. Implemented by child classes
  32429. * @returns an integer
  32430. */
  32431. getTotalVertices(): number;
  32432. /**
  32433. * Returns a positive integer : the total number of indices in this mesh geometry.
  32434. * @returns the numner of indices or zero if the mesh has no geometry.
  32435. */
  32436. getTotalIndices(): number;
  32437. /**
  32438. * Returns null by default. Implemented by child classes
  32439. * @returns null
  32440. */
  32441. getIndices(): Nullable<IndicesArray>;
  32442. /**
  32443. * Returns the array of the requested vertex data kind. Implemented by child classes
  32444. * @param kind defines the vertex data kind to use
  32445. * @returns null
  32446. */
  32447. getVerticesData(kind: string): Nullable<FloatArray>;
  32448. /**
  32449. * Sets the vertex data of the mesh geometry for the requested `kind`.
  32450. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  32451. * Note that a new underlying VertexBuffer object is created each call.
  32452. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  32453. * @param kind defines vertex data kind:
  32454. * * VertexBuffer.PositionKind
  32455. * * VertexBuffer.UVKind
  32456. * * VertexBuffer.UV2Kind
  32457. * * VertexBuffer.UV3Kind
  32458. * * VertexBuffer.UV4Kind
  32459. * * VertexBuffer.UV5Kind
  32460. * * VertexBuffer.UV6Kind
  32461. * * VertexBuffer.ColorKind
  32462. * * VertexBuffer.MatricesIndicesKind
  32463. * * VertexBuffer.MatricesIndicesExtraKind
  32464. * * VertexBuffer.MatricesWeightsKind
  32465. * * VertexBuffer.MatricesWeightsExtraKind
  32466. * @param data defines the data source
  32467. * @param updatable defines if the data must be flagged as updatable (or static)
  32468. * @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
  32469. * @returns the current mesh
  32470. */
  32471. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  32472. /**
  32473. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  32474. * If the mesh has no geometry, it is simply returned as it is.
  32475. * @param kind defines vertex data kind:
  32476. * * VertexBuffer.PositionKind
  32477. * * VertexBuffer.UVKind
  32478. * * VertexBuffer.UV2Kind
  32479. * * VertexBuffer.UV3Kind
  32480. * * VertexBuffer.UV4Kind
  32481. * * VertexBuffer.UV5Kind
  32482. * * VertexBuffer.UV6Kind
  32483. * * VertexBuffer.ColorKind
  32484. * * VertexBuffer.MatricesIndicesKind
  32485. * * VertexBuffer.MatricesIndicesExtraKind
  32486. * * VertexBuffer.MatricesWeightsKind
  32487. * * VertexBuffer.MatricesWeightsExtraKind
  32488. * @param data defines the data source
  32489. * @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
  32490. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  32491. * @returns the current mesh
  32492. */
  32493. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  32494. /**
  32495. * Sets the mesh indices,
  32496. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  32497. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  32498. * @param totalVertices Defines the total number of vertices
  32499. * @returns the current mesh
  32500. */
  32501. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  32502. /**
  32503. * Gets a boolean indicating if specific vertex data is present
  32504. * @param kind defines the vertex data kind to use
  32505. * @returns true is data kind is present
  32506. */
  32507. isVerticesDataPresent(kind: string): boolean;
  32508. /**
  32509. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  32510. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  32511. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  32512. * @returns a BoundingInfo
  32513. */
  32514. getBoundingInfo(): BoundingInfo;
  32515. /**
  32516. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  32517. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  32518. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  32519. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  32520. * @returns the current mesh
  32521. */
  32522. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  32523. /**
  32524. * Overwrite the current bounding info
  32525. * @param boundingInfo defines the new bounding info
  32526. * @returns the current mesh
  32527. */
  32528. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  32529. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  32530. get useBones(): boolean;
  32531. /** @hidden */
  32532. _preActivate(): void;
  32533. /** @hidden */
  32534. _preActivateForIntermediateRendering(renderId: number): void;
  32535. /** @hidden */
  32536. _activate(renderId: number, intermediateRendering: boolean): boolean;
  32537. /** @hidden */
  32538. _postActivate(): void;
  32539. /** @hidden */
  32540. _freeze(): void;
  32541. /** @hidden */
  32542. _unFreeze(): void;
  32543. /**
  32544. * Gets the current world matrix
  32545. * @returns a Matrix
  32546. */
  32547. getWorldMatrix(): Matrix;
  32548. /** @hidden */
  32549. _getWorldMatrixDeterminant(): number;
  32550. /**
  32551. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  32552. */
  32553. get isAnInstance(): boolean;
  32554. /**
  32555. * Gets a boolean indicating if this mesh has instances
  32556. */
  32557. get hasInstances(): boolean;
  32558. /**
  32559. * Gets a boolean indicating if this mesh has thin instances
  32560. */
  32561. get hasThinInstances(): boolean;
  32562. /**
  32563. * Perform relative position change from the point of view of behind the front of the mesh.
  32564. * This is performed taking into account the meshes current rotation, so you do not have to care.
  32565. * Supports definition of mesh facing forward or backward
  32566. * @param amountRight defines the distance on the right axis
  32567. * @param amountUp defines the distance on the up axis
  32568. * @param amountForward defines the distance on the forward axis
  32569. * @returns the current mesh
  32570. */
  32571. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  32572. /**
  32573. * Calculate relative position change from the point of view of behind the front of the mesh.
  32574. * This is performed taking into account the meshes current rotation, so you do not have to care.
  32575. * Supports definition of mesh facing forward or backward
  32576. * @param amountRight defines the distance on the right axis
  32577. * @param amountUp defines the distance on the up axis
  32578. * @param amountForward defines the distance on the forward axis
  32579. * @returns the new displacement vector
  32580. */
  32581. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  32582. /**
  32583. * Perform relative rotation change from the point of view of behind the front of the mesh.
  32584. * Supports definition of mesh facing forward or backward
  32585. * @param flipBack defines the flip
  32586. * @param twirlClockwise defines the twirl
  32587. * @param tiltRight defines the tilt
  32588. * @returns the current mesh
  32589. */
  32590. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  32591. /**
  32592. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  32593. * Supports definition of mesh facing forward or backward.
  32594. * @param flipBack defines the flip
  32595. * @param twirlClockwise defines the twirl
  32596. * @param tiltRight defines the tilt
  32597. * @returns the new rotation vector
  32598. */
  32599. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  32600. /**
  32601. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  32602. * This means the mesh underlying bounding box and sphere are recomputed.
  32603. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  32604. * @returns the current mesh
  32605. */
  32606. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  32607. /** @hidden */
  32608. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  32609. /** @hidden */
  32610. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  32611. /** @hidden */
  32612. _updateBoundingInfo(): AbstractMesh;
  32613. /** @hidden */
  32614. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  32615. /** @hidden */
  32616. protected _afterComputeWorldMatrix(): void;
  32617. /** @hidden */
  32618. get _effectiveMesh(): AbstractMesh;
  32619. /**
  32620. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  32621. * A mesh is in the frustum if its bounding box intersects the frustum
  32622. * @param frustumPlanes defines the frustum to test
  32623. * @returns true if the mesh is in the frustum planes
  32624. */
  32625. isInFrustum(frustumPlanes: Plane[]): boolean;
  32626. /**
  32627. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  32628. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  32629. * @param frustumPlanes defines the frustum to test
  32630. * @returns true if the mesh is completely in the frustum planes
  32631. */
  32632. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  32633. /**
  32634. * True if the mesh intersects another mesh or a SolidParticle object
  32635. * @param mesh defines a target mesh or SolidParticle to test
  32636. * @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)
  32637. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  32638. * @returns true if there is an intersection
  32639. */
  32640. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  32641. /**
  32642. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  32643. * @param point defines the point to test
  32644. * @returns true if there is an intersection
  32645. */
  32646. intersectsPoint(point: Vector3): boolean;
  32647. /**
  32648. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  32649. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  32650. */
  32651. get checkCollisions(): boolean;
  32652. set checkCollisions(collisionEnabled: boolean);
  32653. /**
  32654. * Gets Collider object used to compute collisions (not physics)
  32655. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  32656. */
  32657. get collider(): Nullable<Collider>;
  32658. /**
  32659. * Move the mesh using collision engine
  32660. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  32661. * @param displacement defines the requested displacement vector
  32662. * @returns the current mesh
  32663. */
  32664. moveWithCollisions(displacement: Vector3): AbstractMesh;
  32665. private _onCollisionPositionChange;
  32666. /** @hidden */
  32667. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  32668. /** @hidden */
  32669. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  32670. /** @hidden */
  32671. _checkCollision(collider: Collider): AbstractMesh;
  32672. /** @hidden */
  32673. _generatePointsArray(): boolean;
  32674. /**
  32675. * Checks if the passed Ray intersects with the mesh
  32676. * @param ray defines the ray to use
  32677. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  32678. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  32679. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  32680. * @returns the picking info
  32681. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  32682. */
  32683. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean): PickingInfo;
  32684. /**
  32685. * Clones the current mesh
  32686. * @param name defines the mesh name
  32687. * @param newParent defines the new mesh parent
  32688. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  32689. * @returns the new mesh
  32690. */
  32691. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  32692. /**
  32693. * Disposes all the submeshes of the current meshnp
  32694. * @returns the current mesh
  32695. */
  32696. releaseSubMeshes(): AbstractMesh;
  32697. /**
  32698. * Releases resources associated with this abstract mesh.
  32699. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  32700. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  32701. */
  32702. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  32703. /**
  32704. * Adds the passed mesh as a child to the current mesh
  32705. * @param mesh defines the child mesh
  32706. * @returns the current mesh
  32707. */
  32708. addChild(mesh: AbstractMesh): AbstractMesh;
  32709. /**
  32710. * Removes the passed mesh from the current mesh children list
  32711. * @param mesh defines the child mesh
  32712. * @returns the current mesh
  32713. */
  32714. removeChild(mesh: AbstractMesh): AbstractMesh;
  32715. /** @hidden */
  32716. private _initFacetData;
  32717. /**
  32718. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  32719. * This method can be called within the render loop.
  32720. * 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
  32721. * @returns the current mesh
  32722. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32723. */
  32724. updateFacetData(): AbstractMesh;
  32725. /**
  32726. * Returns the facetLocalNormals array.
  32727. * The normals are expressed in the mesh local spac
  32728. * @returns an array of Vector3
  32729. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32730. */
  32731. getFacetLocalNormals(): Vector3[];
  32732. /**
  32733. * Returns the facetLocalPositions array.
  32734. * The facet positions are expressed in the mesh local space
  32735. * @returns an array of Vector3
  32736. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32737. */
  32738. getFacetLocalPositions(): Vector3[];
  32739. /**
  32740. * Returns the facetLocalPartioning array
  32741. * @returns an array of array of numbers
  32742. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32743. */
  32744. getFacetLocalPartitioning(): number[][];
  32745. /**
  32746. * Returns the i-th facet position in the world system.
  32747. * This method allocates a new Vector3 per call
  32748. * @param i defines the facet index
  32749. * @returns a new Vector3
  32750. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32751. */
  32752. getFacetPosition(i: number): Vector3;
  32753. /**
  32754. * Sets the reference Vector3 with the i-th facet position in the world system
  32755. * @param i defines the facet index
  32756. * @param ref defines the target vector
  32757. * @returns the current mesh
  32758. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32759. */
  32760. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  32761. /**
  32762. * Returns the i-th facet normal in the world system.
  32763. * This method allocates a new Vector3 per call
  32764. * @param i defines the facet index
  32765. * @returns a new Vector3
  32766. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32767. */
  32768. getFacetNormal(i: number): Vector3;
  32769. /**
  32770. * Sets the reference Vector3 with the i-th facet normal in the world system
  32771. * @param i defines the facet index
  32772. * @param ref defines the target vector
  32773. * @returns the current mesh
  32774. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32775. */
  32776. getFacetNormalToRef(i: number, ref: Vector3): this;
  32777. /**
  32778. * 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)
  32779. * @param x defines x coordinate
  32780. * @param y defines y coordinate
  32781. * @param z defines z coordinate
  32782. * @returns the array of facet indexes
  32783. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32784. */
  32785. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  32786. /**
  32787. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  32788. * @param projected sets as the (x,y,z) world projection on the facet
  32789. * @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
  32790. * @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
  32791. * @param x defines x coordinate
  32792. * @param y defines y coordinate
  32793. * @param z defines z coordinate
  32794. * @returns the face index if found (or null instead)
  32795. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32796. */
  32797. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  32798. /**
  32799. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  32800. * @param projected sets as the (x,y,z) local projection on the facet
  32801. * @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
  32802. * @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
  32803. * @param x defines x coordinate
  32804. * @param y defines y coordinate
  32805. * @param z defines z coordinate
  32806. * @returns the face index if found (or null instead)
  32807. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32808. */
  32809. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  32810. /**
  32811. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  32812. * @returns the parameters
  32813. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32814. */
  32815. getFacetDataParameters(): any;
  32816. /**
  32817. * Disables the feature FacetData and frees the related memory
  32818. * @returns the current mesh
  32819. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  32820. */
  32821. disableFacetData(): AbstractMesh;
  32822. /**
  32823. * Updates the AbstractMesh indices array
  32824. * @param indices defines the data source
  32825. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  32826. * @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)
  32827. * @returns the current mesh
  32828. */
  32829. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  32830. /**
  32831. * Creates new normals data for the mesh
  32832. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  32833. * @returns the current mesh
  32834. */
  32835. createNormals(updatable: boolean): AbstractMesh;
  32836. /**
  32837. * Align the mesh with a normal
  32838. * @param normal defines the normal to use
  32839. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  32840. * @returns the current mesh
  32841. */
  32842. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  32843. /** @hidden */
  32844. _checkOcclusionQuery(): boolean;
  32845. /**
  32846. * Disables the mesh edge rendering mode
  32847. * @returns the currentAbstractMesh
  32848. */
  32849. disableEdgesRendering(): AbstractMesh;
  32850. /**
  32851. * Enables the edge rendering mode on the mesh.
  32852. * This mode makes the mesh edges visible
  32853. * @param epsilon defines the maximal distance between two angles to detect a face
  32854. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  32855. * @returns the currentAbstractMesh
  32856. * @see https://www.babylonjs-playground.com/#19O9TU#0
  32857. */
  32858. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  32859. /**
  32860. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  32861. * @returns an array of particle systems in the scene that use the mesh as an emitter
  32862. */
  32863. getConnectedParticleSystems(): IParticleSystem[];
  32864. }
  32865. }
  32866. declare module "babylonjs/Actions/actionEvent" {
  32867. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  32868. import { Nullable } from "babylonjs/types";
  32869. import { Sprite } from "babylonjs/Sprites/sprite";
  32870. import { Scene } from "babylonjs/scene";
  32871. import { Vector2 } from "babylonjs/Maths/math.vector";
  32872. /**
  32873. * Interface used to define ActionEvent
  32874. */
  32875. export interface IActionEvent {
  32876. /** The mesh or sprite that triggered the action */
  32877. source: any;
  32878. /** The X mouse cursor position at the time of the event */
  32879. pointerX: number;
  32880. /** The Y mouse cursor position at the time of the event */
  32881. pointerY: number;
  32882. /** The mesh that is currently pointed at (can be null) */
  32883. meshUnderPointer: Nullable<AbstractMesh>;
  32884. /** the original (browser) event that triggered the ActionEvent */
  32885. sourceEvent?: any;
  32886. /** additional data for the event */
  32887. additionalData?: any;
  32888. }
  32889. /**
  32890. * ActionEvent is the event being sent when an action is triggered.
  32891. */
  32892. export class ActionEvent implements IActionEvent {
  32893. /** The mesh or sprite that triggered the action */
  32894. source: any;
  32895. /** The X mouse cursor position at the time of the event */
  32896. pointerX: number;
  32897. /** The Y mouse cursor position at the time of the event */
  32898. pointerY: number;
  32899. /** The mesh that is currently pointed at (can be null) */
  32900. meshUnderPointer: Nullable<AbstractMesh>;
  32901. /** the original (browser) event that triggered the ActionEvent */
  32902. sourceEvent?: any;
  32903. /** additional data for the event */
  32904. additionalData?: any;
  32905. /**
  32906. * Creates a new ActionEvent
  32907. * @param source The mesh or sprite that triggered the action
  32908. * @param pointerX The X mouse cursor position at the time of the event
  32909. * @param pointerY The Y mouse cursor position at the time of the event
  32910. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  32911. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  32912. * @param additionalData additional data for the event
  32913. */
  32914. constructor(
  32915. /** The mesh or sprite that triggered the action */
  32916. source: any,
  32917. /** The X mouse cursor position at the time of the event */
  32918. pointerX: number,
  32919. /** The Y mouse cursor position at the time of the event */
  32920. pointerY: number,
  32921. /** The mesh that is currently pointed at (can be null) */
  32922. meshUnderPointer: Nullable<AbstractMesh>,
  32923. /** the original (browser) event that triggered the ActionEvent */
  32924. sourceEvent?: any,
  32925. /** additional data for the event */
  32926. additionalData?: any);
  32927. /**
  32928. * Helper function to auto-create an ActionEvent from a source mesh.
  32929. * @param source The source mesh that triggered the event
  32930. * @param evt The original (browser) event
  32931. * @param additionalData additional data for the event
  32932. * @returns the new ActionEvent
  32933. */
  32934. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  32935. /**
  32936. * Helper function to auto-create an ActionEvent from a source sprite
  32937. * @param source The source sprite that triggered the event
  32938. * @param scene Scene associated with the sprite
  32939. * @param evt The original (browser) event
  32940. * @param additionalData additional data for the event
  32941. * @returns the new ActionEvent
  32942. */
  32943. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  32944. /**
  32945. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  32946. * @param scene the scene where the event occurred
  32947. * @param evt The original (browser) event
  32948. * @returns the new ActionEvent
  32949. */
  32950. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  32951. /**
  32952. * Helper function to auto-create an ActionEvent from a primitive
  32953. * @param prim defines the target primitive
  32954. * @param pointerPos defines the pointer position
  32955. * @param evt The original (browser) event
  32956. * @param additionalData additional data for the event
  32957. * @returns the new ActionEvent
  32958. */
  32959. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  32960. }
  32961. }
  32962. declare module "babylonjs/Actions/abstractActionManager" {
  32963. import { IDisposable } from "babylonjs/scene";
  32964. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  32965. import { IAction } from "babylonjs/Actions/action";
  32966. import { Nullable } from "babylonjs/types";
  32967. /**
  32968. * Abstract class used to decouple action Manager from scene and meshes.
  32969. * Do not instantiate.
  32970. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  32971. */
  32972. export abstract class AbstractActionManager implements IDisposable {
  32973. /** Gets the list of active triggers */
  32974. static Triggers: {
  32975. [key: string]: number;
  32976. };
  32977. /** Gets the cursor to use when hovering items */
  32978. hoverCursor: string;
  32979. /** Gets the list of actions */
  32980. actions: IAction[];
  32981. /**
  32982. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  32983. */
  32984. isRecursive: boolean;
  32985. /**
  32986. * Releases all associated resources
  32987. */
  32988. abstract dispose(): void;
  32989. /**
  32990. * Does this action manager has pointer triggers
  32991. */
  32992. abstract get hasPointerTriggers(): boolean;
  32993. /**
  32994. * Does this action manager has pick triggers
  32995. */
  32996. abstract get hasPickTriggers(): boolean;
  32997. /**
  32998. * Process a specific trigger
  32999. * @param trigger defines the trigger to process
  33000. * @param evt defines the event details to be processed
  33001. */
  33002. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  33003. /**
  33004. * Does this action manager handles actions of any of the given triggers
  33005. * @param triggers defines the triggers to be tested
  33006. * @return a boolean indicating whether one (or more) of the triggers is handled
  33007. */
  33008. abstract hasSpecificTriggers(triggers: number[]): boolean;
  33009. /**
  33010. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  33011. * speed.
  33012. * @param triggerA defines the trigger to be tested
  33013. * @param triggerB defines the trigger to be tested
  33014. * @return a boolean indicating whether one (or more) of the triggers is handled
  33015. */
  33016. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  33017. /**
  33018. * Does this action manager handles actions of a given trigger
  33019. * @param trigger defines the trigger to be tested
  33020. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  33021. * @return whether the trigger is handled
  33022. */
  33023. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  33024. /**
  33025. * Serialize this manager to a JSON object
  33026. * @param name defines the property name to store this manager
  33027. * @returns a JSON representation of this manager
  33028. */
  33029. abstract serialize(name: string): any;
  33030. /**
  33031. * Registers an action to this action manager
  33032. * @param action defines the action to be registered
  33033. * @return the action amended (prepared) after registration
  33034. */
  33035. abstract registerAction(action: IAction): Nullable<IAction>;
  33036. /**
  33037. * Unregisters an action to this action manager
  33038. * @param action defines the action to be unregistered
  33039. * @return a boolean indicating whether the action has been unregistered
  33040. */
  33041. abstract unregisterAction(action: IAction): Boolean;
  33042. /**
  33043. * Does exist one action manager with at least one trigger
  33044. **/
  33045. static get HasTriggers(): boolean;
  33046. /**
  33047. * Does exist one action manager with at least one pick trigger
  33048. **/
  33049. static get HasPickTriggers(): boolean;
  33050. /**
  33051. * Does exist one action manager that handles actions of a given trigger
  33052. * @param trigger defines the trigger to be tested
  33053. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  33054. **/
  33055. static HasSpecificTrigger(trigger: number): boolean;
  33056. }
  33057. }
  33058. declare module "babylonjs/node" {
  33059. import { Scene } from "babylonjs/scene";
  33060. import { Nullable } from "babylonjs/types";
  33061. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  33062. import { Engine } from "babylonjs/Engines/engine";
  33063. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  33064. import { Observable } from "babylonjs/Misc/observable";
  33065. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33066. import { IInspectable } from "babylonjs/Misc/iInspectable";
  33067. import { Animatable } from "babylonjs/Animations/animatable";
  33068. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  33069. import { Animation } from "babylonjs/Animations/animation";
  33070. import { AnimationRange } from "babylonjs/Animations/animationRange";
  33071. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33072. /**
  33073. * Defines how a node can be built from a string name.
  33074. */
  33075. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  33076. /**
  33077. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  33078. */
  33079. export class Node implements IBehaviorAware<Node> {
  33080. /** @hidden */
  33081. static _AnimationRangeFactory: (name: string, from: number, to: number) => import("babylonjs/Animations/animationRange").AnimationRange;
  33082. private static _NodeConstructors;
  33083. /**
  33084. * Add a new node constructor
  33085. * @param type defines the type name of the node to construct
  33086. * @param constructorFunc defines the constructor function
  33087. */
  33088. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  33089. /**
  33090. * Returns a node constructor based on type name
  33091. * @param type defines the type name
  33092. * @param name defines the new node name
  33093. * @param scene defines the hosting scene
  33094. * @param options defines optional options to transmit to constructors
  33095. * @returns the new constructor or null
  33096. */
  33097. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  33098. /**
  33099. * Gets or sets the name of the node
  33100. */
  33101. name: string;
  33102. /**
  33103. * Gets or sets the id of the node
  33104. */
  33105. id: string;
  33106. /**
  33107. * Gets or sets the unique id of the node
  33108. */
  33109. uniqueId: number;
  33110. /**
  33111. * Gets or sets a string used to store user defined state for the node
  33112. */
  33113. state: string;
  33114. /**
  33115. * Gets or sets an object used to store user defined information for the node
  33116. */
  33117. metadata: any;
  33118. /**
  33119. * For internal use only. Please do not use.
  33120. */
  33121. reservedDataStore: any;
  33122. /**
  33123. * List of inspectable custom properties (used by the Inspector)
  33124. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  33125. */
  33126. inspectableCustomProperties: IInspectable[];
  33127. private _doNotSerialize;
  33128. /**
  33129. * Gets or sets a boolean used to define if the node must be serialized
  33130. */
  33131. get doNotSerialize(): boolean;
  33132. set doNotSerialize(value: boolean);
  33133. /** @hidden */
  33134. _isDisposed: boolean;
  33135. /**
  33136. * Gets a list of Animations associated with the node
  33137. */
  33138. animations: import("babylonjs/Animations/animation").Animation[];
  33139. protected _ranges: {
  33140. [name: string]: Nullable<AnimationRange>;
  33141. };
  33142. /**
  33143. * Callback raised when the node is ready to be used
  33144. */
  33145. onReady: Nullable<(node: Node) => void>;
  33146. private _isEnabled;
  33147. private _isParentEnabled;
  33148. private _isReady;
  33149. /** @hidden */
  33150. _currentRenderId: number;
  33151. private _parentUpdateId;
  33152. /** @hidden */
  33153. _childUpdateId: number;
  33154. /** @hidden */
  33155. _waitingParentId: Nullable<string>;
  33156. /** @hidden */
  33157. _scene: Scene;
  33158. /** @hidden */
  33159. _cache: any;
  33160. private _parentNode;
  33161. private _children;
  33162. /** @hidden */
  33163. _worldMatrix: Matrix;
  33164. /** @hidden */
  33165. _worldMatrixDeterminant: number;
  33166. /** @hidden */
  33167. _worldMatrixDeterminantIsDirty: boolean;
  33168. /** @hidden */
  33169. private _sceneRootNodesIndex;
  33170. /**
  33171. * Gets a boolean indicating if the node has been disposed
  33172. * @returns true if the node was disposed
  33173. */
  33174. isDisposed(): boolean;
  33175. /**
  33176. * Gets or sets the parent of the node (without keeping the current position in the scene)
  33177. * @see https://doc.babylonjs.com/how_to/parenting
  33178. */
  33179. set parent(parent: Nullable<Node>);
  33180. get parent(): Nullable<Node>;
  33181. /** @hidden */
  33182. _addToSceneRootNodes(): void;
  33183. /** @hidden */
  33184. _removeFromSceneRootNodes(): void;
  33185. private _animationPropertiesOverride;
  33186. /**
  33187. * Gets or sets the animation properties override
  33188. */
  33189. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  33190. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  33191. /**
  33192. * Gets a string idenfifying the name of the class
  33193. * @returns "Node" string
  33194. */
  33195. getClassName(): string;
  33196. /** @hidden */
  33197. readonly _isNode: boolean;
  33198. /**
  33199. * An event triggered when the mesh is disposed
  33200. */
  33201. onDisposeObservable: Observable<Node>;
  33202. private _onDisposeObserver;
  33203. /**
  33204. * Sets a callback that will be raised when the node will be disposed
  33205. */
  33206. set onDispose(callback: () => void);
  33207. /**
  33208. * Creates a new Node
  33209. * @param name the name and id to be given to this node
  33210. * @param scene the scene this node will be added to
  33211. */
  33212. constructor(name: string, scene?: Nullable<Scene>);
  33213. /**
  33214. * Gets the scene of the node
  33215. * @returns a scene
  33216. */
  33217. getScene(): Scene;
  33218. /**
  33219. * Gets the engine of the node
  33220. * @returns a Engine
  33221. */
  33222. getEngine(): Engine;
  33223. private _behaviors;
  33224. /**
  33225. * Attach a behavior to the node
  33226. * @see http://doc.babylonjs.com/features/behaviour
  33227. * @param behavior defines the behavior to attach
  33228. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  33229. * @returns the current Node
  33230. */
  33231. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  33232. /**
  33233. * Remove an attached behavior
  33234. * @see http://doc.babylonjs.com/features/behaviour
  33235. * @param behavior defines the behavior to attach
  33236. * @returns the current Node
  33237. */
  33238. removeBehavior(behavior: Behavior<Node>): Node;
  33239. /**
  33240. * Gets the list of attached behaviors
  33241. * @see http://doc.babylonjs.com/features/behaviour
  33242. */
  33243. get behaviors(): Behavior<Node>[];
  33244. /**
  33245. * Gets an attached behavior by name
  33246. * @param name defines the name of the behavior to look for
  33247. * @see http://doc.babylonjs.com/features/behaviour
  33248. * @returns null if behavior was not found else the requested behavior
  33249. */
  33250. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  33251. /**
  33252. * Returns the latest update of the World matrix
  33253. * @returns a Matrix
  33254. */
  33255. getWorldMatrix(): Matrix;
  33256. /** @hidden */
  33257. _getWorldMatrixDeterminant(): number;
  33258. /**
  33259. * Returns directly the latest state of the mesh World matrix.
  33260. * A Matrix is returned.
  33261. */
  33262. get worldMatrixFromCache(): Matrix;
  33263. /** @hidden */
  33264. _initCache(): void;
  33265. /** @hidden */
  33266. updateCache(force?: boolean): void;
  33267. /** @hidden */
  33268. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33269. /** @hidden */
  33270. _updateCache(ignoreParentClass?: boolean): void;
  33271. /** @hidden */
  33272. _isSynchronized(): boolean;
  33273. /** @hidden */
  33274. _markSyncedWithParent(): void;
  33275. /** @hidden */
  33276. isSynchronizedWithParent(): boolean;
  33277. /** @hidden */
  33278. isSynchronized(): boolean;
  33279. /**
  33280. * Is this node ready to be used/rendered
  33281. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  33282. * @return true if the node is ready
  33283. */
  33284. isReady(completeCheck?: boolean): boolean;
  33285. /**
  33286. * Is this node enabled?
  33287. * 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
  33288. * @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
  33289. * @return whether this node (and its parent) is enabled
  33290. */
  33291. isEnabled(checkAncestors?: boolean): boolean;
  33292. /** @hidden */
  33293. protected _syncParentEnabledState(): void;
  33294. /**
  33295. * Set the enabled state of this node
  33296. * @param value defines the new enabled state
  33297. */
  33298. setEnabled(value: boolean): void;
  33299. /**
  33300. * Is this node a descendant of the given node?
  33301. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  33302. * @param ancestor defines the parent node to inspect
  33303. * @returns a boolean indicating if this node is a descendant of the given node
  33304. */
  33305. isDescendantOf(ancestor: Node): boolean;
  33306. /** @hidden */
  33307. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  33308. /**
  33309. * Will return all nodes that have this node as ascendant
  33310. * @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
  33311. * @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
  33312. * @return all children nodes of all types
  33313. */
  33314. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  33315. /**
  33316. * Get all child-meshes of this node
  33317. * @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)
  33318. * @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
  33319. * @returns an array of AbstractMesh
  33320. */
  33321. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  33322. /**
  33323. * Get all direct children of this node
  33324. * @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
  33325. * @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)
  33326. * @returns an array of Node
  33327. */
  33328. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  33329. /** @hidden */
  33330. _setReady(state: boolean): void;
  33331. /**
  33332. * Get an animation by name
  33333. * @param name defines the name of the animation to look for
  33334. * @returns null if not found else the requested animation
  33335. */
  33336. getAnimationByName(name: string): Nullable<Animation>;
  33337. /**
  33338. * Creates an animation range for this node
  33339. * @param name defines the name of the range
  33340. * @param from defines the starting key
  33341. * @param to defines the end key
  33342. */
  33343. createAnimationRange(name: string, from: number, to: number): void;
  33344. /**
  33345. * Delete a specific animation range
  33346. * @param name defines the name of the range to delete
  33347. * @param deleteFrames defines if animation frames from the range must be deleted as well
  33348. */
  33349. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  33350. /**
  33351. * Get an animation range by name
  33352. * @param name defines the name of the animation range to look for
  33353. * @returns null if not found else the requested animation range
  33354. */
  33355. getAnimationRange(name: string): Nullable<AnimationRange>;
  33356. /**
  33357. * Gets the list of all animation ranges defined on this node
  33358. * @returns an array
  33359. */
  33360. getAnimationRanges(): Nullable<AnimationRange>[];
  33361. /**
  33362. * Will start the animation sequence
  33363. * @param name defines the range frames for animation sequence
  33364. * @param loop defines if the animation should loop (false by default)
  33365. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  33366. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  33367. * @returns the object created for this animation. If range does not exist, it will return null
  33368. */
  33369. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  33370. /**
  33371. * Serialize animation ranges into a JSON compatible object
  33372. * @returns serialization object
  33373. */
  33374. serializeAnimationRanges(): any;
  33375. /**
  33376. * Computes the world matrix of the node
  33377. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  33378. * @returns the world matrix
  33379. */
  33380. computeWorldMatrix(force?: boolean): Matrix;
  33381. /**
  33382. * Releases resources associated with this node.
  33383. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33384. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33385. */
  33386. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33387. /**
  33388. * Parse animation range data from a serialization object and store them into a given node
  33389. * @param node defines where to store the animation ranges
  33390. * @param parsedNode defines the serialization object to read data from
  33391. * @param scene defines the hosting scene
  33392. */
  33393. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  33394. /**
  33395. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  33396. * @param includeDescendants Include bounding info from descendants as well (true by default)
  33397. * @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
  33398. * @returns the new bounding vectors
  33399. */
  33400. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  33401. min: Vector3;
  33402. max: Vector3;
  33403. };
  33404. }
  33405. }
  33406. declare module "babylonjs/Animations/animation" {
  33407. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  33408. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  33409. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33410. import { Nullable } from "babylonjs/types";
  33411. import { Scene } from "babylonjs/scene";
  33412. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  33413. import { AnimationRange } from "babylonjs/Animations/animationRange";
  33414. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  33415. import { Node } from "babylonjs/node";
  33416. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  33417. import { Size } from "babylonjs/Maths/math.size";
  33418. import { Animatable } from "babylonjs/Animations/animatable";
  33419. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  33420. /**
  33421. * @hidden
  33422. */
  33423. export class _IAnimationState {
  33424. key: number;
  33425. repeatCount: number;
  33426. workValue?: any;
  33427. loopMode?: number;
  33428. offsetValue?: any;
  33429. highLimitValue?: any;
  33430. }
  33431. /**
  33432. * Class used to store any kind of animation
  33433. */
  33434. export class Animation {
  33435. /**Name of the animation */
  33436. name: string;
  33437. /**Property to animate */
  33438. targetProperty: string;
  33439. /**The frames per second of the animation */
  33440. framePerSecond: number;
  33441. /**The data type of the animation */
  33442. dataType: number;
  33443. /**The loop mode of the animation */
  33444. loopMode?: number | undefined;
  33445. /**Specifies if blending should be enabled */
  33446. enableBlending?: boolean | undefined;
  33447. /**
  33448. * Use matrix interpolation instead of using direct key value when animating matrices
  33449. */
  33450. static AllowMatricesInterpolation: boolean;
  33451. /**
  33452. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  33453. */
  33454. static AllowMatrixDecomposeForInterpolation: boolean;
  33455. /** Define the Url to load snippets */
  33456. static SnippetUrl: string;
  33457. /** Snippet ID if the animation was created from the snippet server */
  33458. snippetId: string;
  33459. /**
  33460. * Stores the key frames of the animation
  33461. */
  33462. private _keys;
  33463. /**
  33464. * Stores the easing function of the animation
  33465. */
  33466. private _easingFunction;
  33467. /**
  33468. * @hidden Internal use only
  33469. */
  33470. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  33471. /**
  33472. * The set of event that will be linked to this animation
  33473. */
  33474. private _events;
  33475. /**
  33476. * Stores an array of target property paths
  33477. */
  33478. targetPropertyPath: string[];
  33479. /**
  33480. * Stores the blending speed of the animation
  33481. */
  33482. blendingSpeed: number;
  33483. /**
  33484. * Stores the animation ranges for the animation
  33485. */
  33486. private _ranges;
  33487. /**
  33488. * @hidden Internal use
  33489. */
  33490. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  33491. /**
  33492. * Sets up an animation
  33493. * @param property The property to animate
  33494. * @param animationType The animation type to apply
  33495. * @param framePerSecond The frames per second of the animation
  33496. * @param easingFunction The easing function used in the animation
  33497. * @returns The created animation
  33498. */
  33499. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  33500. /**
  33501. * Create and start an animation on a node
  33502. * @param name defines the name of the global animation that will be run on all nodes
  33503. * @param node defines the root node where the animation will take place
  33504. * @param targetProperty defines property to animate
  33505. * @param framePerSecond defines the number of frame per second yo use
  33506. * @param totalFrame defines the number of frames in total
  33507. * @param from defines the initial value
  33508. * @param to defines the final value
  33509. * @param loopMode defines which loop mode you want to use (off by default)
  33510. * @param easingFunction defines the easing function to use (linear by default)
  33511. * @param onAnimationEnd defines the callback to call when animation end
  33512. * @returns the animatable created for this animation
  33513. */
  33514. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  33515. /**
  33516. * Create and start an animation on a node and its descendants
  33517. * @param name defines the name of the global animation that will be run on all nodes
  33518. * @param node defines the root node where the animation will take place
  33519. * @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
  33520. * @param targetProperty defines property to animate
  33521. * @param framePerSecond defines the number of frame per second to use
  33522. * @param totalFrame defines the number of frames in total
  33523. * @param from defines the initial value
  33524. * @param to defines the final value
  33525. * @param loopMode defines which loop mode you want to use (off by default)
  33526. * @param easingFunction defines the easing function to use (linear by default)
  33527. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  33528. * @returns the list of animatables created for all nodes
  33529. * @example https://www.babylonjs-playground.com/#MH0VLI
  33530. */
  33531. 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[]>;
  33532. /**
  33533. * Creates a new animation, merges it with the existing animations and starts it
  33534. * @param name Name of the animation
  33535. * @param node Node which contains the scene that begins the animations
  33536. * @param targetProperty Specifies which property to animate
  33537. * @param framePerSecond The frames per second of the animation
  33538. * @param totalFrame The total number of frames
  33539. * @param from The frame at the beginning of the animation
  33540. * @param to The frame at the end of the animation
  33541. * @param loopMode Specifies the loop mode of the animation
  33542. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  33543. * @param onAnimationEnd Callback to run once the animation is complete
  33544. * @returns Nullable animation
  33545. */
  33546. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  33547. /**
  33548. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  33549. * @param sourceAnimation defines the Animation containing keyframes to convert
  33550. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  33551. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  33552. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  33553. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  33554. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  33555. */
  33556. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  33557. /**
  33558. * Transition property of an host to the target Value
  33559. * @param property The property to transition
  33560. * @param targetValue The target Value of the property
  33561. * @param host The object where the property to animate belongs
  33562. * @param scene Scene used to run the animation
  33563. * @param frameRate Framerate (in frame/s) to use
  33564. * @param transition The transition type we want to use
  33565. * @param duration The duration of the animation, in milliseconds
  33566. * @param onAnimationEnd Callback trigger at the end of the animation
  33567. * @returns Nullable animation
  33568. */
  33569. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  33570. /**
  33571. * Return the array of runtime animations currently using this animation
  33572. */
  33573. get runtimeAnimations(): RuntimeAnimation[];
  33574. /**
  33575. * Specifies if any of the runtime animations are currently running
  33576. */
  33577. get hasRunningRuntimeAnimations(): boolean;
  33578. /**
  33579. * Initializes the animation
  33580. * @param name Name of the animation
  33581. * @param targetProperty Property to animate
  33582. * @param framePerSecond The frames per second of the animation
  33583. * @param dataType The data type of the animation
  33584. * @param loopMode The loop mode of the animation
  33585. * @param enableBlending Specifies if blending should be enabled
  33586. */
  33587. constructor(
  33588. /**Name of the animation */
  33589. name: string,
  33590. /**Property to animate */
  33591. targetProperty: string,
  33592. /**The frames per second of the animation */
  33593. framePerSecond: number,
  33594. /**The data type of the animation */
  33595. dataType: number,
  33596. /**The loop mode of the animation */
  33597. loopMode?: number | undefined,
  33598. /**Specifies if blending should be enabled */
  33599. enableBlending?: boolean | undefined);
  33600. /**
  33601. * Converts the animation to a string
  33602. * @param fullDetails support for multiple levels of logging within scene loading
  33603. * @returns String form of the animation
  33604. */
  33605. toString(fullDetails?: boolean): string;
  33606. /**
  33607. * Add an event to this animation
  33608. * @param event Event to add
  33609. */
  33610. addEvent(event: AnimationEvent): void;
  33611. /**
  33612. * Remove all events found at the given frame
  33613. * @param frame The frame to remove events from
  33614. */
  33615. removeEvents(frame: number): void;
  33616. /**
  33617. * Retrieves all the events from the animation
  33618. * @returns Events from the animation
  33619. */
  33620. getEvents(): AnimationEvent[];
  33621. /**
  33622. * Creates an animation range
  33623. * @param name Name of the animation range
  33624. * @param from Starting frame of the animation range
  33625. * @param to Ending frame of the animation
  33626. */
  33627. createRange(name: string, from: number, to: number): void;
  33628. /**
  33629. * Deletes an animation range by name
  33630. * @param name Name of the animation range to delete
  33631. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  33632. */
  33633. deleteRange(name: string, deleteFrames?: boolean): void;
  33634. /**
  33635. * Gets the animation range by name, or null if not defined
  33636. * @param name Name of the animation range
  33637. * @returns Nullable animation range
  33638. */
  33639. getRange(name: string): Nullable<AnimationRange>;
  33640. /**
  33641. * Gets the key frames from the animation
  33642. * @returns The key frames of the animation
  33643. */
  33644. getKeys(): Array<IAnimationKey>;
  33645. /**
  33646. * Gets the highest frame rate of the animation
  33647. * @returns Highest frame rate of the animation
  33648. */
  33649. getHighestFrame(): number;
  33650. /**
  33651. * Gets the easing function of the animation
  33652. * @returns Easing function of the animation
  33653. */
  33654. getEasingFunction(): IEasingFunction;
  33655. /**
  33656. * Sets the easing function of the animation
  33657. * @param easingFunction A custom mathematical formula for animation
  33658. */
  33659. setEasingFunction(easingFunction: EasingFunction): void;
  33660. /**
  33661. * Interpolates a scalar linearly
  33662. * @param startValue Start value of the animation curve
  33663. * @param endValue End value of the animation curve
  33664. * @param gradient Scalar amount to interpolate
  33665. * @returns Interpolated scalar value
  33666. */
  33667. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  33668. /**
  33669. * Interpolates a scalar cubically
  33670. * @param startValue Start value of the animation curve
  33671. * @param outTangent End tangent of the animation
  33672. * @param endValue End value of the animation curve
  33673. * @param inTangent Start tangent of the animation curve
  33674. * @param gradient Scalar amount to interpolate
  33675. * @returns Interpolated scalar value
  33676. */
  33677. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  33678. /**
  33679. * Interpolates a quaternion using a spherical linear interpolation
  33680. * @param startValue Start value of the animation curve
  33681. * @param endValue End value of the animation curve
  33682. * @param gradient Scalar amount to interpolate
  33683. * @returns Interpolated quaternion value
  33684. */
  33685. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  33686. /**
  33687. * Interpolates a quaternion cubically
  33688. * @param startValue Start value of the animation curve
  33689. * @param outTangent End tangent of the animation curve
  33690. * @param endValue End value of the animation curve
  33691. * @param inTangent Start tangent of the animation curve
  33692. * @param gradient Scalar amount to interpolate
  33693. * @returns Interpolated quaternion value
  33694. */
  33695. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  33696. /**
  33697. * Interpolates a Vector3 linearl
  33698. * @param startValue Start value of the animation curve
  33699. * @param endValue End value of the animation curve
  33700. * @param gradient Scalar amount to interpolate
  33701. * @returns Interpolated scalar value
  33702. */
  33703. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  33704. /**
  33705. * Interpolates a Vector3 cubically
  33706. * @param startValue Start value of the animation curve
  33707. * @param outTangent End tangent of the animation
  33708. * @param endValue End value of the animation curve
  33709. * @param inTangent Start tangent of the animation curve
  33710. * @param gradient Scalar amount to interpolate
  33711. * @returns InterpolatedVector3 value
  33712. */
  33713. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  33714. /**
  33715. * Interpolates a Vector2 linearly
  33716. * @param startValue Start value of the animation curve
  33717. * @param endValue End value of the animation curve
  33718. * @param gradient Scalar amount to interpolate
  33719. * @returns Interpolated Vector2 value
  33720. */
  33721. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  33722. /**
  33723. * Interpolates a Vector2 cubically
  33724. * @param startValue Start value of the animation curve
  33725. * @param outTangent End tangent of the animation
  33726. * @param endValue End value of the animation curve
  33727. * @param inTangent Start tangent of the animation curve
  33728. * @param gradient Scalar amount to interpolate
  33729. * @returns Interpolated Vector2 value
  33730. */
  33731. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  33732. /**
  33733. * Interpolates a size linearly
  33734. * @param startValue Start value of the animation curve
  33735. * @param endValue End value of the animation curve
  33736. * @param gradient Scalar amount to interpolate
  33737. * @returns Interpolated Size value
  33738. */
  33739. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  33740. /**
  33741. * Interpolates a Color3 linearly
  33742. * @param startValue Start value of the animation curve
  33743. * @param endValue End value of the animation curve
  33744. * @param gradient Scalar amount to interpolate
  33745. * @returns Interpolated Color3 value
  33746. */
  33747. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  33748. /**
  33749. * Interpolates a Color4 linearly
  33750. * @param startValue Start value of the animation curve
  33751. * @param endValue End value of the animation curve
  33752. * @param gradient Scalar amount to interpolate
  33753. * @returns Interpolated Color3 value
  33754. */
  33755. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  33756. /**
  33757. * @hidden Internal use only
  33758. */
  33759. _getKeyValue(value: any): any;
  33760. /**
  33761. * @hidden Internal use only
  33762. */
  33763. _interpolate(currentFrame: number, state: _IAnimationState): any;
  33764. /**
  33765. * Defines the function to use to interpolate matrices
  33766. * @param startValue defines the start matrix
  33767. * @param endValue defines the end matrix
  33768. * @param gradient defines the gradient between both matrices
  33769. * @param result defines an optional target matrix where to store the interpolation
  33770. * @returns the interpolated matrix
  33771. */
  33772. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  33773. /**
  33774. * Makes a copy of the animation
  33775. * @returns Cloned animation
  33776. */
  33777. clone(): Animation;
  33778. /**
  33779. * Sets the key frames of the animation
  33780. * @param values The animation key frames to set
  33781. */
  33782. setKeys(values: Array<IAnimationKey>): void;
  33783. /**
  33784. * Serializes the animation to an object
  33785. * @returns Serialized object
  33786. */
  33787. serialize(): any;
  33788. /**
  33789. * Float animation type
  33790. */
  33791. static readonly ANIMATIONTYPE_FLOAT: number;
  33792. /**
  33793. * Vector3 animation type
  33794. */
  33795. static readonly ANIMATIONTYPE_VECTOR3: number;
  33796. /**
  33797. * Quaternion animation type
  33798. */
  33799. static readonly ANIMATIONTYPE_QUATERNION: number;
  33800. /**
  33801. * Matrix animation type
  33802. */
  33803. static readonly ANIMATIONTYPE_MATRIX: number;
  33804. /**
  33805. * Color3 animation type
  33806. */
  33807. static readonly ANIMATIONTYPE_COLOR3: number;
  33808. /**
  33809. * Color3 animation type
  33810. */
  33811. static readonly ANIMATIONTYPE_COLOR4: number;
  33812. /**
  33813. * Vector2 animation type
  33814. */
  33815. static readonly ANIMATIONTYPE_VECTOR2: number;
  33816. /**
  33817. * Size animation type
  33818. */
  33819. static readonly ANIMATIONTYPE_SIZE: number;
  33820. /**
  33821. * Relative Loop Mode
  33822. */
  33823. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  33824. /**
  33825. * Cycle Loop Mode
  33826. */
  33827. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  33828. /**
  33829. * Constant Loop Mode
  33830. */
  33831. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  33832. /** @hidden */
  33833. static _UniversalLerp(left: any, right: any, amount: number): any;
  33834. /**
  33835. * Parses an animation object and creates an animation
  33836. * @param parsedAnimation Parsed animation object
  33837. * @returns Animation object
  33838. */
  33839. static Parse(parsedAnimation: any): Animation;
  33840. /**
  33841. * Appends the serialized animations from the source animations
  33842. * @param source Source containing the animations
  33843. * @param destination Target to store the animations
  33844. */
  33845. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  33846. /**
  33847. * Creates a new animation or an array of animations from a snippet saved in a remote file
  33848. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  33849. * @param url defines the url to load from
  33850. * @returns a promise that will resolve to the new animation or an array of animations
  33851. */
  33852. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  33853. /**
  33854. * Creates an animation or an array of animations from a snippet saved by the Inspector
  33855. * @param snippetId defines the snippet to load
  33856. * @returns a promise that will resolve to the new animation or a new array of animations
  33857. */
  33858. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  33859. }
  33860. }
  33861. declare module "babylonjs/Animations/animatable.interface" {
  33862. import { Nullable } from "babylonjs/types";
  33863. import { Animation } from "babylonjs/Animations/animation";
  33864. /**
  33865. * Interface containing an array of animations
  33866. */
  33867. export interface IAnimatable {
  33868. /**
  33869. * Array of animations
  33870. */
  33871. animations: Nullable<Array<Animation>>;
  33872. }
  33873. }
  33874. declare module "babylonjs/Misc/decorators" {
  33875. import { Nullable } from "babylonjs/types";
  33876. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  33877. import { Scene } from "babylonjs/scene";
  33878. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  33879. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33880. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33881. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33882. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33883. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33884. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33885. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33886. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33887. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33888. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33889. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33890. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33891. /**
  33892. * Decorator used to define property that can be serialized as reference to a camera
  33893. * @param sourceName defines the name of the property to decorate
  33894. */
  33895. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  33896. /**
  33897. * Class used to help serialization objects
  33898. */
  33899. export class SerializationHelper {
  33900. /** @hidden */
  33901. static _ImageProcessingConfigurationParser: (sourceProperty: any) => import("babylonjs/Materials/imageProcessingConfiguration").ImageProcessingConfiguration;
  33902. /** @hidden */
  33903. static _FresnelParametersParser: (sourceProperty: any) => import("babylonjs/Materials/fresnelParameters").FresnelParameters;
  33904. /** @hidden */
  33905. static _ColorCurvesParser: (sourceProperty: any) => import("babylonjs/Materials/colorCurves").ColorCurves;
  33906. /** @hidden */
  33907. static _TextureParser: (sourceProperty: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => Nullable<import("babylonjs/Materials/Textures/baseTexture").BaseTexture>;
  33908. /**
  33909. * Appends the serialized animations from the source animations
  33910. * @param source Source containing the animations
  33911. * @param destination Target to store the animations
  33912. */
  33913. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  33914. /**
  33915. * Static function used to serialized a specific entity
  33916. * @param entity defines the entity to serialize
  33917. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  33918. * @returns a JSON compatible object representing the serialization of the entity
  33919. */
  33920. static Serialize<T>(entity: T, serializationObject?: any): any;
  33921. /**
  33922. * Creates a new entity from a serialization data object
  33923. * @param creationFunction defines a function used to instanciated the new entity
  33924. * @param source defines the source serialization data
  33925. * @param scene defines the hosting scene
  33926. * @param rootUrl defines the root url for resources
  33927. * @returns a new entity
  33928. */
  33929. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  33930. /**
  33931. * Clones an object
  33932. * @param creationFunction defines the function used to instanciate the new object
  33933. * @param source defines the source object
  33934. * @returns the cloned object
  33935. */
  33936. static Clone<T>(creationFunction: () => T, source: T): T;
  33937. /**
  33938. * Instanciates a new object based on a source one (some data will be shared between both object)
  33939. * @param creationFunction defines the function used to instanciate the new object
  33940. * @param source defines the source object
  33941. * @returns the new object
  33942. */
  33943. static Instanciate<T>(creationFunction: () => T, source: T): T;
  33944. }
  33945. }
  33946. declare module "babylonjs/Materials/Textures/baseTexture" {
  33947. import { Observable } from "babylonjs/Misc/observable";
  33948. import { Nullable } from "babylonjs/types";
  33949. import { Scene } from "babylonjs/scene";
  33950. import { Matrix } from "babylonjs/Maths/math.vector";
  33951. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  33952. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  33953. import { ISize } from "babylonjs/Maths/math.size";
  33954. import "babylonjs/Misc/fileTools";
  33955. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  33956. /**
  33957. * Base class of all the textures in babylon.
  33958. * It groups all the common properties the materials, post process, lights... might need
  33959. * in order to make a correct use of the texture.
  33960. */
  33961. export class BaseTexture implements IAnimatable {
  33962. /**
  33963. * Default anisotropic filtering level for the application.
  33964. * It is set to 4 as a good tradeoff between perf and quality.
  33965. */
  33966. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  33967. /**
  33968. * Gets or sets the unique id of the texture
  33969. */
  33970. uniqueId: number;
  33971. /**
  33972. * Define the name of the texture.
  33973. */
  33974. name: string;
  33975. /**
  33976. * Gets or sets an object used to store user defined information.
  33977. */
  33978. metadata: any;
  33979. /**
  33980. * For internal use only. Please do not use.
  33981. */
  33982. reservedDataStore: any;
  33983. private _hasAlpha;
  33984. /**
  33985. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  33986. */
  33987. set hasAlpha(value: boolean);
  33988. get hasAlpha(): boolean;
  33989. /**
  33990. * Defines if the alpha value should be determined via the rgb values.
  33991. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  33992. */
  33993. getAlphaFromRGB: boolean;
  33994. /**
  33995. * Intensity or strength of the texture.
  33996. * It is commonly used by materials to fine tune the intensity of the texture
  33997. */
  33998. level: number;
  33999. /**
  34000. * Define the UV chanel to use starting from 0 and defaulting to 0.
  34001. * This is part of the texture as textures usually maps to one uv set.
  34002. */
  34003. coordinatesIndex: number;
  34004. private _coordinatesMode;
  34005. /**
  34006. * How a texture is mapped.
  34007. *
  34008. * | Value | Type | Description |
  34009. * | ----- | ----------------------------------- | ----------- |
  34010. * | 0 | EXPLICIT_MODE | |
  34011. * | 1 | SPHERICAL_MODE | |
  34012. * | 2 | PLANAR_MODE | |
  34013. * | 3 | CUBIC_MODE | |
  34014. * | 4 | PROJECTION_MODE | |
  34015. * | 5 | SKYBOX_MODE | |
  34016. * | 6 | INVCUBIC_MODE | |
  34017. * | 7 | EQUIRECTANGULAR_MODE | |
  34018. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  34019. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  34020. */
  34021. set coordinatesMode(value: number);
  34022. get coordinatesMode(): number;
  34023. /**
  34024. * | Value | Type | Description |
  34025. * | ----- | ------------------ | ----------- |
  34026. * | 0 | CLAMP_ADDRESSMODE | |
  34027. * | 1 | WRAP_ADDRESSMODE | |
  34028. * | 2 | MIRROR_ADDRESSMODE | |
  34029. */
  34030. wrapU: number;
  34031. /**
  34032. * | Value | Type | Description |
  34033. * | ----- | ------------------ | ----------- |
  34034. * | 0 | CLAMP_ADDRESSMODE | |
  34035. * | 1 | WRAP_ADDRESSMODE | |
  34036. * | 2 | MIRROR_ADDRESSMODE | |
  34037. */
  34038. wrapV: number;
  34039. /**
  34040. * | Value | Type | Description |
  34041. * | ----- | ------------------ | ----------- |
  34042. * | 0 | CLAMP_ADDRESSMODE | |
  34043. * | 1 | WRAP_ADDRESSMODE | |
  34044. * | 2 | MIRROR_ADDRESSMODE | |
  34045. */
  34046. wrapR: number;
  34047. /**
  34048. * With compliant hardware and browser (supporting anisotropic filtering)
  34049. * this defines the level of anisotropic filtering in the texture.
  34050. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  34051. */
  34052. anisotropicFilteringLevel: number;
  34053. /**
  34054. * Define if the texture is a cube texture or if false a 2d texture.
  34055. */
  34056. get isCube(): boolean;
  34057. set isCube(value: boolean);
  34058. /**
  34059. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  34060. */
  34061. get is3D(): boolean;
  34062. set is3D(value: boolean);
  34063. /**
  34064. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  34065. */
  34066. get is2DArray(): boolean;
  34067. set is2DArray(value: boolean);
  34068. /**
  34069. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  34070. * HDR texture are usually stored in linear space.
  34071. * This only impacts the PBR and Background materials
  34072. */
  34073. gammaSpace: boolean;
  34074. /**
  34075. * Gets or sets whether or not the texture contains RGBD data.
  34076. */
  34077. get isRGBD(): boolean;
  34078. set isRGBD(value: boolean);
  34079. /**
  34080. * Is Z inverted in the texture (useful in a cube texture).
  34081. */
  34082. invertZ: boolean;
  34083. /**
  34084. * Are mip maps generated for this texture or not.
  34085. */
  34086. get noMipmap(): boolean;
  34087. /**
  34088. * @hidden
  34089. */
  34090. lodLevelInAlpha: boolean;
  34091. /**
  34092. * With prefiltered texture, defined the offset used during the prefiltering steps.
  34093. */
  34094. get lodGenerationOffset(): number;
  34095. set lodGenerationOffset(value: number);
  34096. /**
  34097. * With prefiltered texture, defined the scale used during the prefiltering steps.
  34098. */
  34099. get lodGenerationScale(): number;
  34100. set lodGenerationScale(value: number);
  34101. /**
  34102. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  34103. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  34104. * average roughness values.
  34105. */
  34106. get linearSpecularLOD(): boolean;
  34107. set linearSpecularLOD(value: boolean);
  34108. /**
  34109. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  34110. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  34111. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  34112. */
  34113. get irradianceTexture(): Nullable<BaseTexture>;
  34114. set irradianceTexture(value: Nullable<BaseTexture>);
  34115. /**
  34116. * Define if the texture is a render target.
  34117. */
  34118. isRenderTarget: boolean;
  34119. /**
  34120. * Define the unique id of the texture in the scene.
  34121. */
  34122. get uid(): string;
  34123. /** @hidden */
  34124. _prefiltered: boolean;
  34125. /**
  34126. * Return a string representation of the texture.
  34127. * @returns the texture as a string
  34128. */
  34129. toString(): string;
  34130. /**
  34131. * Get the class name of the texture.
  34132. * @returns "BaseTexture"
  34133. */
  34134. getClassName(): string;
  34135. /**
  34136. * Define the list of animation attached to the texture.
  34137. */
  34138. animations: import("babylonjs/Animations/animation").Animation[];
  34139. /**
  34140. * An event triggered when the texture is disposed.
  34141. */
  34142. onDisposeObservable: Observable<BaseTexture>;
  34143. private _onDisposeObserver;
  34144. /**
  34145. * Callback triggered when the texture has been disposed.
  34146. * Kept for back compatibility, you can use the onDisposeObservable instead.
  34147. */
  34148. set onDispose(callback: () => void);
  34149. /**
  34150. * Define the current state of the loading sequence when in delayed load mode.
  34151. */
  34152. delayLoadState: number;
  34153. private _scene;
  34154. private _engine;
  34155. /** @hidden */
  34156. _texture: Nullable<InternalTexture>;
  34157. private _uid;
  34158. /**
  34159. * Define if the texture is preventinga material to render or not.
  34160. * If not and the texture is not ready, the engine will use a default black texture instead.
  34161. */
  34162. get isBlocking(): boolean;
  34163. /**
  34164. * Instantiates a new BaseTexture.
  34165. * Base class of all the textures in babylon.
  34166. * It groups all the common properties the materials, post process, lights... might need
  34167. * in order to make a correct use of the texture.
  34168. * @param sceneOrEngine Define the scene or engine the texture blongs to
  34169. */
  34170. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  34171. /**
  34172. * Get the scene the texture belongs to.
  34173. * @returns the scene or null if undefined
  34174. */
  34175. getScene(): Nullable<Scene>;
  34176. /** @hidden */
  34177. protected _getEngine(): Nullable<ThinEngine>;
  34178. /**
  34179. * Get the texture transform matrix used to offset tile the texture for istance.
  34180. * @returns the transformation matrix
  34181. */
  34182. getTextureMatrix(): Matrix;
  34183. /**
  34184. * Get the texture reflection matrix used to rotate/transform the reflection.
  34185. * @returns the reflection matrix
  34186. */
  34187. getReflectionTextureMatrix(): Matrix;
  34188. /**
  34189. * Get the underlying lower level texture from Babylon.
  34190. * @returns the insternal texture
  34191. */
  34192. getInternalTexture(): Nullable<InternalTexture>;
  34193. /**
  34194. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  34195. * @returns true if ready or not blocking
  34196. */
  34197. isReadyOrNotBlocking(): boolean;
  34198. /**
  34199. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  34200. * @returns true if fully ready
  34201. */
  34202. isReady(): boolean;
  34203. private _cachedSize;
  34204. /**
  34205. * Get the size of the texture.
  34206. * @returns the texture size.
  34207. */
  34208. getSize(): ISize;
  34209. /**
  34210. * Get the base size of the texture.
  34211. * It can be different from the size if the texture has been resized for POT for instance
  34212. * @returns the base size
  34213. */
  34214. getBaseSize(): ISize;
  34215. /**
  34216. * Update the sampling mode of the texture.
  34217. * Default is Trilinear mode.
  34218. *
  34219. * | Value | Type | Description |
  34220. * | ----- | ------------------ | ----------- |
  34221. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  34222. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  34223. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  34224. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  34225. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  34226. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  34227. * | 7 | NEAREST_LINEAR | |
  34228. * | 8 | NEAREST_NEAREST | |
  34229. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  34230. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  34231. * | 11 | LINEAR_LINEAR | |
  34232. * | 12 | LINEAR_NEAREST | |
  34233. *
  34234. * > _mag_: magnification filter (close to the viewer)
  34235. * > _min_: minification filter (far from the viewer)
  34236. * > _mip_: filter used between mip map levels
  34237. *@param samplingMode Define the new sampling mode of the texture
  34238. */
  34239. updateSamplingMode(samplingMode: number): void;
  34240. /**
  34241. * Scales the texture if is `canRescale()`
  34242. * @param ratio the resize factor we want to use to rescale
  34243. */
  34244. scale(ratio: number): void;
  34245. /**
  34246. * Get if the texture can rescale.
  34247. */
  34248. get canRescale(): boolean;
  34249. /** @hidden */
  34250. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  34251. /** @hidden */
  34252. _rebuild(): void;
  34253. /**
  34254. * Triggers the load sequence in delayed load mode.
  34255. */
  34256. delayLoad(): void;
  34257. /**
  34258. * Clones the texture.
  34259. * @returns the cloned texture
  34260. */
  34261. clone(): Nullable<BaseTexture>;
  34262. /**
  34263. * Get the texture underlying type (INT, FLOAT...)
  34264. */
  34265. get textureType(): number;
  34266. /**
  34267. * Get the texture underlying format (RGB, RGBA...)
  34268. */
  34269. get textureFormat(): number;
  34270. /**
  34271. * Indicates that textures need to be re-calculated for all materials
  34272. */
  34273. protected _markAllSubMeshesAsTexturesDirty(): void;
  34274. /**
  34275. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  34276. * This will returns an RGBA array buffer containing either in values (0-255) or
  34277. * float values (0-1) depending of the underlying buffer type.
  34278. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  34279. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  34280. * @param buffer defines a user defined buffer to fill with data (can be null)
  34281. * @returns The Array buffer containing the pixels data.
  34282. */
  34283. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  34284. /**
  34285. * Release and destroy the underlying lower level texture aka internalTexture.
  34286. */
  34287. releaseInternalTexture(): void;
  34288. /** @hidden */
  34289. get _lodTextureHigh(): Nullable<BaseTexture>;
  34290. /** @hidden */
  34291. get _lodTextureMid(): Nullable<BaseTexture>;
  34292. /** @hidden */
  34293. get _lodTextureLow(): Nullable<BaseTexture>;
  34294. /**
  34295. * Dispose the texture and release its associated resources.
  34296. */
  34297. dispose(): void;
  34298. /**
  34299. * Serialize the texture into a JSON representation that can be parsed later on.
  34300. * @returns the JSON representation of the texture
  34301. */
  34302. serialize(): any;
  34303. /**
  34304. * Helper function to be called back once a list of texture contains only ready textures.
  34305. * @param textures Define the list of textures to wait for
  34306. * @param callback Define the callback triggered once the entire list will be ready
  34307. */
  34308. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  34309. private static _isScene;
  34310. }
  34311. }
  34312. declare module "babylonjs/Materials/effect" {
  34313. import { Observable } from "babylonjs/Misc/observable";
  34314. import { Nullable } from "babylonjs/types";
  34315. import { IDisposable } from "babylonjs/scene";
  34316. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  34317. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  34318. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  34319. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  34320. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  34321. import { Engine } from "babylonjs/Engines/engine";
  34322. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  34323. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34324. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  34325. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  34326. /**
  34327. * Options to be used when creating an effect.
  34328. */
  34329. export interface IEffectCreationOptions {
  34330. /**
  34331. * Atrributes that will be used in the shader.
  34332. */
  34333. attributes: string[];
  34334. /**
  34335. * Uniform varible names that will be set in the shader.
  34336. */
  34337. uniformsNames: string[];
  34338. /**
  34339. * Uniform buffer variable names that will be set in the shader.
  34340. */
  34341. uniformBuffersNames: string[];
  34342. /**
  34343. * Sampler texture variable names that will be set in the shader.
  34344. */
  34345. samplers: string[];
  34346. /**
  34347. * Define statements that will be set in the shader.
  34348. */
  34349. defines: any;
  34350. /**
  34351. * Possible fallbacks for this effect to improve performance when needed.
  34352. */
  34353. fallbacks: Nullable<IEffectFallbacks>;
  34354. /**
  34355. * Callback that will be called when the shader is compiled.
  34356. */
  34357. onCompiled: Nullable<(effect: Effect) => void>;
  34358. /**
  34359. * Callback that will be called if an error occurs during shader compilation.
  34360. */
  34361. onError: Nullable<(effect: Effect, errors: string) => void>;
  34362. /**
  34363. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  34364. */
  34365. indexParameters?: any;
  34366. /**
  34367. * Max number of lights that can be used in the shader.
  34368. */
  34369. maxSimultaneousLights?: number;
  34370. /**
  34371. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  34372. */
  34373. transformFeedbackVaryings?: Nullable<string[]>;
  34374. /**
  34375. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  34376. */
  34377. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  34378. }
  34379. /**
  34380. * Effect containing vertex and fragment shader that can be executed on an object.
  34381. */
  34382. export class Effect implements IDisposable {
  34383. /**
  34384. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  34385. */
  34386. static ShadersRepository: string;
  34387. /**
  34388. * Enable logging of the shader code when a compilation error occurs
  34389. */
  34390. static LogShaderCodeOnCompilationError: boolean;
  34391. /**
  34392. * Name of the effect.
  34393. */
  34394. name: any;
  34395. /**
  34396. * String container all the define statements that should be set on the shader.
  34397. */
  34398. defines: string;
  34399. /**
  34400. * Callback that will be called when the shader is compiled.
  34401. */
  34402. onCompiled: Nullable<(effect: Effect) => void>;
  34403. /**
  34404. * Callback that will be called if an error occurs during shader compilation.
  34405. */
  34406. onError: Nullable<(effect: Effect, errors: string) => void>;
  34407. /**
  34408. * Callback that will be called when effect is bound.
  34409. */
  34410. onBind: Nullable<(effect: Effect) => void>;
  34411. /**
  34412. * Unique ID of the effect.
  34413. */
  34414. uniqueId: number;
  34415. /**
  34416. * Observable that will be called when the shader is compiled.
  34417. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  34418. */
  34419. onCompileObservable: Observable<Effect>;
  34420. /**
  34421. * Observable that will be called if an error occurs during shader compilation.
  34422. */
  34423. onErrorObservable: Observable<Effect>;
  34424. /** @hidden */
  34425. _onBindObservable: Nullable<Observable<Effect>>;
  34426. /**
  34427. * @hidden
  34428. * Specifies if the effect was previously ready
  34429. */
  34430. _wasPreviouslyReady: boolean;
  34431. /**
  34432. * Observable that will be called when effect is bound.
  34433. */
  34434. get onBindObservable(): Observable<Effect>;
  34435. /** @hidden */
  34436. _bonesComputationForcedToCPU: boolean;
  34437. private static _uniqueIdSeed;
  34438. private _engine;
  34439. private _uniformBuffersNames;
  34440. private _uniformBuffersNamesList;
  34441. private _uniformsNames;
  34442. private _samplerList;
  34443. private _samplers;
  34444. private _isReady;
  34445. private _compilationError;
  34446. private _allFallbacksProcessed;
  34447. private _attributesNames;
  34448. private _attributes;
  34449. private _attributeLocationByName;
  34450. private _uniforms;
  34451. /**
  34452. * Key for the effect.
  34453. * @hidden
  34454. */
  34455. _key: string;
  34456. private _indexParameters;
  34457. private _fallbacks;
  34458. private _vertexSourceCode;
  34459. private _fragmentSourceCode;
  34460. private _vertexSourceCodeOverride;
  34461. private _fragmentSourceCodeOverride;
  34462. private _transformFeedbackVaryings;
  34463. /**
  34464. * Compiled shader to webGL program.
  34465. * @hidden
  34466. */
  34467. _pipelineContext: Nullable<IPipelineContext>;
  34468. private _valueCache;
  34469. private static _baseCache;
  34470. /**
  34471. * Instantiates an effect.
  34472. * An effect can be used to create/manage/execute vertex and fragment shaders.
  34473. * @param baseName Name of the effect.
  34474. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  34475. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  34476. * @param samplers List of sampler variables that will be passed to the shader.
  34477. * @param engine Engine to be used to render the effect
  34478. * @param defines Define statements to be added to the shader.
  34479. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  34480. * @param onCompiled Callback that will be called when the shader is compiled.
  34481. * @param onError Callback that will be called if an error occurs during shader compilation.
  34482. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  34483. */
  34484. 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);
  34485. private _useFinalCode;
  34486. /**
  34487. * Unique key for this effect
  34488. */
  34489. get key(): string;
  34490. /**
  34491. * If the effect has been compiled and prepared.
  34492. * @returns if the effect is compiled and prepared.
  34493. */
  34494. isReady(): boolean;
  34495. private _isReadyInternal;
  34496. /**
  34497. * The engine the effect was initialized with.
  34498. * @returns the engine.
  34499. */
  34500. getEngine(): Engine;
  34501. /**
  34502. * The pipeline context for this effect
  34503. * @returns the associated pipeline context
  34504. */
  34505. getPipelineContext(): Nullable<IPipelineContext>;
  34506. /**
  34507. * The set of names of attribute variables for the shader.
  34508. * @returns An array of attribute names.
  34509. */
  34510. getAttributesNames(): string[];
  34511. /**
  34512. * Returns the attribute at the given index.
  34513. * @param index The index of the attribute.
  34514. * @returns The location of the attribute.
  34515. */
  34516. getAttributeLocation(index: number): number;
  34517. /**
  34518. * Returns the attribute based on the name of the variable.
  34519. * @param name of the attribute to look up.
  34520. * @returns the attribute location.
  34521. */
  34522. getAttributeLocationByName(name: string): number;
  34523. /**
  34524. * The number of attributes.
  34525. * @returns the numnber of attributes.
  34526. */
  34527. getAttributesCount(): number;
  34528. /**
  34529. * Gets the index of a uniform variable.
  34530. * @param uniformName of the uniform to look up.
  34531. * @returns the index.
  34532. */
  34533. getUniformIndex(uniformName: string): number;
  34534. /**
  34535. * Returns the attribute based on the name of the variable.
  34536. * @param uniformName of the uniform to look up.
  34537. * @returns the location of the uniform.
  34538. */
  34539. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  34540. /**
  34541. * Returns an array of sampler variable names
  34542. * @returns The array of sampler variable names.
  34543. */
  34544. getSamplers(): string[];
  34545. /**
  34546. * Returns an array of uniform variable names
  34547. * @returns The array of uniform variable names.
  34548. */
  34549. getUniformNames(): string[];
  34550. /**
  34551. * Returns an array of uniform buffer variable names
  34552. * @returns The array of uniform buffer variable names.
  34553. */
  34554. getUniformBuffersNames(): string[];
  34555. /**
  34556. * Returns the index parameters used to create the effect
  34557. * @returns The index parameters object
  34558. */
  34559. getIndexParameters(): any;
  34560. /**
  34561. * The error from the last compilation.
  34562. * @returns the error string.
  34563. */
  34564. getCompilationError(): string;
  34565. /**
  34566. * Gets a boolean indicating that all fallbacks were used during compilation
  34567. * @returns true if all fallbacks were used
  34568. */
  34569. allFallbacksProcessed(): boolean;
  34570. /**
  34571. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  34572. * @param func The callback to be used.
  34573. */
  34574. executeWhenCompiled(func: (effect: Effect) => void): void;
  34575. private _checkIsReady;
  34576. private _loadShader;
  34577. /**
  34578. * Gets the vertex shader source code of this effect
  34579. */
  34580. get vertexSourceCode(): string;
  34581. /**
  34582. * Gets the fragment shader source code of this effect
  34583. */
  34584. get fragmentSourceCode(): string;
  34585. /**
  34586. * Recompiles the webGL program
  34587. * @param vertexSourceCode The source code for the vertex shader.
  34588. * @param fragmentSourceCode The source code for the fragment shader.
  34589. * @param onCompiled Callback called when completed.
  34590. * @param onError Callback called on error.
  34591. * @hidden
  34592. */
  34593. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  34594. /**
  34595. * Prepares the effect
  34596. * @hidden
  34597. */
  34598. _prepareEffect(): void;
  34599. private _getShaderCodeAndErrorLine;
  34600. private _processCompilationErrors;
  34601. /**
  34602. * Checks if the effect is supported. (Must be called after compilation)
  34603. */
  34604. get isSupported(): boolean;
  34605. /**
  34606. * Binds a texture to the engine to be used as output of the shader.
  34607. * @param channel Name of the output variable.
  34608. * @param texture Texture to bind.
  34609. * @hidden
  34610. */
  34611. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  34612. /**
  34613. * Sets a texture on the engine to be used in the shader.
  34614. * @param channel Name of the sampler variable.
  34615. * @param texture Texture to set.
  34616. */
  34617. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  34618. /**
  34619. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  34620. * @param channel Name of the sampler variable.
  34621. * @param texture Texture to set.
  34622. */
  34623. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  34624. /**
  34625. * Sets an array of textures on the engine to be used in the shader.
  34626. * @param channel Name of the variable.
  34627. * @param textures Textures to set.
  34628. */
  34629. setTextureArray(channel: string, textures: BaseTexture[]): void;
  34630. /**
  34631. * 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)
  34632. * @param channel Name of the sampler variable.
  34633. * @param postProcess Post process to get the input texture from.
  34634. */
  34635. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  34636. /**
  34637. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  34638. * 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)
  34639. * @param channel Name of the sampler variable.
  34640. * @param postProcess Post process to get the output texture from.
  34641. */
  34642. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  34643. /** @hidden */
  34644. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  34645. /** @hidden */
  34646. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  34647. /** @hidden */
  34648. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  34649. /** @hidden */
  34650. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  34651. /**
  34652. * Binds a buffer to a uniform.
  34653. * @param buffer Buffer to bind.
  34654. * @param name Name of the uniform variable to bind to.
  34655. */
  34656. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  34657. /**
  34658. * Binds block to a uniform.
  34659. * @param blockName Name of the block to bind.
  34660. * @param index Index to bind.
  34661. */
  34662. bindUniformBlock(blockName: string, index: number): void;
  34663. /**
  34664. * Sets an interger value on a uniform variable.
  34665. * @param uniformName Name of the variable.
  34666. * @param value Value to be set.
  34667. * @returns this effect.
  34668. */
  34669. setInt(uniformName: string, value: number): Effect;
  34670. /**
  34671. * Sets an int array on a uniform variable.
  34672. * @param uniformName Name of the variable.
  34673. * @param array array to be set.
  34674. * @returns this effect.
  34675. */
  34676. setIntArray(uniformName: string, array: Int32Array): Effect;
  34677. /**
  34678. * 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)
  34679. * @param uniformName Name of the variable.
  34680. * @param array array to be set.
  34681. * @returns this effect.
  34682. */
  34683. setIntArray2(uniformName: string, array: Int32Array): Effect;
  34684. /**
  34685. * 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)
  34686. * @param uniformName Name of the variable.
  34687. * @param array array to be set.
  34688. * @returns this effect.
  34689. */
  34690. setIntArray3(uniformName: string, array: Int32Array): Effect;
  34691. /**
  34692. * 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)
  34693. * @param uniformName Name of the variable.
  34694. * @param array array to be set.
  34695. * @returns this effect.
  34696. */
  34697. setIntArray4(uniformName: string, array: Int32Array): Effect;
  34698. /**
  34699. * Sets an float array on a uniform variable.
  34700. * @param uniformName Name of the variable.
  34701. * @param array array to be set.
  34702. * @returns this effect.
  34703. */
  34704. setFloatArray(uniformName: string, array: Float32Array): Effect;
  34705. /**
  34706. * 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)
  34707. * @param uniformName Name of the variable.
  34708. * @param array array to be set.
  34709. * @returns this effect.
  34710. */
  34711. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  34712. /**
  34713. * 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)
  34714. * @param uniformName Name of the variable.
  34715. * @param array array to be set.
  34716. * @returns this effect.
  34717. */
  34718. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  34719. /**
  34720. * 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)
  34721. * @param uniformName Name of the variable.
  34722. * @param array array to be set.
  34723. * @returns this effect.
  34724. */
  34725. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  34726. /**
  34727. * Sets an array on a uniform variable.
  34728. * @param uniformName Name of the variable.
  34729. * @param array array to be set.
  34730. * @returns this effect.
  34731. */
  34732. setArray(uniformName: string, array: number[]): Effect;
  34733. /**
  34734. * 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)
  34735. * @param uniformName Name of the variable.
  34736. * @param array array to be set.
  34737. * @returns this effect.
  34738. */
  34739. setArray2(uniformName: string, array: number[]): Effect;
  34740. /**
  34741. * 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)
  34742. * @param uniformName Name of the variable.
  34743. * @param array array to be set.
  34744. * @returns this effect.
  34745. */
  34746. setArray3(uniformName: string, array: number[]): Effect;
  34747. /**
  34748. * 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)
  34749. * @param uniformName Name of the variable.
  34750. * @param array array to be set.
  34751. * @returns this effect.
  34752. */
  34753. setArray4(uniformName: string, array: number[]): Effect;
  34754. /**
  34755. * Sets matrices on a uniform variable.
  34756. * @param uniformName Name of the variable.
  34757. * @param matrices matrices to be set.
  34758. * @returns this effect.
  34759. */
  34760. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  34761. /**
  34762. * Sets matrix on a uniform variable.
  34763. * @param uniformName Name of the variable.
  34764. * @param matrix matrix to be set.
  34765. * @returns this effect.
  34766. */
  34767. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  34768. /**
  34769. * 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)
  34770. * @param uniformName Name of the variable.
  34771. * @param matrix matrix to be set.
  34772. * @returns this effect.
  34773. */
  34774. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  34775. /**
  34776. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  34777. * @param uniformName Name of the variable.
  34778. * @param matrix matrix to be set.
  34779. * @returns this effect.
  34780. */
  34781. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  34782. /**
  34783. * Sets a float on a uniform variable.
  34784. * @param uniformName Name of the variable.
  34785. * @param value value to be set.
  34786. * @returns this effect.
  34787. */
  34788. setFloat(uniformName: string, value: number): Effect;
  34789. /**
  34790. * Sets a boolean on a uniform variable.
  34791. * @param uniformName Name of the variable.
  34792. * @param bool value to be set.
  34793. * @returns this effect.
  34794. */
  34795. setBool(uniformName: string, bool: boolean): Effect;
  34796. /**
  34797. * Sets a Vector2 on a uniform variable.
  34798. * @param uniformName Name of the variable.
  34799. * @param vector2 vector2 to be set.
  34800. * @returns this effect.
  34801. */
  34802. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  34803. /**
  34804. * Sets a float2 on a uniform variable.
  34805. * @param uniformName Name of the variable.
  34806. * @param x First float in float2.
  34807. * @param y Second float in float2.
  34808. * @returns this effect.
  34809. */
  34810. setFloat2(uniformName: string, x: number, y: number): Effect;
  34811. /**
  34812. * Sets a Vector3 on a uniform variable.
  34813. * @param uniformName Name of the variable.
  34814. * @param vector3 Value to be set.
  34815. * @returns this effect.
  34816. */
  34817. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  34818. /**
  34819. * Sets a float3 on a uniform variable.
  34820. * @param uniformName Name of the variable.
  34821. * @param x First float in float3.
  34822. * @param y Second float in float3.
  34823. * @param z Third float in float3.
  34824. * @returns this effect.
  34825. */
  34826. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  34827. /**
  34828. * Sets a Vector4 on a uniform variable.
  34829. * @param uniformName Name of the variable.
  34830. * @param vector4 Value to be set.
  34831. * @returns this effect.
  34832. */
  34833. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  34834. /**
  34835. * Sets a float4 on a uniform variable.
  34836. * @param uniformName Name of the variable.
  34837. * @param x First float in float4.
  34838. * @param y Second float in float4.
  34839. * @param z Third float in float4.
  34840. * @param w Fourth float in float4.
  34841. * @returns this effect.
  34842. */
  34843. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  34844. /**
  34845. * Sets a Color3 on a uniform variable.
  34846. * @param uniformName Name of the variable.
  34847. * @param color3 Value to be set.
  34848. * @returns this effect.
  34849. */
  34850. setColor3(uniformName: string, color3: IColor3Like): Effect;
  34851. /**
  34852. * Sets a Color4 on a uniform variable.
  34853. * @param uniformName Name of the variable.
  34854. * @param color3 Value to be set.
  34855. * @param alpha Alpha value to be set.
  34856. * @returns this effect.
  34857. */
  34858. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  34859. /**
  34860. * Sets a Color4 on a uniform variable
  34861. * @param uniformName defines the name of the variable
  34862. * @param color4 defines the value to be set
  34863. * @returns this effect.
  34864. */
  34865. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  34866. /** Release all associated resources */
  34867. dispose(): void;
  34868. /**
  34869. * This function will add a new shader to the shader store
  34870. * @param name the name of the shader
  34871. * @param pixelShader optional pixel shader content
  34872. * @param vertexShader optional vertex shader content
  34873. */
  34874. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  34875. /**
  34876. * Store of each shader (The can be looked up using effect.key)
  34877. */
  34878. static ShadersStore: {
  34879. [key: string]: string;
  34880. };
  34881. /**
  34882. * Store of each included file for a shader (The can be looked up using effect.key)
  34883. */
  34884. static IncludesShadersStore: {
  34885. [key: string]: string;
  34886. };
  34887. /**
  34888. * Resets the cache of effects.
  34889. */
  34890. static ResetCache(): void;
  34891. }
  34892. }
  34893. declare module "babylonjs/Engines/engineCapabilities" {
  34894. /**
  34895. * Interface used to describe the capabilities of the engine relatively to the current browser
  34896. */
  34897. export interface EngineCapabilities {
  34898. /** Maximum textures units per fragment shader */
  34899. maxTexturesImageUnits: number;
  34900. /** Maximum texture units per vertex shader */
  34901. maxVertexTextureImageUnits: number;
  34902. /** Maximum textures units in the entire pipeline */
  34903. maxCombinedTexturesImageUnits: number;
  34904. /** Maximum texture size */
  34905. maxTextureSize: number;
  34906. /** Maximum texture samples */
  34907. maxSamples?: number;
  34908. /** Maximum cube texture size */
  34909. maxCubemapTextureSize: number;
  34910. /** Maximum render texture size */
  34911. maxRenderTextureSize: number;
  34912. /** Maximum number of vertex attributes */
  34913. maxVertexAttribs: number;
  34914. /** Maximum number of varyings */
  34915. maxVaryingVectors: number;
  34916. /** Maximum number of uniforms per vertex shader */
  34917. maxVertexUniformVectors: number;
  34918. /** Maximum number of uniforms per fragment shader */
  34919. maxFragmentUniformVectors: number;
  34920. /** Defines if standard derivates (dx/dy) are supported */
  34921. standardDerivatives: boolean;
  34922. /** Defines if s3tc texture compression is supported */
  34923. s3tc?: WEBGL_compressed_texture_s3tc;
  34924. /** Defines if pvrtc texture compression is supported */
  34925. pvrtc: any;
  34926. /** Defines if etc1 texture compression is supported */
  34927. etc1: any;
  34928. /** Defines if etc2 texture compression is supported */
  34929. etc2: any;
  34930. /** Defines if astc texture compression is supported */
  34931. astc: any;
  34932. /** Defines if float textures are supported */
  34933. textureFloat: boolean;
  34934. /** Defines if vertex array objects are supported */
  34935. vertexArrayObject: boolean;
  34936. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  34937. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  34938. /** Gets the maximum level of anisotropy supported */
  34939. maxAnisotropy: number;
  34940. /** Defines if instancing is supported */
  34941. instancedArrays: boolean;
  34942. /** Defines if 32 bits indices are supported */
  34943. uintIndices: boolean;
  34944. /** Defines if high precision shaders are supported */
  34945. highPrecisionShaderSupported: boolean;
  34946. /** Defines if depth reading in the fragment shader is supported */
  34947. fragmentDepthSupported: boolean;
  34948. /** Defines if float texture linear filtering is supported*/
  34949. textureFloatLinearFiltering: boolean;
  34950. /** Defines if rendering to float textures is supported */
  34951. textureFloatRender: boolean;
  34952. /** Defines if half float textures are supported*/
  34953. textureHalfFloat: boolean;
  34954. /** Defines if half float texture linear filtering is supported*/
  34955. textureHalfFloatLinearFiltering: boolean;
  34956. /** Defines if rendering to half float textures is supported */
  34957. textureHalfFloatRender: boolean;
  34958. /** Defines if textureLOD shader command is supported */
  34959. textureLOD: boolean;
  34960. /** Defines if draw buffers extension is supported */
  34961. drawBuffersExtension: boolean;
  34962. /** Defines if depth textures are supported */
  34963. depthTextureExtension: boolean;
  34964. /** Defines if float color buffer are supported */
  34965. colorBufferFloat: boolean;
  34966. /** Gets disjoint timer query extension (null if not supported) */
  34967. timerQuery?: EXT_disjoint_timer_query;
  34968. /** Defines if timestamp can be used with timer query */
  34969. canUseTimestampForTimerQuery: boolean;
  34970. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  34971. multiview?: any;
  34972. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  34973. oculusMultiview?: any;
  34974. /** Function used to let the system compiles shaders in background */
  34975. parallelShaderCompile?: {
  34976. COMPLETION_STATUS_KHR: number;
  34977. };
  34978. /** Max number of texture samples for MSAA */
  34979. maxMSAASamples: number;
  34980. /** Defines if the blend min max extension is supported */
  34981. blendMinMax: boolean;
  34982. }
  34983. }
  34984. declare module "babylonjs/States/depthCullingState" {
  34985. import { Nullable } from "babylonjs/types";
  34986. /**
  34987. * @hidden
  34988. **/
  34989. export class DepthCullingState {
  34990. private _isDepthTestDirty;
  34991. private _isDepthMaskDirty;
  34992. private _isDepthFuncDirty;
  34993. private _isCullFaceDirty;
  34994. private _isCullDirty;
  34995. private _isZOffsetDirty;
  34996. private _isFrontFaceDirty;
  34997. private _depthTest;
  34998. private _depthMask;
  34999. private _depthFunc;
  35000. private _cull;
  35001. private _cullFace;
  35002. private _zOffset;
  35003. private _frontFace;
  35004. /**
  35005. * Initializes the state.
  35006. */
  35007. constructor();
  35008. get isDirty(): boolean;
  35009. get zOffset(): number;
  35010. set zOffset(value: number);
  35011. get cullFace(): Nullable<number>;
  35012. set cullFace(value: Nullable<number>);
  35013. get cull(): Nullable<boolean>;
  35014. set cull(value: Nullable<boolean>);
  35015. get depthFunc(): Nullable<number>;
  35016. set depthFunc(value: Nullable<number>);
  35017. get depthMask(): boolean;
  35018. set depthMask(value: boolean);
  35019. get depthTest(): boolean;
  35020. set depthTest(value: boolean);
  35021. get frontFace(): Nullable<number>;
  35022. set frontFace(value: Nullable<number>);
  35023. reset(): void;
  35024. apply(gl: WebGLRenderingContext): void;
  35025. }
  35026. }
  35027. declare module "babylonjs/States/stencilState" {
  35028. /**
  35029. * @hidden
  35030. **/
  35031. export class StencilState {
  35032. /** 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 */
  35033. static readonly ALWAYS: number;
  35034. /** Passed to stencilOperation to specify that stencil value must be kept */
  35035. static readonly KEEP: number;
  35036. /** Passed to stencilOperation to specify that stencil value must be replaced */
  35037. static readonly REPLACE: number;
  35038. private _isStencilTestDirty;
  35039. private _isStencilMaskDirty;
  35040. private _isStencilFuncDirty;
  35041. private _isStencilOpDirty;
  35042. private _stencilTest;
  35043. private _stencilMask;
  35044. private _stencilFunc;
  35045. private _stencilFuncRef;
  35046. private _stencilFuncMask;
  35047. private _stencilOpStencilFail;
  35048. private _stencilOpDepthFail;
  35049. private _stencilOpStencilDepthPass;
  35050. get isDirty(): boolean;
  35051. get stencilFunc(): number;
  35052. set stencilFunc(value: number);
  35053. get stencilFuncRef(): number;
  35054. set stencilFuncRef(value: number);
  35055. get stencilFuncMask(): number;
  35056. set stencilFuncMask(value: number);
  35057. get stencilOpStencilFail(): number;
  35058. set stencilOpStencilFail(value: number);
  35059. get stencilOpDepthFail(): number;
  35060. set stencilOpDepthFail(value: number);
  35061. get stencilOpStencilDepthPass(): number;
  35062. set stencilOpStencilDepthPass(value: number);
  35063. get stencilMask(): number;
  35064. set stencilMask(value: number);
  35065. get stencilTest(): boolean;
  35066. set stencilTest(value: boolean);
  35067. constructor();
  35068. reset(): void;
  35069. apply(gl: WebGLRenderingContext): void;
  35070. }
  35071. }
  35072. declare module "babylonjs/States/alphaCullingState" {
  35073. /**
  35074. * @hidden
  35075. **/
  35076. export class AlphaState {
  35077. private _isAlphaBlendDirty;
  35078. private _isBlendFunctionParametersDirty;
  35079. private _isBlendEquationParametersDirty;
  35080. private _isBlendConstantsDirty;
  35081. private _alphaBlend;
  35082. private _blendFunctionParameters;
  35083. private _blendEquationParameters;
  35084. private _blendConstants;
  35085. /**
  35086. * Initializes the state.
  35087. */
  35088. constructor();
  35089. get isDirty(): boolean;
  35090. get alphaBlend(): boolean;
  35091. set alphaBlend(value: boolean);
  35092. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  35093. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  35094. setAlphaEquationParameters(rgb: number, alpha: number): void;
  35095. reset(): void;
  35096. apply(gl: WebGLRenderingContext): void;
  35097. }
  35098. }
  35099. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  35100. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  35101. /** @hidden */
  35102. export class WebGL2ShaderProcessor implements IShaderProcessor {
  35103. attributeProcessor(attribute: string): string;
  35104. varyingProcessor(varying: string, isFragment: boolean): string;
  35105. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  35106. }
  35107. }
  35108. declare module "babylonjs/Engines/instancingAttributeInfo" {
  35109. /**
  35110. * Interface for attribute information associated with buffer instanciation
  35111. */
  35112. export interface InstancingAttributeInfo {
  35113. /**
  35114. * Name of the GLSL attribute
  35115. * if attribute index is not specified, this is used to retrieve the index from the effect
  35116. */
  35117. attributeName: string;
  35118. /**
  35119. * Index/offset of the attribute in the vertex shader
  35120. * if not specified, this will be computes from the name.
  35121. */
  35122. index?: number;
  35123. /**
  35124. * size of the attribute, 1, 2, 3 or 4
  35125. */
  35126. attributeSize: number;
  35127. /**
  35128. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  35129. */
  35130. offset: number;
  35131. /**
  35132. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  35133. * default to 1
  35134. */
  35135. divisor?: number;
  35136. /**
  35137. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  35138. * default is FLOAT
  35139. */
  35140. attributeType?: number;
  35141. /**
  35142. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  35143. */
  35144. normalized?: boolean;
  35145. }
  35146. }
  35147. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  35148. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35149. import { Nullable } from "babylonjs/types";
  35150. module "babylonjs/Engines/thinEngine" {
  35151. interface ThinEngine {
  35152. /**
  35153. * Update a video texture
  35154. * @param texture defines the texture to update
  35155. * @param video defines the video element to use
  35156. * @param invertY defines if data must be stored with Y axis inverted
  35157. */
  35158. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  35159. }
  35160. }
  35161. }
  35162. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  35163. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35164. import { Nullable } from "babylonjs/types";
  35165. module "babylonjs/Engines/thinEngine" {
  35166. interface ThinEngine {
  35167. /**
  35168. * Creates a dynamic texture
  35169. * @param width defines the width of the texture
  35170. * @param height defines the height of the texture
  35171. * @param generateMipMaps defines if the engine should generate the mip levels
  35172. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  35173. * @returns the dynamic texture inside an InternalTexture
  35174. */
  35175. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  35176. /**
  35177. * Update the content of a dynamic texture
  35178. * @param texture defines the texture to update
  35179. * @param canvas defines the canvas containing the source
  35180. * @param invertY defines if data must be stored with Y axis inverted
  35181. * @param premulAlpha defines if alpha is stored as premultiplied
  35182. * @param format defines the format of the data
  35183. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  35184. */
  35185. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  35186. }
  35187. }
  35188. }
  35189. declare module "babylonjs/Materials/Textures/videoTexture" {
  35190. import { Observable } from "babylonjs/Misc/observable";
  35191. import { Nullable } from "babylonjs/types";
  35192. import { Scene } from "babylonjs/scene";
  35193. import { Texture } from "babylonjs/Materials/Textures/texture";
  35194. import "babylonjs/Engines/Extensions/engine.videoTexture";
  35195. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  35196. /**
  35197. * Settings for finer control over video usage
  35198. */
  35199. export interface VideoTextureSettings {
  35200. /**
  35201. * Applies `autoplay` to video, if specified
  35202. */
  35203. autoPlay?: boolean;
  35204. /**
  35205. * Applies `loop` to video, if specified
  35206. */
  35207. loop?: boolean;
  35208. /**
  35209. * Automatically updates internal texture from video at every frame in the render loop
  35210. */
  35211. autoUpdateTexture: boolean;
  35212. /**
  35213. * Image src displayed during the video loading or until the user interacts with the video.
  35214. */
  35215. poster?: string;
  35216. }
  35217. /**
  35218. * If you want to display a video in your scene, this is the special texture for that.
  35219. * This special texture works similar to other textures, with the exception of a few parameters.
  35220. * @see https://doc.babylonjs.com/how_to/video_texture
  35221. */
  35222. export class VideoTexture extends Texture {
  35223. /**
  35224. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  35225. */
  35226. readonly autoUpdateTexture: boolean;
  35227. /**
  35228. * The video instance used by the texture internally
  35229. */
  35230. readonly video: HTMLVideoElement;
  35231. private _onUserActionRequestedObservable;
  35232. /**
  35233. * Event triggerd when a dom action is required by the user to play the video.
  35234. * This happens due to recent changes in browser policies preventing video to auto start.
  35235. */
  35236. get onUserActionRequestedObservable(): Observable<Texture>;
  35237. private _generateMipMaps;
  35238. private _stillImageCaptured;
  35239. private _displayingPosterTexture;
  35240. private _settings;
  35241. private _createInternalTextureOnEvent;
  35242. private _frameId;
  35243. private _currentSrc;
  35244. /**
  35245. * Creates a video texture.
  35246. * If you want to display a video in your scene, this is the special texture for that.
  35247. * This special texture works similar to other textures, with the exception of a few parameters.
  35248. * @see https://doc.babylonjs.com/how_to/video_texture
  35249. * @param name optional name, will detect from video source, if not defined
  35250. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  35251. * @param scene is obviously the current scene.
  35252. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  35253. * @param invertY is false by default but can be used to invert video on Y axis
  35254. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  35255. * @param settings allows finer control over video usage
  35256. */
  35257. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  35258. private _getName;
  35259. private _getVideo;
  35260. private _createInternalTexture;
  35261. private reset;
  35262. /**
  35263. * @hidden Internal method to initiate `update`.
  35264. */
  35265. _rebuild(): void;
  35266. /**
  35267. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  35268. */
  35269. update(): void;
  35270. /**
  35271. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  35272. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  35273. */
  35274. updateTexture(isVisible: boolean): void;
  35275. protected _updateInternalTexture: () => void;
  35276. /**
  35277. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  35278. * @param url New url.
  35279. */
  35280. updateURL(url: string): void;
  35281. /**
  35282. * Clones the texture.
  35283. * @returns the cloned texture
  35284. */
  35285. clone(): VideoTexture;
  35286. /**
  35287. * Dispose the texture and release its associated resources.
  35288. */
  35289. dispose(): void;
  35290. /**
  35291. * Creates a video texture straight from a stream.
  35292. * @param scene Define the scene the texture should be created in
  35293. * @param stream Define the stream the texture should be created from
  35294. * @returns The created video texture as a promise
  35295. */
  35296. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  35297. /**
  35298. * Creates a video texture straight from your WebCam video feed.
  35299. * @param scene Define the scene the texture should be created in
  35300. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  35301. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  35302. * @returns The created video texture as a promise
  35303. */
  35304. static CreateFromWebCamAsync(scene: Scene, constraints: {
  35305. minWidth: number;
  35306. maxWidth: number;
  35307. minHeight: number;
  35308. maxHeight: number;
  35309. deviceId: string;
  35310. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  35311. /**
  35312. * Creates a video texture straight from your WebCam video feed.
  35313. * @param scene Define the scene the texture should be created in
  35314. * @param onReady Define a callback to triggered once the texture will be ready
  35315. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  35316. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  35317. */
  35318. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  35319. minWidth: number;
  35320. maxWidth: number;
  35321. minHeight: number;
  35322. maxHeight: number;
  35323. deviceId: string;
  35324. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  35325. }
  35326. }
  35327. declare module "babylonjs/Engines/thinEngine" {
  35328. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  35329. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  35330. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  35331. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  35332. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  35333. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  35334. import { Observable } from "babylonjs/Misc/observable";
  35335. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  35336. import { StencilState } from "babylonjs/States/stencilState";
  35337. import { AlphaState } from "babylonjs/States/alphaCullingState";
  35338. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35339. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  35340. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35341. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  35342. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35343. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  35344. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  35345. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  35346. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35347. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  35348. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35349. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  35350. import { WebRequest } from "babylonjs/Misc/webRequest";
  35351. import { LoadFileError } from "babylonjs/Misc/fileTools";
  35352. /**
  35353. * Defines the interface used by objects working like Scene
  35354. * @hidden
  35355. */
  35356. export interface ISceneLike {
  35357. _addPendingData(data: any): void;
  35358. _removePendingData(data: any): void;
  35359. offlineProvider: IOfflineProvider;
  35360. }
  35361. /** Interface defining initialization parameters for Engine class */
  35362. export interface EngineOptions extends WebGLContextAttributes {
  35363. /**
  35364. * Defines if the engine should no exceed a specified device ratio
  35365. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  35366. */
  35367. limitDeviceRatio?: number;
  35368. /**
  35369. * Defines if webvr should be enabled automatically
  35370. * @see http://doc.babylonjs.com/how_to/webvr_camera
  35371. */
  35372. autoEnableWebVR?: boolean;
  35373. /**
  35374. * Defines if webgl2 should be turned off even if supported
  35375. * @see http://doc.babylonjs.com/features/webgl2
  35376. */
  35377. disableWebGL2Support?: boolean;
  35378. /**
  35379. * Defines if webaudio should be initialized as well
  35380. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  35381. */
  35382. audioEngine?: boolean;
  35383. /**
  35384. * Defines if animations should run using a deterministic lock step
  35385. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  35386. */
  35387. deterministicLockstep?: boolean;
  35388. /** Defines the maximum steps to use with deterministic lock step mode */
  35389. lockstepMaxSteps?: number;
  35390. /** Defines the seconds between each deterministic lock step */
  35391. timeStep?: number;
  35392. /**
  35393. * Defines that engine should ignore context lost events
  35394. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  35395. */
  35396. doNotHandleContextLost?: boolean;
  35397. /**
  35398. * Defines that engine should ignore modifying touch action attribute and style
  35399. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  35400. */
  35401. doNotHandleTouchAction?: boolean;
  35402. /**
  35403. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  35404. */
  35405. useHighPrecisionFloats?: boolean;
  35406. /**
  35407. * Make the canvas XR Compatible for XR sessions
  35408. */
  35409. xrCompatible?: boolean;
  35410. }
  35411. /**
  35412. * The base engine class (root of all engines)
  35413. */
  35414. export class ThinEngine {
  35415. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  35416. static ExceptionList: ({
  35417. key: string;
  35418. capture: string;
  35419. captureConstraint: number;
  35420. targets: string[];
  35421. } | {
  35422. key: string;
  35423. capture: null;
  35424. captureConstraint: null;
  35425. targets: string[];
  35426. })[];
  35427. /** @hidden */
  35428. static _TextureLoaders: IInternalTextureLoader[];
  35429. /**
  35430. * Returns the current npm package of the sdk
  35431. */
  35432. static get NpmPackage(): string;
  35433. /**
  35434. * Returns the current version of the framework
  35435. */
  35436. static get Version(): string;
  35437. /**
  35438. * Returns a string describing the current engine
  35439. */
  35440. get description(): string;
  35441. /**
  35442. * Gets or sets the epsilon value used by collision engine
  35443. */
  35444. static CollisionsEpsilon: number;
  35445. /**
  35446. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35447. */
  35448. static get ShadersRepository(): string;
  35449. static set ShadersRepository(value: string);
  35450. /** @hidden */
  35451. _shaderProcessor: IShaderProcessor;
  35452. /**
  35453. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  35454. */
  35455. forcePOTTextures: boolean;
  35456. /**
  35457. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  35458. */
  35459. isFullscreen: boolean;
  35460. /**
  35461. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  35462. */
  35463. cullBackFaces: boolean;
  35464. /**
  35465. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  35466. */
  35467. renderEvenInBackground: boolean;
  35468. /**
  35469. * Gets or sets a boolean indicating that cache can be kept between frames
  35470. */
  35471. preventCacheWipeBetweenFrames: boolean;
  35472. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  35473. validateShaderPrograms: boolean;
  35474. /**
  35475. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  35476. * This can provide greater z depth for distant objects.
  35477. */
  35478. useReverseDepthBuffer: boolean;
  35479. /**
  35480. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  35481. */
  35482. disableUniformBuffers: boolean;
  35483. /** @hidden */
  35484. _uniformBuffers: UniformBuffer[];
  35485. /**
  35486. * Gets a boolean indicating that the engine supports uniform buffers
  35487. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  35488. */
  35489. get supportsUniformBuffers(): boolean;
  35490. /** @hidden */
  35491. _gl: WebGLRenderingContext;
  35492. /** @hidden */
  35493. _webGLVersion: number;
  35494. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  35495. protected _windowIsBackground: boolean;
  35496. protected _creationOptions: EngineOptions;
  35497. protected _highPrecisionShadersAllowed: boolean;
  35498. /** @hidden */
  35499. get _shouldUseHighPrecisionShader(): boolean;
  35500. /**
  35501. * Gets a boolean indicating that only power of 2 textures are supported
  35502. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  35503. */
  35504. get needPOTTextures(): boolean;
  35505. /** @hidden */
  35506. _badOS: boolean;
  35507. /** @hidden */
  35508. _badDesktopOS: boolean;
  35509. private _hardwareScalingLevel;
  35510. /** @hidden */
  35511. _caps: EngineCapabilities;
  35512. private _isStencilEnable;
  35513. private _glVersion;
  35514. private _glRenderer;
  35515. private _glVendor;
  35516. /** @hidden */
  35517. _videoTextureSupported: boolean;
  35518. protected _renderingQueueLaunched: boolean;
  35519. protected _activeRenderLoops: (() => void)[];
  35520. /**
  35521. * Observable signaled when a context lost event is raised
  35522. */
  35523. onContextLostObservable: Observable<ThinEngine>;
  35524. /**
  35525. * Observable signaled when a context restored event is raised
  35526. */
  35527. onContextRestoredObservable: Observable<ThinEngine>;
  35528. private _onContextLost;
  35529. private _onContextRestored;
  35530. protected _contextWasLost: boolean;
  35531. /** @hidden */
  35532. _doNotHandleContextLost: boolean;
  35533. /**
  35534. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  35535. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  35536. */
  35537. get doNotHandleContextLost(): boolean;
  35538. set doNotHandleContextLost(value: boolean);
  35539. /**
  35540. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  35541. */
  35542. disableVertexArrayObjects: boolean;
  35543. /** @hidden */
  35544. protected _colorWrite: boolean;
  35545. /** @hidden */
  35546. protected _colorWriteChanged: boolean;
  35547. /** @hidden */
  35548. protected _depthCullingState: DepthCullingState;
  35549. /** @hidden */
  35550. protected _stencilState: StencilState;
  35551. /** @hidden */
  35552. _alphaState: AlphaState;
  35553. /** @hidden */
  35554. _alphaMode: number;
  35555. /** @hidden */
  35556. _alphaEquation: number;
  35557. /** @hidden */
  35558. _internalTexturesCache: InternalTexture[];
  35559. /** @hidden */
  35560. protected _activeChannel: number;
  35561. private _currentTextureChannel;
  35562. /** @hidden */
  35563. protected _boundTexturesCache: {
  35564. [key: string]: Nullable<InternalTexture>;
  35565. };
  35566. /** @hidden */
  35567. protected _currentEffect: Nullable<Effect>;
  35568. /** @hidden */
  35569. protected _currentProgram: Nullable<WebGLProgram>;
  35570. private _compiledEffects;
  35571. private _vertexAttribArraysEnabled;
  35572. /** @hidden */
  35573. protected _cachedViewport: Nullable<IViewportLike>;
  35574. private _cachedVertexArrayObject;
  35575. /** @hidden */
  35576. protected _cachedVertexBuffers: any;
  35577. /** @hidden */
  35578. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  35579. /** @hidden */
  35580. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  35581. /** @hidden */
  35582. _currentRenderTarget: Nullable<InternalTexture>;
  35583. private _uintIndicesCurrentlySet;
  35584. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  35585. /** @hidden */
  35586. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  35587. /** @hidden */
  35588. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  35589. private _currentBufferPointers;
  35590. private _currentInstanceLocations;
  35591. private _currentInstanceBuffers;
  35592. private _textureUnits;
  35593. /** @hidden */
  35594. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  35595. /** @hidden */
  35596. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  35597. /** @hidden */
  35598. _boundRenderFunction: any;
  35599. private _vaoRecordInProgress;
  35600. private _mustWipeVertexAttributes;
  35601. private _emptyTexture;
  35602. private _emptyCubeTexture;
  35603. private _emptyTexture3D;
  35604. private _emptyTexture2DArray;
  35605. /** @hidden */
  35606. _frameHandler: number;
  35607. private _nextFreeTextureSlots;
  35608. private _maxSimultaneousTextures;
  35609. private _activeRequests;
  35610. /** @hidden */
  35611. _transformTextureUrl: Nullable<(url: string) => string>;
  35612. protected get _supportsHardwareTextureRescaling(): boolean;
  35613. private _framebufferDimensionsObject;
  35614. /**
  35615. * sets the object from which width and height will be taken from when getting render width and height
  35616. * Will fallback to the gl object
  35617. * @param dimensions the framebuffer width and height that will be used.
  35618. */
  35619. set framebufferDimensionsObject(dimensions: Nullable<{
  35620. framebufferWidth: number;
  35621. framebufferHeight: number;
  35622. }>);
  35623. /**
  35624. * Gets the current viewport
  35625. */
  35626. get currentViewport(): Nullable<IViewportLike>;
  35627. /**
  35628. * Gets the default empty texture
  35629. */
  35630. get emptyTexture(): InternalTexture;
  35631. /**
  35632. * Gets the default empty 3D texture
  35633. */
  35634. get emptyTexture3D(): InternalTexture;
  35635. /**
  35636. * Gets the default empty 2D array texture
  35637. */
  35638. get emptyTexture2DArray(): InternalTexture;
  35639. /**
  35640. * Gets the default empty cube texture
  35641. */
  35642. get emptyCubeTexture(): InternalTexture;
  35643. /**
  35644. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  35645. */
  35646. readonly premultipliedAlpha: boolean;
  35647. /**
  35648. * Observable event triggered before each texture is initialized
  35649. */
  35650. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  35651. /**
  35652. * Creates a new engine
  35653. * @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
  35654. * @param antialias defines enable antialiasing (default: false)
  35655. * @param options defines further options to be sent to the getContext() function
  35656. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  35657. */
  35658. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  35659. private _rebuildInternalTextures;
  35660. private _rebuildEffects;
  35661. /**
  35662. * Gets a boolean indicating if all created effects are ready
  35663. * @returns true if all effects are ready
  35664. */
  35665. areAllEffectsReady(): boolean;
  35666. protected _rebuildBuffers(): void;
  35667. protected _initGLContext(): void;
  35668. /**
  35669. * Gets version of the current webGL context
  35670. */
  35671. get webGLVersion(): number;
  35672. /**
  35673. * Gets a string idenfifying the name of the class
  35674. * @returns "Engine" string
  35675. */
  35676. getClassName(): string;
  35677. /**
  35678. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  35679. */
  35680. get isStencilEnable(): boolean;
  35681. /** @hidden */
  35682. _prepareWorkingCanvas(): void;
  35683. /**
  35684. * Reset the texture cache to empty state
  35685. */
  35686. resetTextureCache(): void;
  35687. /**
  35688. * Gets an object containing information about the current webGL context
  35689. * @returns an object containing the vender, the renderer and the version of the current webGL context
  35690. */
  35691. getGlInfo(): {
  35692. vendor: string;
  35693. renderer: string;
  35694. version: string;
  35695. };
  35696. /**
  35697. * Defines the hardware scaling level.
  35698. * By default the hardware scaling level is computed from the window device ratio.
  35699. * 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.
  35700. * @param level defines the level to use
  35701. */
  35702. setHardwareScalingLevel(level: number): void;
  35703. /**
  35704. * Gets the current hardware scaling level.
  35705. * By default the hardware scaling level is computed from the window device ratio.
  35706. * 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.
  35707. * @returns a number indicating the current hardware scaling level
  35708. */
  35709. getHardwareScalingLevel(): number;
  35710. /**
  35711. * Gets the list of loaded textures
  35712. * @returns an array containing all loaded textures
  35713. */
  35714. getLoadedTexturesCache(): InternalTexture[];
  35715. /**
  35716. * Gets the object containing all engine capabilities
  35717. * @returns the EngineCapabilities object
  35718. */
  35719. getCaps(): EngineCapabilities;
  35720. /**
  35721. * stop executing a render loop function and remove it from the execution array
  35722. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  35723. */
  35724. stopRenderLoop(renderFunction?: () => void): void;
  35725. /** @hidden */
  35726. _renderLoop(): void;
  35727. /**
  35728. * Gets the HTML canvas attached with the current webGL context
  35729. * @returns a HTML canvas
  35730. */
  35731. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  35732. /**
  35733. * Gets host window
  35734. * @returns the host window object
  35735. */
  35736. getHostWindow(): Nullable<Window>;
  35737. /**
  35738. * Gets the current render width
  35739. * @param useScreen defines if screen size must be used (or the current render target if any)
  35740. * @returns a number defining the current render width
  35741. */
  35742. getRenderWidth(useScreen?: boolean): number;
  35743. /**
  35744. * Gets the current render height
  35745. * @param useScreen defines if screen size must be used (or the current render target if any)
  35746. * @returns a number defining the current render height
  35747. */
  35748. getRenderHeight(useScreen?: boolean): number;
  35749. /**
  35750. * Can be used to override the current requestAnimationFrame requester.
  35751. * @hidden
  35752. */
  35753. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  35754. /**
  35755. * Register and execute a render loop. The engine can have more than one render function
  35756. * @param renderFunction defines the function to continuously execute
  35757. */
  35758. runRenderLoop(renderFunction: () => void): void;
  35759. /**
  35760. * Clear the current render buffer or the current render target (if any is set up)
  35761. * @param color defines the color to use
  35762. * @param backBuffer defines if the back buffer must be cleared
  35763. * @param depth defines if the depth buffer must be cleared
  35764. * @param stencil defines if the stencil buffer must be cleared
  35765. */
  35766. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  35767. private _viewportCached;
  35768. /** @hidden */
  35769. _viewport(x: number, y: number, width: number, height: number): void;
  35770. /**
  35771. * Set the WebGL's viewport
  35772. * @param viewport defines the viewport element to be used
  35773. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  35774. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  35775. */
  35776. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  35777. /**
  35778. * Begin a new frame
  35779. */
  35780. beginFrame(): void;
  35781. /**
  35782. * Enf the current frame
  35783. */
  35784. endFrame(): void;
  35785. /**
  35786. * Resize the view according to the canvas' size
  35787. */
  35788. resize(): void;
  35789. /**
  35790. * Force a specific size of the canvas
  35791. * @param width defines the new canvas' width
  35792. * @param height defines the new canvas' height
  35793. * @returns true if the size was changed
  35794. */
  35795. setSize(width: number, height: number): boolean;
  35796. /**
  35797. * Binds the frame buffer to the specified texture.
  35798. * @param texture The texture to render to or null for the default canvas
  35799. * @param faceIndex The face of the texture to render to in case of cube texture
  35800. * @param requiredWidth The width of the target to render to
  35801. * @param requiredHeight The height of the target to render to
  35802. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  35803. * @param lodLevel defines the lod level to bind to the frame buffer
  35804. * @param layer defines the 2d array index to bind to frame buffer to
  35805. */
  35806. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  35807. /** @hidden */
  35808. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  35809. /**
  35810. * Unbind the current render target texture from the webGL context
  35811. * @param texture defines the render target texture to unbind
  35812. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  35813. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  35814. */
  35815. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  35816. /**
  35817. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  35818. */
  35819. flushFramebuffer(): void;
  35820. /**
  35821. * Unbind the current render target and bind the default framebuffer
  35822. */
  35823. restoreDefaultFramebuffer(): void;
  35824. /** @hidden */
  35825. protected _resetVertexBufferBinding(): void;
  35826. /**
  35827. * Creates a vertex buffer
  35828. * @param data the data for the vertex buffer
  35829. * @returns the new WebGL static buffer
  35830. */
  35831. createVertexBuffer(data: DataArray): DataBuffer;
  35832. private _createVertexBuffer;
  35833. /**
  35834. * Creates a dynamic vertex buffer
  35835. * @param data the data for the dynamic vertex buffer
  35836. * @returns the new WebGL dynamic buffer
  35837. */
  35838. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  35839. protected _resetIndexBufferBinding(): void;
  35840. /**
  35841. * Creates a new index buffer
  35842. * @param indices defines the content of the index buffer
  35843. * @param updatable defines if the index buffer must be updatable
  35844. * @returns a new webGL buffer
  35845. */
  35846. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  35847. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  35848. /**
  35849. * Bind a webGL buffer to the webGL context
  35850. * @param buffer defines the buffer to bind
  35851. */
  35852. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  35853. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  35854. private bindBuffer;
  35855. /**
  35856. * update the bound buffer with the given data
  35857. * @param data defines the data to update
  35858. */
  35859. updateArrayBuffer(data: Float32Array): void;
  35860. private _vertexAttribPointer;
  35861. /** @hidden */
  35862. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  35863. private _bindVertexBuffersAttributes;
  35864. /**
  35865. * Records a vertex array object
  35866. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  35867. * @param vertexBuffers defines the list of vertex buffers to store
  35868. * @param indexBuffer defines the index buffer to store
  35869. * @param effect defines the effect to store
  35870. * @returns the new vertex array object
  35871. */
  35872. recordVertexArrayObject(vertexBuffers: {
  35873. [key: string]: VertexBuffer;
  35874. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  35875. /**
  35876. * Bind a specific vertex array object
  35877. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  35878. * @param vertexArrayObject defines the vertex array object to bind
  35879. * @param indexBuffer defines the index buffer to bind
  35880. */
  35881. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  35882. /**
  35883. * Bind webGl buffers directly to the webGL context
  35884. * @param vertexBuffer defines the vertex buffer to bind
  35885. * @param indexBuffer defines the index buffer to bind
  35886. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  35887. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  35888. * @param effect defines the effect associated with the vertex buffer
  35889. */
  35890. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  35891. private _unbindVertexArrayObject;
  35892. /**
  35893. * Bind a list of vertex buffers to the webGL context
  35894. * @param vertexBuffers defines the list of vertex buffers to bind
  35895. * @param indexBuffer defines the index buffer to bind
  35896. * @param effect defines the effect associated with the vertex buffers
  35897. */
  35898. bindBuffers(vertexBuffers: {
  35899. [key: string]: Nullable<VertexBuffer>;
  35900. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  35901. /**
  35902. * Unbind all instance attributes
  35903. */
  35904. unbindInstanceAttributes(): void;
  35905. /**
  35906. * Release and free the memory of a vertex array object
  35907. * @param vao defines the vertex array object to delete
  35908. */
  35909. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  35910. /** @hidden */
  35911. _releaseBuffer(buffer: DataBuffer): boolean;
  35912. protected _deleteBuffer(buffer: DataBuffer): void;
  35913. /**
  35914. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  35915. * @param instancesBuffer defines the webGL buffer to update and bind
  35916. * @param data defines the data to store in the buffer
  35917. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  35918. */
  35919. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  35920. /**
  35921. * Bind the content of a webGL buffer used with instantiation
  35922. * @param instancesBuffer defines the webGL buffer to bind
  35923. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  35924. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  35925. */
  35926. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  35927. /**
  35928. * Disable the instance attribute corresponding to the name in parameter
  35929. * @param name defines the name of the attribute to disable
  35930. */
  35931. disableInstanceAttributeByName(name: string): void;
  35932. /**
  35933. * Disable the instance attribute corresponding to the location in parameter
  35934. * @param attributeLocation defines the attribute location of the attribute to disable
  35935. */
  35936. disableInstanceAttribute(attributeLocation: number): void;
  35937. /**
  35938. * Disable the attribute corresponding to the location in parameter
  35939. * @param attributeLocation defines the attribute location of the attribute to disable
  35940. */
  35941. disableAttributeByIndex(attributeLocation: number): void;
  35942. /**
  35943. * Send a draw order
  35944. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  35945. * @param indexStart defines the starting index
  35946. * @param indexCount defines the number of index to draw
  35947. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  35948. */
  35949. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  35950. /**
  35951. * Draw a list of points
  35952. * @param verticesStart defines the index of first vertex to draw
  35953. * @param verticesCount defines the count of vertices to draw
  35954. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  35955. */
  35956. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  35957. /**
  35958. * Draw a list of unindexed primitives
  35959. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  35960. * @param verticesStart defines the index of first vertex to draw
  35961. * @param verticesCount defines the count of vertices to draw
  35962. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  35963. */
  35964. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  35965. /**
  35966. * Draw a list of indexed primitives
  35967. * @param fillMode defines the primitive to use
  35968. * @param indexStart defines the starting index
  35969. * @param indexCount defines the number of index to draw
  35970. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  35971. */
  35972. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  35973. /**
  35974. * Draw a list of unindexed primitives
  35975. * @param fillMode defines the primitive to use
  35976. * @param verticesStart defines the index of first vertex to draw
  35977. * @param verticesCount defines the count of vertices to draw
  35978. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  35979. */
  35980. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  35981. private _drawMode;
  35982. /** @hidden */
  35983. protected _reportDrawCall(): void;
  35984. /** @hidden */
  35985. _releaseEffect(effect: Effect): void;
  35986. /** @hidden */
  35987. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  35988. /**
  35989. * Create a new effect (used to store vertex/fragment shaders)
  35990. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  35991. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  35992. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  35993. * @param samplers defines an array of string used to represent textures
  35994. * @param defines defines the string containing the defines to use to compile the shaders
  35995. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  35996. * @param onCompiled defines a function to call when the effect creation is successful
  35997. * @param onError defines a function to call when the effect creation has failed
  35998. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  35999. * @returns the new Effect
  36000. */
  36001. 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;
  36002. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  36003. private _compileShader;
  36004. private _compileRawShader;
  36005. /** @hidden */
  36006. _getShaderSource(shader: WebGLShader): Nullable<string>;
  36007. /**
  36008. * Directly creates a webGL program
  36009. * @param pipelineContext defines the pipeline context to attach to
  36010. * @param vertexCode defines the vertex shader code to use
  36011. * @param fragmentCode defines the fragment shader code to use
  36012. * @param context defines the webGL context to use (if not set, the current one will be used)
  36013. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  36014. * @returns the new webGL program
  36015. */
  36016. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  36017. /**
  36018. * Creates a webGL program
  36019. * @param pipelineContext defines the pipeline context to attach to
  36020. * @param vertexCode defines the vertex shader code to use
  36021. * @param fragmentCode defines the fragment shader code to use
  36022. * @param defines defines the string containing the defines to use to compile the shaders
  36023. * @param context defines the webGL context to use (if not set, the current one will be used)
  36024. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  36025. * @returns the new webGL program
  36026. */
  36027. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  36028. /**
  36029. * Creates a new pipeline context
  36030. * @returns the new pipeline
  36031. */
  36032. createPipelineContext(): IPipelineContext;
  36033. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  36034. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  36035. /** @hidden */
  36036. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  36037. /** @hidden */
  36038. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  36039. /** @hidden */
  36040. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  36041. /**
  36042. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  36043. * @param pipelineContext defines the pipeline context to use
  36044. * @param uniformsNames defines the list of uniform names
  36045. * @returns an array of webGL uniform locations
  36046. */
  36047. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  36048. /**
  36049. * Gets the lsit of active attributes for a given webGL program
  36050. * @param pipelineContext defines the pipeline context to use
  36051. * @param attributesNames defines the list of attribute names to get
  36052. * @returns an array of indices indicating the offset of each attribute
  36053. */
  36054. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  36055. /**
  36056. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  36057. * @param effect defines the effect to activate
  36058. */
  36059. enableEffect(effect: Nullable<Effect>): void;
  36060. /**
  36061. * Set the value of an uniform to a number (int)
  36062. * @param uniform defines the webGL uniform location where to store the value
  36063. * @param value defines the int number to store
  36064. */
  36065. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  36066. /**
  36067. * Set the value of an uniform to an array of int32
  36068. * @param uniform defines the webGL uniform location where to store the value
  36069. * @param array defines the array of int32 to store
  36070. */
  36071. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36072. /**
  36073. * Set the value of an uniform to an array of int32 (stored as vec2)
  36074. * @param uniform defines the webGL uniform location where to store the value
  36075. * @param array defines the array of int32 to store
  36076. */
  36077. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36078. /**
  36079. * Set the value of an uniform to an array of int32 (stored as vec3)
  36080. * @param uniform defines the webGL uniform location where to store the value
  36081. * @param array defines the array of int32 to store
  36082. */
  36083. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36084. /**
  36085. * Set the value of an uniform to an array of int32 (stored as vec4)
  36086. * @param uniform defines the webGL uniform location where to store the value
  36087. * @param array defines the array of int32 to store
  36088. */
  36089. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36090. /**
  36091. * Set the value of an uniform to an array of number
  36092. * @param uniform defines the webGL uniform location where to store the value
  36093. * @param array defines the array of number to store
  36094. */
  36095. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36096. /**
  36097. * Set the value of an uniform to an array of number (stored as vec2)
  36098. * @param uniform defines the webGL uniform location where to store the value
  36099. * @param array defines the array of number to store
  36100. */
  36101. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36102. /**
  36103. * Set the value of an uniform to an array of number (stored as vec3)
  36104. * @param uniform defines the webGL uniform location where to store the value
  36105. * @param array defines the array of number to store
  36106. */
  36107. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36108. /**
  36109. * Set the value of an uniform to an array of number (stored as vec4)
  36110. * @param uniform defines the webGL uniform location where to store the value
  36111. * @param array defines the array of number to store
  36112. */
  36113. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36114. /**
  36115. * Set the value of an uniform to an array of float32 (stored as matrices)
  36116. * @param uniform defines the webGL uniform location where to store the value
  36117. * @param matrices defines the array of float32 to store
  36118. */
  36119. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  36120. /**
  36121. * Set the value of an uniform to a matrix (3x3)
  36122. * @param uniform defines the webGL uniform location where to store the value
  36123. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  36124. */
  36125. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  36126. /**
  36127. * Set the value of an uniform to a matrix (2x2)
  36128. * @param uniform defines the webGL uniform location where to store the value
  36129. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  36130. */
  36131. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  36132. /**
  36133. * Set the value of an uniform to a number (float)
  36134. * @param uniform defines the webGL uniform location where to store the value
  36135. * @param value defines the float number to store
  36136. */
  36137. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  36138. /**
  36139. * Set the value of an uniform to a vec2
  36140. * @param uniform defines the webGL uniform location where to store the value
  36141. * @param x defines the 1st component of the value
  36142. * @param y defines the 2nd component of the value
  36143. */
  36144. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  36145. /**
  36146. * Set the value of an uniform to a vec3
  36147. * @param uniform defines the webGL uniform location where to store the value
  36148. * @param x defines the 1st component of the value
  36149. * @param y defines the 2nd component of the value
  36150. * @param z defines the 3rd component of the value
  36151. */
  36152. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  36153. /**
  36154. * Set the value of an uniform to a vec4
  36155. * @param uniform defines the webGL uniform location where to store the value
  36156. * @param x defines the 1st component of the value
  36157. * @param y defines the 2nd component of the value
  36158. * @param z defines the 3rd component of the value
  36159. * @param w defines the 4th component of the value
  36160. */
  36161. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  36162. /**
  36163. * Apply all cached states (depth, culling, stencil and alpha)
  36164. */
  36165. applyStates(): void;
  36166. /**
  36167. * Enable or disable color writing
  36168. * @param enable defines the state to set
  36169. */
  36170. setColorWrite(enable: boolean): void;
  36171. /**
  36172. * Gets a boolean indicating if color writing is enabled
  36173. * @returns the current color writing state
  36174. */
  36175. getColorWrite(): boolean;
  36176. /**
  36177. * Gets the depth culling state manager
  36178. */
  36179. get depthCullingState(): DepthCullingState;
  36180. /**
  36181. * Gets the alpha state manager
  36182. */
  36183. get alphaState(): AlphaState;
  36184. /**
  36185. * Gets the stencil state manager
  36186. */
  36187. get stencilState(): StencilState;
  36188. /**
  36189. * Clears the list of texture accessible through engine.
  36190. * This can help preventing texture load conflict due to name collision.
  36191. */
  36192. clearInternalTexturesCache(): void;
  36193. /**
  36194. * Force the entire cache to be cleared
  36195. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  36196. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  36197. */
  36198. wipeCaches(bruteForce?: boolean): void;
  36199. /** @hidden */
  36200. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  36201. min: number;
  36202. mag: number;
  36203. };
  36204. /** @hidden */
  36205. _createTexture(): WebGLTexture;
  36206. /**
  36207. * Usually called from Texture.ts.
  36208. * Passed information to create a WebGLTexture
  36209. * @param url defines a value which contains one of the following:
  36210. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  36211. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  36212. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  36213. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  36214. * @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)
  36215. * @param scene needed for loading to the correct scene
  36216. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  36217. * @param onLoad optional callback to be called upon successful completion
  36218. * @param onError optional callback to be called upon failure
  36219. * @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
  36220. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  36221. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  36222. * @param forcedExtension defines the extension to use to pick the right loader
  36223. * @param mimeType defines an optional mime type
  36224. * @returns a InternalTexture for assignment back into BABYLON.Texture
  36225. */
  36226. createTexture(url: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string): InternalTexture;
  36227. /**
  36228. * Loads an image as an HTMLImageElement.
  36229. * @param input url string, ArrayBuffer, or Blob to load
  36230. * @param onLoad callback called when the image successfully loads
  36231. * @param onError callback called when the image fails to load
  36232. * @param offlineProvider offline provider for caching
  36233. * @param mimeType optional mime type
  36234. * @returns the HTMLImageElement of the loaded image
  36235. * @hidden
  36236. */
  36237. static _FileToolsLoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  36238. /**
  36239. * @hidden
  36240. */
  36241. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  36242. private _unpackFlipYCached;
  36243. /**
  36244. * In case you are sharing the context with other applications, it might
  36245. * be interested to not cache the unpack flip y state to ensure a consistent
  36246. * value would be set.
  36247. */
  36248. enableUnpackFlipYCached: boolean;
  36249. /** @hidden */
  36250. _unpackFlipY(value: boolean): void;
  36251. /** @hidden */
  36252. _getUnpackAlignement(): number;
  36253. private _getTextureTarget;
  36254. /**
  36255. * Update the sampling mode of a given texture
  36256. * @param samplingMode defines the required sampling mode
  36257. * @param texture defines the texture to update
  36258. * @param generateMipMaps defines whether to generate mipmaps for the texture
  36259. */
  36260. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  36261. /**
  36262. * Update the sampling mode of a given texture
  36263. * @param texture defines the texture to update
  36264. * @param wrapU defines the texture wrap mode of the u coordinates
  36265. * @param wrapV defines the texture wrap mode of the v coordinates
  36266. * @param wrapR defines the texture wrap mode of the r coordinates
  36267. */
  36268. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  36269. /** @hidden */
  36270. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  36271. width: number;
  36272. height: number;
  36273. layers?: number;
  36274. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  36275. /** @hidden */
  36276. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  36277. /** @hidden */
  36278. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  36279. /**
  36280. * Update a portion of an internal texture
  36281. * @param texture defines the texture to update
  36282. * @param imageData defines the data to store into the texture
  36283. * @param xOffset defines the x coordinates of the update rectangle
  36284. * @param yOffset defines the y coordinates of the update rectangle
  36285. * @param width defines the width of the update rectangle
  36286. * @param height defines the height of the update rectangle
  36287. * @param faceIndex defines the face index if texture is a cube (0 by default)
  36288. * @param lod defines the lod level to update (0 by default)
  36289. */
  36290. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  36291. /** @hidden */
  36292. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  36293. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  36294. private _prepareWebGLTexture;
  36295. /** @hidden */
  36296. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  36297. private _getDepthStencilBuffer;
  36298. /** @hidden */
  36299. _releaseFramebufferObjects(texture: InternalTexture): void;
  36300. /** @hidden */
  36301. _releaseTexture(texture: InternalTexture): void;
  36302. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  36303. protected _setProgram(program: WebGLProgram): void;
  36304. protected _boundUniforms: {
  36305. [key: number]: WebGLUniformLocation;
  36306. };
  36307. /**
  36308. * Binds an effect to the webGL context
  36309. * @param effect defines the effect to bind
  36310. */
  36311. bindSamplers(effect: Effect): void;
  36312. private _activateCurrentTexture;
  36313. /** @hidden */
  36314. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  36315. /** @hidden */
  36316. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  36317. /**
  36318. * Unbind all textures from the webGL context
  36319. */
  36320. unbindAllTextures(): void;
  36321. /**
  36322. * Sets a texture to the according uniform.
  36323. * @param channel The texture channel
  36324. * @param uniform The uniform to set
  36325. * @param texture The texture to apply
  36326. */
  36327. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  36328. private _bindSamplerUniformToChannel;
  36329. private _getTextureWrapMode;
  36330. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  36331. /**
  36332. * Sets an array of texture to the webGL context
  36333. * @param channel defines the channel where the texture array must be set
  36334. * @param uniform defines the associated uniform location
  36335. * @param textures defines the array of textures to bind
  36336. */
  36337. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  36338. /** @hidden */
  36339. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  36340. private _setTextureParameterFloat;
  36341. private _setTextureParameterInteger;
  36342. /**
  36343. * Unbind all vertex attributes from the webGL context
  36344. */
  36345. unbindAllAttributes(): void;
  36346. /**
  36347. * 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
  36348. */
  36349. releaseEffects(): void;
  36350. /**
  36351. * Dispose and release all associated resources
  36352. */
  36353. dispose(): void;
  36354. /**
  36355. * Attach a new callback raised when context lost event is fired
  36356. * @param callback defines the callback to call
  36357. */
  36358. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  36359. /**
  36360. * Attach a new callback raised when context restored event is fired
  36361. * @param callback defines the callback to call
  36362. */
  36363. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  36364. /**
  36365. * Get the current error code of the webGL context
  36366. * @returns the error code
  36367. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  36368. */
  36369. getError(): number;
  36370. private _canRenderToFloatFramebuffer;
  36371. private _canRenderToHalfFloatFramebuffer;
  36372. private _canRenderToFramebuffer;
  36373. /** @hidden */
  36374. _getWebGLTextureType(type: number): number;
  36375. /** @hidden */
  36376. _getInternalFormat(format: number): number;
  36377. /** @hidden */
  36378. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  36379. /** @hidden */
  36380. _getRGBAMultiSampleBufferFormat(type: number): number;
  36381. /** @hidden */
  36382. _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;
  36383. /**
  36384. * Loads a file from a url
  36385. * @param url url to load
  36386. * @param onSuccess callback called when the file successfully loads
  36387. * @param onProgress callback called while file is loading (if the server supports this mode)
  36388. * @param offlineProvider defines the offline provider for caching
  36389. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  36390. * @param onError callback called when the file fails to load
  36391. * @returns a file request object
  36392. * @hidden
  36393. */
  36394. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  36395. /**
  36396. * Reads pixels from the current frame buffer. Please note that this function can be slow
  36397. * @param x defines the x coordinate of the rectangle where pixels must be read
  36398. * @param y defines the y coordinate of the rectangle where pixels must be read
  36399. * @param width defines the width of the rectangle where pixels must be read
  36400. * @param height defines the height of the rectangle where pixels must be read
  36401. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  36402. * @returns a Uint8Array containing RGBA colors
  36403. */
  36404. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  36405. private static _isSupported;
  36406. /**
  36407. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  36408. * @returns true if the engine can be created
  36409. * @ignorenaming
  36410. */
  36411. static isSupported(): boolean;
  36412. /**
  36413. * Find the next highest power of two.
  36414. * @param x Number to start search from.
  36415. * @return Next highest power of two.
  36416. */
  36417. static CeilingPOT(x: number): number;
  36418. /**
  36419. * Find the next lowest power of two.
  36420. * @param x Number to start search from.
  36421. * @return Next lowest power of two.
  36422. */
  36423. static FloorPOT(x: number): number;
  36424. /**
  36425. * Find the nearest power of two.
  36426. * @param x Number to start search from.
  36427. * @return Next nearest power of two.
  36428. */
  36429. static NearestPOT(x: number): number;
  36430. /**
  36431. * Get the closest exponent of two
  36432. * @param value defines the value to approximate
  36433. * @param max defines the maximum value to return
  36434. * @param mode defines how to define the closest value
  36435. * @returns closest exponent of two of the given value
  36436. */
  36437. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  36438. /**
  36439. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  36440. * @param func - the function to be called
  36441. * @param requester - the object that will request the next frame. Falls back to window.
  36442. * @returns frame number
  36443. */
  36444. static QueueNewFrame(func: () => void, requester?: any): number;
  36445. /**
  36446. * Gets host document
  36447. * @returns the host document object
  36448. */
  36449. getHostDocument(): Nullable<Document>;
  36450. }
  36451. }
  36452. declare module "babylonjs/Maths/sphericalPolynomial" {
  36453. import { Vector3 } from "babylonjs/Maths/math.vector";
  36454. import { Color3 } from "babylonjs/Maths/math.color";
  36455. /**
  36456. * Class representing spherical harmonics coefficients to the 3rd degree
  36457. */
  36458. export class SphericalHarmonics {
  36459. /**
  36460. * Defines whether or not the harmonics have been prescaled for rendering.
  36461. */
  36462. preScaled: boolean;
  36463. /**
  36464. * The l0,0 coefficients of the spherical harmonics
  36465. */
  36466. l00: Vector3;
  36467. /**
  36468. * The l1,-1 coefficients of the spherical harmonics
  36469. */
  36470. l1_1: Vector3;
  36471. /**
  36472. * The l1,0 coefficients of the spherical harmonics
  36473. */
  36474. l10: Vector3;
  36475. /**
  36476. * The l1,1 coefficients of the spherical harmonics
  36477. */
  36478. l11: Vector3;
  36479. /**
  36480. * The l2,-2 coefficients of the spherical harmonics
  36481. */
  36482. l2_2: Vector3;
  36483. /**
  36484. * The l2,-1 coefficients of the spherical harmonics
  36485. */
  36486. l2_1: Vector3;
  36487. /**
  36488. * The l2,0 coefficients of the spherical harmonics
  36489. */
  36490. l20: Vector3;
  36491. /**
  36492. * The l2,1 coefficients of the spherical harmonics
  36493. */
  36494. l21: Vector3;
  36495. /**
  36496. * The l2,2 coefficients of the spherical harmonics
  36497. */
  36498. l22: Vector3;
  36499. /**
  36500. * Adds a light to the spherical harmonics
  36501. * @param direction the direction of the light
  36502. * @param color the color of the light
  36503. * @param deltaSolidAngle the delta solid angle of the light
  36504. */
  36505. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  36506. /**
  36507. * Scales the spherical harmonics by the given amount
  36508. * @param scale the amount to scale
  36509. */
  36510. scaleInPlace(scale: number): void;
  36511. /**
  36512. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  36513. *
  36514. * ```
  36515. * E_lm = A_l * L_lm
  36516. * ```
  36517. *
  36518. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  36519. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  36520. * the scaling factors are given in equation 9.
  36521. */
  36522. convertIncidentRadianceToIrradiance(): void;
  36523. /**
  36524. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  36525. *
  36526. * ```
  36527. * L = (1/pi) * E * rho
  36528. * ```
  36529. *
  36530. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  36531. */
  36532. convertIrradianceToLambertianRadiance(): void;
  36533. /**
  36534. * Integrates the reconstruction coefficients directly in to the SH preventing further
  36535. * required operations at run time.
  36536. *
  36537. * This is simply done by scaling back the SH with Ylm constants parameter.
  36538. * The trigonometric part being applied by the shader at run time.
  36539. */
  36540. preScaleForRendering(): void;
  36541. /**
  36542. * Constructs a spherical harmonics from an array.
  36543. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  36544. * @returns the spherical harmonics
  36545. */
  36546. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  36547. /**
  36548. * Gets the spherical harmonics from polynomial
  36549. * @param polynomial the spherical polynomial
  36550. * @returns the spherical harmonics
  36551. */
  36552. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  36553. }
  36554. /**
  36555. * Class representing spherical polynomial coefficients to the 3rd degree
  36556. */
  36557. export class SphericalPolynomial {
  36558. private _harmonics;
  36559. /**
  36560. * The spherical harmonics used to create the polynomials.
  36561. */
  36562. get preScaledHarmonics(): SphericalHarmonics;
  36563. /**
  36564. * The x coefficients of the spherical polynomial
  36565. */
  36566. x: Vector3;
  36567. /**
  36568. * The y coefficients of the spherical polynomial
  36569. */
  36570. y: Vector3;
  36571. /**
  36572. * The z coefficients of the spherical polynomial
  36573. */
  36574. z: Vector3;
  36575. /**
  36576. * The xx coefficients of the spherical polynomial
  36577. */
  36578. xx: Vector3;
  36579. /**
  36580. * The yy coefficients of the spherical polynomial
  36581. */
  36582. yy: Vector3;
  36583. /**
  36584. * The zz coefficients of the spherical polynomial
  36585. */
  36586. zz: Vector3;
  36587. /**
  36588. * The xy coefficients of the spherical polynomial
  36589. */
  36590. xy: Vector3;
  36591. /**
  36592. * The yz coefficients of the spherical polynomial
  36593. */
  36594. yz: Vector3;
  36595. /**
  36596. * The zx coefficients of the spherical polynomial
  36597. */
  36598. zx: Vector3;
  36599. /**
  36600. * Adds an ambient color to the spherical polynomial
  36601. * @param color the color to add
  36602. */
  36603. addAmbient(color: Color3): void;
  36604. /**
  36605. * Scales the spherical polynomial by the given amount
  36606. * @param scale the amount to scale
  36607. */
  36608. scaleInPlace(scale: number): void;
  36609. /**
  36610. * Gets the spherical polynomial from harmonics
  36611. * @param harmonics the spherical harmonics
  36612. * @returns the spherical polynomial
  36613. */
  36614. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  36615. /**
  36616. * Constructs a spherical polynomial from an array.
  36617. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  36618. * @returns the spherical polynomial
  36619. */
  36620. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  36621. }
  36622. }
  36623. declare module "babylonjs/Materials/Textures/internalTexture" {
  36624. import { Observable } from "babylonjs/Misc/observable";
  36625. import { Nullable, int } from "babylonjs/types";
  36626. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  36627. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36628. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  36629. /**
  36630. * Defines the source of the internal texture
  36631. */
  36632. export enum InternalTextureSource {
  36633. /**
  36634. * The source of the texture data is unknown
  36635. */
  36636. Unknown = 0,
  36637. /**
  36638. * Texture data comes from an URL
  36639. */
  36640. Url = 1,
  36641. /**
  36642. * Texture data is only used for temporary storage
  36643. */
  36644. Temp = 2,
  36645. /**
  36646. * Texture data comes from raw data (ArrayBuffer)
  36647. */
  36648. Raw = 3,
  36649. /**
  36650. * Texture content is dynamic (video or dynamic texture)
  36651. */
  36652. Dynamic = 4,
  36653. /**
  36654. * Texture content is generated by rendering to it
  36655. */
  36656. RenderTarget = 5,
  36657. /**
  36658. * Texture content is part of a multi render target process
  36659. */
  36660. MultiRenderTarget = 6,
  36661. /**
  36662. * Texture data comes from a cube data file
  36663. */
  36664. Cube = 7,
  36665. /**
  36666. * Texture data comes from a raw cube data
  36667. */
  36668. CubeRaw = 8,
  36669. /**
  36670. * Texture data come from a prefiltered cube data file
  36671. */
  36672. CubePrefiltered = 9,
  36673. /**
  36674. * Texture content is raw 3D data
  36675. */
  36676. Raw3D = 10,
  36677. /**
  36678. * Texture content is raw 2D array data
  36679. */
  36680. Raw2DArray = 11,
  36681. /**
  36682. * Texture content is a depth texture
  36683. */
  36684. Depth = 12,
  36685. /**
  36686. * Texture data comes from a raw cube data encoded with RGBD
  36687. */
  36688. CubeRawRGBD = 13
  36689. }
  36690. /**
  36691. * Class used to store data associated with WebGL texture data for the engine
  36692. * This class should not be used directly
  36693. */
  36694. export class InternalTexture {
  36695. /** @hidden */
  36696. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<import("babylonjs/Maths/sphericalPolynomial").SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  36697. /**
  36698. * Defines if the texture is ready
  36699. */
  36700. isReady: boolean;
  36701. /**
  36702. * Defines if the texture is a cube texture
  36703. */
  36704. isCube: boolean;
  36705. /**
  36706. * Defines if the texture contains 3D data
  36707. */
  36708. is3D: boolean;
  36709. /**
  36710. * Defines if the texture contains 2D array data
  36711. */
  36712. is2DArray: boolean;
  36713. /**
  36714. * Defines if the texture contains multiview data
  36715. */
  36716. isMultiview: boolean;
  36717. /**
  36718. * Gets the URL used to load this texture
  36719. */
  36720. url: string;
  36721. /**
  36722. * Gets the sampling mode of the texture
  36723. */
  36724. samplingMode: number;
  36725. /**
  36726. * Gets a boolean indicating if the texture needs mipmaps generation
  36727. */
  36728. generateMipMaps: boolean;
  36729. /**
  36730. * Gets the number of samples used by the texture (WebGL2+ only)
  36731. */
  36732. samples: number;
  36733. /**
  36734. * Gets the type of the texture (int, float...)
  36735. */
  36736. type: number;
  36737. /**
  36738. * Gets the format of the texture (RGB, RGBA...)
  36739. */
  36740. format: number;
  36741. /**
  36742. * Observable called when the texture is loaded
  36743. */
  36744. onLoadedObservable: Observable<InternalTexture>;
  36745. /**
  36746. * Gets the width of the texture
  36747. */
  36748. width: number;
  36749. /**
  36750. * Gets the height of the texture
  36751. */
  36752. height: number;
  36753. /**
  36754. * Gets the depth of the texture
  36755. */
  36756. depth: number;
  36757. /**
  36758. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  36759. */
  36760. baseWidth: number;
  36761. /**
  36762. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  36763. */
  36764. baseHeight: number;
  36765. /**
  36766. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  36767. */
  36768. baseDepth: number;
  36769. /**
  36770. * Gets a boolean indicating if the texture is inverted on Y axis
  36771. */
  36772. invertY: boolean;
  36773. /** @hidden */
  36774. _invertVScale: boolean;
  36775. /** @hidden */
  36776. _associatedChannel: number;
  36777. /** @hidden */
  36778. _source: InternalTextureSource;
  36779. /** @hidden */
  36780. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  36781. /** @hidden */
  36782. _bufferView: Nullable<ArrayBufferView>;
  36783. /** @hidden */
  36784. _bufferViewArray: Nullable<ArrayBufferView[]>;
  36785. /** @hidden */
  36786. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  36787. /** @hidden */
  36788. _size: number;
  36789. /** @hidden */
  36790. _extension: string;
  36791. /** @hidden */
  36792. _files: Nullable<string[]>;
  36793. /** @hidden */
  36794. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36795. /** @hidden */
  36796. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36797. /** @hidden */
  36798. _framebuffer: Nullable<WebGLFramebuffer>;
  36799. /** @hidden */
  36800. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  36801. /** @hidden */
  36802. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  36803. /** @hidden */
  36804. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  36805. /** @hidden */
  36806. _attachments: Nullable<number[]>;
  36807. /** @hidden */
  36808. _cachedCoordinatesMode: Nullable<number>;
  36809. /** @hidden */
  36810. _cachedWrapU: Nullable<number>;
  36811. /** @hidden */
  36812. _cachedWrapV: Nullable<number>;
  36813. /** @hidden */
  36814. _cachedWrapR: Nullable<number>;
  36815. /** @hidden */
  36816. _cachedAnisotropicFilteringLevel: Nullable<number>;
  36817. /** @hidden */
  36818. _isDisabled: boolean;
  36819. /** @hidden */
  36820. _compression: Nullable<string>;
  36821. /** @hidden */
  36822. _generateStencilBuffer: boolean;
  36823. /** @hidden */
  36824. _generateDepthBuffer: boolean;
  36825. /** @hidden */
  36826. _comparisonFunction: number;
  36827. /** @hidden */
  36828. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  36829. /** @hidden */
  36830. _lodGenerationScale: number;
  36831. /** @hidden */
  36832. _lodGenerationOffset: number;
  36833. /** @hidden */
  36834. _depthStencilTexture: Nullable<InternalTexture>;
  36835. /** @hidden */
  36836. _colorTextureArray: Nullable<WebGLTexture>;
  36837. /** @hidden */
  36838. _depthStencilTextureArray: Nullable<WebGLTexture>;
  36839. /** @hidden */
  36840. _lodTextureHigh: Nullable<BaseTexture>;
  36841. /** @hidden */
  36842. _lodTextureMid: Nullable<BaseTexture>;
  36843. /** @hidden */
  36844. _lodTextureLow: Nullable<BaseTexture>;
  36845. /** @hidden */
  36846. _isRGBD: boolean;
  36847. /** @hidden */
  36848. _linearSpecularLOD: boolean;
  36849. /** @hidden */
  36850. _irradianceTexture: Nullable<BaseTexture>;
  36851. /** @hidden */
  36852. _webGLTexture: Nullable<WebGLTexture>;
  36853. /** @hidden */
  36854. _references: number;
  36855. private _engine;
  36856. /**
  36857. * Gets the Engine the texture belongs to.
  36858. * @returns The babylon engine
  36859. */
  36860. getEngine(): ThinEngine;
  36861. /**
  36862. * Gets the data source type of the texture
  36863. */
  36864. get source(): InternalTextureSource;
  36865. /**
  36866. * Creates a new InternalTexture
  36867. * @param engine defines the engine to use
  36868. * @param source defines the type of data that will be used
  36869. * @param delayAllocation if the texture allocation should be delayed (default: false)
  36870. */
  36871. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  36872. /**
  36873. * Increments the number of references (ie. the number of Texture that point to it)
  36874. */
  36875. incrementReferences(): void;
  36876. /**
  36877. * Change the size of the texture (not the size of the content)
  36878. * @param width defines the new width
  36879. * @param height defines the new height
  36880. * @param depth defines the new depth (1 by default)
  36881. */
  36882. updateSize(width: int, height: int, depth?: int): void;
  36883. /** @hidden */
  36884. _rebuild(): void;
  36885. /** @hidden */
  36886. _swapAndDie(target: InternalTexture): void;
  36887. /**
  36888. * Dispose the current allocated resources
  36889. */
  36890. dispose(): void;
  36891. }
  36892. }
  36893. declare module "babylonjs/Audio/analyser" {
  36894. import { Scene } from "babylonjs/scene";
  36895. /**
  36896. * Class used to work with sound analyzer using fast fourier transform (FFT)
  36897. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36898. */
  36899. export class Analyser {
  36900. /**
  36901. * Gets or sets the smoothing
  36902. * @ignorenaming
  36903. */
  36904. SMOOTHING: number;
  36905. /**
  36906. * Gets or sets the FFT table size
  36907. * @ignorenaming
  36908. */
  36909. FFT_SIZE: number;
  36910. /**
  36911. * Gets or sets the bar graph amplitude
  36912. * @ignorenaming
  36913. */
  36914. BARGRAPHAMPLITUDE: number;
  36915. /**
  36916. * Gets or sets the position of the debug canvas
  36917. * @ignorenaming
  36918. */
  36919. DEBUGCANVASPOS: {
  36920. x: number;
  36921. y: number;
  36922. };
  36923. /**
  36924. * Gets or sets the debug canvas size
  36925. * @ignorenaming
  36926. */
  36927. DEBUGCANVASSIZE: {
  36928. width: number;
  36929. height: number;
  36930. };
  36931. private _byteFreqs;
  36932. private _byteTime;
  36933. private _floatFreqs;
  36934. private _webAudioAnalyser;
  36935. private _debugCanvas;
  36936. private _debugCanvasContext;
  36937. private _scene;
  36938. private _registerFunc;
  36939. private _audioEngine;
  36940. /**
  36941. * Creates a new analyser
  36942. * @param scene defines hosting scene
  36943. */
  36944. constructor(scene: Scene);
  36945. /**
  36946. * Get the number of data values you will have to play with for the visualization
  36947. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  36948. * @returns a number
  36949. */
  36950. getFrequencyBinCount(): number;
  36951. /**
  36952. * Gets the current frequency data as a byte array
  36953. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  36954. * @returns a Uint8Array
  36955. */
  36956. getByteFrequencyData(): Uint8Array;
  36957. /**
  36958. * Gets the current waveform as a byte array
  36959. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  36960. * @returns a Uint8Array
  36961. */
  36962. getByteTimeDomainData(): Uint8Array;
  36963. /**
  36964. * Gets the current frequency data as a float array
  36965. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  36966. * @returns a Float32Array
  36967. */
  36968. getFloatFrequencyData(): Float32Array;
  36969. /**
  36970. * Renders the debug canvas
  36971. */
  36972. drawDebugCanvas(): void;
  36973. /**
  36974. * Stops rendering the debug canvas and removes it
  36975. */
  36976. stopDebugCanvas(): void;
  36977. /**
  36978. * Connects two audio nodes
  36979. * @param inputAudioNode defines first node to connect
  36980. * @param outputAudioNode defines second node to connect
  36981. */
  36982. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  36983. /**
  36984. * Releases all associated resources
  36985. */
  36986. dispose(): void;
  36987. }
  36988. }
  36989. declare module "babylonjs/Audio/audioEngine" {
  36990. import { IDisposable } from "babylonjs/scene";
  36991. import { Analyser } from "babylonjs/Audio/analyser";
  36992. import { Nullable } from "babylonjs/types";
  36993. import { Observable } from "babylonjs/Misc/observable";
  36994. /**
  36995. * This represents an audio engine and it is responsible
  36996. * to play, synchronize and analyse sounds throughout the application.
  36997. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36998. */
  36999. export interface IAudioEngine extends IDisposable {
  37000. /**
  37001. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  37002. */
  37003. readonly canUseWebAudio: boolean;
  37004. /**
  37005. * Gets the current AudioContext if available.
  37006. */
  37007. readonly audioContext: Nullable<AudioContext>;
  37008. /**
  37009. * The master gain node defines the global audio volume of your audio engine.
  37010. */
  37011. readonly masterGain: GainNode;
  37012. /**
  37013. * Gets whether or not mp3 are supported by your browser.
  37014. */
  37015. readonly isMP3supported: boolean;
  37016. /**
  37017. * Gets whether or not ogg are supported by your browser.
  37018. */
  37019. readonly isOGGsupported: boolean;
  37020. /**
  37021. * Defines if Babylon should emit a warning if WebAudio is not supported.
  37022. * @ignoreNaming
  37023. */
  37024. WarnedWebAudioUnsupported: boolean;
  37025. /**
  37026. * Defines if the audio engine relies on a custom unlocked button.
  37027. * In this case, the embedded button will not be displayed.
  37028. */
  37029. useCustomUnlockedButton: boolean;
  37030. /**
  37031. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  37032. */
  37033. readonly unlocked: boolean;
  37034. /**
  37035. * Event raised when audio has been unlocked on the browser.
  37036. */
  37037. onAudioUnlockedObservable: Observable<AudioEngine>;
  37038. /**
  37039. * Event raised when audio has been locked on the browser.
  37040. */
  37041. onAudioLockedObservable: Observable<AudioEngine>;
  37042. /**
  37043. * Flags the audio engine in Locked state.
  37044. * This happens due to new browser policies preventing audio to autoplay.
  37045. */
  37046. lock(): void;
  37047. /**
  37048. * Unlocks the audio engine once a user action has been done on the dom.
  37049. * This is helpful to resume play once browser policies have been satisfied.
  37050. */
  37051. unlock(): void;
  37052. /**
  37053. * Gets the global volume sets on the master gain.
  37054. * @returns the global volume if set or -1 otherwise
  37055. */
  37056. getGlobalVolume(): number;
  37057. /**
  37058. * Sets the global volume of your experience (sets on the master gain).
  37059. * @param newVolume Defines the new global volume of the application
  37060. */
  37061. setGlobalVolume(newVolume: number): void;
  37062. /**
  37063. * Connect the audio engine to an audio analyser allowing some amazing
  37064. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  37065. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  37066. * @param analyser The analyser to connect to the engine
  37067. */
  37068. connectToAnalyser(analyser: Analyser): void;
  37069. }
  37070. /**
  37071. * This represents the default audio engine used in babylon.
  37072. * It is responsible to play, synchronize and analyse sounds throughout the application.
  37073. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  37074. */
  37075. export class AudioEngine implements IAudioEngine {
  37076. private _audioContext;
  37077. private _audioContextInitialized;
  37078. private _muteButton;
  37079. private _hostElement;
  37080. /**
  37081. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  37082. */
  37083. canUseWebAudio: boolean;
  37084. /**
  37085. * The master gain node defines the global audio volume of your audio engine.
  37086. */
  37087. masterGain: GainNode;
  37088. /**
  37089. * Defines if Babylon should emit a warning if WebAudio is not supported.
  37090. * @ignoreNaming
  37091. */
  37092. WarnedWebAudioUnsupported: boolean;
  37093. /**
  37094. * Gets whether or not mp3 are supported by your browser.
  37095. */
  37096. isMP3supported: boolean;
  37097. /**
  37098. * Gets whether or not ogg are supported by your browser.
  37099. */
  37100. isOGGsupported: boolean;
  37101. /**
  37102. * Gets whether audio has been unlocked on the device.
  37103. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  37104. * a user interaction has happened.
  37105. */
  37106. unlocked: boolean;
  37107. /**
  37108. * Defines if the audio engine relies on a custom unlocked button.
  37109. * In this case, the embedded button will not be displayed.
  37110. */
  37111. useCustomUnlockedButton: boolean;
  37112. /**
  37113. * Event raised when audio has been unlocked on the browser.
  37114. */
  37115. onAudioUnlockedObservable: Observable<AudioEngine>;
  37116. /**
  37117. * Event raised when audio has been locked on the browser.
  37118. */
  37119. onAudioLockedObservable: Observable<AudioEngine>;
  37120. /**
  37121. * Gets the current AudioContext if available.
  37122. */
  37123. get audioContext(): Nullable<AudioContext>;
  37124. private _connectedAnalyser;
  37125. /**
  37126. * Instantiates a new audio engine.
  37127. *
  37128. * There should be only one per page as some browsers restrict the number
  37129. * of audio contexts you can create.
  37130. * @param hostElement defines the host element where to display the mute icon if necessary
  37131. */
  37132. constructor(hostElement?: Nullable<HTMLElement>);
  37133. /**
  37134. * Flags the audio engine in Locked state.
  37135. * This happens due to new browser policies preventing audio to autoplay.
  37136. */
  37137. lock(): void;
  37138. /**
  37139. * Unlocks the audio engine once a user action has been done on the dom.
  37140. * This is helpful to resume play once browser policies have been satisfied.
  37141. */
  37142. unlock(): void;
  37143. private _resumeAudioContext;
  37144. private _initializeAudioContext;
  37145. private _tryToRun;
  37146. private _triggerRunningState;
  37147. private _triggerSuspendedState;
  37148. private _displayMuteButton;
  37149. private _moveButtonToTopLeft;
  37150. private _onResize;
  37151. private _hideMuteButton;
  37152. /**
  37153. * Destroy and release the resources associated with the audio ccontext.
  37154. */
  37155. dispose(): void;
  37156. /**
  37157. * Gets the global volume sets on the master gain.
  37158. * @returns the global volume if set or -1 otherwise
  37159. */
  37160. getGlobalVolume(): number;
  37161. /**
  37162. * Sets the global volume of your experience (sets on the master gain).
  37163. * @param newVolume Defines the new global volume of the application
  37164. */
  37165. setGlobalVolume(newVolume: number): void;
  37166. /**
  37167. * Connect the audio engine to an audio analyser allowing some amazing
  37168. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  37169. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  37170. * @param analyser The analyser to connect to the engine
  37171. */
  37172. connectToAnalyser(analyser: Analyser): void;
  37173. }
  37174. }
  37175. declare module "babylonjs/Loading/loadingScreen" {
  37176. /**
  37177. * Interface used to present a loading screen while loading a scene
  37178. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  37179. */
  37180. export interface ILoadingScreen {
  37181. /**
  37182. * Function called to display the loading screen
  37183. */
  37184. displayLoadingUI: () => void;
  37185. /**
  37186. * Function called to hide the loading screen
  37187. */
  37188. hideLoadingUI: () => void;
  37189. /**
  37190. * Gets or sets the color to use for the background
  37191. */
  37192. loadingUIBackgroundColor: string;
  37193. /**
  37194. * Gets or sets the text to display while loading
  37195. */
  37196. loadingUIText: string;
  37197. }
  37198. /**
  37199. * Class used for the default loading screen
  37200. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  37201. */
  37202. export class DefaultLoadingScreen implements ILoadingScreen {
  37203. private _renderingCanvas;
  37204. private _loadingText;
  37205. private _loadingDivBackgroundColor;
  37206. private _loadingDiv;
  37207. private _loadingTextDiv;
  37208. /** Gets or sets the logo url to use for the default loading screen */
  37209. static DefaultLogoUrl: string;
  37210. /** Gets or sets the spinner url to use for the default loading screen */
  37211. static DefaultSpinnerUrl: string;
  37212. /**
  37213. * Creates a new default loading screen
  37214. * @param _renderingCanvas defines the canvas used to render the scene
  37215. * @param _loadingText defines the default text to display
  37216. * @param _loadingDivBackgroundColor defines the default background color
  37217. */
  37218. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  37219. /**
  37220. * Function called to display the loading screen
  37221. */
  37222. displayLoadingUI(): void;
  37223. /**
  37224. * Function called to hide the loading screen
  37225. */
  37226. hideLoadingUI(): void;
  37227. /**
  37228. * Gets or sets the text to display while loading
  37229. */
  37230. set loadingUIText(text: string);
  37231. get loadingUIText(): string;
  37232. /**
  37233. * Gets or sets the color to use for the background
  37234. */
  37235. get loadingUIBackgroundColor(): string;
  37236. set loadingUIBackgroundColor(color: string);
  37237. private _resizeLoadingUI;
  37238. }
  37239. }
  37240. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  37241. /**
  37242. * Interface for any object that can request an animation frame
  37243. */
  37244. export interface ICustomAnimationFrameRequester {
  37245. /**
  37246. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  37247. */
  37248. renderFunction?: Function;
  37249. /**
  37250. * Called to request the next frame to render to
  37251. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  37252. */
  37253. requestAnimationFrame: Function;
  37254. /**
  37255. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  37256. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  37257. */
  37258. requestID?: number;
  37259. }
  37260. }
  37261. declare module "babylonjs/Misc/performanceMonitor" {
  37262. /**
  37263. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  37264. */
  37265. export class PerformanceMonitor {
  37266. private _enabled;
  37267. private _rollingFrameTime;
  37268. private _lastFrameTimeMs;
  37269. /**
  37270. * constructor
  37271. * @param frameSampleSize The number of samples required to saturate the sliding window
  37272. */
  37273. constructor(frameSampleSize?: number);
  37274. /**
  37275. * Samples current frame
  37276. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  37277. */
  37278. sampleFrame(timeMs?: number): void;
  37279. /**
  37280. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  37281. */
  37282. get averageFrameTime(): number;
  37283. /**
  37284. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  37285. */
  37286. get averageFrameTimeVariance(): number;
  37287. /**
  37288. * Returns the frame time of the most recent frame
  37289. */
  37290. get instantaneousFrameTime(): number;
  37291. /**
  37292. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  37293. */
  37294. get averageFPS(): number;
  37295. /**
  37296. * Returns the average framerate in frames per second using the most recent frame time
  37297. */
  37298. get instantaneousFPS(): number;
  37299. /**
  37300. * Returns true if enough samples have been taken to completely fill the sliding window
  37301. */
  37302. get isSaturated(): boolean;
  37303. /**
  37304. * Enables contributions to the sliding window sample set
  37305. */
  37306. enable(): void;
  37307. /**
  37308. * Disables contributions to the sliding window sample set
  37309. * Samples will not be interpolated over the disabled period
  37310. */
  37311. disable(): void;
  37312. /**
  37313. * Returns true if sampling is enabled
  37314. */
  37315. get isEnabled(): boolean;
  37316. /**
  37317. * Resets performance monitor
  37318. */
  37319. reset(): void;
  37320. }
  37321. /**
  37322. * RollingAverage
  37323. *
  37324. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  37325. */
  37326. export class RollingAverage {
  37327. /**
  37328. * Current average
  37329. */
  37330. average: number;
  37331. /**
  37332. * Current variance
  37333. */
  37334. variance: number;
  37335. protected _samples: Array<number>;
  37336. protected _sampleCount: number;
  37337. protected _pos: number;
  37338. protected _m2: number;
  37339. /**
  37340. * constructor
  37341. * @param length The number of samples required to saturate the sliding window
  37342. */
  37343. constructor(length: number);
  37344. /**
  37345. * Adds a sample to the sample set
  37346. * @param v The sample value
  37347. */
  37348. add(v: number): void;
  37349. /**
  37350. * Returns previously added values or null if outside of history or outside the sliding window domain
  37351. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  37352. * @return Value previously recorded with add() or null if outside of range
  37353. */
  37354. history(i: number): number;
  37355. /**
  37356. * Returns true if enough samples have been taken to completely fill the sliding window
  37357. * @return true if sample-set saturated
  37358. */
  37359. isSaturated(): boolean;
  37360. /**
  37361. * Resets the rolling average (equivalent to 0 samples taken so far)
  37362. */
  37363. reset(): void;
  37364. /**
  37365. * Wraps a value around the sample range boundaries
  37366. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  37367. * @return Wrapped position in sample range
  37368. */
  37369. protected _wrapPosition(i: number): number;
  37370. }
  37371. }
  37372. declare module "babylonjs/Misc/perfCounter" {
  37373. /**
  37374. * This class is used to track a performance counter which is number based.
  37375. * The user has access to many properties which give statistics of different nature.
  37376. *
  37377. * The implementer can track two kinds of Performance Counter: time and count.
  37378. * 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.
  37379. * 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.
  37380. */
  37381. export class PerfCounter {
  37382. /**
  37383. * Gets or sets a global boolean to turn on and off all the counters
  37384. */
  37385. static Enabled: boolean;
  37386. /**
  37387. * Returns the smallest value ever
  37388. */
  37389. get min(): number;
  37390. /**
  37391. * Returns the biggest value ever
  37392. */
  37393. get max(): number;
  37394. /**
  37395. * Returns the average value since the performance counter is running
  37396. */
  37397. get average(): number;
  37398. /**
  37399. * Returns the average value of the last second the counter was monitored
  37400. */
  37401. get lastSecAverage(): number;
  37402. /**
  37403. * Returns the current value
  37404. */
  37405. get current(): number;
  37406. /**
  37407. * Gets the accumulated total
  37408. */
  37409. get total(): number;
  37410. /**
  37411. * Gets the total value count
  37412. */
  37413. get count(): number;
  37414. /**
  37415. * Creates a new counter
  37416. */
  37417. constructor();
  37418. /**
  37419. * Call this method to start monitoring a new frame.
  37420. * 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.
  37421. */
  37422. fetchNewFrame(): void;
  37423. /**
  37424. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  37425. * @param newCount the count value to add to the monitored count
  37426. * @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.
  37427. */
  37428. addCount(newCount: number, fetchResult: boolean): void;
  37429. /**
  37430. * Start monitoring this performance counter
  37431. */
  37432. beginMonitoring(): void;
  37433. /**
  37434. * Compute the time lapsed since the previous beginMonitoring() call.
  37435. * @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
  37436. */
  37437. endMonitoring(newFrame?: boolean): void;
  37438. private _fetchResult;
  37439. private _startMonitoringTime;
  37440. private _min;
  37441. private _max;
  37442. private _average;
  37443. private _current;
  37444. private _totalValueCount;
  37445. private _totalAccumulated;
  37446. private _lastSecAverage;
  37447. private _lastSecAccumulated;
  37448. private _lastSecTime;
  37449. private _lastSecValueCount;
  37450. }
  37451. }
  37452. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  37453. module "babylonjs/Engines/thinEngine" {
  37454. interface ThinEngine {
  37455. /**
  37456. * Sets alpha constants used by some alpha blending modes
  37457. * @param r defines the red component
  37458. * @param g defines the green component
  37459. * @param b defines the blue component
  37460. * @param a defines the alpha component
  37461. */
  37462. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  37463. /**
  37464. * Sets the current alpha mode
  37465. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  37466. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  37467. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  37468. */
  37469. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  37470. /**
  37471. * Gets the current alpha mode
  37472. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  37473. * @returns the current alpha mode
  37474. */
  37475. getAlphaMode(): number;
  37476. /**
  37477. * Sets the current alpha equation
  37478. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  37479. */
  37480. setAlphaEquation(equation: number): void;
  37481. /**
  37482. * Gets the current alpha equation.
  37483. * @returns the current alpha equation
  37484. */
  37485. getAlphaEquation(): number;
  37486. }
  37487. }
  37488. }
  37489. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  37490. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  37491. import { Nullable } from "babylonjs/types";
  37492. module "babylonjs/Engines/thinEngine" {
  37493. interface ThinEngine {
  37494. /** @hidden */
  37495. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  37496. }
  37497. }
  37498. }
  37499. declare module "babylonjs/Engines/engine" {
  37500. import { Observable } from "babylonjs/Misc/observable";
  37501. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  37502. import { Scene } from "babylonjs/scene";
  37503. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  37504. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  37505. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  37506. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  37507. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  37508. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  37509. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  37510. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  37511. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  37512. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  37513. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  37514. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  37515. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  37516. import "babylonjs/Engines/Extensions/engine.alpha";
  37517. import "babylonjs/Engines/Extensions/engine.readTexture";
  37518. import { Material } from "babylonjs/Materials/material";
  37519. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  37520. /**
  37521. * Defines the interface used by display changed events
  37522. */
  37523. export interface IDisplayChangedEventArgs {
  37524. /** Gets the vrDisplay object (if any) */
  37525. vrDisplay: Nullable<any>;
  37526. /** Gets a boolean indicating if webVR is supported */
  37527. vrSupported: boolean;
  37528. }
  37529. /**
  37530. * Defines the interface used by objects containing a viewport (like a camera)
  37531. */
  37532. interface IViewportOwnerLike {
  37533. /**
  37534. * Gets or sets the viewport
  37535. */
  37536. viewport: IViewportLike;
  37537. }
  37538. /**
  37539. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  37540. */
  37541. export class Engine extends ThinEngine {
  37542. /** Defines that alpha blending is disabled */
  37543. static readonly ALPHA_DISABLE: number;
  37544. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  37545. static readonly ALPHA_ADD: number;
  37546. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  37547. static readonly ALPHA_COMBINE: number;
  37548. /** Defines that alpha blending to DEST - SRC * DEST */
  37549. static readonly ALPHA_SUBTRACT: number;
  37550. /** Defines that alpha blending to SRC * DEST */
  37551. static readonly ALPHA_MULTIPLY: number;
  37552. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  37553. static readonly ALPHA_MAXIMIZED: number;
  37554. /** Defines that alpha blending to SRC + DEST */
  37555. static readonly ALPHA_ONEONE: number;
  37556. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  37557. static readonly ALPHA_PREMULTIPLIED: number;
  37558. /**
  37559. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  37560. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  37561. */
  37562. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  37563. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  37564. static readonly ALPHA_INTERPOLATE: number;
  37565. /**
  37566. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  37567. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  37568. */
  37569. static readonly ALPHA_SCREENMODE: number;
  37570. /** Defines that the ressource is not delayed*/
  37571. static readonly DELAYLOADSTATE_NONE: number;
  37572. /** Defines that the ressource was successfully delay loaded */
  37573. static readonly DELAYLOADSTATE_LOADED: number;
  37574. /** Defines that the ressource is currently delay loading */
  37575. static readonly DELAYLOADSTATE_LOADING: number;
  37576. /** Defines that the ressource is delayed and has not started loading */
  37577. static readonly DELAYLOADSTATE_NOTLOADED: number;
  37578. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  37579. static readonly NEVER: number;
  37580. /** 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 */
  37581. static readonly ALWAYS: number;
  37582. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  37583. static readonly LESS: number;
  37584. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  37585. static readonly EQUAL: number;
  37586. /** 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 */
  37587. static readonly LEQUAL: number;
  37588. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  37589. static readonly GREATER: number;
  37590. /** 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 */
  37591. static readonly GEQUAL: number;
  37592. /** 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 */
  37593. static readonly NOTEQUAL: number;
  37594. /** Passed to stencilOperation to specify that stencil value must be kept */
  37595. static readonly KEEP: number;
  37596. /** Passed to stencilOperation to specify that stencil value must be replaced */
  37597. static readonly REPLACE: number;
  37598. /** Passed to stencilOperation to specify that stencil value must be incremented */
  37599. static readonly INCR: number;
  37600. /** Passed to stencilOperation to specify that stencil value must be decremented */
  37601. static readonly DECR: number;
  37602. /** Passed to stencilOperation to specify that stencil value must be inverted */
  37603. static readonly INVERT: number;
  37604. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  37605. static readonly INCR_WRAP: number;
  37606. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  37607. static readonly DECR_WRAP: number;
  37608. /** Texture is not repeating outside of 0..1 UVs */
  37609. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  37610. /** Texture is repeating outside of 0..1 UVs */
  37611. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  37612. /** Texture is repeating and mirrored */
  37613. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  37614. /** ALPHA */
  37615. static readonly TEXTUREFORMAT_ALPHA: number;
  37616. /** LUMINANCE */
  37617. static readonly TEXTUREFORMAT_LUMINANCE: number;
  37618. /** LUMINANCE_ALPHA */
  37619. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  37620. /** RGB */
  37621. static readonly TEXTUREFORMAT_RGB: number;
  37622. /** RGBA */
  37623. static readonly TEXTUREFORMAT_RGBA: number;
  37624. /** RED */
  37625. static readonly TEXTUREFORMAT_RED: number;
  37626. /** RED (2nd reference) */
  37627. static readonly TEXTUREFORMAT_R: number;
  37628. /** RG */
  37629. static readonly TEXTUREFORMAT_RG: number;
  37630. /** RED_INTEGER */
  37631. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  37632. /** RED_INTEGER (2nd reference) */
  37633. static readonly TEXTUREFORMAT_R_INTEGER: number;
  37634. /** RG_INTEGER */
  37635. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  37636. /** RGB_INTEGER */
  37637. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  37638. /** RGBA_INTEGER */
  37639. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  37640. /** UNSIGNED_BYTE */
  37641. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  37642. /** UNSIGNED_BYTE (2nd reference) */
  37643. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  37644. /** FLOAT */
  37645. static readonly TEXTURETYPE_FLOAT: number;
  37646. /** HALF_FLOAT */
  37647. static readonly TEXTURETYPE_HALF_FLOAT: number;
  37648. /** BYTE */
  37649. static readonly TEXTURETYPE_BYTE: number;
  37650. /** SHORT */
  37651. static readonly TEXTURETYPE_SHORT: number;
  37652. /** UNSIGNED_SHORT */
  37653. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  37654. /** INT */
  37655. static readonly TEXTURETYPE_INT: number;
  37656. /** UNSIGNED_INT */
  37657. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  37658. /** UNSIGNED_SHORT_4_4_4_4 */
  37659. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  37660. /** UNSIGNED_SHORT_5_5_5_1 */
  37661. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  37662. /** UNSIGNED_SHORT_5_6_5 */
  37663. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  37664. /** UNSIGNED_INT_2_10_10_10_REV */
  37665. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  37666. /** UNSIGNED_INT_24_8 */
  37667. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  37668. /** UNSIGNED_INT_10F_11F_11F_REV */
  37669. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  37670. /** UNSIGNED_INT_5_9_9_9_REV */
  37671. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  37672. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  37673. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  37674. /** nearest is mag = nearest and min = nearest and mip = linear */
  37675. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  37676. /** Bilinear is mag = linear and min = linear and mip = nearest */
  37677. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  37678. /** Trilinear is mag = linear and min = linear and mip = linear */
  37679. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  37680. /** nearest is mag = nearest and min = nearest and mip = linear */
  37681. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  37682. /** Bilinear is mag = linear and min = linear and mip = nearest */
  37683. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  37684. /** Trilinear is mag = linear and min = linear and mip = linear */
  37685. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  37686. /** mag = nearest and min = nearest and mip = nearest */
  37687. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  37688. /** mag = nearest and min = linear and mip = nearest */
  37689. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  37690. /** mag = nearest and min = linear and mip = linear */
  37691. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  37692. /** mag = nearest and min = linear and mip = none */
  37693. static readonly TEXTURE_NEAREST_LINEAR: number;
  37694. /** mag = nearest and min = nearest and mip = none */
  37695. static readonly TEXTURE_NEAREST_NEAREST: number;
  37696. /** mag = linear and min = nearest and mip = nearest */
  37697. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  37698. /** mag = linear and min = nearest and mip = linear */
  37699. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  37700. /** mag = linear and min = linear and mip = none */
  37701. static readonly TEXTURE_LINEAR_LINEAR: number;
  37702. /** mag = linear and min = nearest and mip = none */
  37703. static readonly TEXTURE_LINEAR_NEAREST: number;
  37704. /** Explicit coordinates mode */
  37705. static readonly TEXTURE_EXPLICIT_MODE: number;
  37706. /** Spherical coordinates mode */
  37707. static readonly TEXTURE_SPHERICAL_MODE: number;
  37708. /** Planar coordinates mode */
  37709. static readonly TEXTURE_PLANAR_MODE: number;
  37710. /** Cubic coordinates mode */
  37711. static readonly TEXTURE_CUBIC_MODE: number;
  37712. /** Projection coordinates mode */
  37713. static readonly TEXTURE_PROJECTION_MODE: number;
  37714. /** Skybox coordinates mode */
  37715. static readonly TEXTURE_SKYBOX_MODE: number;
  37716. /** Inverse Cubic coordinates mode */
  37717. static readonly TEXTURE_INVCUBIC_MODE: number;
  37718. /** Equirectangular coordinates mode */
  37719. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  37720. /** Equirectangular Fixed coordinates mode */
  37721. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  37722. /** Equirectangular Fixed Mirrored coordinates mode */
  37723. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  37724. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  37725. static readonly SCALEMODE_FLOOR: number;
  37726. /** Defines that texture rescaling will look for the nearest power of 2 size */
  37727. static readonly SCALEMODE_NEAREST: number;
  37728. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  37729. static readonly SCALEMODE_CEILING: number;
  37730. /**
  37731. * Returns the current npm package of the sdk
  37732. */
  37733. static get NpmPackage(): string;
  37734. /**
  37735. * Returns the current version of the framework
  37736. */
  37737. static get Version(): string;
  37738. /** Gets the list of created engines */
  37739. static get Instances(): Engine[];
  37740. /**
  37741. * Gets the latest created engine
  37742. */
  37743. static get LastCreatedEngine(): Nullable<Engine>;
  37744. /**
  37745. * Gets the latest created scene
  37746. */
  37747. static get LastCreatedScene(): Nullable<Scene>;
  37748. /**
  37749. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  37750. * @param flag defines which part of the materials must be marked as dirty
  37751. * @param predicate defines a predicate used to filter which materials should be affected
  37752. */
  37753. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  37754. /**
  37755. * Method called to create the default loading screen.
  37756. * This can be overriden in your own app.
  37757. * @param canvas The rendering canvas element
  37758. * @returns The loading screen
  37759. */
  37760. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  37761. /**
  37762. * Method called to create the default rescale post process on each engine.
  37763. */
  37764. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  37765. /**
  37766. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  37767. **/
  37768. enableOfflineSupport: boolean;
  37769. /**
  37770. * 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)
  37771. **/
  37772. disableManifestCheck: boolean;
  37773. /**
  37774. * Gets the list of created scenes
  37775. */
  37776. scenes: Scene[];
  37777. /**
  37778. * Event raised when a new scene is created
  37779. */
  37780. onNewSceneAddedObservable: Observable<Scene>;
  37781. /**
  37782. * Gets the list of created postprocesses
  37783. */
  37784. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  37785. /**
  37786. * Gets a boolean indicating if the pointer is currently locked
  37787. */
  37788. isPointerLock: boolean;
  37789. /**
  37790. * Observable event triggered each time the rendering canvas is resized
  37791. */
  37792. onResizeObservable: Observable<Engine>;
  37793. /**
  37794. * Observable event triggered each time the canvas loses focus
  37795. */
  37796. onCanvasBlurObservable: Observable<Engine>;
  37797. /**
  37798. * Observable event triggered each time the canvas gains focus
  37799. */
  37800. onCanvasFocusObservable: Observable<Engine>;
  37801. /**
  37802. * Observable event triggered each time the canvas receives pointerout event
  37803. */
  37804. onCanvasPointerOutObservable: Observable<PointerEvent>;
  37805. /**
  37806. * Observable raised when the engine begins a new frame
  37807. */
  37808. onBeginFrameObservable: Observable<Engine>;
  37809. /**
  37810. * If set, will be used to request the next animation frame for the render loop
  37811. */
  37812. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  37813. /**
  37814. * Observable raised when the engine ends the current frame
  37815. */
  37816. onEndFrameObservable: Observable<Engine>;
  37817. /**
  37818. * Observable raised when the engine is about to compile a shader
  37819. */
  37820. onBeforeShaderCompilationObservable: Observable<Engine>;
  37821. /**
  37822. * Observable raised when the engine has jsut compiled a shader
  37823. */
  37824. onAfterShaderCompilationObservable: Observable<Engine>;
  37825. /**
  37826. * Gets the audio engine
  37827. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  37828. * @ignorenaming
  37829. */
  37830. static audioEngine: IAudioEngine;
  37831. /**
  37832. * Default AudioEngine factory responsible of creating the Audio Engine.
  37833. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  37834. */
  37835. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  37836. /**
  37837. * Default offline support factory responsible of creating a tool used to store data locally.
  37838. * By default, this will create a Database object if the workload has been embedded.
  37839. */
  37840. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  37841. private _loadingScreen;
  37842. private _pointerLockRequested;
  37843. private _rescalePostProcess;
  37844. private _deterministicLockstep;
  37845. private _lockstepMaxSteps;
  37846. private _timeStep;
  37847. protected get _supportsHardwareTextureRescaling(): boolean;
  37848. private _fps;
  37849. private _deltaTime;
  37850. /** @hidden */
  37851. _drawCalls: PerfCounter;
  37852. /** Gets or sets the tab index to set to the rendering canvas. 1 is the minimum value to set to be able to capture keyboard events */
  37853. canvasTabIndex: number;
  37854. /**
  37855. * Turn this value on if you want to pause FPS computation when in background
  37856. */
  37857. disablePerformanceMonitorInBackground: boolean;
  37858. private _performanceMonitor;
  37859. /**
  37860. * Gets the performance monitor attached to this engine
  37861. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  37862. */
  37863. get performanceMonitor(): PerformanceMonitor;
  37864. private _onFocus;
  37865. private _onBlur;
  37866. private _onCanvasPointerOut;
  37867. private _onCanvasBlur;
  37868. private _onCanvasFocus;
  37869. private _onFullscreenChange;
  37870. private _onPointerLockChange;
  37871. /**
  37872. * Gets the HTML element used to attach event listeners
  37873. * @returns a HTML element
  37874. */
  37875. getInputElement(): Nullable<HTMLElement>;
  37876. /**
  37877. * Creates a new engine
  37878. * @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
  37879. * @param antialias defines enable antialiasing (default: false)
  37880. * @param options defines further options to be sent to the getContext() function
  37881. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  37882. */
  37883. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  37884. /**
  37885. * Gets current aspect ratio
  37886. * @param viewportOwner defines the camera to use to get the aspect ratio
  37887. * @param useScreen defines if screen size must be used (or the current render target if any)
  37888. * @returns a number defining the aspect ratio
  37889. */
  37890. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  37891. /**
  37892. * Gets current screen aspect ratio
  37893. * @returns a number defining the aspect ratio
  37894. */
  37895. getScreenAspectRatio(): number;
  37896. /**
  37897. * Gets the client rect of the HTML canvas attached with the current webGL context
  37898. * @returns a client rectanglee
  37899. */
  37900. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  37901. /**
  37902. * Gets the client rect of the HTML element used for events
  37903. * @returns a client rectanglee
  37904. */
  37905. getInputElementClientRect(): Nullable<ClientRect>;
  37906. /**
  37907. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  37908. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  37909. * @returns true if engine is in deterministic lock step mode
  37910. */
  37911. isDeterministicLockStep(): boolean;
  37912. /**
  37913. * Gets the max steps when engine is running in deterministic lock step
  37914. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  37915. * @returns the max steps
  37916. */
  37917. getLockstepMaxSteps(): number;
  37918. /**
  37919. * Returns the time in ms between steps when using deterministic lock step.
  37920. * @returns time step in (ms)
  37921. */
  37922. getTimeStep(): number;
  37923. /**
  37924. * Force the mipmap generation for the given render target texture
  37925. * @param texture defines the render target texture to use
  37926. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  37927. */
  37928. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  37929. /** States */
  37930. /**
  37931. * Set various states to the webGL context
  37932. * @param culling defines backface culling state
  37933. * @param zOffset defines the value to apply to zOffset (0 by default)
  37934. * @param force defines if states must be applied even if cache is up to date
  37935. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  37936. */
  37937. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  37938. /**
  37939. * Set the z offset to apply to current rendering
  37940. * @param value defines the offset to apply
  37941. */
  37942. setZOffset(value: number): void;
  37943. /**
  37944. * Gets the current value of the zOffset
  37945. * @returns the current zOffset state
  37946. */
  37947. getZOffset(): number;
  37948. /**
  37949. * Enable or disable depth buffering
  37950. * @param enable defines the state to set
  37951. */
  37952. setDepthBuffer(enable: boolean): void;
  37953. /**
  37954. * Gets a boolean indicating if depth writing is enabled
  37955. * @returns the current depth writing state
  37956. */
  37957. getDepthWrite(): boolean;
  37958. /**
  37959. * Enable or disable depth writing
  37960. * @param enable defines the state to set
  37961. */
  37962. setDepthWrite(enable: boolean): void;
  37963. /**
  37964. * Gets a boolean indicating if stencil buffer is enabled
  37965. * @returns the current stencil buffer state
  37966. */
  37967. getStencilBuffer(): boolean;
  37968. /**
  37969. * Enable or disable the stencil buffer
  37970. * @param enable defines if the stencil buffer must be enabled or disabled
  37971. */
  37972. setStencilBuffer(enable: boolean): void;
  37973. /**
  37974. * Gets the current stencil mask
  37975. * @returns a number defining the new stencil mask to use
  37976. */
  37977. getStencilMask(): number;
  37978. /**
  37979. * Sets the current stencil mask
  37980. * @param mask defines the new stencil mask to use
  37981. */
  37982. setStencilMask(mask: number): void;
  37983. /**
  37984. * Gets the current stencil function
  37985. * @returns a number defining the stencil function to use
  37986. */
  37987. getStencilFunction(): number;
  37988. /**
  37989. * Gets the current stencil reference value
  37990. * @returns a number defining the stencil reference value to use
  37991. */
  37992. getStencilFunctionReference(): number;
  37993. /**
  37994. * Gets the current stencil mask
  37995. * @returns a number defining the stencil mask to use
  37996. */
  37997. getStencilFunctionMask(): number;
  37998. /**
  37999. * Sets the current stencil function
  38000. * @param stencilFunc defines the new stencil function to use
  38001. */
  38002. setStencilFunction(stencilFunc: number): void;
  38003. /**
  38004. * Sets the current stencil reference
  38005. * @param reference defines the new stencil reference to use
  38006. */
  38007. setStencilFunctionReference(reference: number): void;
  38008. /**
  38009. * Sets the current stencil mask
  38010. * @param mask defines the new stencil mask to use
  38011. */
  38012. setStencilFunctionMask(mask: number): void;
  38013. /**
  38014. * Gets the current stencil operation when stencil fails
  38015. * @returns a number defining stencil operation to use when stencil fails
  38016. */
  38017. getStencilOperationFail(): number;
  38018. /**
  38019. * Gets the current stencil operation when depth fails
  38020. * @returns a number defining stencil operation to use when depth fails
  38021. */
  38022. getStencilOperationDepthFail(): number;
  38023. /**
  38024. * Gets the current stencil operation when stencil passes
  38025. * @returns a number defining stencil operation to use when stencil passes
  38026. */
  38027. getStencilOperationPass(): number;
  38028. /**
  38029. * Sets the stencil operation to use when stencil fails
  38030. * @param operation defines the stencil operation to use when stencil fails
  38031. */
  38032. setStencilOperationFail(operation: number): void;
  38033. /**
  38034. * Sets the stencil operation to use when depth fails
  38035. * @param operation defines the stencil operation to use when depth fails
  38036. */
  38037. setStencilOperationDepthFail(operation: number): void;
  38038. /**
  38039. * Sets the stencil operation to use when stencil passes
  38040. * @param operation defines the stencil operation to use when stencil passes
  38041. */
  38042. setStencilOperationPass(operation: number): void;
  38043. /**
  38044. * Sets a boolean indicating if the dithering state is enabled or disabled
  38045. * @param value defines the dithering state
  38046. */
  38047. setDitheringState(value: boolean): void;
  38048. /**
  38049. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  38050. * @param value defines the rasterizer state
  38051. */
  38052. setRasterizerState(value: boolean): void;
  38053. /**
  38054. * Gets the current depth function
  38055. * @returns a number defining the depth function
  38056. */
  38057. getDepthFunction(): Nullable<number>;
  38058. /**
  38059. * Sets the current depth function
  38060. * @param depthFunc defines the function to use
  38061. */
  38062. setDepthFunction(depthFunc: number): void;
  38063. /**
  38064. * Sets the current depth function to GREATER
  38065. */
  38066. setDepthFunctionToGreater(): void;
  38067. /**
  38068. * Sets the current depth function to GEQUAL
  38069. */
  38070. setDepthFunctionToGreaterOrEqual(): void;
  38071. /**
  38072. * Sets the current depth function to LESS
  38073. */
  38074. setDepthFunctionToLess(): void;
  38075. /**
  38076. * Sets the current depth function to LEQUAL
  38077. */
  38078. setDepthFunctionToLessOrEqual(): void;
  38079. private _cachedStencilBuffer;
  38080. private _cachedStencilFunction;
  38081. private _cachedStencilMask;
  38082. private _cachedStencilOperationPass;
  38083. private _cachedStencilOperationFail;
  38084. private _cachedStencilOperationDepthFail;
  38085. private _cachedStencilReference;
  38086. /**
  38087. * Caches the the state of the stencil buffer
  38088. */
  38089. cacheStencilState(): void;
  38090. /**
  38091. * Restores the state of the stencil buffer
  38092. */
  38093. restoreStencilState(): void;
  38094. /**
  38095. * Directly set the WebGL Viewport
  38096. * @param x defines the x coordinate of the viewport (in screen space)
  38097. * @param y defines the y coordinate of the viewport (in screen space)
  38098. * @param width defines the width of the viewport (in screen space)
  38099. * @param height defines the height of the viewport (in screen space)
  38100. * @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
  38101. */
  38102. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  38103. /**
  38104. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  38105. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  38106. * @param y defines the y-coordinate of the corner of the clear rectangle
  38107. * @param width defines the width of the clear rectangle
  38108. * @param height defines the height of the clear rectangle
  38109. * @param clearColor defines the clear color
  38110. */
  38111. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  38112. /**
  38113. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  38114. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  38115. * @param y defines the y-coordinate of the corner of the clear rectangle
  38116. * @param width defines the width of the clear rectangle
  38117. * @param height defines the height of the clear rectangle
  38118. */
  38119. enableScissor(x: number, y: number, width: number, height: number): void;
  38120. /**
  38121. * Disable previously set scissor test rectangle
  38122. */
  38123. disableScissor(): void;
  38124. protected _reportDrawCall(): void;
  38125. /**
  38126. * Initializes a webVR display and starts listening to display change events
  38127. * The onVRDisplayChangedObservable will be notified upon these changes
  38128. * @returns The onVRDisplayChangedObservable
  38129. */
  38130. initWebVR(): Observable<IDisplayChangedEventArgs>;
  38131. /** @hidden */
  38132. _prepareVRComponent(): void;
  38133. /** @hidden */
  38134. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  38135. /** @hidden */
  38136. _submitVRFrame(): void;
  38137. /**
  38138. * Call this function to leave webVR mode
  38139. * Will do nothing if webVR is not supported or if there is no webVR device
  38140. * @see http://doc.babylonjs.com/how_to/webvr_camera
  38141. */
  38142. disableVR(): void;
  38143. /**
  38144. * Gets a boolean indicating that the system is in VR mode and is presenting
  38145. * @returns true if VR mode is engaged
  38146. */
  38147. isVRPresenting(): boolean;
  38148. /** @hidden */
  38149. _requestVRFrame(): void;
  38150. /** @hidden */
  38151. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  38152. /**
  38153. * Gets the source code of the vertex shader associated with a specific webGL program
  38154. * @param program defines the program to use
  38155. * @returns a string containing the source code of the vertex shader associated with the program
  38156. */
  38157. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  38158. /**
  38159. * Gets the source code of the fragment shader associated with a specific webGL program
  38160. * @param program defines the program to use
  38161. * @returns a string containing the source code of the fragment shader associated with the program
  38162. */
  38163. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  38164. /**
  38165. * Sets a depth stencil texture from a render target to the according uniform.
  38166. * @param channel The texture channel
  38167. * @param uniform The uniform to set
  38168. * @param texture The render target texture containing the depth stencil texture to apply
  38169. */
  38170. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  38171. /**
  38172. * Sets a texture to the webGL context from a postprocess
  38173. * @param channel defines the channel to use
  38174. * @param postProcess defines the source postprocess
  38175. */
  38176. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  38177. /**
  38178. * Binds the output of the passed in post process to the texture channel specified
  38179. * @param channel The channel the texture should be bound to
  38180. * @param postProcess The post process which's output should be bound
  38181. */
  38182. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  38183. protected _rebuildBuffers(): void;
  38184. /** @hidden */
  38185. _renderFrame(): void;
  38186. _renderLoop(): void;
  38187. /** @hidden */
  38188. _renderViews(): boolean;
  38189. /**
  38190. * Toggle full screen mode
  38191. * @param requestPointerLock defines if a pointer lock should be requested from the user
  38192. */
  38193. switchFullscreen(requestPointerLock: boolean): void;
  38194. /**
  38195. * Enters full screen mode
  38196. * @param requestPointerLock defines if a pointer lock should be requested from the user
  38197. */
  38198. enterFullscreen(requestPointerLock: boolean): void;
  38199. /**
  38200. * Exits full screen mode
  38201. */
  38202. exitFullscreen(): void;
  38203. /**
  38204. * Enters Pointerlock mode
  38205. */
  38206. enterPointerlock(): void;
  38207. /**
  38208. * Exits Pointerlock mode
  38209. */
  38210. exitPointerlock(): void;
  38211. /**
  38212. * Begin a new frame
  38213. */
  38214. beginFrame(): void;
  38215. /**
  38216. * Enf the current frame
  38217. */
  38218. endFrame(): void;
  38219. resize(): void;
  38220. /**
  38221. * Force a specific size of the canvas
  38222. * @param width defines the new canvas' width
  38223. * @param height defines the new canvas' height
  38224. * @returns true if the size was changed
  38225. */
  38226. setSize(width: number, height: number): boolean;
  38227. /**
  38228. * Updates a dynamic vertex buffer.
  38229. * @param vertexBuffer the vertex buffer to update
  38230. * @param data the data used to update the vertex buffer
  38231. * @param byteOffset the byte offset of the data
  38232. * @param byteLength the byte length of the data
  38233. */
  38234. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  38235. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  38236. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  38237. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  38238. _releaseTexture(texture: InternalTexture): void;
  38239. /**
  38240. * @hidden
  38241. * Rescales a texture
  38242. * @param source input texutre
  38243. * @param destination destination texture
  38244. * @param scene scene to use to render the resize
  38245. * @param internalFormat format to use when resizing
  38246. * @param onComplete callback to be called when resize has completed
  38247. */
  38248. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  38249. /**
  38250. * Gets the current framerate
  38251. * @returns a number representing the framerate
  38252. */
  38253. getFps(): number;
  38254. /**
  38255. * Gets the time spent between current and previous frame
  38256. * @returns a number representing the delta time in ms
  38257. */
  38258. getDeltaTime(): number;
  38259. private _measureFps;
  38260. /** @hidden */
  38261. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  38262. /**
  38263. * Update a dynamic index buffer
  38264. * @param indexBuffer defines the target index buffer
  38265. * @param indices defines the data to update
  38266. * @param offset defines the offset in the target index buffer where update should start
  38267. */
  38268. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  38269. /**
  38270. * Updates the sample count of a render target texture
  38271. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  38272. * @param texture defines the texture to update
  38273. * @param samples defines the sample count to set
  38274. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  38275. */
  38276. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  38277. /**
  38278. * Updates a depth texture Comparison Mode and Function.
  38279. * If the comparison Function is equal to 0, the mode will be set to none.
  38280. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  38281. * @param texture The texture to set the comparison function for
  38282. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  38283. */
  38284. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  38285. /**
  38286. * Creates a webGL buffer to use with instanciation
  38287. * @param capacity defines the size of the buffer
  38288. * @returns the webGL buffer
  38289. */
  38290. createInstancesBuffer(capacity: number): DataBuffer;
  38291. /**
  38292. * Delete a webGL buffer used with instanciation
  38293. * @param buffer defines the webGL buffer to delete
  38294. */
  38295. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  38296. private _clientWaitAsync;
  38297. /** @hidden */
  38298. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  38299. dispose(): void;
  38300. private _disableTouchAction;
  38301. /**
  38302. * Display the loading screen
  38303. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38304. */
  38305. displayLoadingUI(): void;
  38306. /**
  38307. * Hide the loading screen
  38308. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38309. */
  38310. hideLoadingUI(): void;
  38311. /**
  38312. * Gets the current loading screen object
  38313. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38314. */
  38315. get loadingScreen(): ILoadingScreen;
  38316. /**
  38317. * Sets the current loading screen object
  38318. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38319. */
  38320. set loadingScreen(loadingScreen: ILoadingScreen);
  38321. /**
  38322. * Sets the current loading screen text
  38323. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38324. */
  38325. set loadingUIText(text: string);
  38326. /**
  38327. * Sets the current loading screen background color
  38328. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38329. */
  38330. set loadingUIBackgroundColor(color: string);
  38331. /** Pointerlock and fullscreen */
  38332. /**
  38333. * Ask the browser to promote the current element to pointerlock mode
  38334. * @param element defines the DOM element to promote
  38335. */
  38336. static _RequestPointerlock(element: HTMLElement): void;
  38337. /**
  38338. * Asks the browser to exit pointerlock mode
  38339. */
  38340. static _ExitPointerlock(): void;
  38341. /**
  38342. * Ask the browser to promote the current element to fullscreen rendering mode
  38343. * @param element defines the DOM element to promote
  38344. */
  38345. static _RequestFullscreen(element: HTMLElement): void;
  38346. /**
  38347. * Asks the browser to exit fullscreen mode
  38348. */
  38349. static _ExitFullscreen(): void;
  38350. }
  38351. }
  38352. declare module "babylonjs/Engines/engineStore" {
  38353. import { Nullable } from "babylonjs/types";
  38354. import { Engine } from "babylonjs/Engines/engine";
  38355. import { Scene } from "babylonjs/scene";
  38356. /**
  38357. * The engine store class is responsible to hold all the instances of Engine and Scene created
  38358. * during the life time of the application.
  38359. */
  38360. export class EngineStore {
  38361. /** Gets the list of created engines */
  38362. static Instances: import("babylonjs/Engines/engine").Engine[];
  38363. /** @hidden */
  38364. static _LastCreatedScene: Nullable<Scene>;
  38365. /**
  38366. * Gets the latest created engine
  38367. */
  38368. static get LastCreatedEngine(): Nullable<Engine>;
  38369. /**
  38370. * Gets the latest created scene
  38371. */
  38372. static get LastCreatedScene(): Nullable<Scene>;
  38373. /**
  38374. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  38375. * @ignorenaming
  38376. */
  38377. static UseFallbackTexture: boolean;
  38378. /**
  38379. * Texture content used if a texture cannot loaded
  38380. * @ignorenaming
  38381. */
  38382. static FallbackTexture: string;
  38383. }
  38384. }
  38385. declare module "babylonjs/Misc/promise" {
  38386. /**
  38387. * Helper class that provides a small promise polyfill
  38388. */
  38389. export class PromisePolyfill {
  38390. /**
  38391. * Static function used to check if the polyfill is required
  38392. * If this is the case then the function will inject the polyfill to window.Promise
  38393. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  38394. */
  38395. static Apply(force?: boolean): void;
  38396. }
  38397. }
  38398. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  38399. /**
  38400. * Interface for screenshot methods with describe argument called `size` as object with options
  38401. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  38402. */
  38403. export interface IScreenshotSize {
  38404. /**
  38405. * number in pixels for canvas height
  38406. */
  38407. height?: number;
  38408. /**
  38409. * multiplier allowing render at a higher or lower resolution
  38410. * If value is defined then height and width will be ignored and taken from camera
  38411. */
  38412. precision?: number;
  38413. /**
  38414. * number in pixels for canvas width
  38415. */
  38416. width?: number;
  38417. }
  38418. }
  38419. declare module "babylonjs/Misc/tools" {
  38420. import { Nullable, float } from "babylonjs/types";
  38421. import { DomManagement } from "babylonjs/Misc/domManagement";
  38422. import { WebRequest } from "babylonjs/Misc/webRequest";
  38423. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  38424. import { ReadFileError } from "babylonjs/Misc/fileTools";
  38425. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38426. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  38427. import { Camera } from "babylonjs/Cameras/camera";
  38428. import { Engine } from "babylonjs/Engines/engine";
  38429. interface IColor4Like {
  38430. r: float;
  38431. g: float;
  38432. b: float;
  38433. a: float;
  38434. }
  38435. /**
  38436. * Class containing a set of static utilities functions
  38437. */
  38438. export class Tools {
  38439. /**
  38440. * Gets or sets the base URL to use to load assets
  38441. */
  38442. static get BaseUrl(): string;
  38443. static set BaseUrl(value: string);
  38444. /**
  38445. * Enable/Disable Custom HTTP Request Headers globally.
  38446. * default = false
  38447. * @see CustomRequestHeaders
  38448. */
  38449. static UseCustomRequestHeaders: boolean;
  38450. /**
  38451. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  38452. * i.e. when loading files, where the server/service expects an Authorization header
  38453. */
  38454. static CustomRequestHeaders: {
  38455. [key: string]: string;
  38456. };
  38457. /**
  38458. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  38459. */
  38460. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  38461. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  38462. /**
  38463. * Default behaviour for cors in the application.
  38464. * It can be a string if the expected behavior is identical in the entire app.
  38465. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  38466. */
  38467. static get CorsBehavior(): string | ((url: string | string[]) => string);
  38468. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  38469. /**
  38470. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  38471. * @ignorenaming
  38472. */
  38473. static get UseFallbackTexture(): boolean;
  38474. static set UseFallbackTexture(value: boolean);
  38475. /**
  38476. * Use this object to register external classes like custom textures or material
  38477. * to allow the laoders to instantiate them
  38478. */
  38479. static get RegisteredExternalClasses(): {
  38480. [key: string]: Object;
  38481. };
  38482. static set RegisteredExternalClasses(classes: {
  38483. [key: string]: Object;
  38484. });
  38485. /**
  38486. * Texture content used if a texture cannot loaded
  38487. * @ignorenaming
  38488. */
  38489. static get fallbackTexture(): string;
  38490. static set fallbackTexture(value: string);
  38491. /**
  38492. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  38493. * @param u defines the coordinate on X axis
  38494. * @param v defines the coordinate on Y axis
  38495. * @param width defines the width of the source data
  38496. * @param height defines the height of the source data
  38497. * @param pixels defines the source byte array
  38498. * @param color defines the output color
  38499. */
  38500. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  38501. /**
  38502. * Interpolates between a and b via alpha
  38503. * @param a The lower value (returned when alpha = 0)
  38504. * @param b The upper value (returned when alpha = 1)
  38505. * @param alpha The interpolation-factor
  38506. * @return The mixed value
  38507. */
  38508. static Mix(a: number, b: number, alpha: number): number;
  38509. /**
  38510. * Tries to instantiate a new object from a given class name
  38511. * @param className defines the class name to instantiate
  38512. * @returns the new object or null if the system was not able to do the instantiation
  38513. */
  38514. static Instantiate(className: string): any;
  38515. /**
  38516. * Provides a slice function that will work even on IE
  38517. * @param data defines the array to slice
  38518. * @param start defines the start of the data (optional)
  38519. * @param end defines the end of the data (optional)
  38520. * @returns the new sliced array
  38521. */
  38522. static Slice<T>(data: T, start?: number, end?: number): T;
  38523. /**
  38524. * Polyfill for setImmediate
  38525. * @param action defines the action to execute after the current execution block
  38526. */
  38527. static SetImmediate(action: () => void): void;
  38528. /**
  38529. * Function indicating if a number is an exponent of 2
  38530. * @param value defines the value to test
  38531. * @returns true if the value is an exponent of 2
  38532. */
  38533. static IsExponentOfTwo(value: number): boolean;
  38534. private static _tmpFloatArray;
  38535. /**
  38536. * Returns the nearest 32-bit single precision float representation of a Number
  38537. * @param value A Number. If the parameter is of a different type, it will get converted
  38538. * to a number or to NaN if it cannot be converted
  38539. * @returns number
  38540. */
  38541. static FloatRound(value: number): number;
  38542. /**
  38543. * Extracts the filename from a path
  38544. * @param path defines the path to use
  38545. * @returns the filename
  38546. */
  38547. static GetFilename(path: string): string;
  38548. /**
  38549. * Extracts the "folder" part of a path (everything before the filename).
  38550. * @param uri The URI to extract the info from
  38551. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  38552. * @returns The "folder" part of the path
  38553. */
  38554. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  38555. /**
  38556. * Extracts text content from a DOM element hierarchy
  38557. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  38558. */
  38559. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  38560. /**
  38561. * Convert an angle in radians to degrees
  38562. * @param angle defines the angle to convert
  38563. * @returns the angle in degrees
  38564. */
  38565. static ToDegrees(angle: number): number;
  38566. /**
  38567. * Convert an angle in degrees to radians
  38568. * @param angle defines the angle to convert
  38569. * @returns the angle in radians
  38570. */
  38571. static ToRadians(angle: number): number;
  38572. /**
  38573. * Returns an array if obj is not an array
  38574. * @param obj defines the object to evaluate as an array
  38575. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  38576. * @returns either obj directly if obj is an array or a new array containing obj
  38577. */
  38578. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  38579. /**
  38580. * Gets the pointer prefix to use
  38581. * @param engine defines the engine we are finding the prefix for
  38582. * @returns "pointer" if touch is enabled. Else returns "mouse"
  38583. */
  38584. static GetPointerPrefix(engine: Engine): string;
  38585. /**
  38586. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  38587. * @param url define the url we are trying
  38588. * @param element define the dom element where to configure the cors policy
  38589. */
  38590. static SetCorsBehavior(url: string | string[], element: {
  38591. crossOrigin: string | null;
  38592. }): void;
  38593. /**
  38594. * Removes unwanted characters from an url
  38595. * @param url defines the url to clean
  38596. * @returns the cleaned url
  38597. */
  38598. static CleanUrl(url: string): string;
  38599. /**
  38600. * Gets or sets a function used to pre-process url before using them to load assets
  38601. */
  38602. static get PreprocessUrl(): (url: string) => string;
  38603. static set PreprocessUrl(processor: (url: string) => string);
  38604. /**
  38605. * Loads an image as an HTMLImageElement.
  38606. * @param input url string, ArrayBuffer, or Blob to load
  38607. * @param onLoad callback called when the image successfully loads
  38608. * @param onError callback called when the image fails to load
  38609. * @param offlineProvider offline provider for caching
  38610. * @param mimeType optional mime type
  38611. * @returns the HTMLImageElement of the loaded image
  38612. */
  38613. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  38614. /**
  38615. * Loads a file from a url
  38616. * @param url url string, ArrayBuffer, or Blob to load
  38617. * @param onSuccess callback called when the file successfully loads
  38618. * @param onProgress callback called while file is loading (if the server supports this mode)
  38619. * @param offlineProvider defines the offline provider for caching
  38620. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  38621. * @param onError callback called when the file fails to load
  38622. * @returns a file request object
  38623. */
  38624. 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;
  38625. /**
  38626. * Loads a file from a url
  38627. * @param url the file url to load
  38628. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  38629. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  38630. */
  38631. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  38632. /**
  38633. * Load a script (identified by an url). When the url returns, the
  38634. * content of this file is added into a new script element, attached to the DOM (body element)
  38635. * @param scriptUrl defines the url of the script to laod
  38636. * @param onSuccess defines the callback called when the script is loaded
  38637. * @param onError defines the callback to call if an error occurs
  38638. * @param scriptId defines the id of the script element
  38639. */
  38640. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  38641. /**
  38642. * Load an asynchronous script (identified by an url). When the url returns, the
  38643. * content of this file is added into a new script element, attached to the DOM (body element)
  38644. * @param scriptUrl defines the url of the script to laod
  38645. * @param scriptId defines the id of the script element
  38646. * @returns a promise request object
  38647. */
  38648. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  38649. /**
  38650. * Loads a file from a blob
  38651. * @param fileToLoad defines the blob to use
  38652. * @param callback defines the callback to call when data is loaded
  38653. * @param progressCallback defines the callback to call during loading process
  38654. * @returns a file request object
  38655. */
  38656. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  38657. /**
  38658. * Reads a file from a File object
  38659. * @param file defines the file to load
  38660. * @param onSuccess defines the callback to call when data is loaded
  38661. * @param onProgress defines the callback to call during loading process
  38662. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  38663. * @param onError defines the callback to call when an error occurs
  38664. * @returns a file request object
  38665. */
  38666. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  38667. /**
  38668. * Creates a data url from a given string content
  38669. * @param content defines the content to convert
  38670. * @returns the new data url link
  38671. */
  38672. static FileAsURL(content: string): string;
  38673. /**
  38674. * Format the given number to a specific decimal format
  38675. * @param value defines the number to format
  38676. * @param decimals defines the number of decimals to use
  38677. * @returns the formatted string
  38678. */
  38679. static Format(value: number, decimals?: number): string;
  38680. /**
  38681. * Tries to copy an object by duplicating every property
  38682. * @param source defines the source object
  38683. * @param destination defines the target object
  38684. * @param doNotCopyList defines a list of properties to avoid
  38685. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  38686. */
  38687. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  38688. /**
  38689. * Gets a boolean indicating if the given object has no own property
  38690. * @param obj defines the object to test
  38691. * @returns true if object has no own property
  38692. */
  38693. static IsEmpty(obj: any): boolean;
  38694. /**
  38695. * Function used to register events at window level
  38696. * @param windowElement defines the Window object to use
  38697. * @param events defines the events to register
  38698. */
  38699. static RegisterTopRootEvents(windowElement: Window, events: {
  38700. name: string;
  38701. handler: Nullable<(e: FocusEvent) => any>;
  38702. }[]): void;
  38703. /**
  38704. * Function used to unregister events from window level
  38705. * @param windowElement defines the Window object to use
  38706. * @param events defines the events to unregister
  38707. */
  38708. static UnregisterTopRootEvents(windowElement: Window, events: {
  38709. name: string;
  38710. handler: Nullable<(e: FocusEvent) => any>;
  38711. }[]): void;
  38712. /**
  38713. * @ignore
  38714. */
  38715. static _ScreenshotCanvas: HTMLCanvasElement;
  38716. /**
  38717. * Dumps the current bound framebuffer
  38718. * @param width defines the rendering width
  38719. * @param height defines the rendering height
  38720. * @param engine defines the hosting engine
  38721. * @param successCallback defines the callback triggered once the data are available
  38722. * @param mimeType defines the mime type of the result
  38723. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  38724. */
  38725. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  38726. /**
  38727. * Converts the canvas data to blob.
  38728. * This acts as a polyfill for browsers not supporting the to blob function.
  38729. * @param canvas Defines the canvas to extract the data from
  38730. * @param successCallback Defines the callback triggered once the data are available
  38731. * @param mimeType Defines the mime type of the result
  38732. */
  38733. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  38734. /**
  38735. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  38736. * @param successCallback defines the callback triggered once the data are available
  38737. * @param mimeType defines the mime type of the result
  38738. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  38739. */
  38740. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  38741. /**
  38742. * Downloads a blob in the browser
  38743. * @param blob defines the blob to download
  38744. * @param fileName defines the name of the downloaded file
  38745. */
  38746. static Download(blob: Blob, fileName: string): void;
  38747. /**
  38748. * Captures a screenshot of the current rendering
  38749. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  38750. * @param engine defines the rendering engine
  38751. * @param camera defines the source camera
  38752. * @param size This parameter can be set to a single number or to an object with the
  38753. * following (optional) properties: precision, width, height. If a single number is passed,
  38754. * it will be used for both width and height. If an object is passed, the screenshot size
  38755. * will be derived from the parameters. The precision property is a multiplier allowing
  38756. * rendering at a higher or lower resolution
  38757. * @param successCallback defines the callback receives a single parameter which contains the
  38758. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  38759. * src parameter of an <img> to display it
  38760. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  38761. * Check your browser for supported MIME types
  38762. */
  38763. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  38764. /**
  38765. * Captures a screenshot of the current rendering
  38766. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  38767. * @param engine defines the rendering engine
  38768. * @param camera defines the source camera
  38769. * @param size This parameter can be set to a single number or to an object with the
  38770. * following (optional) properties: precision, width, height. If a single number is passed,
  38771. * it will be used for both width and height. If an object is passed, the screenshot size
  38772. * will be derived from the parameters. The precision property is a multiplier allowing
  38773. * rendering at a higher or lower resolution
  38774. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  38775. * Check your browser for supported MIME types
  38776. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  38777. * to the src parameter of an <img> to display it
  38778. */
  38779. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  38780. /**
  38781. * Generates an image screenshot from the specified camera.
  38782. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  38783. * @param engine The engine to use for rendering
  38784. * @param camera The camera to use for rendering
  38785. * @param size This parameter can be set to a single number or to an object with the
  38786. * following (optional) properties: precision, width, height. If a single number is passed,
  38787. * it will be used for both width and height. If an object is passed, the screenshot size
  38788. * will be derived from the parameters. The precision property is a multiplier allowing
  38789. * rendering at a higher or lower resolution
  38790. * @param successCallback The callback receives a single parameter which contains the
  38791. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  38792. * src parameter of an <img> to display it
  38793. * @param mimeType The MIME type of the screenshot image (default: image/png).
  38794. * Check your browser for supported MIME types
  38795. * @param samples Texture samples (default: 1)
  38796. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  38797. * @param fileName A name for for the downloaded file.
  38798. */
  38799. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  38800. /**
  38801. * Generates an image screenshot from the specified camera.
  38802. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  38803. * @param engine The engine to use for rendering
  38804. * @param camera The camera to use for rendering
  38805. * @param size This parameter can be set to a single number or to an object with the
  38806. * following (optional) properties: precision, width, height. If a single number is passed,
  38807. * it will be used for both width and height. If an object is passed, the screenshot size
  38808. * will be derived from the parameters. The precision property is a multiplier allowing
  38809. * rendering at a higher or lower resolution
  38810. * @param mimeType The MIME type of the screenshot image (default: image/png).
  38811. * Check your browser for supported MIME types
  38812. * @param samples Texture samples (default: 1)
  38813. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  38814. * @param fileName A name for for the downloaded file.
  38815. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  38816. * to the src parameter of an <img> to display it
  38817. */
  38818. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  38819. /**
  38820. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  38821. * Be aware Math.random() could cause collisions, but:
  38822. * "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"
  38823. * @returns a pseudo random id
  38824. */
  38825. static RandomId(): string;
  38826. /**
  38827. * Test if the given uri is a base64 string
  38828. * @param uri The uri to test
  38829. * @return True if the uri is a base64 string or false otherwise
  38830. */
  38831. static IsBase64(uri: string): boolean;
  38832. /**
  38833. * Decode the given base64 uri.
  38834. * @param uri The uri to decode
  38835. * @return The decoded base64 data.
  38836. */
  38837. static DecodeBase64(uri: string): ArrayBuffer;
  38838. /**
  38839. * Gets the absolute url.
  38840. * @param url the input url
  38841. * @return the absolute url
  38842. */
  38843. static GetAbsoluteUrl(url: string): string;
  38844. /**
  38845. * No log
  38846. */
  38847. static readonly NoneLogLevel: number;
  38848. /**
  38849. * Only message logs
  38850. */
  38851. static readonly MessageLogLevel: number;
  38852. /**
  38853. * Only warning logs
  38854. */
  38855. static readonly WarningLogLevel: number;
  38856. /**
  38857. * Only error logs
  38858. */
  38859. static readonly ErrorLogLevel: number;
  38860. /**
  38861. * All logs
  38862. */
  38863. static readonly AllLogLevel: number;
  38864. /**
  38865. * Gets a value indicating the number of loading errors
  38866. * @ignorenaming
  38867. */
  38868. static get errorsCount(): number;
  38869. /**
  38870. * Callback called when a new log is added
  38871. */
  38872. static OnNewCacheEntry: (entry: string) => void;
  38873. /**
  38874. * Log a message to the console
  38875. * @param message defines the message to log
  38876. */
  38877. static Log(message: string): void;
  38878. /**
  38879. * Write a warning message to the console
  38880. * @param message defines the message to log
  38881. */
  38882. static Warn(message: string): void;
  38883. /**
  38884. * Write an error message to the console
  38885. * @param message defines the message to log
  38886. */
  38887. static Error(message: string): void;
  38888. /**
  38889. * Gets current log cache (list of logs)
  38890. */
  38891. static get LogCache(): string;
  38892. /**
  38893. * Clears the log cache
  38894. */
  38895. static ClearLogCache(): void;
  38896. /**
  38897. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  38898. */
  38899. static set LogLevels(level: number);
  38900. /**
  38901. * Checks if the window object exists
  38902. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  38903. */
  38904. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  38905. /**
  38906. * No performance log
  38907. */
  38908. static readonly PerformanceNoneLogLevel: number;
  38909. /**
  38910. * Use user marks to log performance
  38911. */
  38912. static readonly PerformanceUserMarkLogLevel: number;
  38913. /**
  38914. * Log performance to the console
  38915. */
  38916. static readonly PerformanceConsoleLogLevel: number;
  38917. private static _performance;
  38918. /**
  38919. * Sets the current performance log level
  38920. */
  38921. static set PerformanceLogLevel(level: number);
  38922. private static _StartPerformanceCounterDisabled;
  38923. private static _EndPerformanceCounterDisabled;
  38924. private static _StartUserMark;
  38925. private static _EndUserMark;
  38926. private static _StartPerformanceConsole;
  38927. private static _EndPerformanceConsole;
  38928. /**
  38929. * Starts a performance counter
  38930. */
  38931. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  38932. /**
  38933. * Ends a specific performance coutner
  38934. */
  38935. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  38936. /**
  38937. * Gets either window.performance.now() if supported or Date.now() else
  38938. */
  38939. static get Now(): number;
  38940. /**
  38941. * This method will return the name of the class used to create the instance of the given object.
  38942. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  38943. * @param object the object to get the class name from
  38944. * @param isType defines if the object is actually a type
  38945. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  38946. */
  38947. static GetClassName(object: any, isType?: boolean): string;
  38948. /**
  38949. * Gets the first element of an array satisfying a given predicate
  38950. * @param array defines the array to browse
  38951. * @param predicate defines the predicate to use
  38952. * @returns null if not found or the element
  38953. */
  38954. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  38955. /**
  38956. * This method will return the name of the full name of the class, including its owning module (if any).
  38957. * 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).
  38958. * @param object the object to get the class name from
  38959. * @param isType defines if the object is actually a type
  38960. * @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.
  38961. * @ignorenaming
  38962. */
  38963. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  38964. /**
  38965. * Returns a promise that resolves after the given amount of time.
  38966. * @param delay Number of milliseconds to delay
  38967. * @returns Promise that resolves after the given amount of time
  38968. */
  38969. static DelayAsync(delay: number): Promise<void>;
  38970. /**
  38971. * Utility function to detect if the current user agent is Safari
  38972. * @returns whether or not the current user agent is safari
  38973. */
  38974. static IsSafari(): boolean;
  38975. }
  38976. /**
  38977. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  38978. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  38979. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  38980. * @param name The name of the class, case should be preserved
  38981. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  38982. */
  38983. export function className(name: string, module?: string): (target: Object) => void;
  38984. /**
  38985. * An implementation of a loop for asynchronous functions.
  38986. */
  38987. export class AsyncLoop {
  38988. /**
  38989. * Defines the number of iterations for the loop
  38990. */
  38991. iterations: number;
  38992. /**
  38993. * Defines the current index of the loop.
  38994. */
  38995. index: number;
  38996. private _done;
  38997. private _fn;
  38998. private _successCallback;
  38999. /**
  39000. * Constructor.
  39001. * @param iterations the number of iterations.
  39002. * @param func the function to run each iteration
  39003. * @param successCallback the callback that will be called upon succesful execution
  39004. * @param offset starting offset.
  39005. */
  39006. constructor(
  39007. /**
  39008. * Defines the number of iterations for the loop
  39009. */
  39010. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  39011. /**
  39012. * Execute the next iteration. Must be called after the last iteration was finished.
  39013. */
  39014. executeNext(): void;
  39015. /**
  39016. * Break the loop and run the success callback.
  39017. */
  39018. breakLoop(): void;
  39019. /**
  39020. * Create and run an async loop.
  39021. * @param iterations the number of iterations.
  39022. * @param fn the function to run each iteration
  39023. * @param successCallback the callback that will be called upon succesful execution
  39024. * @param offset starting offset.
  39025. * @returns the created async loop object
  39026. */
  39027. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  39028. /**
  39029. * A for-loop that will run a given number of iterations synchronous and the rest async.
  39030. * @param iterations total number of iterations
  39031. * @param syncedIterations number of synchronous iterations in each async iteration.
  39032. * @param fn the function to call each iteration.
  39033. * @param callback a success call back that will be called when iterating stops.
  39034. * @param breakFunction a break condition (optional)
  39035. * @param timeout timeout settings for the setTimeout function. default - 0.
  39036. * @returns the created async loop object
  39037. */
  39038. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  39039. }
  39040. }
  39041. declare module "babylonjs/Misc/stringDictionary" {
  39042. import { Nullable } from "babylonjs/types";
  39043. /**
  39044. * This class implement a typical dictionary using a string as key and the generic type T as value.
  39045. * The underlying implementation relies on an associative array to ensure the best performances.
  39046. * The value can be anything including 'null' but except 'undefined'
  39047. */
  39048. export class StringDictionary<T> {
  39049. /**
  39050. * This will clear this dictionary and copy the content from the 'source' one.
  39051. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  39052. * @param source the dictionary to take the content from and copy to this dictionary
  39053. */
  39054. copyFrom(source: StringDictionary<T>): void;
  39055. /**
  39056. * Get a value based from its key
  39057. * @param key the given key to get the matching value from
  39058. * @return the value if found, otherwise undefined is returned
  39059. */
  39060. get(key: string): T | undefined;
  39061. /**
  39062. * Get a value from its key or add it if it doesn't exist.
  39063. * This method will ensure you that a given key/data will be present in the dictionary.
  39064. * @param key the given key to get the matching value from
  39065. * @param factory the factory that will create the value if the key is not present in the dictionary.
  39066. * The factory will only be invoked if there's no data for the given key.
  39067. * @return the value corresponding to the key.
  39068. */
  39069. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  39070. /**
  39071. * Get a value from its key if present in the dictionary otherwise add it
  39072. * @param key the key to get the value from
  39073. * @param val if there's no such key/value pair in the dictionary add it with this value
  39074. * @return the value corresponding to the key
  39075. */
  39076. getOrAdd(key: string, val: T): T;
  39077. /**
  39078. * Check if there's a given key in the dictionary
  39079. * @param key the key to check for
  39080. * @return true if the key is present, false otherwise
  39081. */
  39082. contains(key: string): boolean;
  39083. /**
  39084. * Add a new key and its corresponding value
  39085. * @param key the key to add
  39086. * @param value the value corresponding to the key
  39087. * @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
  39088. */
  39089. add(key: string, value: T): boolean;
  39090. /**
  39091. * Update a specific value associated to a key
  39092. * @param key defines the key to use
  39093. * @param value defines the value to store
  39094. * @returns true if the value was updated (or false if the key was not found)
  39095. */
  39096. set(key: string, value: T): boolean;
  39097. /**
  39098. * Get the element of the given key and remove it from the dictionary
  39099. * @param key defines the key to search
  39100. * @returns the value associated with the key or null if not found
  39101. */
  39102. getAndRemove(key: string): Nullable<T>;
  39103. /**
  39104. * Remove a key/value from the dictionary.
  39105. * @param key the key to remove
  39106. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  39107. */
  39108. remove(key: string): boolean;
  39109. /**
  39110. * Clear the whole content of the dictionary
  39111. */
  39112. clear(): void;
  39113. /**
  39114. * Gets the current count
  39115. */
  39116. get count(): number;
  39117. /**
  39118. * Execute a callback on each key/val of the dictionary.
  39119. * Note that you can remove any element in this dictionary in the callback implementation
  39120. * @param callback the callback to execute on a given key/value pair
  39121. */
  39122. forEach(callback: (key: string, val: T) => void): void;
  39123. /**
  39124. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  39125. * If the callback returns null or undefined the method will iterate to the next key/value pair
  39126. * Note that you can remove any element in this dictionary in the callback implementation
  39127. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  39128. * @returns the first item
  39129. */
  39130. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  39131. private _count;
  39132. private _data;
  39133. }
  39134. }
  39135. declare module "babylonjs/Collisions/collisionCoordinator" {
  39136. import { Nullable } from "babylonjs/types";
  39137. import { Scene } from "babylonjs/scene";
  39138. import { Vector3 } from "babylonjs/Maths/math.vector";
  39139. import { Collider } from "babylonjs/Collisions/collider";
  39140. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39141. /** @hidden */
  39142. export interface ICollisionCoordinator {
  39143. createCollider(): Collider;
  39144. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  39145. init(scene: Scene): void;
  39146. }
  39147. /** @hidden */
  39148. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  39149. private _scene;
  39150. private _scaledPosition;
  39151. private _scaledVelocity;
  39152. private _finalPosition;
  39153. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  39154. createCollider(): Collider;
  39155. init(scene: Scene): void;
  39156. private _collideWithWorld;
  39157. }
  39158. }
  39159. declare module "babylonjs/Inputs/scene.inputManager" {
  39160. import { Nullable } from "babylonjs/types";
  39161. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  39162. import { Vector2 } from "babylonjs/Maths/math.vector";
  39163. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39164. import { Scene } from "babylonjs/scene";
  39165. /**
  39166. * Class used to manage all inputs for the scene.
  39167. */
  39168. export class InputManager {
  39169. /** The distance in pixel that you have to move to prevent some events */
  39170. static DragMovementThreshold: number;
  39171. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  39172. static LongPressDelay: number;
  39173. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  39174. static DoubleClickDelay: number;
  39175. /** If you need to check double click without raising a single click at first click, enable this flag */
  39176. static ExclusiveDoubleClickMode: boolean;
  39177. private _wheelEventName;
  39178. private _onPointerMove;
  39179. private _onPointerDown;
  39180. private _onPointerUp;
  39181. private _initClickEvent;
  39182. private _initActionManager;
  39183. private _delayedSimpleClick;
  39184. private _delayedSimpleClickTimeout;
  39185. private _previousDelayedSimpleClickTimeout;
  39186. private _meshPickProceed;
  39187. private _previousButtonPressed;
  39188. private _currentPickResult;
  39189. private _previousPickResult;
  39190. private _totalPointersPressed;
  39191. private _doubleClickOccured;
  39192. private _pointerOverMesh;
  39193. private _pickedDownMesh;
  39194. private _pickedUpMesh;
  39195. private _pointerX;
  39196. private _pointerY;
  39197. private _unTranslatedPointerX;
  39198. private _unTranslatedPointerY;
  39199. private _startingPointerPosition;
  39200. private _previousStartingPointerPosition;
  39201. private _startingPointerTime;
  39202. private _previousStartingPointerTime;
  39203. private _pointerCaptures;
  39204. private _onKeyDown;
  39205. private _onKeyUp;
  39206. private _onCanvasFocusObserver;
  39207. private _onCanvasBlurObserver;
  39208. private _scene;
  39209. /**
  39210. * Creates a new InputManager
  39211. * @param scene defines the hosting scene
  39212. */
  39213. constructor(scene: Scene);
  39214. /**
  39215. * Gets the mesh that is currently under the pointer
  39216. */
  39217. get meshUnderPointer(): Nullable<AbstractMesh>;
  39218. /**
  39219. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  39220. */
  39221. get unTranslatedPointer(): Vector2;
  39222. /**
  39223. * Gets or sets the current on-screen X position of the pointer
  39224. */
  39225. get pointerX(): number;
  39226. set pointerX(value: number);
  39227. /**
  39228. * Gets or sets the current on-screen Y position of the pointer
  39229. */
  39230. get pointerY(): number;
  39231. set pointerY(value: number);
  39232. private _updatePointerPosition;
  39233. private _processPointerMove;
  39234. private _setRayOnPointerInfo;
  39235. private _checkPrePointerObservable;
  39236. /**
  39237. * Use this method to simulate a pointer move on a mesh
  39238. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  39239. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  39240. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  39241. */
  39242. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  39243. /**
  39244. * Use this method to simulate a pointer down on a mesh
  39245. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  39246. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  39247. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  39248. */
  39249. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  39250. private _processPointerDown;
  39251. /** @hidden */
  39252. _isPointerSwiping(): boolean;
  39253. /**
  39254. * Use this method to simulate a pointer up on a mesh
  39255. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  39256. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  39257. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  39258. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  39259. */
  39260. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  39261. private _processPointerUp;
  39262. /**
  39263. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  39264. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  39265. * @returns true if the pointer was captured
  39266. */
  39267. isPointerCaptured(pointerId?: number): boolean;
  39268. /**
  39269. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  39270. * @param attachUp defines if you want to attach events to pointerup
  39271. * @param attachDown defines if you want to attach events to pointerdown
  39272. * @param attachMove defines if you want to attach events to pointermove
  39273. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  39274. */
  39275. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  39276. /**
  39277. * Detaches all event handlers
  39278. */
  39279. detachControl(): void;
  39280. /**
  39281. * Force the value of meshUnderPointer
  39282. * @param mesh defines the mesh to use
  39283. */
  39284. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  39285. /**
  39286. * Gets the mesh under the pointer
  39287. * @returns a Mesh or null if no mesh is under the pointer
  39288. */
  39289. getPointerOverMesh(): Nullable<AbstractMesh>;
  39290. }
  39291. }
  39292. declare module "babylonjs/Animations/animationGroup" {
  39293. import { Animatable } from "babylonjs/Animations/animatable";
  39294. import { Animation } from "babylonjs/Animations/animation";
  39295. import { Scene, IDisposable } from "babylonjs/scene";
  39296. import { Observable } from "babylonjs/Misc/observable";
  39297. import { Nullable } from "babylonjs/types";
  39298. import "babylonjs/Animations/animatable";
  39299. /**
  39300. * This class defines the direct association between an animation and a target
  39301. */
  39302. export class TargetedAnimation {
  39303. /**
  39304. * Animation to perform
  39305. */
  39306. animation: Animation;
  39307. /**
  39308. * Target to animate
  39309. */
  39310. target: any;
  39311. /**
  39312. * Returns the string "TargetedAnimation"
  39313. * @returns "TargetedAnimation"
  39314. */
  39315. getClassName(): string;
  39316. /**
  39317. * Serialize the object
  39318. * @returns the JSON object representing the current entity
  39319. */
  39320. serialize(): any;
  39321. }
  39322. /**
  39323. * Use this class to create coordinated animations on multiple targets
  39324. */
  39325. export class AnimationGroup implements IDisposable {
  39326. /** The name of the animation group */
  39327. name: string;
  39328. private _scene;
  39329. private _targetedAnimations;
  39330. private _animatables;
  39331. private _from;
  39332. private _to;
  39333. private _isStarted;
  39334. private _isPaused;
  39335. private _speedRatio;
  39336. private _loopAnimation;
  39337. private _isAdditive;
  39338. /**
  39339. * Gets or sets the unique id of the node
  39340. */
  39341. uniqueId: number;
  39342. /**
  39343. * This observable will notify when one animation have ended
  39344. */
  39345. onAnimationEndObservable: Observable<TargetedAnimation>;
  39346. /**
  39347. * Observer raised when one animation loops
  39348. */
  39349. onAnimationLoopObservable: Observable<TargetedAnimation>;
  39350. /**
  39351. * Observer raised when all animations have looped
  39352. */
  39353. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  39354. /**
  39355. * This observable will notify when all animations have ended.
  39356. */
  39357. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  39358. /**
  39359. * This observable will notify when all animations have paused.
  39360. */
  39361. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  39362. /**
  39363. * This observable will notify when all animations are playing.
  39364. */
  39365. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  39366. /**
  39367. * Gets the first frame
  39368. */
  39369. get from(): number;
  39370. /**
  39371. * Gets the last frame
  39372. */
  39373. get to(): number;
  39374. /**
  39375. * Define if the animations are started
  39376. */
  39377. get isStarted(): boolean;
  39378. /**
  39379. * Gets a value indicating that the current group is playing
  39380. */
  39381. get isPlaying(): boolean;
  39382. /**
  39383. * Gets or sets the speed ratio to use for all animations
  39384. */
  39385. get speedRatio(): number;
  39386. /**
  39387. * Gets or sets the speed ratio to use for all animations
  39388. */
  39389. set speedRatio(value: number);
  39390. /**
  39391. * Gets or sets if all animations should loop or not
  39392. */
  39393. get loopAnimation(): boolean;
  39394. set loopAnimation(value: boolean);
  39395. /**
  39396. * Gets or sets if all animations should be evaluated additively
  39397. */
  39398. get isAdditive(): boolean;
  39399. set isAdditive(value: boolean);
  39400. /**
  39401. * Gets the targeted animations for this animation group
  39402. */
  39403. get targetedAnimations(): Array<TargetedAnimation>;
  39404. /**
  39405. * returning the list of animatables controlled by this animation group.
  39406. */
  39407. get animatables(): Array<Animatable>;
  39408. /**
  39409. * Gets the list of target animations
  39410. */
  39411. get children(): TargetedAnimation[];
  39412. /**
  39413. * Instantiates a new Animation Group.
  39414. * This helps managing several animations at once.
  39415. * @see http://doc.babylonjs.com/how_to/group
  39416. * @param name Defines the name of the group
  39417. * @param scene Defines the scene the group belongs to
  39418. */
  39419. constructor(
  39420. /** The name of the animation group */
  39421. name: string, scene?: Nullable<Scene>);
  39422. /**
  39423. * Add an animation (with its target) in the group
  39424. * @param animation defines the animation we want to add
  39425. * @param target defines the target of the animation
  39426. * @returns the TargetedAnimation object
  39427. */
  39428. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  39429. /**
  39430. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  39431. * It can add constant keys at begin or end
  39432. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  39433. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  39434. * @returns the animation group
  39435. */
  39436. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  39437. private _animationLoopCount;
  39438. private _animationLoopFlags;
  39439. private _processLoop;
  39440. /**
  39441. * Start all animations on given targets
  39442. * @param loop defines if animations must loop
  39443. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  39444. * @param from defines the from key (optional)
  39445. * @param to defines the to key (optional)
  39446. * @param isAdditive defines the additive state for the resulting animatables (optional)
  39447. * @returns the current animation group
  39448. */
  39449. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  39450. /**
  39451. * Pause all animations
  39452. * @returns the animation group
  39453. */
  39454. pause(): AnimationGroup;
  39455. /**
  39456. * Play all animations to initial state
  39457. * This function will start() the animations if they were not started or will restart() them if they were paused
  39458. * @param loop defines if animations must loop
  39459. * @returns the animation group
  39460. */
  39461. play(loop?: boolean): AnimationGroup;
  39462. /**
  39463. * Reset all animations to initial state
  39464. * @returns the animation group
  39465. */
  39466. reset(): AnimationGroup;
  39467. /**
  39468. * Restart animations from key 0
  39469. * @returns the animation group
  39470. */
  39471. restart(): AnimationGroup;
  39472. /**
  39473. * Stop all animations
  39474. * @returns the animation group
  39475. */
  39476. stop(): AnimationGroup;
  39477. /**
  39478. * Set animation weight for all animatables
  39479. * @param weight defines the weight to use
  39480. * @return the animationGroup
  39481. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  39482. */
  39483. setWeightForAllAnimatables(weight: number): AnimationGroup;
  39484. /**
  39485. * Synchronize and normalize all animatables with a source animatable
  39486. * @param root defines the root animatable to synchronize with
  39487. * @return the animationGroup
  39488. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  39489. */
  39490. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  39491. /**
  39492. * Goes to a specific frame in this animation group
  39493. * @param frame the frame number to go to
  39494. * @return the animationGroup
  39495. */
  39496. goToFrame(frame: number): AnimationGroup;
  39497. /**
  39498. * Dispose all associated resources
  39499. */
  39500. dispose(): void;
  39501. private _checkAnimationGroupEnded;
  39502. /**
  39503. * Clone the current animation group and returns a copy
  39504. * @param newName defines the name of the new group
  39505. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  39506. * @returns the new aniamtion group
  39507. */
  39508. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  39509. /**
  39510. * Serializes the animationGroup to an object
  39511. * @returns Serialized object
  39512. */
  39513. serialize(): any;
  39514. /**
  39515. * Returns a new AnimationGroup object parsed from the source provided.
  39516. * @param parsedAnimationGroup defines the source
  39517. * @param scene defines the scene that will receive the animationGroup
  39518. * @returns a new AnimationGroup
  39519. */
  39520. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  39521. /**
  39522. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  39523. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  39524. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  39525. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  39526. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  39527. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  39528. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  39529. */
  39530. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  39531. /**
  39532. * Returns the string "AnimationGroup"
  39533. * @returns "AnimationGroup"
  39534. */
  39535. getClassName(): string;
  39536. /**
  39537. * Creates a detailled string about the object
  39538. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  39539. * @returns a string representing the object
  39540. */
  39541. toString(fullDetails?: boolean): string;
  39542. }
  39543. }
  39544. declare module "babylonjs/scene" {
  39545. import { Nullable } from "babylonjs/types";
  39546. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  39547. import { Observable } from "babylonjs/Misc/observable";
  39548. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  39549. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  39550. import { Geometry } from "babylonjs/Meshes/geometry";
  39551. import { TransformNode } from "babylonjs/Meshes/transformNode";
  39552. import { SubMesh } from "babylonjs/Meshes/subMesh";
  39553. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39554. import { Mesh } from "babylonjs/Meshes/mesh";
  39555. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  39556. import { Bone } from "babylonjs/Bones/bone";
  39557. import { Skeleton } from "babylonjs/Bones/skeleton";
  39558. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  39559. import { Camera } from "babylonjs/Cameras/camera";
  39560. import { AbstractScene } from "babylonjs/abstractScene";
  39561. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  39562. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  39563. import { Material } from "babylonjs/Materials/material";
  39564. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  39565. import { Effect } from "babylonjs/Materials/effect";
  39566. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  39567. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  39568. import { Light } from "babylonjs/Lights/light";
  39569. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  39570. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  39571. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  39572. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  39573. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  39574. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  39575. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39576. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  39577. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  39578. import { Engine } from "babylonjs/Engines/engine";
  39579. import { Node } from "babylonjs/node";
  39580. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  39581. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  39582. import { WebRequest } from "babylonjs/Misc/webRequest";
  39583. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  39584. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  39585. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39586. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  39587. import { Plane } from "babylonjs/Maths/math.plane";
  39588. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  39589. import { Ray } from "babylonjs/Culling/ray";
  39590. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  39591. import { Animation } from "babylonjs/Animations/animation";
  39592. import { Animatable } from "babylonjs/Animations/animatable";
  39593. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  39594. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  39595. import { Collider } from "babylonjs/Collisions/collider";
  39596. /**
  39597. * Define an interface for all classes that will hold resources
  39598. */
  39599. export interface IDisposable {
  39600. /**
  39601. * Releases all held resources
  39602. */
  39603. dispose(): void;
  39604. }
  39605. /** Interface defining initialization parameters for Scene class */
  39606. export interface SceneOptions {
  39607. /**
  39608. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  39609. * It will improve performance when the number of geometries becomes important.
  39610. */
  39611. useGeometryUniqueIdsMap?: boolean;
  39612. /**
  39613. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  39614. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  39615. */
  39616. useMaterialMeshMap?: boolean;
  39617. /**
  39618. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  39619. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  39620. */
  39621. useClonedMeshMap?: boolean;
  39622. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  39623. virtual?: boolean;
  39624. }
  39625. /**
  39626. * Represents a scene to be rendered by the engine.
  39627. * @see http://doc.babylonjs.com/features/scene
  39628. */
  39629. export class Scene extends AbstractScene implements IAnimatable {
  39630. /** The fog is deactivated */
  39631. static readonly FOGMODE_NONE: number;
  39632. /** The fog density is following an exponential function */
  39633. static readonly FOGMODE_EXP: number;
  39634. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  39635. static readonly FOGMODE_EXP2: number;
  39636. /** The fog density is following a linear function. */
  39637. static readonly FOGMODE_LINEAR: number;
  39638. /**
  39639. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  39640. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  39641. */
  39642. static MinDeltaTime: number;
  39643. /**
  39644. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  39645. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  39646. */
  39647. static MaxDeltaTime: number;
  39648. /**
  39649. * Factory used to create the default material.
  39650. * @param name The name of the material to create
  39651. * @param scene The scene to create the material for
  39652. * @returns The default material
  39653. */
  39654. static DefaultMaterialFactory(scene: Scene): Material;
  39655. /**
  39656. * Factory used to create the a collision coordinator.
  39657. * @returns The collision coordinator
  39658. */
  39659. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  39660. /** @hidden */
  39661. _inputManager: InputManager;
  39662. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  39663. cameraToUseForPointers: Nullable<Camera>;
  39664. /** @hidden */
  39665. readonly _isScene: boolean;
  39666. /** @hidden */
  39667. _blockEntityCollection: boolean;
  39668. /**
  39669. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  39670. */
  39671. autoClear: boolean;
  39672. /**
  39673. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  39674. */
  39675. autoClearDepthAndStencil: boolean;
  39676. /**
  39677. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  39678. */
  39679. clearColor: Color4;
  39680. /**
  39681. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  39682. */
  39683. ambientColor: Color3;
  39684. /**
  39685. * This is use to store the default BRDF lookup for PBR materials in your scene.
  39686. * It should only be one of the following (if not the default embedded one):
  39687. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  39688. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  39689. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  39690. * The material properties need to be setup according to the type of texture in use.
  39691. */
  39692. environmentBRDFTexture: BaseTexture;
  39693. /** @hidden */
  39694. protected _environmentTexture: Nullable<BaseTexture>;
  39695. /**
  39696. * Texture used in all pbr material as the reflection texture.
  39697. * As in the majority of the scene they are the same (exception for multi room and so on),
  39698. * this is easier to reference from here than from all the materials.
  39699. */
  39700. get environmentTexture(): Nullable<BaseTexture>;
  39701. /**
  39702. * Texture used in all pbr material as the reflection texture.
  39703. * As in the majority of the scene they are the same (exception for multi room and so on),
  39704. * this is easier to set here than in all the materials.
  39705. */
  39706. set environmentTexture(value: Nullable<BaseTexture>);
  39707. /** @hidden */
  39708. protected _environmentIntensity: number;
  39709. /**
  39710. * Intensity of the environment in all pbr material.
  39711. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  39712. * As in the majority of the scene they are the same (exception for multi room and so on),
  39713. * this is easier to reference from here than from all the materials.
  39714. */
  39715. get environmentIntensity(): number;
  39716. /**
  39717. * Intensity of the environment in all pbr material.
  39718. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  39719. * As in the majority of the scene they are the same (exception for multi room and so on),
  39720. * this is easier to set here than in all the materials.
  39721. */
  39722. set environmentIntensity(value: number);
  39723. /** @hidden */
  39724. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  39725. /**
  39726. * Default image processing configuration used either in the rendering
  39727. * Forward main pass or through the imageProcessingPostProcess if present.
  39728. * As in the majority of the scene they are the same (exception for multi camera),
  39729. * this is easier to reference from here than from all the materials and post process.
  39730. *
  39731. * No setter as we it is a shared configuration, you can set the values instead.
  39732. */
  39733. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  39734. private _forceWireframe;
  39735. /**
  39736. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  39737. */
  39738. set forceWireframe(value: boolean);
  39739. get forceWireframe(): boolean;
  39740. private _skipFrustumClipping;
  39741. /**
  39742. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  39743. */
  39744. set skipFrustumClipping(value: boolean);
  39745. get skipFrustumClipping(): boolean;
  39746. private _forcePointsCloud;
  39747. /**
  39748. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  39749. */
  39750. set forcePointsCloud(value: boolean);
  39751. get forcePointsCloud(): boolean;
  39752. /**
  39753. * Gets or sets the active clipplane 1
  39754. */
  39755. clipPlane: Nullable<Plane>;
  39756. /**
  39757. * Gets or sets the active clipplane 2
  39758. */
  39759. clipPlane2: Nullable<Plane>;
  39760. /**
  39761. * Gets or sets the active clipplane 3
  39762. */
  39763. clipPlane3: Nullable<Plane>;
  39764. /**
  39765. * Gets or sets the active clipplane 4
  39766. */
  39767. clipPlane4: Nullable<Plane>;
  39768. /**
  39769. * Gets or sets the active clipplane 5
  39770. */
  39771. clipPlane5: Nullable<Plane>;
  39772. /**
  39773. * Gets or sets the active clipplane 6
  39774. */
  39775. clipPlane6: Nullable<Plane>;
  39776. /**
  39777. * Gets or sets a boolean indicating if animations are enabled
  39778. */
  39779. animationsEnabled: boolean;
  39780. private _animationPropertiesOverride;
  39781. /**
  39782. * Gets or sets the animation properties override
  39783. */
  39784. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  39785. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  39786. /**
  39787. * Gets or sets a boolean indicating if a constant deltatime has to be used
  39788. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  39789. */
  39790. useConstantAnimationDeltaTime: boolean;
  39791. /**
  39792. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  39793. * Please note that it requires to run a ray cast through the scene on every frame
  39794. */
  39795. constantlyUpdateMeshUnderPointer: boolean;
  39796. /**
  39797. * Defines the HTML cursor to use when hovering over interactive elements
  39798. */
  39799. hoverCursor: string;
  39800. /**
  39801. * Defines the HTML default cursor to use (empty by default)
  39802. */
  39803. defaultCursor: string;
  39804. /**
  39805. * Defines whether cursors are handled by the scene.
  39806. */
  39807. doNotHandleCursors: boolean;
  39808. /**
  39809. * This is used to call preventDefault() on pointer down
  39810. * in order to block unwanted artifacts like system double clicks
  39811. */
  39812. preventDefaultOnPointerDown: boolean;
  39813. /**
  39814. * This is used to call preventDefault() on pointer up
  39815. * in order to block unwanted artifacts like system double clicks
  39816. */
  39817. preventDefaultOnPointerUp: boolean;
  39818. /**
  39819. * Gets or sets user defined metadata
  39820. */
  39821. metadata: any;
  39822. /**
  39823. * For internal use only. Please do not use.
  39824. */
  39825. reservedDataStore: any;
  39826. /**
  39827. * Gets the name of the plugin used to load this scene (null by default)
  39828. */
  39829. loadingPluginName: string;
  39830. /**
  39831. * Use this array to add regular expressions used to disable offline support for specific urls
  39832. */
  39833. disableOfflineSupportExceptionRules: RegExp[];
  39834. /**
  39835. * An event triggered when the scene is disposed.
  39836. */
  39837. onDisposeObservable: Observable<Scene>;
  39838. private _onDisposeObserver;
  39839. /** Sets a function to be executed when this scene is disposed. */
  39840. set onDispose(callback: () => void);
  39841. /**
  39842. * An event triggered before rendering the scene (right after animations and physics)
  39843. */
  39844. onBeforeRenderObservable: Observable<Scene>;
  39845. private _onBeforeRenderObserver;
  39846. /** Sets a function to be executed before rendering this scene */
  39847. set beforeRender(callback: Nullable<() => void>);
  39848. /**
  39849. * An event triggered after rendering the scene
  39850. */
  39851. onAfterRenderObservable: Observable<Scene>;
  39852. /**
  39853. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  39854. */
  39855. onAfterRenderCameraObservable: Observable<Camera>;
  39856. private _onAfterRenderObserver;
  39857. /** Sets a function to be executed after rendering this scene */
  39858. set afterRender(callback: Nullable<() => void>);
  39859. /**
  39860. * An event triggered before animating the scene
  39861. */
  39862. onBeforeAnimationsObservable: Observable<Scene>;
  39863. /**
  39864. * An event triggered after animations processing
  39865. */
  39866. onAfterAnimationsObservable: Observable<Scene>;
  39867. /**
  39868. * An event triggered before draw calls are ready to be sent
  39869. */
  39870. onBeforeDrawPhaseObservable: Observable<Scene>;
  39871. /**
  39872. * An event triggered after draw calls have been sent
  39873. */
  39874. onAfterDrawPhaseObservable: Observable<Scene>;
  39875. /**
  39876. * An event triggered when the scene is ready
  39877. */
  39878. onReadyObservable: Observable<Scene>;
  39879. /**
  39880. * An event triggered before rendering a camera
  39881. */
  39882. onBeforeCameraRenderObservable: Observable<Camera>;
  39883. private _onBeforeCameraRenderObserver;
  39884. /** Sets a function to be executed before rendering a camera*/
  39885. set beforeCameraRender(callback: () => void);
  39886. /**
  39887. * An event triggered after rendering a camera
  39888. */
  39889. onAfterCameraRenderObservable: Observable<Camera>;
  39890. private _onAfterCameraRenderObserver;
  39891. /** Sets a function to be executed after rendering a camera*/
  39892. set afterCameraRender(callback: () => void);
  39893. /**
  39894. * An event triggered when active meshes evaluation is about to start
  39895. */
  39896. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  39897. /**
  39898. * An event triggered when active meshes evaluation is done
  39899. */
  39900. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  39901. /**
  39902. * An event triggered when particles rendering is about to start
  39903. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  39904. */
  39905. onBeforeParticlesRenderingObservable: Observable<Scene>;
  39906. /**
  39907. * An event triggered when particles rendering is done
  39908. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  39909. */
  39910. onAfterParticlesRenderingObservable: Observable<Scene>;
  39911. /**
  39912. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  39913. */
  39914. onDataLoadedObservable: Observable<Scene>;
  39915. /**
  39916. * An event triggered when a camera is created
  39917. */
  39918. onNewCameraAddedObservable: Observable<Camera>;
  39919. /**
  39920. * An event triggered when a camera is removed
  39921. */
  39922. onCameraRemovedObservable: Observable<Camera>;
  39923. /**
  39924. * An event triggered when a light is created
  39925. */
  39926. onNewLightAddedObservable: Observable<Light>;
  39927. /**
  39928. * An event triggered when a light is removed
  39929. */
  39930. onLightRemovedObservable: Observable<Light>;
  39931. /**
  39932. * An event triggered when a geometry is created
  39933. */
  39934. onNewGeometryAddedObservable: Observable<Geometry>;
  39935. /**
  39936. * An event triggered when a geometry is removed
  39937. */
  39938. onGeometryRemovedObservable: Observable<Geometry>;
  39939. /**
  39940. * An event triggered when a transform node is created
  39941. */
  39942. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  39943. /**
  39944. * An event triggered when a transform node is removed
  39945. */
  39946. onTransformNodeRemovedObservable: Observable<TransformNode>;
  39947. /**
  39948. * An event triggered when a mesh is created
  39949. */
  39950. onNewMeshAddedObservable: Observable<AbstractMesh>;
  39951. /**
  39952. * An event triggered when a mesh is removed
  39953. */
  39954. onMeshRemovedObservable: Observable<AbstractMesh>;
  39955. /**
  39956. * An event triggered when a skeleton is created
  39957. */
  39958. onNewSkeletonAddedObservable: Observable<Skeleton>;
  39959. /**
  39960. * An event triggered when a skeleton is removed
  39961. */
  39962. onSkeletonRemovedObservable: Observable<Skeleton>;
  39963. /**
  39964. * An event triggered when a material is created
  39965. */
  39966. onNewMaterialAddedObservable: Observable<Material>;
  39967. /**
  39968. * An event triggered when a material is removed
  39969. */
  39970. onMaterialRemovedObservable: Observable<Material>;
  39971. /**
  39972. * An event triggered when a texture is created
  39973. */
  39974. onNewTextureAddedObservable: Observable<BaseTexture>;
  39975. /**
  39976. * An event triggered when a texture is removed
  39977. */
  39978. onTextureRemovedObservable: Observable<BaseTexture>;
  39979. /**
  39980. * An event triggered when render targets are about to be rendered
  39981. * Can happen multiple times per frame.
  39982. */
  39983. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  39984. /**
  39985. * An event triggered when render targets were rendered.
  39986. * Can happen multiple times per frame.
  39987. */
  39988. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  39989. /**
  39990. * An event triggered before calculating deterministic simulation step
  39991. */
  39992. onBeforeStepObservable: Observable<Scene>;
  39993. /**
  39994. * An event triggered after calculating deterministic simulation step
  39995. */
  39996. onAfterStepObservable: Observable<Scene>;
  39997. /**
  39998. * An event triggered when the activeCamera property is updated
  39999. */
  40000. onActiveCameraChanged: Observable<Scene>;
  40001. /**
  40002. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  40003. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  40004. * 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)
  40005. */
  40006. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  40007. /**
  40008. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  40009. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  40010. * 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)
  40011. */
  40012. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  40013. /**
  40014. * This Observable will when a mesh has been imported into the scene.
  40015. */
  40016. onMeshImportedObservable: Observable<AbstractMesh>;
  40017. /**
  40018. * This Observable will when an animation file has been imported into the scene.
  40019. */
  40020. onAnimationFileImportedObservable: Observable<Scene>;
  40021. /**
  40022. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  40023. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  40024. */
  40025. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  40026. /** @hidden */
  40027. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  40028. /**
  40029. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  40030. */
  40031. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  40032. /**
  40033. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  40034. */
  40035. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  40036. /**
  40037. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  40038. */
  40039. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  40040. /** Callback called when a pointer move is detected */
  40041. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  40042. /** Callback called when a pointer down is detected */
  40043. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  40044. /** Callback called when a pointer up is detected */
  40045. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  40046. /** Callback called when a pointer pick is detected */
  40047. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  40048. /**
  40049. * 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).
  40050. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  40051. */
  40052. onPrePointerObservable: Observable<PointerInfoPre>;
  40053. /**
  40054. * Observable event triggered each time an input event is received from the rendering canvas
  40055. */
  40056. onPointerObservable: Observable<PointerInfo>;
  40057. /**
  40058. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  40059. */
  40060. get unTranslatedPointer(): Vector2;
  40061. /**
  40062. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  40063. */
  40064. static get DragMovementThreshold(): number;
  40065. static set DragMovementThreshold(value: number);
  40066. /**
  40067. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  40068. */
  40069. static get LongPressDelay(): number;
  40070. static set LongPressDelay(value: number);
  40071. /**
  40072. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  40073. */
  40074. static get DoubleClickDelay(): number;
  40075. static set DoubleClickDelay(value: number);
  40076. /** If you need to check double click without raising a single click at first click, enable this flag */
  40077. static get ExclusiveDoubleClickMode(): boolean;
  40078. static set ExclusiveDoubleClickMode(value: boolean);
  40079. /** @hidden */
  40080. _mirroredCameraPosition: Nullable<Vector3>;
  40081. /**
  40082. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  40083. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  40084. */
  40085. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  40086. /**
  40087. * Observable event triggered each time an keyboard event is received from the hosting window
  40088. */
  40089. onKeyboardObservable: Observable<KeyboardInfo>;
  40090. private _useRightHandedSystem;
  40091. /**
  40092. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  40093. */
  40094. set useRightHandedSystem(value: boolean);
  40095. get useRightHandedSystem(): boolean;
  40096. private _timeAccumulator;
  40097. private _currentStepId;
  40098. private _currentInternalStep;
  40099. /**
  40100. * Sets the step Id used by deterministic lock step
  40101. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40102. * @param newStepId defines the step Id
  40103. */
  40104. setStepId(newStepId: number): void;
  40105. /**
  40106. * Gets the step Id used by deterministic lock step
  40107. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40108. * @returns the step Id
  40109. */
  40110. getStepId(): number;
  40111. /**
  40112. * Gets the internal step used by deterministic lock step
  40113. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40114. * @returns the internal step
  40115. */
  40116. getInternalStep(): number;
  40117. private _fogEnabled;
  40118. /**
  40119. * Gets or sets a boolean indicating if fog is enabled on this scene
  40120. * @see http://doc.babylonjs.com/babylon101/environment#fog
  40121. * (Default is true)
  40122. */
  40123. set fogEnabled(value: boolean);
  40124. get fogEnabled(): boolean;
  40125. private _fogMode;
  40126. /**
  40127. * Gets or sets the fog mode to use
  40128. * @see http://doc.babylonjs.com/babylon101/environment#fog
  40129. * | mode | value |
  40130. * | --- | --- |
  40131. * | FOGMODE_NONE | 0 |
  40132. * | FOGMODE_EXP | 1 |
  40133. * | FOGMODE_EXP2 | 2 |
  40134. * | FOGMODE_LINEAR | 3 |
  40135. */
  40136. set fogMode(value: number);
  40137. get fogMode(): number;
  40138. /**
  40139. * Gets or sets the fog color to use
  40140. * @see http://doc.babylonjs.com/babylon101/environment#fog
  40141. * (Default is Color3(0.2, 0.2, 0.3))
  40142. */
  40143. fogColor: Color3;
  40144. /**
  40145. * Gets or sets the fog density to use
  40146. * @see http://doc.babylonjs.com/babylon101/environment#fog
  40147. * (Default is 0.1)
  40148. */
  40149. fogDensity: number;
  40150. /**
  40151. * Gets or sets the fog start distance to use
  40152. * @see http://doc.babylonjs.com/babylon101/environment#fog
  40153. * (Default is 0)
  40154. */
  40155. fogStart: number;
  40156. /**
  40157. * Gets or sets the fog end distance to use
  40158. * @see http://doc.babylonjs.com/babylon101/environment#fog
  40159. * (Default is 1000)
  40160. */
  40161. fogEnd: number;
  40162. private _shadowsEnabled;
  40163. /**
  40164. * Gets or sets a boolean indicating if shadows are enabled on this scene
  40165. */
  40166. set shadowsEnabled(value: boolean);
  40167. get shadowsEnabled(): boolean;
  40168. private _lightsEnabled;
  40169. /**
  40170. * Gets or sets a boolean indicating if lights are enabled on this scene
  40171. */
  40172. set lightsEnabled(value: boolean);
  40173. get lightsEnabled(): boolean;
  40174. /** All of the active cameras added to this scene. */
  40175. activeCameras: Camera[];
  40176. /** @hidden */
  40177. _activeCamera: Nullable<Camera>;
  40178. /** Gets or sets the current active camera */
  40179. get activeCamera(): Nullable<Camera>;
  40180. set activeCamera(value: Nullable<Camera>);
  40181. private _defaultMaterial;
  40182. /** The default material used on meshes when no material is affected */
  40183. get defaultMaterial(): Material;
  40184. /** The default material used on meshes when no material is affected */
  40185. set defaultMaterial(value: Material);
  40186. private _texturesEnabled;
  40187. /**
  40188. * Gets or sets a boolean indicating if textures are enabled on this scene
  40189. */
  40190. set texturesEnabled(value: boolean);
  40191. get texturesEnabled(): boolean;
  40192. /**
  40193. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  40194. */
  40195. physicsEnabled: boolean;
  40196. /**
  40197. * Gets or sets a boolean indicating if particles are enabled on this scene
  40198. */
  40199. particlesEnabled: boolean;
  40200. /**
  40201. * Gets or sets a boolean indicating if sprites are enabled on this scene
  40202. */
  40203. spritesEnabled: boolean;
  40204. private _skeletonsEnabled;
  40205. /**
  40206. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  40207. */
  40208. set skeletonsEnabled(value: boolean);
  40209. get skeletonsEnabled(): boolean;
  40210. /**
  40211. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  40212. */
  40213. lensFlaresEnabled: boolean;
  40214. /**
  40215. * Gets or sets a boolean indicating if collisions are enabled on this scene
  40216. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  40217. */
  40218. collisionsEnabled: boolean;
  40219. private _collisionCoordinator;
  40220. /** @hidden */
  40221. get collisionCoordinator(): ICollisionCoordinator;
  40222. /**
  40223. * Defines the gravity applied to this scene (used only for collisions)
  40224. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  40225. */
  40226. gravity: Vector3;
  40227. /**
  40228. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  40229. */
  40230. postProcessesEnabled: boolean;
  40231. /**
  40232. * The list of postprocesses added to the scene
  40233. */
  40234. postProcesses: PostProcess[];
  40235. /**
  40236. * Gets the current postprocess manager
  40237. */
  40238. postProcessManager: PostProcessManager;
  40239. /**
  40240. * Gets or sets a boolean indicating if render targets are enabled on this scene
  40241. */
  40242. renderTargetsEnabled: boolean;
  40243. /**
  40244. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  40245. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  40246. */
  40247. dumpNextRenderTargets: boolean;
  40248. /**
  40249. * The list of user defined render targets added to the scene
  40250. */
  40251. customRenderTargets: RenderTargetTexture[];
  40252. /**
  40253. * Defines if texture loading must be delayed
  40254. * If true, textures will only be loaded when they need to be rendered
  40255. */
  40256. useDelayedTextureLoading: boolean;
  40257. /**
  40258. * Gets the list of meshes imported to the scene through SceneLoader
  40259. */
  40260. importedMeshesFiles: String[];
  40261. /**
  40262. * Gets or sets a boolean indicating if probes are enabled on this scene
  40263. */
  40264. probesEnabled: boolean;
  40265. /**
  40266. * Gets or sets the current offline provider to use to store scene data
  40267. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  40268. */
  40269. offlineProvider: IOfflineProvider;
  40270. /**
  40271. * Gets or sets the action manager associated with the scene
  40272. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  40273. */
  40274. actionManager: AbstractActionManager;
  40275. private _meshesForIntersections;
  40276. /**
  40277. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  40278. */
  40279. proceduralTexturesEnabled: boolean;
  40280. private _engine;
  40281. private _totalVertices;
  40282. /** @hidden */
  40283. _activeIndices: PerfCounter;
  40284. /** @hidden */
  40285. _activeParticles: PerfCounter;
  40286. /** @hidden */
  40287. _activeBones: PerfCounter;
  40288. private _animationRatio;
  40289. /** @hidden */
  40290. _animationTimeLast: number;
  40291. /** @hidden */
  40292. _animationTime: number;
  40293. /**
  40294. * Gets or sets a general scale for animation speed
  40295. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  40296. */
  40297. animationTimeScale: number;
  40298. /** @hidden */
  40299. _cachedMaterial: Nullable<Material>;
  40300. /** @hidden */
  40301. _cachedEffect: Nullable<Effect>;
  40302. /** @hidden */
  40303. _cachedVisibility: Nullable<number>;
  40304. private _renderId;
  40305. private _frameId;
  40306. private _executeWhenReadyTimeoutId;
  40307. private _intermediateRendering;
  40308. private _viewUpdateFlag;
  40309. private _projectionUpdateFlag;
  40310. /** @hidden */
  40311. _toBeDisposed: Nullable<IDisposable>[];
  40312. private _activeRequests;
  40313. /** @hidden */
  40314. _pendingData: any[];
  40315. private _isDisposed;
  40316. /**
  40317. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  40318. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  40319. */
  40320. dispatchAllSubMeshesOfActiveMeshes: boolean;
  40321. private _activeMeshes;
  40322. private _processedMaterials;
  40323. private _renderTargets;
  40324. /** @hidden */
  40325. _activeParticleSystems: SmartArray<IParticleSystem>;
  40326. private _activeSkeletons;
  40327. private _softwareSkinnedMeshes;
  40328. private _renderingManager;
  40329. /** @hidden */
  40330. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  40331. private _transformMatrix;
  40332. private _sceneUbo;
  40333. /** @hidden */
  40334. _viewMatrix: Matrix;
  40335. private _projectionMatrix;
  40336. /** @hidden */
  40337. _forcedViewPosition: Nullable<Vector3>;
  40338. /** @hidden */
  40339. _frustumPlanes: Plane[];
  40340. /**
  40341. * Gets the list of frustum planes (built from the active camera)
  40342. */
  40343. get frustumPlanes(): Plane[];
  40344. /**
  40345. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  40346. * This is useful if there are more lights that the maximum simulteanous authorized
  40347. */
  40348. requireLightSorting: boolean;
  40349. /** @hidden */
  40350. readonly useMaterialMeshMap: boolean;
  40351. /** @hidden */
  40352. readonly useClonedMeshMap: boolean;
  40353. private _externalData;
  40354. private _uid;
  40355. /**
  40356. * @hidden
  40357. * Backing store of defined scene components.
  40358. */
  40359. _components: ISceneComponent[];
  40360. /**
  40361. * @hidden
  40362. * Backing store of defined scene components.
  40363. */
  40364. _serializableComponents: ISceneSerializableComponent[];
  40365. /**
  40366. * List of components to register on the next registration step.
  40367. */
  40368. private _transientComponents;
  40369. /**
  40370. * Registers the transient components if needed.
  40371. */
  40372. private _registerTransientComponents;
  40373. /**
  40374. * @hidden
  40375. * Add a component to the scene.
  40376. * Note that the ccomponent could be registered on th next frame if this is called after
  40377. * the register component stage.
  40378. * @param component Defines the component to add to the scene
  40379. */
  40380. _addComponent(component: ISceneComponent): void;
  40381. /**
  40382. * @hidden
  40383. * Gets a component from the scene.
  40384. * @param name defines the name of the component to retrieve
  40385. * @returns the component or null if not present
  40386. */
  40387. _getComponent(name: string): Nullable<ISceneComponent>;
  40388. /**
  40389. * @hidden
  40390. * Defines the actions happening before camera updates.
  40391. */
  40392. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  40393. /**
  40394. * @hidden
  40395. * Defines the actions happening before clear the canvas.
  40396. */
  40397. _beforeClearStage: Stage<SimpleStageAction>;
  40398. /**
  40399. * @hidden
  40400. * Defines the actions when collecting render targets for the frame.
  40401. */
  40402. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  40403. /**
  40404. * @hidden
  40405. * Defines the actions happening for one camera in the frame.
  40406. */
  40407. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  40408. /**
  40409. * @hidden
  40410. * Defines the actions happening during the per mesh ready checks.
  40411. */
  40412. _isReadyForMeshStage: Stage<MeshStageAction>;
  40413. /**
  40414. * @hidden
  40415. * Defines the actions happening before evaluate active mesh checks.
  40416. */
  40417. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  40418. /**
  40419. * @hidden
  40420. * Defines the actions happening during the evaluate sub mesh checks.
  40421. */
  40422. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  40423. /**
  40424. * @hidden
  40425. * Defines the actions happening during the active mesh stage.
  40426. */
  40427. _activeMeshStage: Stage<ActiveMeshStageAction>;
  40428. /**
  40429. * @hidden
  40430. * Defines the actions happening during the per camera render target step.
  40431. */
  40432. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  40433. /**
  40434. * @hidden
  40435. * Defines the actions happening just before the active camera is drawing.
  40436. */
  40437. _beforeCameraDrawStage: Stage<CameraStageAction>;
  40438. /**
  40439. * @hidden
  40440. * Defines the actions happening just before a render target is drawing.
  40441. */
  40442. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  40443. /**
  40444. * @hidden
  40445. * Defines the actions happening just before a rendering group is drawing.
  40446. */
  40447. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  40448. /**
  40449. * @hidden
  40450. * Defines the actions happening just before a mesh is drawing.
  40451. */
  40452. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  40453. /**
  40454. * @hidden
  40455. * Defines the actions happening just after a mesh has been drawn.
  40456. */
  40457. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  40458. /**
  40459. * @hidden
  40460. * Defines the actions happening just after a rendering group has been drawn.
  40461. */
  40462. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  40463. /**
  40464. * @hidden
  40465. * Defines the actions happening just after the active camera has been drawn.
  40466. */
  40467. _afterCameraDrawStage: Stage<CameraStageAction>;
  40468. /**
  40469. * @hidden
  40470. * Defines the actions happening just after a render target has been drawn.
  40471. */
  40472. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  40473. /**
  40474. * @hidden
  40475. * Defines the actions happening just after rendering all cameras and computing intersections.
  40476. */
  40477. _afterRenderStage: Stage<SimpleStageAction>;
  40478. /**
  40479. * @hidden
  40480. * Defines the actions happening when a pointer move event happens.
  40481. */
  40482. _pointerMoveStage: Stage<PointerMoveStageAction>;
  40483. /**
  40484. * @hidden
  40485. * Defines the actions happening when a pointer down event happens.
  40486. */
  40487. _pointerDownStage: Stage<PointerUpDownStageAction>;
  40488. /**
  40489. * @hidden
  40490. * Defines the actions happening when a pointer up event happens.
  40491. */
  40492. _pointerUpStage: Stage<PointerUpDownStageAction>;
  40493. /**
  40494. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  40495. */
  40496. private geometriesByUniqueId;
  40497. /**
  40498. * Creates a new Scene
  40499. * @param engine defines the engine to use to render this scene
  40500. * @param options defines the scene options
  40501. */
  40502. constructor(engine: Engine, options?: SceneOptions);
  40503. /**
  40504. * Gets a string idenfifying the name of the class
  40505. * @returns "Scene" string
  40506. */
  40507. getClassName(): string;
  40508. private _defaultMeshCandidates;
  40509. /**
  40510. * @hidden
  40511. */
  40512. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  40513. private _defaultSubMeshCandidates;
  40514. /**
  40515. * @hidden
  40516. */
  40517. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  40518. /**
  40519. * Sets the default candidate providers for the scene.
  40520. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  40521. * and getCollidingSubMeshCandidates to their default function
  40522. */
  40523. setDefaultCandidateProviders(): void;
  40524. /**
  40525. * Gets the mesh that is currently under the pointer
  40526. */
  40527. get meshUnderPointer(): Nullable<AbstractMesh>;
  40528. /**
  40529. * Gets or sets the current on-screen X position of the pointer
  40530. */
  40531. get pointerX(): number;
  40532. set pointerX(value: number);
  40533. /**
  40534. * Gets or sets the current on-screen Y position of the pointer
  40535. */
  40536. get pointerY(): number;
  40537. set pointerY(value: number);
  40538. /**
  40539. * Gets the cached material (ie. the latest rendered one)
  40540. * @returns the cached material
  40541. */
  40542. getCachedMaterial(): Nullable<Material>;
  40543. /**
  40544. * Gets the cached effect (ie. the latest rendered one)
  40545. * @returns the cached effect
  40546. */
  40547. getCachedEffect(): Nullable<Effect>;
  40548. /**
  40549. * Gets the cached visibility state (ie. the latest rendered one)
  40550. * @returns the cached visibility state
  40551. */
  40552. getCachedVisibility(): Nullable<number>;
  40553. /**
  40554. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  40555. * @param material defines the current material
  40556. * @param effect defines the current effect
  40557. * @param visibility defines the current visibility state
  40558. * @returns true if one parameter is not cached
  40559. */
  40560. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  40561. /**
  40562. * Gets the engine associated with the scene
  40563. * @returns an Engine
  40564. */
  40565. getEngine(): Engine;
  40566. /**
  40567. * Gets the total number of vertices rendered per frame
  40568. * @returns the total number of vertices rendered per frame
  40569. */
  40570. getTotalVertices(): number;
  40571. /**
  40572. * Gets the performance counter for total vertices
  40573. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  40574. */
  40575. get totalVerticesPerfCounter(): PerfCounter;
  40576. /**
  40577. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  40578. * @returns the total number of active indices rendered per frame
  40579. */
  40580. getActiveIndices(): number;
  40581. /**
  40582. * Gets the performance counter for active indices
  40583. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  40584. */
  40585. get totalActiveIndicesPerfCounter(): PerfCounter;
  40586. /**
  40587. * Gets the total number of active particles rendered per frame
  40588. * @returns the total number of active particles rendered per frame
  40589. */
  40590. getActiveParticles(): number;
  40591. /**
  40592. * Gets the performance counter for active particles
  40593. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  40594. */
  40595. get activeParticlesPerfCounter(): PerfCounter;
  40596. /**
  40597. * Gets the total number of active bones rendered per frame
  40598. * @returns the total number of active bones rendered per frame
  40599. */
  40600. getActiveBones(): number;
  40601. /**
  40602. * Gets the performance counter for active bones
  40603. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  40604. */
  40605. get activeBonesPerfCounter(): PerfCounter;
  40606. /**
  40607. * Gets the array of active meshes
  40608. * @returns an array of AbstractMesh
  40609. */
  40610. getActiveMeshes(): SmartArray<AbstractMesh>;
  40611. /**
  40612. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  40613. * @returns a number
  40614. */
  40615. getAnimationRatio(): number;
  40616. /**
  40617. * Gets an unique Id for the current render phase
  40618. * @returns a number
  40619. */
  40620. getRenderId(): number;
  40621. /**
  40622. * Gets an unique Id for the current frame
  40623. * @returns a number
  40624. */
  40625. getFrameId(): number;
  40626. /** Call this function if you want to manually increment the render Id*/
  40627. incrementRenderId(): void;
  40628. private _createUbo;
  40629. /**
  40630. * Use this method to simulate a pointer move on a mesh
  40631. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40632. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40633. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40634. * @returns the current scene
  40635. */
  40636. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  40637. /**
  40638. * Use this method to simulate a pointer down on a mesh
  40639. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40640. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40641. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40642. * @returns the current scene
  40643. */
  40644. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  40645. /**
  40646. * Use this method to simulate a pointer up on a mesh
  40647. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40648. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40649. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40650. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40651. * @returns the current scene
  40652. */
  40653. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  40654. /**
  40655. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40656. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40657. * @returns true if the pointer was captured
  40658. */
  40659. isPointerCaptured(pointerId?: number): boolean;
  40660. /**
  40661. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40662. * @param attachUp defines if you want to attach events to pointerup
  40663. * @param attachDown defines if you want to attach events to pointerdown
  40664. * @param attachMove defines if you want to attach events to pointermove
  40665. */
  40666. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  40667. /** Detaches all event handlers*/
  40668. detachControl(): void;
  40669. /**
  40670. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  40671. * Delay loaded resources are not taking in account
  40672. * @return true if all required resources are ready
  40673. */
  40674. isReady(): boolean;
  40675. /** Resets all cached information relative to material (including effect and visibility) */
  40676. resetCachedMaterial(): void;
  40677. /**
  40678. * Registers a function to be called before every frame render
  40679. * @param func defines the function to register
  40680. */
  40681. registerBeforeRender(func: () => void): void;
  40682. /**
  40683. * Unregisters a function called before every frame render
  40684. * @param func defines the function to unregister
  40685. */
  40686. unregisterBeforeRender(func: () => void): void;
  40687. /**
  40688. * Registers a function to be called after every frame render
  40689. * @param func defines the function to register
  40690. */
  40691. registerAfterRender(func: () => void): void;
  40692. /**
  40693. * Unregisters a function called after every frame render
  40694. * @param func defines the function to unregister
  40695. */
  40696. unregisterAfterRender(func: () => void): void;
  40697. private _executeOnceBeforeRender;
  40698. /**
  40699. * The provided function will run before render once and will be disposed afterwards.
  40700. * A timeout delay can be provided so that the function will be executed in N ms.
  40701. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  40702. * @param func The function to be executed.
  40703. * @param timeout optional delay in ms
  40704. */
  40705. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  40706. /** @hidden */
  40707. _addPendingData(data: any): void;
  40708. /** @hidden */
  40709. _removePendingData(data: any): void;
  40710. /**
  40711. * Returns the number of items waiting to be loaded
  40712. * @returns the number of items waiting to be loaded
  40713. */
  40714. getWaitingItemsCount(): number;
  40715. /**
  40716. * Returns a boolean indicating if the scene is still loading data
  40717. */
  40718. get isLoading(): boolean;
  40719. /**
  40720. * Registers a function to be executed when the scene is ready
  40721. * @param {Function} func - the function to be executed
  40722. */
  40723. executeWhenReady(func: () => void): void;
  40724. /**
  40725. * Returns a promise that resolves when the scene is ready
  40726. * @returns A promise that resolves when the scene is ready
  40727. */
  40728. whenReadyAsync(): Promise<void>;
  40729. /** @hidden */
  40730. _checkIsReady(): void;
  40731. /**
  40732. * Gets all animatable attached to the scene
  40733. */
  40734. get animatables(): Animatable[];
  40735. /**
  40736. * Resets the last animation time frame.
  40737. * Useful to override when animations start running when loading a scene for the first time.
  40738. */
  40739. resetLastAnimationTimeFrame(): void;
  40740. /**
  40741. * Gets the current view matrix
  40742. * @returns a Matrix
  40743. */
  40744. getViewMatrix(): Matrix;
  40745. /**
  40746. * Gets the current projection matrix
  40747. * @returns a Matrix
  40748. */
  40749. getProjectionMatrix(): Matrix;
  40750. /**
  40751. * Gets the current transform matrix
  40752. * @returns a Matrix made of View * Projection
  40753. */
  40754. getTransformMatrix(): Matrix;
  40755. /**
  40756. * Sets the current transform matrix
  40757. * @param viewL defines the View matrix to use
  40758. * @param projectionL defines the Projection matrix to use
  40759. * @param viewR defines the right View matrix to use (if provided)
  40760. * @param projectionR defines the right Projection matrix to use (if provided)
  40761. */
  40762. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  40763. /**
  40764. * Gets the uniform buffer used to store scene data
  40765. * @returns a UniformBuffer
  40766. */
  40767. getSceneUniformBuffer(): UniformBuffer;
  40768. /**
  40769. * Gets an unique (relatively to the current scene) Id
  40770. * @returns an unique number for the scene
  40771. */
  40772. getUniqueId(): number;
  40773. /**
  40774. * Add a mesh to the list of scene's meshes
  40775. * @param newMesh defines the mesh to add
  40776. * @param recursive if all child meshes should also be added to the scene
  40777. */
  40778. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  40779. /**
  40780. * Remove a mesh for the list of scene's meshes
  40781. * @param toRemove defines the mesh to remove
  40782. * @param recursive if all child meshes should also be removed from the scene
  40783. * @returns the index where the mesh was in the mesh list
  40784. */
  40785. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  40786. /**
  40787. * Add a transform node to the list of scene's transform nodes
  40788. * @param newTransformNode defines the transform node to add
  40789. */
  40790. addTransformNode(newTransformNode: TransformNode): void;
  40791. /**
  40792. * Remove a transform node for the list of scene's transform nodes
  40793. * @param toRemove defines the transform node to remove
  40794. * @returns the index where the transform node was in the transform node list
  40795. */
  40796. removeTransformNode(toRemove: TransformNode): number;
  40797. /**
  40798. * Remove a skeleton for the list of scene's skeletons
  40799. * @param toRemove defines the skeleton to remove
  40800. * @returns the index where the skeleton was in the skeleton list
  40801. */
  40802. removeSkeleton(toRemove: Skeleton): number;
  40803. /**
  40804. * Remove a morph target for the list of scene's morph targets
  40805. * @param toRemove defines the morph target to remove
  40806. * @returns the index where the morph target was in the morph target list
  40807. */
  40808. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  40809. /**
  40810. * Remove a light for the list of scene's lights
  40811. * @param toRemove defines the light to remove
  40812. * @returns the index where the light was in the light list
  40813. */
  40814. removeLight(toRemove: Light): number;
  40815. /**
  40816. * Remove a camera for the list of scene's cameras
  40817. * @param toRemove defines the camera to remove
  40818. * @returns the index where the camera was in the camera list
  40819. */
  40820. removeCamera(toRemove: Camera): number;
  40821. /**
  40822. * Remove a particle system for the list of scene's particle systems
  40823. * @param toRemove defines the particle system to remove
  40824. * @returns the index where the particle system was in the particle system list
  40825. */
  40826. removeParticleSystem(toRemove: IParticleSystem): number;
  40827. /**
  40828. * Remove a animation for the list of scene's animations
  40829. * @param toRemove defines the animation to remove
  40830. * @returns the index where the animation was in the animation list
  40831. */
  40832. removeAnimation(toRemove: Animation): number;
  40833. /**
  40834. * Will stop the animation of the given target
  40835. * @param target - the target
  40836. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  40837. * @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)
  40838. */
  40839. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  40840. /**
  40841. * Removes the given animation group from this scene.
  40842. * @param toRemove The animation group to remove
  40843. * @returns The index of the removed animation group
  40844. */
  40845. removeAnimationGroup(toRemove: AnimationGroup): number;
  40846. /**
  40847. * Removes the given multi-material from this scene.
  40848. * @param toRemove The multi-material to remove
  40849. * @returns The index of the removed multi-material
  40850. */
  40851. removeMultiMaterial(toRemove: MultiMaterial): number;
  40852. /**
  40853. * Removes the given material from this scene.
  40854. * @param toRemove The material to remove
  40855. * @returns The index of the removed material
  40856. */
  40857. removeMaterial(toRemove: Material): number;
  40858. /**
  40859. * Removes the given action manager from this scene.
  40860. * @param toRemove The action manager to remove
  40861. * @returns The index of the removed action manager
  40862. */
  40863. removeActionManager(toRemove: AbstractActionManager): number;
  40864. /**
  40865. * Removes the given texture from this scene.
  40866. * @param toRemove The texture to remove
  40867. * @returns The index of the removed texture
  40868. */
  40869. removeTexture(toRemove: BaseTexture): number;
  40870. /**
  40871. * Adds the given light to this scene
  40872. * @param newLight The light to add
  40873. */
  40874. addLight(newLight: Light): void;
  40875. /**
  40876. * Sorts the list list based on light priorities
  40877. */
  40878. sortLightsByPriority(): void;
  40879. /**
  40880. * Adds the given camera to this scene
  40881. * @param newCamera The camera to add
  40882. */
  40883. addCamera(newCamera: Camera): void;
  40884. /**
  40885. * Adds the given skeleton to this scene
  40886. * @param newSkeleton The skeleton to add
  40887. */
  40888. addSkeleton(newSkeleton: Skeleton): void;
  40889. /**
  40890. * Adds the given particle system to this scene
  40891. * @param newParticleSystem The particle system to add
  40892. */
  40893. addParticleSystem(newParticleSystem: IParticleSystem): void;
  40894. /**
  40895. * Adds the given animation to this scene
  40896. * @param newAnimation The animation to add
  40897. */
  40898. addAnimation(newAnimation: Animation): void;
  40899. /**
  40900. * Adds the given animation group to this scene.
  40901. * @param newAnimationGroup The animation group to add
  40902. */
  40903. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  40904. /**
  40905. * Adds the given multi-material to this scene
  40906. * @param newMultiMaterial The multi-material to add
  40907. */
  40908. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  40909. /**
  40910. * Adds the given material to this scene
  40911. * @param newMaterial The material to add
  40912. */
  40913. addMaterial(newMaterial: Material): void;
  40914. /**
  40915. * Adds the given morph target to this scene
  40916. * @param newMorphTargetManager The morph target to add
  40917. */
  40918. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  40919. /**
  40920. * Adds the given geometry to this scene
  40921. * @param newGeometry The geometry to add
  40922. */
  40923. addGeometry(newGeometry: Geometry): void;
  40924. /**
  40925. * Adds the given action manager to this scene
  40926. * @param newActionManager The action manager to add
  40927. */
  40928. addActionManager(newActionManager: AbstractActionManager): void;
  40929. /**
  40930. * Adds the given texture to this scene.
  40931. * @param newTexture The texture to add
  40932. */
  40933. addTexture(newTexture: BaseTexture): void;
  40934. /**
  40935. * Switch active camera
  40936. * @param newCamera defines the new active camera
  40937. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  40938. */
  40939. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  40940. /**
  40941. * sets the active camera of the scene using its ID
  40942. * @param id defines the camera's ID
  40943. * @return the new active camera or null if none found.
  40944. */
  40945. setActiveCameraByID(id: string): Nullable<Camera>;
  40946. /**
  40947. * sets the active camera of the scene using its name
  40948. * @param name defines the camera's name
  40949. * @returns the new active camera or null if none found.
  40950. */
  40951. setActiveCameraByName(name: string): Nullable<Camera>;
  40952. /**
  40953. * get an animation group using its name
  40954. * @param name defines the material's name
  40955. * @return the animation group or null if none found.
  40956. */
  40957. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  40958. /**
  40959. * Get a material using its unique id
  40960. * @param uniqueId defines the material's unique id
  40961. * @return the material or null if none found.
  40962. */
  40963. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  40964. /**
  40965. * get a material using its id
  40966. * @param id defines the material's ID
  40967. * @return the material or null if none found.
  40968. */
  40969. getMaterialByID(id: string): Nullable<Material>;
  40970. /**
  40971. * Gets a the last added material using a given id
  40972. * @param id defines the material's ID
  40973. * @return the last material with the given id or null if none found.
  40974. */
  40975. getLastMaterialByID(id: string): Nullable<Material>;
  40976. /**
  40977. * Gets a material using its name
  40978. * @param name defines the material's name
  40979. * @return the material or null if none found.
  40980. */
  40981. getMaterialByName(name: string): Nullable<Material>;
  40982. /**
  40983. * Get a texture using its unique id
  40984. * @param uniqueId defines the texture's unique id
  40985. * @return the texture or null if none found.
  40986. */
  40987. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  40988. /**
  40989. * Gets a camera using its id
  40990. * @param id defines the id to look for
  40991. * @returns the camera or null if not found
  40992. */
  40993. getCameraByID(id: string): Nullable<Camera>;
  40994. /**
  40995. * Gets a camera using its unique id
  40996. * @param uniqueId defines the unique id to look for
  40997. * @returns the camera or null if not found
  40998. */
  40999. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  41000. /**
  41001. * Gets a camera using its name
  41002. * @param name defines the camera's name
  41003. * @return the camera or null if none found.
  41004. */
  41005. getCameraByName(name: string): Nullable<Camera>;
  41006. /**
  41007. * Gets a bone using its id
  41008. * @param id defines the bone's id
  41009. * @return the bone or null if not found
  41010. */
  41011. getBoneByID(id: string): Nullable<Bone>;
  41012. /**
  41013. * Gets a bone using its id
  41014. * @param name defines the bone's name
  41015. * @return the bone or null if not found
  41016. */
  41017. getBoneByName(name: string): Nullable<Bone>;
  41018. /**
  41019. * Gets a light node using its name
  41020. * @param name defines the the light's name
  41021. * @return the light or null if none found.
  41022. */
  41023. getLightByName(name: string): Nullable<Light>;
  41024. /**
  41025. * Gets a light node using its id
  41026. * @param id defines the light's id
  41027. * @return the light or null if none found.
  41028. */
  41029. getLightByID(id: string): Nullable<Light>;
  41030. /**
  41031. * Gets a light node using its scene-generated unique ID
  41032. * @param uniqueId defines the light's unique id
  41033. * @return the light or null if none found.
  41034. */
  41035. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  41036. /**
  41037. * Gets a particle system by id
  41038. * @param id defines the particle system id
  41039. * @return the corresponding system or null if none found
  41040. */
  41041. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  41042. /**
  41043. * Gets a geometry using its ID
  41044. * @param id defines the geometry's id
  41045. * @return the geometry or null if none found.
  41046. */
  41047. getGeometryByID(id: string): Nullable<Geometry>;
  41048. private _getGeometryByUniqueID;
  41049. /**
  41050. * Add a new geometry to this scene
  41051. * @param geometry defines the geometry to be added to the scene.
  41052. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  41053. * @return a boolean defining if the geometry was added or not
  41054. */
  41055. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  41056. /**
  41057. * Removes an existing geometry
  41058. * @param geometry defines the geometry to be removed from the scene
  41059. * @return a boolean defining if the geometry was removed or not
  41060. */
  41061. removeGeometry(geometry: Geometry): boolean;
  41062. /**
  41063. * Gets the list of geometries attached to the scene
  41064. * @returns an array of Geometry
  41065. */
  41066. getGeometries(): Geometry[];
  41067. /**
  41068. * Gets the first added mesh found of a given ID
  41069. * @param id defines the id to search for
  41070. * @return the mesh found or null if not found at all
  41071. */
  41072. getMeshByID(id: string): Nullable<AbstractMesh>;
  41073. /**
  41074. * Gets a list of meshes using their id
  41075. * @param id defines the id to search for
  41076. * @returns a list of meshes
  41077. */
  41078. getMeshesByID(id: string): Array<AbstractMesh>;
  41079. /**
  41080. * Gets the first added transform node found of a given ID
  41081. * @param id defines the id to search for
  41082. * @return the found transform node or null if not found at all.
  41083. */
  41084. getTransformNodeByID(id: string): Nullable<TransformNode>;
  41085. /**
  41086. * Gets a transform node with its auto-generated unique id
  41087. * @param uniqueId efines the unique id to search for
  41088. * @return the found transform node or null if not found at all.
  41089. */
  41090. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  41091. /**
  41092. * Gets a list of transform nodes using their id
  41093. * @param id defines the id to search for
  41094. * @returns a list of transform nodes
  41095. */
  41096. getTransformNodesByID(id: string): Array<TransformNode>;
  41097. /**
  41098. * Gets a mesh with its auto-generated unique id
  41099. * @param uniqueId defines the unique id to search for
  41100. * @return the found mesh or null if not found at all.
  41101. */
  41102. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  41103. /**
  41104. * Gets a the last added mesh using a given id
  41105. * @param id defines the id to search for
  41106. * @return the found mesh or null if not found at all.
  41107. */
  41108. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  41109. /**
  41110. * Gets a the last added node (Mesh, Camera, Light) using a given id
  41111. * @param id defines the id to search for
  41112. * @return the found node or null if not found at all
  41113. */
  41114. getLastEntryByID(id: string): Nullable<Node>;
  41115. /**
  41116. * Gets a node (Mesh, Camera, Light) using a given id
  41117. * @param id defines the id to search for
  41118. * @return the found node or null if not found at all
  41119. */
  41120. getNodeByID(id: string): Nullable<Node>;
  41121. /**
  41122. * Gets a node (Mesh, Camera, Light) using a given name
  41123. * @param name defines the name to search for
  41124. * @return the found node or null if not found at all.
  41125. */
  41126. getNodeByName(name: string): Nullable<Node>;
  41127. /**
  41128. * Gets a mesh using a given name
  41129. * @param name defines the name to search for
  41130. * @return the found mesh or null if not found at all.
  41131. */
  41132. getMeshByName(name: string): Nullable<AbstractMesh>;
  41133. /**
  41134. * Gets a transform node using a given name
  41135. * @param name defines the name to search for
  41136. * @return the found transform node or null if not found at all.
  41137. */
  41138. getTransformNodeByName(name: string): Nullable<TransformNode>;
  41139. /**
  41140. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  41141. * @param id defines the id to search for
  41142. * @return the found skeleton or null if not found at all.
  41143. */
  41144. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  41145. /**
  41146. * Gets a skeleton using a given auto generated unique id
  41147. * @param uniqueId defines the unique id to search for
  41148. * @return the found skeleton or null if not found at all.
  41149. */
  41150. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  41151. /**
  41152. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  41153. * @param id defines the id to search for
  41154. * @return the found skeleton or null if not found at all.
  41155. */
  41156. getSkeletonById(id: string): Nullable<Skeleton>;
  41157. /**
  41158. * Gets a skeleton using a given name
  41159. * @param name defines the name to search for
  41160. * @return the found skeleton or null if not found at all.
  41161. */
  41162. getSkeletonByName(name: string): Nullable<Skeleton>;
  41163. /**
  41164. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  41165. * @param id defines the id to search for
  41166. * @return the found morph target manager or null if not found at all.
  41167. */
  41168. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  41169. /**
  41170. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  41171. * @param id defines the id to search for
  41172. * @return the found morph target or null if not found at all.
  41173. */
  41174. getMorphTargetById(id: string): Nullable<MorphTarget>;
  41175. /**
  41176. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  41177. * @param name defines the name to search for
  41178. * @return the found morph target or null if not found at all.
  41179. */
  41180. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  41181. /**
  41182. * Gets a boolean indicating if the given mesh is active
  41183. * @param mesh defines the mesh to look for
  41184. * @returns true if the mesh is in the active list
  41185. */
  41186. isActiveMesh(mesh: AbstractMesh): boolean;
  41187. /**
  41188. * Return a unique id as a string which can serve as an identifier for the scene
  41189. */
  41190. get uid(): string;
  41191. /**
  41192. * Add an externaly attached data from its key.
  41193. * This method call will fail and return false, if such key already exists.
  41194. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  41195. * @param key the unique key that identifies the data
  41196. * @param data the data object to associate to the key for this Engine instance
  41197. * @return true if no such key were already present and the data was added successfully, false otherwise
  41198. */
  41199. addExternalData<T>(key: string, data: T): boolean;
  41200. /**
  41201. * Get an externaly attached data from its key
  41202. * @param key the unique key that identifies the data
  41203. * @return the associated data, if present (can be null), or undefined if not present
  41204. */
  41205. getExternalData<T>(key: string): Nullable<T>;
  41206. /**
  41207. * Get an externaly attached data from its key, create it using a factory if it's not already present
  41208. * @param key the unique key that identifies the data
  41209. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  41210. * @return the associated data, can be null if the factory returned null.
  41211. */
  41212. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  41213. /**
  41214. * Remove an externaly attached data from the Engine instance
  41215. * @param key the unique key that identifies the data
  41216. * @return true if the data was successfully removed, false if it doesn't exist
  41217. */
  41218. removeExternalData(key: string): boolean;
  41219. private _evaluateSubMesh;
  41220. /**
  41221. * Clear the processed materials smart array preventing retention point in material dispose.
  41222. */
  41223. freeProcessedMaterials(): void;
  41224. private _preventFreeActiveMeshesAndRenderingGroups;
  41225. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  41226. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  41227. * when disposing several meshes in a row or a hierarchy of meshes.
  41228. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  41229. */
  41230. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  41231. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  41232. /**
  41233. * Clear the active meshes smart array preventing retention point in mesh dispose.
  41234. */
  41235. freeActiveMeshes(): void;
  41236. /**
  41237. * Clear the info related to rendering groups preventing retention points during dispose.
  41238. */
  41239. freeRenderingGroups(): void;
  41240. /** @hidden */
  41241. _isInIntermediateRendering(): boolean;
  41242. /**
  41243. * Lambda returning the list of potentially active meshes.
  41244. */
  41245. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  41246. /**
  41247. * Lambda returning the list of potentially active sub meshes.
  41248. */
  41249. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  41250. /**
  41251. * Lambda returning the list of potentially intersecting sub meshes.
  41252. */
  41253. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  41254. /**
  41255. * Lambda returning the list of potentially colliding sub meshes.
  41256. */
  41257. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  41258. private _activeMeshesFrozen;
  41259. private _skipEvaluateActiveMeshesCompletely;
  41260. /**
  41261. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  41262. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  41263. * @returns the current scene
  41264. */
  41265. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  41266. /**
  41267. * Use this function to restart evaluating active meshes on every frame
  41268. * @returns the current scene
  41269. */
  41270. unfreezeActiveMeshes(): Scene;
  41271. private _evaluateActiveMeshes;
  41272. private _activeMesh;
  41273. /**
  41274. * Update the transform matrix to update from the current active camera
  41275. * @param force defines a boolean used to force the update even if cache is up to date
  41276. */
  41277. updateTransformMatrix(force?: boolean): void;
  41278. private _bindFrameBuffer;
  41279. /** @hidden */
  41280. _allowPostProcessClearColor: boolean;
  41281. /** @hidden */
  41282. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  41283. private _processSubCameras;
  41284. private _checkIntersections;
  41285. /** @hidden */
  41286. _advancePhysicsEngineStep(step: number): void;
  41287. /**
  41288. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  41289. */
  41290. getDeterministicFrameTime: () => number;
  41291. /** @hidden */
  41292. _animate(): void;
  41293. /** Execute all animations (for a frame) */
  41294. animate(): void;
  41295. /**
  41296. * Render the scene
  41297. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  41298. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  41299. */
  41300. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  41301. /**
  41302. * Freeze all materials
  41303. * A frozen material will not be updatable but should be faster to render
  41304. */
  41305. freezeMaterials(): void;
  41306. /**
  41307. * Unfreeze all materials
  41308. * A frozen material will not be updatable but should be faster to render
  41309. */
  41310. unfreezeMaterials(): void;
  41311. /**
  41312. * Releases all held ressources
  41313. */
  41314. dispose(): void;
  41315. /**
  41316. * Gets if the scene is already disposed
  41317. */
  41318. get isDisposed(): boolean;
  41319. /**
  41320. * Call this function to reduce memory footprint of the scene.
  41321. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  41322. */
  41323. clearCachedVertexData(): void;
  41324. /**
  41325. * This function will remove the local cached buffer data from texture.
  41326. * It will save memory but will prevent the texture from being rebuilt
  41327. */
  41328. cleanCachedTextureBuffer(): void;
  41329. /**
  41330. * Get the world extend vectors with an optional filter
  41331. *
  41332. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  41333. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  41334. */
  41335. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  41336. min: Vector3;
  41337. max: Vector3;
  41338. };
  41339. /**
  41340. * Creates a ray that can be used to pick in the scene
  41341. * @param x defines the x coordinate of the origin (on-screen)
  41342. * @param y defines the y coordinate of the origin (on-screen)
  41343. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  41344. * @param camera defines the camera to use for the picking
  41345. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  41346. * @returns a Ray
  41347. */
  41348. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  41349. /**
  41350. * Creates a ray that can be used to pick in the scene
  41351. * @param x defines the x coordinate of the origin (on-screen)
  41352. * @param y defines the y coordinate of the origin (on-screen)
  41353. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  41354. * @param result defines the ray where to store the picking ray
  41355. * @param camera defines the camera to use for the picking
  41356. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  41357. * @returns the current scene
  41358. */
  41359. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  41360. /**
  41361. * Creates a ray that can be used to pick in the scene
  41362. * @param x defines the x coordinate of the origin (on-screen)
  41363. * @param y defines the y coordinate of the origin (on-screen)
  41364. * @param camera defines the camera to use for the picking
  41365. * @returns a Ray
  41366. */
  41367. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  41368. /**
  41369. * Creates a ray that can be used to pick in the scene
  41370. * @param x defines the x coordinate of the origin (on-screen)
  41371. * @param y defines the y coordinate of the origin (on-screen)
  41372. * @param result defines the ray where to store the picking ray
  41373. * @param camera defines the camera to use for the picking
  41374. * @returns the current scene
  41375. */
  41376. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  41377. /** Launch a ray to try to pick a mesh in the scene
  41378. * @param x position on screen
  41379. * @param y position on screen
  41380. * @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
  41381. * @param fastCheck defines if the first intersection will be used (and not the closest)
  41382. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  41383. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  41384. * @returns a PickingInfo
  41385. */
  41386. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  41387. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  41388. * @param x position on screen
  41389. * @param y position on screen
  41390. * @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
  41391. * @param fastCheck defines if the first intersection will be used (and not the closest)
  41392. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  41393. * @returns a PickingInfo (Please note that some info will not be set like distance, bv, bu and everything that cannot be capture by only using bounding infos)
  41394. */
  41395. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  41396. /** Use the given ray to pick a mesh in the scene
  41397. * @param ray The ray to use to pick meshes
  41398. * @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
  41399. * @param fastCheck defines if the first intersection will be used (and not the closest)
  41400. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  41401. * @returns a PickingInfo
  41402. */
  41403. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  41404. /**
  41405. * Launch a ray to try to pick a mesh in the scene
  41406. * @param x X position on screen
  41407. * @param y Y position on screen
  41408. * @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
  41409. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  41410. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  41411. * @returns an array of PickingInfo
  41412. */
  41413. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  41414. /**
  41415. * Launch a ray to try to pick a mesh in the scene
  41416. * @param ray Ray to use
  41417. * @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
  41418. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  41419. * @returns an array of PickingInfo
  41420. */
  41421. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  41422. /**
  41423. * Force the value of meshUnderPointer
  41424. * @param mesh defines the mesh to use
  41425. */
  41426. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  41427. /**
  41428. * Gets the mesh under the pointer
  41429. * @returns a Mesh or null if no mesh is under the pointer
  41430. */
  41431. getPointerOverMesh(): Nullable<AbstractMesh>;
  41432. /** @hidden */
  41433. _rebuildGeometries(): void;
  41434. /** @hidden */
  41435. _rebuildTextures(): void;
  41436. private _getByTags;
  41437. /**
  41438. * Get a list of meshes by tags
  41439. * @param tagsQuery defines the tags query to use
  41440. * @param forEach defines a predicate used to filter results
  41441. * @returns an array of Mesh
  41442. */
  41443. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  41444. /**
  41445. * Get a list of cameras by tags
  41446. * @param tagsQuery defines the tags query to use
  41447. * @param forEach defines a predicate used to filter results
  41448. * @returns an array of Camera
  41449. */
  41450. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  41451. /**
  41452. * Get a list of lights by tags
  41453. * @param tagsQuery defines the tags query to use
  41454. * @param forEach defines a predicate used to filter results
  41455. * @returns an array of Light
  41456. */
  41457. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  41458. /**
  41459. * Get a list of materials by tags
  41460. * @param tagsQuery defines the tags query to use
  41461. * @param forEach defines a predicate used to filter results
  41462. * @returns an array of Material
  41463. */
  41464. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  41465. /**
  41466. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  41467. * This allowed control for front to back rendering or reversly depending of the special needs.
  41468. *
  41469. * @param renderingGroupId The rendering group id corresponding to its index
  41470. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  41471. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  41472. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  41473. */
  41474. 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;
  41475. /**
  41476. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  41477. *
  41478. * @param renderingGroupId The rendering group id corresponding to its index
  41479. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  41480. * @param depth Automatically clears depth between groups if true and autoClear is true.
  41481. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  41482. */
  41483. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  41484. /**
  41485. * Gets the current auto clear configuration for one rendering group of the rendering
  41486. * manager.
  41487. * @param index the rendering group index to get the information for
  41488. * @returns The auto clear setup for the requested rendering group
  41489. */
  41490. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  41491. private _blockMaterialDirtyMechanism;
  41492. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  41493. get blockMaterialDirtyMechanism(): boolean;
  41494. set blockMaterialDirtyMechanism(value: boolean);
  41495. /**
  41496. * Will flag all materials as dirty to trigger new shader compilation
  41497. * @param flag defines the flag used to specify which material part must be marked as dirty
  41498. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  41499. */
  41500. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  41501. /** @hidden */
  41502. _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;
  41503. /** @hidden */
  41504. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  41505. /** @hidden */
  41506. _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;
  41507. /** @hidden */
  41508. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  41509. /** @hidden */
  41510. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  41511. /** @hidden */
  41512. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  41513. }
  41514. }
  41515. declare module "babylonjs/assetContainer" {
  41516. import { AbstractScene } from "babylonjs/abstractScene";
  41517. import { Scene } from "babylonjs/scene";
  41518. import { Mesh } from "babylonjs/Meshes/mesh";
  41519. import { TransformNode } from "babylonjs/Meshes/transformNode";
  41520. import { Skeleton } from "babylonjs/Bones/skeleton";
  41521. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  41522. import { Animatable } from "babylonjs/Animations/animatable";
  41523. import { Nullable } from "babylonjs/types";
  41524. import { Node } from "babylonjs/node";
  41525. /**
  41526. * Set of assets to keep when moving a scene into an asset container.
  41527. */
  41528. export class KeepAssets extends AbstractScene {
  41529. }
  41530. /**
  41531. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  41532. */
  41533. export class InstantiatedEntries {
  41534. /**
  41535. * List of new root nodes (eg. nodes with no parent)
  41536. */
  41537. rootNodes: TransformNode[];
  41538. /**
  41539. * List of new skeletons
  41540. */
  41541. skeletons: Skeleton[];
  41542. /**
  41543. * List of new animation groups
  41544. */
  41545. animationGroups: AnimationGroup[];
  41546. }
  41547. /**
  41548. * Container with a set of assets that can be added or removed from a scene.
  41549. */
  41550. export class AssetContainer extends AbstractScene {
  41551. private _wasAddedToScene;
  41552. /**
  41553. * The scene the AssetContainer belongs to.
  41554. */
  41555. scene: Scene;
  41556. /**
  41557. * Instantiates an AssetContainer.
  41558. * @param scene The scene the AssetContainer belongs to.
  41559. */
  41560. constructor(scene: Scene);
  41561. /**
  41562. * Instantiate or clone all meshes and add the new ones to the scene.
  41563. * Skeletons and animation groups will all be cloned
  41564. * @param nameFunction defines an optional function used to get new names for clones
  41565. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  41566. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  41567. */
  41568. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  41569. /**
  41570. * Adds all the assets from the container to the scene.
  41571. */
  41572. addAllToScene(): void;
  41573. /**
  41574. * Removes all the assets in the container from the scene
  41575. */
  41576. removeAllFromScene(): void;
  41577. /**
  41578. * Disposes all the assets in the container
  41579. */
  41580. dispose(): void;
  41581. private _moveAssets;
  41582. /**
  41583. * Removes all the assets contained in the scene and adds them to the container.
  41584. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  41585. */
  41586. moveAllFromScene(keepAssets?: KeepAssets): void;
  41587. /**
  41588. * 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.
  41589. * @returns the root mesh
  41590. */
  41591. createRootMesh(): Mesh;
  41592. /**
  41593. * Merge animations (direct and animation groups) from this asset container into a scene
  41594. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  41595. * @param animatables set of animatables to retarget to a node from the scene
  41596. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  41597. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  41598. */
  41599. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  41600. }
  41601. }
  41602. declare module "babylonjs/abstractScene" {
  41603. import { Scene } from "babylonjs/scene";
  41604. import { Nullable } from "babylonjs/types";
  41605. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41606. import { TransformNode } from "babylonjs/Meshes/transformNode";
  41607. import { Geometry } from "babylonjs/Meshes/geometry";
  41608. import { Skeleton } from "babylonjs/Bones/skeleton";
  41609. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  41610. import { AssetContainer } from "babylonjs/assetContainer";
  41611. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  41612. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  41613. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  41614. import { Material } from "babylonjs/Materials/material";
  41615. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  41616. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  41617. import { Camera } from "babylonjs/Cameras/camera";
  41618. import { Light } from "babylonjs/Lights/light";
  41619. import { Node } from "babylonjs/node";
  41620. import { Animation } from "babylonjs/Animations/animation";
  41621. /**
  41622. * Defines how the parser contract is defined.
  41623. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  41624. */
  41625. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  41626. /**
  41627. * Defines how the individual parser contract is defined.
  41628. * These parser can parse an individual asset
  41629. */
  41630. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  41631. /**
  41632. * Base class of the scene acting as a container for the different elements composing a scene.
  41633. * This class is dynamically extended by the different components of the scene increasing
  41634. * flexibility and reducing coupling
  41635. */
  41636. export abstract class AbstractScene {
  41637. /**
  41638. * Stores the list of available parsers in the application.
  41639. */
  41640. private static _BabylonFileParsers;
  41641. /**
  41642. * Stores the list of available individual parsers in the application.
  41643. */
  41644. private static _IndividualBabylonFileParsers;
  41645. /**
  41646. * Adds a parser in the list of available ones
  41647. * @param name Defines the name of the parser
  41648. * @param parser Defines the parser to add
  41649. */
  41650. static AddParser(name: string, parser: BabylonFileParser): void;
  41651. /**
  41652. * Gets a general parser from the list of avaialble ones
  41653. * @param name Defines the name of the parser
  41654. * @returns the requested parser or null
  41655. */
  41656. static GetParser(name: string): Nullable<BabylonFileParser>;
  41657. /**
  41658. * Adds n individual parser in the list of available ones
  41659. * @param name Defines the name of the parser
  41660. * @param parser Defines the parser to add
  41661. */
  41662. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  41663. /**
  41664. * Gets an individual parser from the list of avaialble ones
  41665. * @param name Defines the name of the parser
  41666. * @returns the requested parser or null
  41667. */
  41668. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  41669. /**
  41670. * Parser json data and populate both a scene and its associated container object
  41671. * @param jsonData Defines the data to parse
  41672. * @param scene Defines the scene to parse the data for
  41673. * @param container Defines the container attached to the parsing sequence
  41674. * @param rootUrl Defines the root url of the data
  41675. */
  41676. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  41677. /**
  41678. * Gets the list of root nodes (ie. nodes with no parent)
  41679. */
  41680. rootNodes: Node[];
  41681. /** All of the cameras added to this scene
  41682. * @see http://doc.babylonjs.com/babylon101/cameras
  41683. */
  41684. cameras: Camera[];
  41685. /**
  41686. * All of the lights added to this scene
  41687. * @see http://doc.babylonjs.com/babylon101/lights
  41688. */
  41689. lights: Light[];
  41690. /**
  41691. * All of the (abstract) meshes added to this scene
  41692. */
  41693. meshes: AbstractMesh[];
  41694. /**
  41695. * The list of skeletons added to the scene
  41696. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  41697. */
  41698. skeletons: Skeleton[];
  41699. /**
  41700. * All of the particle systems added to this scene
  41701. * @see http://doc.babylonjs.com/babylon101/particles
  41702. */
  41703. particleSystems: IParticleSystem[];
  41704. /**
  41705. * Gets a list of Animations associated with the scene
  41706. */
  41707. animations: Animation[];
  41708. /**
  41709. * All of the animation groups added to this scene
  41710. * @see http://doc.babylonjs.com/how_to/group
  41711. */
  41712. animationGroups: AnimationGroup[];
  41713. /**
  41714. * All of the multi-materials added to this scene
  41715. * @see http://doc.babylonjs.com/how_to/multi_materials
  41716. */
  41717. multiMaterials: MultiMaterial[];
  41718. /**
  41719. * All of the materials added to this scene
  41720. * In the context of a Scene, it is not supposed to be modified manually.
  41721. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  41722. * Note also that the order of the Material within the array is not significant and might change.
  41723. * @see http://doc.babylonjs.com/babylon101/materials
  41724. */
  41725. materials: Material[];
  41726. /**
  41727. * The list of morph target managers added to the scene
  41728. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  41729. */
  41730. morphTargetManagers: MorphTargetManager[];
  41731. /**
  41732. * The list of geometries used in the scene.
  41733. */
  41734. geometries: Geometry[];
  41735. /**
  41736. * All of the tranform nodes added to this scene
  41737. * In the context of a Scene, it is not supposed to be modified manually.
  41738. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  41739. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  41740. * @see http://doc.babylonjs.com/how_to/transformnode
  41741. */
  41742. transformNodes: TransformNode[];
  41743. /**
  41744. * ActionManagers available on the scene.
  41745. */
  41746. actionManagers: AbstractActionManager[];
  41747. /**
  41748. * Textures to keep.
  41749. */
  41750. textures: BaseTexture[];
  41751. /**
  41752. * Environment texture for the scene
  41753. */
  41754. environmentTexture: Nullable<BaseTexture>;
  41755. /**
  41756. * @returns all meshes, lights, cameras, transformNodes and bones
  41757. */
  41758. getNodes(): Array<Node>;
  41759. }
  41760. }
  41761. declare module "babylonjs/Audio/sound" {
  41762. import { Observable } from "babylonjs/Misc/observable";
  41763. import { Vector3 } from "babylonjs/Maths/math.vector";
  41764. import { Nullable } from "babylonjs/types";
  41765. import { Scene } from "babylonjs/scene";
  41766. import { TransformNode } from "babylonjs/Meshes/transformNode";
  41767. /**
  41768. * Interface used to define options for Sound class
  41769. */
  41770. export interface ISoundOptions {
  41771. /**
  41772. * Does the sound autoplay once loaded.
  41773. */
  41774. autoplay?: boolean;
  41775. /**
  41776. * Does the sound loop after it finishes playing once.
  41777. */
  41778. loop?: boolean;
  41779. /**
  41780. * Sound's volume
  41781. */
  41782. volume?: number;
  41783. /**
  41784. * Is it a spatial sound?
  41785. */
  41786. spatialSound?: boolean;
  41787. /**
  41788. * Maximum distance to hear that sound
  41789. */
  41790. maxDistance?: number;
  41791. /**
  41792. * Uses user defined attenuation function
  41793. */
  41794. useCustomAttenuation?: boolean;
  41795. /**
  41796. * Define the roll off factor of spatial sounds.
  41797. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  41798. */
  41799. rolloffFactor?: number;
  41800. /**
  41801. * Define the reference distance the sound should be heard perfectly.
  41802. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  41803. */
  41804. refDistance?: number;
  41805. /**
  41806. * Define the distance attenuation model the sound will follow.
  41807. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  41808. */
  41809. distanceModel?: string;
  41810. /**
  41811. * Defines the playback speed (1 by default)
  41812. */
  41813. playbackRate?: number;
  41814. /**
  41815. * Defines if the sound is from a streaming source
  41816. */
  41817. streaming?: boolean;
  41818. /**
  41819. * Defines an optional length (in seconds) inside the sound file
  41820. */
  41821. length?: number;
  41822. /**
  41823. * Defines an optional offset (in seconds) inside the sound file
  41824. */
  41825. offset?: number;
  41826. /**
  41827. * If true, URLs will not be required to state the audio file codec to use.
  41828. */
  41829. skipCodecCheck?: boolean;
  41830. }
  41831. /**
  41832. * Defines a sound that can be played in the application.
  41833. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  41834. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  41835. */
  41836. export class Sound {
  41837. /**
  41838. * The name of the sound in the scene.
  41839. */
  41840. name: string;
  41841. /**
  41842. * Does the sound autoplay once loaded.
  41843. */
  41844. autoplay: boolean;
  41845. /**
  41846. * Does the sound loop after it finishes playing once.
  41847. */
  41848. loop: boolean;
  41849. /**
  41850. * Does the sound use a custom attenuation curve to simulate the falloff
  41851. * happening when the source gets further away from the camera.
  41852. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  41853. */
  41854. useCustomAttenuation: boolean;
  41855. /**
  41856. * The sound track id this sound belongs to.
  41857. */
  41858. soundTrackId: number;
  41859. /**
  41860. * Is this sound currently played.
  41861. */
  41862. isPlaying: boolean;
  41863. /**
  41864. * Is this sound currently paused.
  41865. */
  41866. isPaused: boolean;
  41867. /**
  41868. * Does this sound enables spatial sound.
  41869. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  41870. */
  41871. spatialSound: boolean;
  41872. /**
  41873. * Define the reference distance the sound should be heard perfectly.
  41874. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  41875. */
  41876. refDistance: number;
  41877. /**
  41878. * Define the roll off factor of spatial sounds.
  41879. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  41880. */
  41881. rolloffFactor: number;
  41882. /**
  41883. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  41884. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  41885. */
  41886. maxDistance: number;
  41887. /**
  41888. * Define the distance attenuation model the sound will follow.
  41889. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  41890. */
  41891. distanceModel: string;
  41892. /**
  41893. * @hidden
  41894. * Back Compat
  41895. **/
  41896. onended: () => any;
  41897. /**
  41898. * Gets or sets an object used to store user defined information for the sound.
  41899. */
  41900. metadata: any;
  41901. /**
  41902. * Observable event when the current playing sound finishes.
  41903. */
  41904. onEndedObservable: Observable<Sound>;
  41905. private _panningModel;
  41906. private _playbackRate;
  41907. private _streaming;
  41908. private _startTime;
  41909. private _startOffset;
  41910. private _position;
  41911. /** @hidden */
  41912. _positionInEmitterSpace: boolean;
  41913. private _localDirection;
  41914. private _volume;
  41915. private _isReadyToPlay;
  41916. private _isDirectional;
  41917. private _readyToPlayCallback;
  41918. private _audioBuffer;
  41919. private _soundSource;
  41920. private _streamingSource;
  41921. private _soundPanner;
  41922. private _soundGain;
  41923. private _inputAudioNode;
  41924. private _outputAudioNode;
  41925. private _coneInnerAngle;
  41926. private _coneOuterAngle;
  41927. private _coneOuterGain;
  41928. private _scene;
  41929. private _connectedTransformNode;
  41930. private _customAttenuationFunction;
  41931. private _registerFunc;
  41932. private _isOutputConnected;
  41933. private _htmlAudioElement;
  41934. private _urlType;
  41935. private _length?;
  41936. private _offset?;
  41937. /** @hidden */
  41938. static _SceneComponentInitialization: (scene: Scene) => void;
  41939. /**
  41940. * Create a sound and attach it to a scene
  41941. * @param name Name of your sound
  41942. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  41943. * @param scene defines the scene the sound belongs to
  41944. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  41945. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  41946. */
  41947. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  41948. /**
  41949. * Release the sound and its associated resources
  41950. */
  41951. dispose(): void;
  41952. /**
  41953. * Gets if the sounds is ready to be played or not.
  41954. * @returns true if ready, otherwise false
  41955. */
  41956. isReady(): boolean;
  41957. private _soundLoaded;
  41958. /**
  41959. * Sets the data of the sound from an audiobuffer
  41960. * @param audioBuffer The audioBuffer containing the data
  41961. */
  41962. setAudioBuffer(audioBuffer: AudioBuffer): void;
  41963. /**
  41964. * Updates the current sounds options such as maxdistance, loop...
  41965. * @param options A JSON object containing values named as the object properties
  41966. */
  41967. updateOptions(options: ISoundOptions): void;
  41968. private _createSpatialParameters;
  41969. private _updateSpatialParameters;
  41970. /**
  41971. * Switch the panning model to HRTF:
  41972. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  41973. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  41974. */
  41975. switchPanningModelToHRTF(): void;
  41976. /**
  41977. * Switch the panning model to Equal Power:
  41978. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  41979. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  41980. */
  41981. switchPanningModelToEqualPower(): void;
  41982. private _switchPanningModel;
  41983. /**
  41984. * Connect this sound to a sound track audio node like gain...
  41985. * @param soundTrackAudioNode the sound track audio node to connect to
  41986. */
  41987. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  41988. /**
  41989. * Transform this sound into a directional source
  41990. * @param coneInnerAngle Size of the inner cone in degree
  41991. * @param coneOuterAngle Size of the outer cone in degree
  41992. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  41993. */
  41994. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  41995. /**
  41996. * Gets or sets the inner angle for the directional cone.
  41997. */
  41998. get directionalConeInnerAngle(): number;
  41999. /**
  42000. * Gets or sets the inner angle for the directional cone.
  42001. */
  42002. set directionalConeInnerAngle(value: number);
  42003. /**
  42004. * Gets or sets the outer angle for the directional cone.
  42005. */
  42006. get directionalConeOuterAngle(): number;
  42007. /**
  42008. * Gets or sets the outer angle for the directional cone.
  42009. */
  42010. set directionalConeOuterAngle(value: number);
  42011. /**
  42012. * Sets the position of the emitter if spatial sound is enabled
  42013. * @param newPosition Defines the new posisiton
  42014. */
  42015. setPosition(newPosition: Vector3): void;
  42016. /**
  42017. * Sets the local direction of the emitter if spatial sound is enabled
  42018. * @param newLocalDirection Defines the new local direction
  42019. */
  42020. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  42021. private _updateDirection;
  42022. /** @hidden */
  42023. updateDistanceFromListener(): void;
  42024. /**
  42025. * Sets a new custom attenuation function for the sound.
  42026. * @param callback Defines the function used for the attenuation
  42027. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42028. */
  42029. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  42030. /**
  42031. * Play the sound
  42032. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  42033. * @param offset (optional) Start the sound at a specific time in seconds
  42034. * @param length (optional) Sound duration (in seconds)
  42035. */
  42036. play(time?: number, offset?: number, length?: number): void;
  42037. private _onended;
  42038. /**
  42039. * Stop the sound
  42040. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  42041. */
  42042. stop(time?: number): void;
  42043. /**
  42044. * Put the sound in pause
  42045. */
  42046. pause(): void;
  42047. /**
  42048. * Sets a dedicated volume for this sounds
  42049. * @param newVolume Define the new volume of the sound
  42050. * @param time Define time for gradual change to new volume
  42051. */
  42052. setVolume(newVolume: number, time?: number): void;
  42053. /**
  42054. * Set the sound play back rate
  42055. * @param newPlaybackRate Define the playback rate the sound should be played at
  42056. */
  42057. setPlaybackRate(newPlaybackRate: number): void;
  42058. /**
  42059. * Gets the volume of the sound.
  42060. * @returns the volume of the sound
  42061. */
  42062. getVolume(): number;
  42063. /**
  42064. * Attach the sound to a dedicated mesh
  42065. * @param transformNode The transform node to connect the sound with
  42066. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  42067. */
  42068. attachToMesh(transformNode: TransformNode): void;
  42069. /**
  42070. * Detach the sound from the previously attached mesh
  42071. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  42072. */
  42073. detachFromMesh(): void;
  42074. private _onRegisterAfterWorldMatrixUpdate;
  42075. /**
  42076. * Clone the current sound in the scene.
  42077. * @returns the new sound clone
  42078. */
  42079. clone(): Nullable<Sound>;
  42080. /**
  42081. * Gets the current underlying audio buffer containing the data
  42082. * @returns the audio buffer
  42083. */
  42084. getAudioBuffer(): Nullable<AudioBuffer>;
  42085. /**
  42086. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  42087. * @returns the source node
  42088. */
  42089. getSoundSource(): Nullable<AudioBufferSourceNode>;
  42090. /**
  42091. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  42092. * @returns the gain node
  42093. */
  42094. getSoundGain(): Nullable<GainNode>;
  42095. /**
  42096. * Serializes the Sound in a JSON representation
  42097. * @returns the JSON representation of the sound
  42098. */
  42099. serialize(): any;
  42100. /**
  42101. * Parse a JSON representation of a sound to innstantiate in a given scene
  42102. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  42103. * @param scene Define the scene the new parsed sound should be created in
  42104. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  42105. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  42106. * @returns the newly parsed sound
  42107. */
  42108. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  42109. }
  42110. }
  42111. declare module "babylonjs/Actions/directAudioActions" {
  42112. import { Action } from "babylonjs/Actions/action";
  42113. import { Condition } from "babylonjs/Actions/condition";
  42114. import { Sound } from "babylonjs/Audio/sound";
  42115. /**
  42116. * This defines an action helpful to play a defined sound on a triggered action.
  42117. */
  42118. export class PlaySoundAction extends Action {
  42119. private _sound;
  42120. /**
  42121. * Instantiate the action
  42122. * @param triggerOptions defines the trigger options
  42123. * @param sound defines the sound to play
  42124. * @param condition defines the trigger related conditions
  42125. */
  42126. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  42127. /** @hidden */
  42128. _prepare(): void;
  42129. /**
  42130. * Execute the action and play the sound.
  42131. */
  42132. execute(): void;
  42133. /**
  42134. * Serializes the actions and its related information.
  42135. * @param parent defines the object to serialize in
  42136. * @returns the serialized object
  42137. */
  42138. serialize(parent: any): any;
  42139. }
  42140. /**
  42141. * This defines an action helpful to stop a defined sound on a triggered action.
  42142. */
  42143. export class StopSoundAction extends Action {
  42144. private _sound;
  42145. /**
  42146. * Instantiate the action
  42147. * @param triggerOptions defines the trigger options
  42148. * @param sound defines the sound to stop
  42149. * @param condition defines the trigger related conditions
  42150. */
  42151. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  42152. /** @hidden */
  42153. _prepare(): void;
  42154. /**
  42155. * Execute the action and stop the sound.
  42156. */
  42157. execute(): void;
  42158. /**
  42159. * Serializes the actions and its related information.
  42160. * @param parent defines the object to serialize in
  42161. * @returns the serialized object
  42162. */
  42163. serialize(parent: any): any;
  42164. }
  42165. }
  42166. declare module "babylonjs/Actions/interpolateValueAction" {
  42167. import { Action } from "babylonjs/Actions/action";
  42168. import { Condition } from "babylonjs/Actions/condition";
  42169. import { Observable } from "babylonjs/Misc/observable";
  42170. /**
  42171. * This defines an action responsible to change the value of a property
  42172. * by interpolating between its current value and the newly set one once triggered.
  42173. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  42174. */
  42175. export class InterpolateValueAction extends Action {
  42176. /**
  42177. * Defines the path of the property where the value should be interpolated
  42178. */
  42179. propertyPath: string;
  42180. /**
  42181. * Defines the target value at the end of the interpolation.
  42182. */
  42183. value: any;
  42184. /**
  42185. * Defines the time it will take for the property to interpolate to the value.
  42186. */
  42187. duration: number;
  42188. /**
  42189. * Defines if the other scene animations should be stopped when the action has been triggered
  42190. */
  42191. stopOtherAnimations?: boolean;
  42192. /**
  42193. * Defines a callback raised once the interpolation animation has been done.
  42194. */
  42195. onInterpolationDone?: () => void;
  42196. /**
  42197. * Observable triggered once the interpolation animation has been done.
  42198. */
  42199. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  42200. private _target;
  42201. private _effectiveTarget;
  42202. private _property;
  42203. /**
  42204. * Instantiate the action
  42205. * @param triggerOptions defines the trigger options
  42206. * @param target defines the object containing the value to interpolate
  42207. * @param propertyPath defines the path to the property in the target object
  42208. * @param value defines the target value at the end of the interpolation
  42209. * @param duration deines the time it will take for the property to interpolate to the value.
  42210. * @param condition defines the trigger related conditions
  42211. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  42212. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  42213. */
  42214. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  42215. /** @hidden */
  42216. _prepare(): void;
  42217. /**
  42218. * Execute the action starts the value interpolation.
  42219. */
  42220. execute(): void;
  42221. /**
  42222. * Serializes the actions and its related information.
  42223. * @param parent defines the object to serialize in
  42224. * @returns the serialized object
  42225. */
  42226. serialize(parent: any): any;
  42227. }
  42228. }
  42229. declare module "babylonjs/Actions/index" {
  42230. export * from "babylonjs/Actions/abstractActionManager";
  42231. export * from "babylonjs/Actions/action";
  42232. export * from "babylonjs/Actions/actionEvent";
  42233. export * from "babylonjs/Actions/actionManager";
  42234. export * from "babylonjs/Actions/condition";
  42235. export * from "babylonjs/Actions/directActions";
  42236. export * from "babylonjs/Actions/directAudioActions";
  42237. export * from "babylonjs/Actions/interpolateValueAction";
  42238. }
  42239. declare module "babylonjs/Animations/index" {
  42240. export * from "babylonjs/Animations/animatable";
  42241. export * from "babylonjs/Animations/animation";
  42242. export * from "babylonjs/Animations/animationGroup";
  42243. export * from "babylonjs/Animations/animationPropertiesOverride";
  42244. export * from "babylonjs/Animations/easing";
  42245. export * from "babylonjs/Animations/runtimeAnimation";
  42246. export * from "babylonjs/Animations/animationEvent";
  42247. export * from "babylonjs/Animations/animationGroup";
  42248. export * from "babylonjs/Animations/animationKey";
  42249. export * from "babylonjs/Animations/animationRange";
  42250. export * from "babylonjs/Animations/animatable.interface";
  42251. }
  42252. declare module "babylonjs/Audio/soundTrack" {
  42253. import { Sound } from "babylonjs/Audio/sound";
  42254. import { Analyser } from "babylonjs/Audio/analyser";
  42255. import { Scene } from "babylonjs/scene";
  42256. /**
  42257. * Options allowed during the creation of a sound track.
  42258. */
  42259. export interface ISoundTrackOptions {
  42260. /**
  42261. * The volume the sound track should take during creation
  42262. */
  42263. volume?: number;
  42264. /**
  42265. * Define if the sound track is the main sound track of the scene
  42266. */
  42267. mainTrack?: boolean;
  42268. }
  42269. /**
  42270. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  42271. * It will be also used in a future release to apply effects on a specific track.
  42272. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  42273. */
  42274. export class SoundTrack {
  42275. /**
  42276. * The unique identifier of the sound track in the scene.
  42277. */
  42278. id: number;
  42279. /**
  42280. * The list of sounds included in the sound track.
  42281. */
  42282. soundCollection: Array<Sound>;
  42283. private _outputAudioNode;
  42284. private _scene;
  42285. private _connectedAnalyser;
  42286. private _options;
  42287. private _isInitialized;
  42288. /**
  42289. * Creates a new sound track.
  42290. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  42291. * @param scene Define the scene the sound track belongs to
  42292. * @param options
  42293. */
  42294. constructor(scene: Scene, options?: ISoundTrackOptions);
  42295. private _initializeSoundTrackAudioGraph;
  42296. /**
  42297. * Release the sound track and its associated resources
  42298. */
  42299. dispose(): void;
  42300. /**
  42301. * Adds a sound to this sound track
  42302. * @param sound define the cound to add
  42303. * @ignoreNaming
  42304. */
  42305. AddSound(sound: Sound): void;
  42306. /**
  42307. * Removes a sound to this sound track
  42308. * @param sound define the cound to remove
  42309. * @ignoreNaming
  42310. */
  42311. RemoveSound(sound: Sound): void;
  42312. /**
  42313. * Set a global volume for the full sound track.
  42314. * @param newVolume Define the new volume of the sound track
  42315. */
  42316. setVolume(newVolume: number): void;
  42317. /**
  42318. * Switch the panning model to HRTF:
  42319. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  42320. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42321. */
  42322. switchPanningModelToHRTF(): void;
  42323. /**
  42324. * Switch the panning model to Equal Power:
  42325. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  42326. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42327. */
  42328. switchPanningModelToEqualPower(): void;
  42329. /**
  42330. * Connect the sound track to an audio analyser allowing some amazing
  42331. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  42332. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  42333. * @param analyser The analyser to connect to the engine
  42334. */
  42335. connectToAnalyser(analyser: Analyser): void;
  42336. }
  42337. }
  42338. declare module "babylonjs/Audio/audioSceneComponent" {
  42339. import { Sound } from "babylonjs/Audio/sound";
  42340. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  42341. import { Nullable } from "babylonjs/types";
  42342. import { Vector3 } from "babylonjs/Maths/math.vector";
  42343. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  42344. import { Scene } from "babylonjs/scene";
  42345. import { AbstractScene } from "babylonjs/abstractScene";
  42346. import "babylonjs/Audio/audioEngine";
  42347. module "babylonjs/abstractScene" {
  42348. interface AbstractScene {
  42349. /**
  42350. * The list of sounds used in the scene.
  42351. */
  42352. sounds: Nullable<Array<Sound>>;
  42353. }
  42354. }
  42355. module "babylonjs/scene" {
  42356. interface Scene {
  42357. /**
  42358. * @hidden
  42359. * Backing field
  42360. */
  42361. _mainSoundTrack: SoundTrack;
  42362. /**
  42363. * The main sound track played by the scene.
  42364. * It cotains your primary collection of sounds.
  42365. */
  42366. mainSoundTrack: SoundTrack;
  42367. /**
  42368. * The list of sound tracks added to the scene
  42369. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  42370. */
  42371. soundTracks: Nullable<Array<SoundTrack>>;
  42372. /**
  42373. * Gets a sound using a given name
  42374. * @param name defines the name to search for
  42375. * @return the found sound or null if not found at all.
  42376. */
  42377. getSoundByName(name: string): Nullable<Sound>;
  42378. /**
  42379. * Gets or sets if audio support is enabled
  42380. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  42381. */
  42382. audioEnabled: boolean;
  42383. /**
  42384. * Gets or sets if audio will be output to headphones
  42385. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  42386. */
  42387. headphone: boolean;
  42388. /**
  42389. * Gets or sets custom audio listener position provider
  42390. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  42391. */
  42392. audioListenerPositionProvider: Nullable<() => Vector3>;
  42393. /**
  42394. * Gets or sets a refresh rate when using 3D audio positioning
  42395. */
  42396. audioPositioningRefreshRate: number;
  42397. }
  42398. }
  42399. /**
  42400. * Defines the sound scene component responsible to manage any sounds
  42401. * in a given scene.
  42402. */
  42403. export class AudioSceneComponent implements ISceneSerializableComponent {
  42404. /**
  42405. * The component name helpfull to identify the component in the list of scene components.
  42406. */
  42407. readonly name: string;
  42408. /**
  42409. * The scene the component belongs to.
  42410. */
  42411. scene: Scene;
  42412. private _audioEnabled;
  42413. /**
  42414. * Gets whether audio is enabled or not.
  42415. * Please use related enable/disable method to switch state.
  42416. */
  42417. get audioEnabled(): boolean;
  42418. private _headphone;
  42419. /**
  42420. * Gets whether audio is outputing to headphone or not.
  42421. * Please use the according Switch methods to change output.
  42422. */
  42423. get headphone(): boolean;
  42424. /**
  42425. * Gets or sets a refresh rate when using 3D audio positioning
  42426. */
  42427. audioPositioningRefreshRate: number;
  42428. private _audioListenerPositionProvider;
  42429. /**
  42430. * Gets the current audio listener position provider
  42431. */
  42432. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  42433. /**
  42434. * Sets a custom listener position for all sounds in the scene
  42435. * By default, this is the position of the first active camera
  42436. */
  42437. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  42438. /**
  42439. * Creates a new instance of the component for the given scene
  42440. * @param scene Defines the scene to register the component in
  42441. */
  42442. constructor(scene: Scene);
  42443. /**
  42444. * Registers the component in a given scene
  42445. */
  42446. register(): void;
  42447. /**
  42448. * Rebuilds the elements related to this component in case of
  42449. * context lost for instance.
  42450. */
  42451. rebuild(): void;
  42452. /**
  42453. * Serializes the component data to the specified json object
  42454. * @param serializationObject The object to serialize to
  42455. */
  42456. serialize(serializationObject: any): void;
  42457. /**
  42458. * Adds all the elements from the container to the scene
  42459. * @param container the container holding the elements
  42460. */
  42461. addFromContainer(container: AbstractScene): void;
  42462. /**
  42463. * Removes all the elements in the container from the scene
  42464. * @param container contains the elements to remove
  42465. * @param dispose if the removed element should be disposed (default: false)
  42466. */
  42467. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  42468. /**
  42469. * Disposes the component and the associated ressources.
  42470. */
  42471. dispose(): void;
  42472. /**
  42473. * Disables audio in the associated scene.
  42474. */
  42475. disableAudio(): void;
  42476. /**
  42477. * Enables audio in the associated scene.
  42478. */
  42479. enableAudio(): void;
  42480. /**
  42481. * Switch audio to headphone output.
  42482. */
  42483. switchAudioModeForHeadphones(): void;
  42484. /**
  42485. * Switch audio to normal speakers.
  42486. */
  42487. switchAudioModeForNormalSpeakers(): void;
  42488. private _cachedCameraDirection;
  42489. private _cachedCameraPosition;
  42490. private _lastCheck;
  42491. private _afterRender;
  42492. }
  42493. }
  42494. declare module "babylonjs/Audio/weightedsound" {
  42495. import { Sound } from "babylonjs/Audio/sound";
  42496. /**
  42497. * Wraps one or more Sound objects and selects one with random weight for playback.
  42498. */
  42499. export class WeightedSound {
  42500. /** When true a Sound will be selected and played when the current playing Sound completes. */
  42501. loop: boolean;
  42502. private _coneInnerAngle;
  42503. private _coneOuterAngle;
  42504. private _volume;
  42505. /** A Sound is currently playing. */
  42506. isPlaying: boolean;
  42507. /** A Sound is currently paused. */
  42508. isPaused: boolean;
  42509. private _sounds;
  42510. private _weights;
  42511. private _currentIndex?;
  42512. /**
  42513. * Creates a new WeightedSound from the list of sounds given.
  42514. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  42515. * @param sounds Array of Sounds that will be selected from.
  42516. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  42517. */
  42518. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  42519. /**
  42520. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  42521. */
  42522. get directionalConeInnerAngle(): number;
  42523. /**
  42524. * The size of cone in degress for a directional sound in which there will be no attenuation.
  42525. */
  42526. set directionalConeInnerAngle(value: number);
  42527. /**
  42528. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  42529. * Listener angles between innerAngle and outerAngle will falloff linearly.
  42530. */
  42531. get directionalConeOuterAngle(): number;
  42532. /**
  42533. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  42534. * Listener angles between innerAngle and outerAngle will falloff linearly.
  42535. */
  42536. set directionalConeOuterAngle(value: number);
  42537. /**
  42538. * Playback volume.
  42539. */
  42540. get volume(): number;
  42541. /**
  42542. * Playback volume.
  42543. */
  42544. set volume(value: number);
  42545. private _onended;
  42546. /**
  42547. * Suspend playback
  42548. */
  42549. pause(): void;
  42550. /**
  42551. * Stop playback
  42552. */
  42553. stop(): void;
  42554. /**
  42555. * Start playback.
  42556. * @param startOffset Position the clip head at a specific time in seconds.
  42557. */
  42558. play(startOffset?: number): void;
  42559. }
  42560. }
  42561. declare module "babylonjs/Audio/index" {
  42562. export * from "babylonjs/Audio/analyser";
  42563. export * from "babylonjs/Audio/audioEngine";
  42564. export * from "babylonjs/Audio/audioSceneComponent";
  42565. export * from "babylonjs/Audio/sound";
  42566. export * from "babylonjs/Audio/soundTrack";
  42567. export * from "babylonjs/Audio/weightedsound";
  42568. }
  42569. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  42570. import { Behavior } from "babylonjs/Behaviors/behavior";
  42571. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  42572. import { BackEase } from "babylonjs/Animations/easing";
  42573. /**
  42574. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  42575. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  42576. */
  42577. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  42578. /**
  42579. * Gets the name of the behavior.
  42580. */
  42581. get name(): string;
  42582. /**
  42583. * The easing function used by animations
  42584. */
  42585. static EasingFunction: BackEase;
  42586. /**
  42587. * The easing mode used by animations
  42588. */
  42589. static EasingMode: number;
  42590. /**
  42591. * The duration of the animation, in milliseconds
  42592. */
  42593. transitionDuration: number;
  42594. /**
  42595. * Length of the distance animated by the transition when lower radius is reached
  42596. */
  42597. lowerRadiusTransitionRange: number;
  42598. /**
  42599. * Length of the distance animated by the transition when upper radius is reached
  42600. */
  42601. upperRadiusTransitionRange: number;
  42602. private _autoTransitionRange;
  42603. /**
  42604. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  42605. */
  42606. get autoTransitionRange(): boolean;
  42607. /**
  42608. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  42609. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  42610. */
  42611. set autoTransitionRange(value: boolean);
  42612. private _attachedCamera;
  42613. private _onAfterCheckInputsObserver;
  42614. private _onMeshTargetChangedObserver;
  42615. /**
  42616. * Initializes the behavior.
  42617. */
  42618. init(): void;
  42619. /**
  42620. * Attaches the behavior to its arc rotate camera.
  42621. * @param camera Defines the camera to attach the behavior to
  42622. */
  42623. attach(camera: ArcRotateCamera): void;
  42624. /**
  42625. * Detaches the behavior from its current arc rotate camera.
  42626. */
  42627. detach(): void;
  42628. private _radiusIsAnimating;
  42629. private _radiusBounceTransition;
  42630. private _animatables;
  42631. private _cachedWheelPrecision;
  42632. /**
  42633. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  42634. * @param radiusLimit The limit to check against.
  42635. * @return Bool to indicate if at limit.
  42636. */
  42637. private _isRadiusAtLimit;
  42638. /**
  42639. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  42640. * @param radiusDelta The delta by which to animate to. Can be negative.
  42641. */
  42642. private _applyBoundRadiusAnimation;
  42643. /**
  42644. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  42645. */
  42646. protected _clearAnimationLocks(): void;
  42647. /**
  42648. * Stops and removes all animations that have been applied to the camera
  42649. */
  42650. stopAllAnimations(): void;
  42651. }
  42652. }
  42653. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  42654. import { Behavior } from "babylonjs/Behaviors/behavior";
  42655. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  42656. import { ExponentialEase } from "babylonjs/Animations/easing";
  42657. import { Nullable } from "babylonjs/types";
  42658. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42659. import { Vector3 } from "babylonjs/Maths/math.vector";
  42660. /**
  42661. * 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.
  42662. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  42663. */
  42664. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  42665. /**
  42666. * Gets the name of the behavior.
  42667. */
  42668. get name(): string;
  42669. private _mode;
  42670. private _radiusScale;
  42671. private _positionScale;
  42672. private _defaultElevation;
  42673. private _elevationReturnTime;
  42674. private _elevationReturnWaitTime;
  42675. private _zoomStopsAnimation;
  42676. private _framingTime;
  42677. /**
  42678. * The easing function used by animations
  42679. */
  42680. static EasingFunction: ExponentialEase;
  42681. /**
  42682. * The easing mode used by animations
  42683. */
  42684. static EasingMode: number;
  42685. /**
  42686. * Sets the current mode used by the behavior
  42687. */
  42688. set mode(mode: number);
  42689. /**
  42690. * Gets current mode used by the behavior.
  42691. */
  42692. get mode(): number;
  42693. /**
  42694. * Sets the scale applied to the radius (1 by default)
  42695. */
  42696. set radiusScale(radius: number);
  42697. /**
  42698. * Gets the scale applied to the radius
  42699. */
  42700. get radiusScale(): number;
  42701. /**
  42702. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  42703. */
  42704. set positionScale(scale: number);
  42705. /**
  42706. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  42707. */
  42708. get positionScale(): number;
  42709. /**
  42710. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  42711. * behaviour is triggered, in radians.
  42712. */
  42713. set defaultElevation(elevation: number);
  42714. /**
  42715. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  42716. * behaviour is triggered, in radians.
  42717. */
  42718. get defaultElevation(): number;
  42719. /**
  42720. * Sets the time (in milliseconds) taken to return to the default beta position.
  42721. * Negative value indicates camera should not return to default.
  42722. */
  42723. set elevationReturnTime(speed: number);
  42724. /**
  42725. * Gets the time (in milliseconds) taken to return to the default beta position.
  42726. * Negative value indicates camera should not return to default.
  42727. */
  42728. get elevationReturnTime(): number;
  42729. /**
  42730. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  42731. */
  42732. set elevationReturnWaitTime(time: number);
  42733. /**
  42734. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  42735. */
  42736. get elevationReturnWaitTime(): number;
  42737. /**
  42738. * Sets the flag that indicates if user zooming should stop animation.
  42739. */
  42740. set zoomStopsAnimation(flag: boolean);
  42741. /**
  42742. * Gets the flag that indicates if user zooming should stop animation.
  42743. */
  42744. get zoomStopsAnimation(): boolean;
  42745. /**
  42746. * Sets the transition time when framing the mesh, in milliseconds
  42747. */
  42748. set framingTime(time: number);
  42749. /**
  42750. * Gets the transition time when framing the mesh, in milliseconds
  42751. */
  42752. get framingTime(): number;
  42753. /**
  42754. * Define if the behavior should automatically change the configured
  42755. * camera limits and sensibilities.
  42756. */
  42757. autoCorrectCameraLimitsAndSensibility: boolean;
  42758. private _onPrePointerObservableObserver;
  42759. private _onAfterCheckInputsObserver;
  42760. private _onMeshTargetChangedObserver;
  42761. private _attachedCamera;
  42762. private _isPointerDown;
  42763. private _lastInteractionTime;
  42764. /**
  42765. * Initializes the behavior.
  42766. */
  42767. init(): void;
  42768. /**
  42769. * Attaches the behavior to its arc rotate camera.
  42770. * @param camera Defines the camera to attach the behavior to
  42771. */
  42772. attach(camera: ArcRotateCamera): void;
  42773. /**
  42774. * Detaches the behavior from its current arc rotate camera.
  42775. */
  42776. detach(): void;
  42777. private _animatables;
  42778. private _betaIsAnimating;
  42779. private _betaTransition;
  42780. private _radiusTransition;
  42781. private _vectorTransition;
  42782. /**
  42783. * Targets the given mesh and updates zoom level accordingly.
  42784. * @param mesh The mesh to target.
  42785. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  42786. * @param onAnimationEnd Callback triggered at the end of the framing animation
  42787. */
  42788. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  42789. /**
  42790. * Targets the given mesh with its children and updates zoom level accordingly.
  42791. * @param mesh The mesh to target.
  42792. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  42793. * @param onAnimationEnd Callback triggered at the end of the framing animation
  42794. */
  42795. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  42796. /**
  42797. * Targets the given meshes with their children and updates zoom level accordingly.
  42798. * @param meshes The mesh to target.
  42799. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  42800. * @param onAnimationEnd Callback triggered at the end of the framing animation
  42801. */
  42802. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  42803. /**
  42804. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  42805. * @param minimumWorld Determines the smaller position of the bounding box extend
  42806. * @param maximumWorld Determines the bigger position of the bounding box extend
  42807. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  42808. * @param onAnimationEnd Callback triggered at the end of the framing animation
  42809. */
  42810. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  42811. /**
  42812. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  42813. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  42814. * frustum width.
  42815. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  42816. * to fully enclose the mesh in the viewing frustum.
  42817. */
  42818. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  42819. /**
  42820. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  42821. * is automatically returned to its default position (expected to be above ground plane).
  42822. */
  42823. private _maintainCameraAboveGround;
  42824. /**
  42825. * Returns the frustum slope based on the canvas ratio and camera FOV
  42826. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  42827. */
  42828. private _getFrustumSlope;
  42829. /**
  42830. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  42831. */
  42832. private _clearAnimationLocks;
  42833. /**
  42834. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  42835. */
  42836. private _applyUserInteraction;
  42837. /**
  42838. * Stops and removes all animations that have been applied to the camera
  42839. */
  42840. stopAllAnimations(): void;
  42841. /**
  42842. * Gets a value indicating if the user is moving the camera
  42843. */
  42844. get isUserIsMoving(): boolean;
  42845. /**
  42846. * The camera can move all the way towards the mesh.
  42847. */
  42848. static IgnoreBoundsSizeMode: number;
  42849. /**
  42850. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  42851. */
  42852. static FitFrustumSidesMode: number;
  42853. }
  42854. }
  42855. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  42856. import { Nullable } from "babylonjs/types";
  42857. import { Camera } from "babylonjs/Cameras/camera";
  42858. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  42859. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  42860. /**
  42861. * Base class for Camera Pointer Inputs.
  42862. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  42863. * for example usage.
  42864. */
  42865. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  42866. /**
  42867. * Defines the camera the input is attached to.
  42868. */
  42869. abstract camera: Camera;
  42870. /**
  42871. * Whether keyboard modifier keys are pressed at time of last mouse event.
  42872. */
  42873. protected _altKey: boolean;
  42874. protected _ctrlKey: boolean;
  42875. protected _metaKey: boolean;
  42876. protected _shiftKey: boolean;
  42877. /**
  42878. * Which mouse buttons were pressed at time of last mouse event.
  42879. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  42880. */
  42881. protected _buttonsPressed: number;
  42882. /**
  42883. * Defines the buttons associated with the input to handle camera move.
  42884. */
  42885. buttons: number[];
  42886. /**
  42887. * Attach the input controls to a specific dom element to get the input from.
  42888. * @param element Defines the element the controls should be listened from
  42889. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  42890. */
  42891. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  42892. /**
  42893. * Detach the current controls from the specified dom element.
  42894. * @param element Defines the element to stop listening the inputs from
  42895. */
  42896. detachControl(element: Nullable<HTMLElement>): void;
  42897. /**
  42898. * Gets the class name of the current input.
  42899. * @returns the class name
  42900. */
  42901. getClassName(): string;
  42902. /**
  42903. * Get the friendly name associated with the input class.
  42904. * @returns the input friendly name
  42905. */
  42906. getSimpleName(): string;
  42907. /**
  42908. * Called on pointer POINTERDOUBLETAP event.
  42909. * Override this method to provide functionality on POINTERDOUBLETAP event.
  42910. */
  42911. protected onDoubleTap(type: string): void;
  42912. /**
  42913. * Called on pointer POINTERMOVE event if only a single touch is active.
  42914. * Override this method to provide functionality.
  42915. */
  42916. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  42917. /**
  42918. * Called on pointer POINTERMOVE event if multiple touches are active.
  42919. * Override this method to provide functionality.
  42920. */
  42921. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  42922. /**
  42923. * Called on JS contextmenu event.
  42924. * Override this method to provide functionality.
  42925. */
  42926. protected onContextMenu(evt: PointerEvent): void;
  42927. /**
  42928. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  42929. * press.
  42930. * Override this method to provide functionality.
  42931. */
  42932. protected onButtonDown(evt: PointerEvent): void;
  42933. /**
  42934. * Called each time a new POINTERUP event occurs. Ie, for each button
  42935. * release.
  42936. * Override this method to provide functionality.
  42937. */
  42938. protected onButtonUp(evt: PointerEvent): void;
  42939. /**
  42940. * Called when window becomes inactive.
  42941. * Override this method to provide functionality.
  42942. */
  42943. protected onLostFocus(): void;
  42944. private _pointerInput;
  42945. private _observer;
  42946. private _onLostFocus;
  42947. private pointA;
  42948. private pointB;
  42949. }
  42950. }
  42951. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  42952. import { Nullable } from "babylonjs/types";
  42953. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  42954. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  42955. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  42956. /**
  42957. * Manage the pointers inputs to control an arc rotate camera.
  42958. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  42959. */
  42960. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  42961. /**
  42962. * Defines the camera the input is attached to.
  42963. */
  42964. camera: ArcRotateCamera;
  42965. /**
  42966. * Gets the class name of the current input.
  42967. * @returns the class name
  42968. */
  42969. getClassName(): string;
  42970. /**
  42971. * Defines the buttons associated with the input to handle camera move.
  42972. */
  42973. buttons: number[];
  42974. /**
  42975. * Defines the pointer angular sensibility along the X axis or how fast is
  42976. * the camera rotating.
  42977. */
  42978. angularSensibilityX: number;
  42979. /**
  42980. * Defines the pointer angular sensibility along the Y axis or how fast is
  42981. * the camera rotating.
  42982. */
  42983. angularSensibilityY: number;
  42984. /**
  42985. * Defines the pointer pinch precision or how fast is the camera zooming.
  42986. */
  42987. pinchPrecision: number;
  42988. /**
  42989. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  42990. * from 0.
  42991. * It defines the percentage of current camera.radius to use as delta when
  42992. * pinch zoom is used.
  42993. */
  42994. pinchDeltaPercentage: number;
  42995. /**
  42996. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  42997. * that any object in the plane at the camera's target point will scale
  42998. * perfectly with finger motion.
  42999. * Overrides pinchDeltaPercentage and pinchPrecision.
  43000. */
  43001. useNaturalPinchZoom: boolean;
  43002. /**
  43003. * Defines the pointer panning sensibility or how fast is the camera moving.
  43004. */
  43005. panningSensibility: number;
  43006. /**
  43007. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  43008. */
  43009. multiTouchPanning: boolean;
  43010. /**
  43011. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  43012. * zoom (pinch) through multitouch.
  43013. */
  43014. multiTouchPanAndZoom: boolean;
  43015. /**
  43016. * Revers pinch action direction.
  43017. */
  43018. pinchInwards: boolean;
  43019. private _isPanClick;
  43020. private _twoFingerActivityCount;
  43021. private _isPinching;
  43022. /**
  43023. * Called on pointer POINTERMOVE event if only a single touch is active.
  43024. */
  43025. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  43026. /**
  43027. * Called on pointer POINTERDOUBLETAP event.
  43028. */
  43029. protected onDoubleTap(type: string): void;
  43030. /**
  43031. * Called on pointer POINTERMOVE event if multiple touches are active.
  43032. */
  43033. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  43034. /**
  43035. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  43036. * press.
  43037. */
  43038. protected onButtonDown(evt: PointerEvent): void;
  43039. /**
  43040. * Called each time a new POINTERUP event occurs. Ie, for each button
  43041. * release.
  43042. */
  43043. protected onButtonUp(evt: PointerEvent): void;
  43044. /**
  43045. * Called when window becomes inactive.
  43046. */
  43047. protected onLostFocus(): void;
  43048. }
  43049. }
  43050. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  43051. import { Nullable } from "babylonjs/types";
  43052. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43053. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43054. /**
  43055. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  43056. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  43057. */
  43058. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  43059. /**
  43060. * Defines the camera the input is attached to.
  43061. */
  43062. camera: ArcRotateCamera;
  43063. /**
  43064. * Defines the list of key codes associated with the up action (increase alpha)
  43065. */
  43066. keysUp: number[];
  43067. /**
  43068. * Defines the list of key codes associated with the down action (decrease alpha)
  43069. */
  43070. keysDown: number[];
  43071. /**
  43072. * Defines the list of key codes associated with the left action (increase beta)
  43073. */
  43074. keysLeft: number[];
  43075. /**
  43076. * Defines the list of key codes associated with the right action (decrease beta)
  43077. */
  43078. keysRight: number[];
  43079. /**
  43080. * Defines the list of key codes associated with the reset action.
  43081. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  43082. */
  43083. keysReset: number[];
  43084. /**
  43085. * Defines the panning sensibility of the inputs.
  43086. * (How fast is the camera panning)
  43087. */
  43088. panningSensibility: number;
  43089. /**
  43090. * Defines the zooming sensibility of the inputs.
  43091. * (How fast is the camera zooming)
  43092. */
  43093. zoomingSensibility: number;
  43094. /**
  43095. * Defines whether maintaining the alt key down switch the movement mode from
  43096. * orientation to zoom.
  43097. */
  43098. useAltToZoom: boolean;
  43099. /**
  43100. * Rotation speed of the camera
  43101. */
  43102. angularSpeed: number;
  43103. private _keys;
  43104. private _ctrlPressed;
  43105. private _altPressed;
  43106. private _onCanvasBlurObserver;
  43107. private _onKeyboardObserver;
  43108. private _engine;
  43109. private _scene;
  43110. /**
  43111. * Attach the input controls to a specific dom element to get the input from.
  43112. * @param element Defines the element the controls should be listened from
  43113. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43114. */
  43115. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43116. /**
  43117. * Detach the current controls from the specified dom element.
  43118. * @param element Defines the element to stop listening the inputs from
  43119. */
  43120. detachControl(element: Nullable<HTMLElement>): void;
  43121. /**
  43122. * Update the current camera state depending on the inputs that have been used this frame.
  43123. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  43124. */
  43125. checkInputs(): void;
  43126. /**
  43127. * Gets the class name of the current intput.
  43128. * @returns the class name
  43129. */
  43130. getClassName(): string;
  43131. /**
  43132. * Get the friendly name associated with the input class.
  43133. * @returns the input friendly name
  43134. */
  43135. getSimpleName(): string;
  43136. }
  43137. }
  43138. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  43139. import { Nullable } from "babylonjs/types";
  43140. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43141. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43142. /**
  43143. * Manage the mouse wheel inputs to control an arc rotate camera.
  43144. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  43145. */
  43146. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  43147. /**
  43148. * Defines the camera the input is attached to.
  43149. */
  43150. camera: ArcRotateCamera;
  43151. /**
  43152. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  43153. */
  43154. wheelPrecision: number;
  43155. /**
  43156. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  43157. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  43158. */
  43159. wheelDeltaPercentage: number;
  43160. private _wheel;
  43161. private _observer;
  43162. private computeDeltaFromMouseWheelLegacyEvent;
  43163. /**
  43164. * Attach the input controls to a specific dom element to get the input from.
  43165. * @param element Defines the element the controls should be listened from
  43166. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43167. */
  43168. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43169. /**
  43170. * Detach the current controls from the specified dom element.
  43171. * @param element Defines the element to stop listening the inputs from
  43172. */
  43173. detachControl(element: Nullable<HTMLElement>): void;
  43174. /**
  43175. * Gets the class name of the current intput.
  43176. * @returns the class name
  43177. */
  43178. getClassName(): string;
  43179. /**
  43180. * Get the friendly name associated with the input class.
  43181. * @returns the input friendly name
  43182. */
  43183. getSimpleName(): string;
  43184. }
  43185. }
  43186. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  43187. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43188. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  43189. /**
  43190. * Default Inputs manager for the ArcRotateCamera.
  43191. * It groups all the default supported inputs for ease of use.
  43192. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  43193. */
  43194. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  43195. /**
  43196. * Instantiates a new ArcRotateCameraInputsManager.
  43197. * @param camera Defines the camera the inputs belong to
  43198. */
  43199. constructor(camera: ArcRotateCamera);
  43200. /**
  43201. * Add mouse wheel input support to the input manager.
  43202. * @returns the current input manager
  43203. */
  43204. addMouseWheel(): ArcRotateCameraInputsManager;
  43205. /**
  43206. * Add pointers input support to the input manager.
  43207. * @returns the current input manager
  43208. */
  43209. addPointers(): ArcRotateCameraInputsManager;
  43210. /**
  43211. * Add keyboard input support to the input manager.
  43212. * @returns the current input manager
  43213. */
  43214. addKeyboard(): ArcRotateCameraInputsManager;
  43215. }
  43216. }
  43217. declare module "babylonjs/Cameras/arcRotateCamera" {
  43218. import { Observable } from "babylonjs/Misc/observable";
  43219. import { Nullable } from "babylonjs/types";
  43220. import { Scene } from "babylonjs/scene";
  43221. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  43222. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43223. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  43224. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  43225. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  43226. import { Camera } from "babylonjs/Cameras/camera";
  43227. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  43228. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  43229. import { Collider } from "babylonjs/Collisions/collider";
  43230. /**
  43231. * This represents an orbital type of camera.
  43232. *
  43233. * 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.
  43234. * 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.
  43235. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  43236. */
  43237. export class ArcRotateCamera extends TargetCamera {
  43238. /**
  43239. * Defines the rotation angle of the camera along the longitudinal axis.
  43240. */
  43241. alpha: number;
  43242. /**
  43243. * Defines the rotation angle of the camera along the latitudinal axis.
  43244. */
  43245. beta: number;
  43246. /**
  43247. * Defines the radius of the camera from it s target point.
  43248. */
  43249. radius: number;
  43250. protected _target: Vector3;
  43251. protected _targetHost: Nullable<AbstractMesh>;
  43252. /**
  43253. * Defines the target point of the camera.
  43254. * The camera looks towards it form the radius distance.
  43255. */
  43256. get target(): Vector3;
  43257. set target(value: Vector3);
  43258. /**
  43259. * Define the current local position of the camera in the scene
  43260. */
  43261. get position(): Vector3;
  43262. set position(newPosition: Vector3);
  43263. protected _upVector: Vector3;
  43264. protected _upToYMatrix: Matrix;
  43265. protected _YToUpMatrix: Matrix;
  43266. /**
  43267. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  43268. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  43269. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  43270. */
  43271. set upVector(vec: Vector3);
  43272. get upVector(): Vector3;
  43273. /**
  43274. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  43275. */
  43276. setMatUp(): void;
  43277. /**
  43278. * Current inertia value on the longitudinal axis.
  43279. * The bigger this number the longer it will take for the camera to stop.
  43280. */
  43281. inertialAlphaOffset: number;
  43282. /**
  43283. * Current inertia value on the latitudinal axis.
  43284. * The bigger this number the longer it will take for the camera to stop.
  43285. */
  43286. inertialBetaOffset: number;
  43287. /**
  43288. * Current inertia value on the radius axis.
  43289. * The bigger this number the longer it will take for the camera to stop.
  43290. */
  43291. inertialRadiusOffset: number;
  43292. /**
  43293. * Minimum allowed angle on the longitudinal axis.
  43294. * This can help limiting how the Camera is able to move in the scene.
  43295. */
  43296. lowerAlphaLimit: Nullable<number>;
  43297. /**
  43298. * Maximum allowed angle on the longitudinal axis.
  43299. * This can help limiting how the Camera is able to move in the scene.
  43300. */
  43301. upperAlphaLimit: Nullable<number>;
  43302. /**
  43303. * Minimum allowed angle on the latitudinal axis.
  43304. * This can help limiting how the Camera is able to move in the scene.
  43305. */
  43306. lowerBetaLimit: number;
  43307. /**
  43308. * Maximum allowed angle on the latitudinal axis.
  43309. * This can help limiting how the Camera is able to move in the scene.
  43310. */
  43311. upperBetaLimit: number;
  43312. /**
  43313. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  43314. * This can help limiting how the Camera is able to move in the scene.
  43315. */
  43316. lowerRadiusLimit: Nullable<number>;
  43317. /**
  43318. * Maximum allowed distance of the camera to the target (The camera can not get further).
  43319. * This can help limiting how the Camera is able to move in the scene.
  43320. */
  43321. upperRadiusLimit: Nullable<number>;
  43322. /**
  43323. * Defines the current inertia value used during panning of the camera along the X axis.
  43324. */
  43325. inertialPanningX: number;
  43326. /**
  43327. * Defines the current inertia value used during panning of the camera along the Y axis.
  43328. */
  43329. inertialPanningY: number;
  43330. /**
  43331. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  43332. * Basically if your fingers moves away from more than this distance you will be considered
  43333. * in pinch mode.
  43334. */
  43335. pinchToPanMaxDistance: number;
  43336. /**
  43337. * Defines the maximum distance the camera can pan.
  43338. * This could help keeping the cammera always in your scene.
  43339. */
  43340. panningDistanceLimit: Nullable<number>;
  43341. /**
  43342. * Defines the target of the camera before paning.
  43343. */
  43344. panningOriginTarget: Vector3;
  43345. /**
  43346. * Defines the value of the inertia used during panning.
  43347. * 0 would mean stop inertia and one would mean no decelleration at all.
  43348. */
  43349. panningInertia: number;
  43350. /**
  43351. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  43352. */
  43353. get angularSensibilityX(): number;
  43354. set angularSensibilityX(value: number);
  43355. /**
  43356. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  43357. */
  43358. get angularSensibilityY(): number;
  43359. set angularSensibilityY(value: number);
  43360. /**
  43361. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  43362. */
  43363. get pinchPrecision(): number;
  43364. set pinchPrecision(value: number);
  43365. /**
  43366. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  43367. * It will be used instead of pinchDeltaPrecision if different from 0.
  43368. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  43369. */
  43370. get pinchDeltaPercentage(): number;
  43371. set pinchDeltaPercentage(value: number);
  43372. /**
  43373. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  43374. * and pinch delta percentage.
  43375. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  43376. * that any object in the plane at the camera's target point will scale
  43377. * perfectly with finger motion.
  43378. */
  43379. get useNaturalPinchZoom(): boolean;
  43380. set useNaturalPinchZoom(value: boolean);
  43381. /**
  43382. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  43383. */
  43384. get panningSensibility(): number;
  43385. set panningSensibility(value: number);
  43386. /**
  43387. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  43388. */
  43389. get keysUp(): number[];
  43390. set keysUp(value: number[]);
  43391. /**
  43392. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  43393. */
  43394. get keysDown(): number[];
  43395. set keysDown(value: number[]);
  43396. /**
  43397. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  43398. */
  43399. get keysLeft(): number[];
  43400. set keysLeft(value: number[]);
  43401. /**
  43402. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  43403. */
  43404. get keysRight(): number[];
  43405. set keysRight(value: number[]);
  43406. /**
  43407. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  43408. */
  43409. get wheelPrecision(): number;
  43410. set wheelPrecision(value: number);
  43411. /**
  43412. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  43413. * It will be used instead of pinchDeltaPrecision if different from 0.
  43414. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  43415. */
  43416. get wheelDeltaPercentage(): number;
  43417. set wheelDeltaPercentage(value: number);
  43418. /**
  43419. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  43420. */
  43421. zoomOnFactor: number;
  43422. /**
  43423. * Defines a screen offset for the camera position.
  43424. */
  43425. targetScreenOffset: Vector2;
  43426. /**
  43427. * Allows the camera to be completely reversed.
  43428. * If false the camera can not arrive upside down.
  43429. */
  43430. allowUpsideDown: boolean;
  43431. /**
  43432. * Define if double tap/click is used to restore the previously saved state of the camera.
  43433. */
  43434. useInputToRestoreState: boolean;
  43435. /** @hidden */
  43436. _viewMatrix: Matrix;
  43437. /** @hidden */
  43438. _useCtrlForPanning: boolean;
  43439. /** @hidden */
  43440. _panningMouseButton: number;
  43441. /**
  43442. * Defines the input associated to the camera.
  43443. */
  43444. inputs: ArcRotateCameraInputsManager;
  43445. /** @hidden */
  43446. _reset: () => void;
  43447. /**
  43448. * Defines the allowed panning axis.
  43449. */
  43450. panningAxis: Vector3;
  43451. protected _localDirection: Vector3;
  43452. protected _transformedDirection: Vector3;
  43453. private _bouncingBehavior;
  43454. /**
  43455. * Gets the bouncing behavior of the camera if it has been enabled.
  43456. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43457. */
  43458. get bouncingBehavior(): Nullable<BouncingBehavior>;
  43459. /**
  43460. * Defines if the bouncing behavior of the camera is enabled on the camera.
  43461. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43462. */
  43463. get useBouncingBehavior(): boolean;
  43464. set useBouncingBehavior(value: boolean);
  43465. private _framingBehavior;
  43466. /**
  43467. * Gets the framing behavior of the camera if it has been enabled.
  43468. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43469. */
  43470. get framingBehavior(): Nullable<FramingBehavior>;
  43471. /**
  43472. * Defines if the framing behavior of the camera is enabled on the camera.
  43473. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43474. */
  43475. get useFramingBehavior(): boolean;
  43476. set useFramingBehavior(value: boolean);
  43477. private _autoRotationBehavior;
  43478. /**
  43479. * Gets the auto rotation behavior of the camera if it has been enabled.
  43480. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  43481. */
  43482. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  43483. /**
  43484. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  43485. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  43486. */
  43487. get useAutoRotationBehavior(): boolean;
  43488. set useAutoRotationBehavior(value: boolean);
  43489. /**
  43490. * Observable triggered when the mesh target has been changed on the camera.
  43491. */
  43492. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  43493. /**
  43494. * Event raised when the camera is colliding with a mesh.
  43495. */
  43496. onCollide: (collidedMesh: AbstractMesh) => void;
  43497. /**
  43498. * Defines whether the camera should check collision with the objects oh the scene.
  43499. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  43500. */
  43501. checkCollisions: boolean;
  43502. /**
  43503. * Defines the collision radius of the camera.
  43504. * This simulates a sphere around the camera.
  43505. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  43506. */
  43507. collisionRadius: Vector3;
  43508. protected _collider: Collider;
  43509. protected _previousPosition: Vector3;
  43510. protected _collisionVelocity: Vector3;
  43511. protected _newPosition: Vector3;
  43512. protected _previousAlpha: number;
  43513. protected _previousBeta: number;
  43514. protected _previousRadius: number;
  43515. protected _collisionTriggered: boolean;
  43516. protected _targetBoundingCenter: Nullable<Vector3>;
  43517. private _computationVector;
  43518. /**
  43519. * Instantiates a new ArcRotateCamera in a given scene
  43520. * @param name Defines the name of the camera
  43521. * @param alpha Defines the camera rotation along the logitudinal axis
  43522. * @param beta Defines the camera rotation along the latitudinal axis
  43523. * @param radius Defines the camera distance from its target
  43524. * @param target Defines the camera target
  43525. * @param scene Defines the scene the camera belongs to
  43526. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  43527. */
  43528. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  43529. /** @hidden */
  43530. _initCache(): void;
  43531. /** @hidden */
  43532. _updateCache(ignoreParentClass?: boolean): void;
  43533. protected _getTargetPosition(): Vector3;
  43534. private _storedAlpha;
  43535. private _storedBeta;
  43536. private _storedRadius;
  43537. private _storedTarget;
  43538. private _storedTargetScreenOffset;
  43539. /**
  43540. * Stores the current state of the camera (alpha, beta, radius and target)
  43541. * @returns the camera itself
  43542. */
  43543. storeState(): Camera;
  43544. /**
  43545. * @hidden
  43546. * Restored camera state. You must call storeState() first
  43547. */
  43548. _restoreStateValues(): boolean;
  43549. /** @hidden */
  43550. _isSynchronizedViewMatrix(): boolean;
  43551. /**
  43552. * Attached controls to the current camera.
  43553. * @param element Defines the element the controls should be listened from
  43554. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43555. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  43556. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  43557. */
  43558. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  43559. /**
  43560. * Detach the current controls from the camera.
  43561. * The camera will stop reacting to inputs.
  43562. * @param element Defines the element to stop listening the inputs from
  43563. */
  43564. detachControl(element: HTMLElement): void;
  43565. /** @hidden */
  43566. _checkInputs(): void;
  43567. protected _checkLimits(): void;
  43568. /**
  43569. * Rebuilds angles (alpha, beta) and radius from the give position and target
  43570. */
  43571. rebuildAnglesAndRadius(): void;
  43572. /**
  43573. * Use a position to define the current camera related information like alpha, beta and radius
  43574. * @param position Defines the position to set the camera at
  43575. */
  43576. setPosition(position: Vector3): void;
  43577. /**
  43578. * Defines the target the camera should look at.
  43579. * This will automatically adapt alpha beta and radius to fit within the new target.
  43580. * @param target Defines the new target as a Vector or a mesh
  43581. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  43582. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  43583. */
  43584. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  43585. /** @hidden */
  43586. _getViewMatrix(): Matrix;
  43587. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  43588. /**
  43589. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  43590. * @param meshes Defines the mesh to zoom on
  43591. * @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)
  43592. */
  43593. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  43594. /**
  43595. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  43596. * The target will be changed but the radius
  43597. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  43598. * @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)
  43599. */
  43600. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  43601. min: Vector3;
  43602. max: Vector3;
  43603. distance: number;
  43604. }, doNotUpdateMaxZ?: boolean): void;
  43605. /**
  43606. * @override
  43607. * Override Camera.createRigCamera
  43608. */
  43609. createRigCamera(name: string, cameraIndex: number): Camera;
  43610. /**
  43611. * @hidden
  43612. * @override
  43613. * Override Camera._updateRigCameras
  43614. */
  43615. _updateRigCameras(): void;
  43616. /**
  43617. * Destroy the camera and release the current resources hold by it.
  43618. */
  43619. dispose(): void;
  43620. /**
  43621. * Gets the current object class name.
  43622. * @return the class name
  43623. */
  43624. getClassName(): string;
  43625. }
  43626. }
  43627. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  43628. import { Behavior } from "babylonjs/Behaviors/behavior";
  43629. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43630. /**
  43631. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  43632. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  43633. */
  43634. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  43635. /**
  43636. * Gets the name of the behavior.
  43637. */
  43638. get name(): string;
  43639. private _zoomStopsAnimation;
  43640. private _idleRotationSpeed;
  43641. private _idleRotationWaitTime;
  43642. private _idleRotationSpinupTime;
  43643. /**
  43644. * Sets the flag that indicates if user zooming should stop animation.
  43645. */
  43646. set zoomStopsAnimation(flag: boolean);
  43647. /**
  43648. * Gets the flag that indicates if user zooming should stop animation.
  43649. */
  43650. get zoomStopsAnimation(): boolean;
  43651. /**
  43652. * Sets the default speed at which the camera rotates around the model.
  43653. */
  43654. set idleRotationSpeed(speed: number);
  43655. /**
  43656. * Gets the default speed at which the camera rotates around the model.
  43657. */
  43658. get idleRotationSpeed(): number;
  43659. /**
  43660. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  43661. */
  43662. set idleRotationWaitTime(time: number);
  43663. /**
  43664. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  43665. */
  43666. get idleRotationWaitTime(): number;
  43667. /**
  43668. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  43669. */
  43670. set idleRotationSpinupTime(time: number);
  43671. /**
  43672. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  43673. */
  43674. get idleRotationSpinupTime(): number;
  43675. /**
  43676. * Gets a value indicating if the camera is currently rotating because of this behavior
  43677. */
  43678. get rotationInProgress(): boolean;
  43679. private _onPrePointerObservableObserver;
  43680. private _onAfterCheckInputsObserver;
  43681. private _attachedCamera;
  43682. private _isPointerDown;
  43683. private _lastFrameTime;
  43684. private _lastInteractionTime;
  43685. private _cameraRotationSpeed;
  43686. /**
  43687. * Initializes the behavior.
  43688. */
  43689. init(): void;
  43690. /**
  43691. * Attaches the behavior to its arc rotate camera.
  43692. * @param camera Defines the camera to attach the behavior to
  43693. */
  43694. attach(camera: ArcRotateCamera): void;
  43695. /**
  43696. * Detaches the behavior from its current arc rotate camera.
  43697. */
  43698. detach(): void;
  43699. /**
  43700. * Returns true if user is scrolling.
  43701. * @return true if user is scrolling.
  43702. */
  43703. private _userIsZooming;
  43704. private _lastFrameRadius;
  43705. private _shouldAnimationStopForInteraction;
  43706. /**
  43707. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43708. */
  43709. private _applyUserInteraction;
  43710. private _userIsMoving;
  43711. }
  43712. }
  43713. declare module "babylonjs/Behaviors/Cameras/index" {
  43714. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  43715. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  43716. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  43717. }
  43718. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  43719. import { Mesh } from "babylonjs/Meshes/mesh";
  43720. import { TransformNode } from "babylonjs/Meshes/transformNode";
  43721. import { Behavior } from "babylonjs/Behaviors/behavior";
  43722. /**
  43723. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  43724. */
  43725. export class AttachToBoxBehavior implements Behavior<Mesh> {
  43726. private ui;
  43727. /**
  43728. * The name of the behavior
  43729. */
  43730. name: string;
  43731. /**
  43732. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  43733. */
  43734. distanceAwayFromFace: number;
  43735. /**
  43736. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  43737. */
  43738. distanceAwayFromBottomOfFace: number;
  43739. private _faceVectors;
  43740. private _target;
  43741. private _scene;
  43742. private _onRenderObserver;
  43743. private _tmpMatrix;
  43744. private _tmpVector;
  43745. /**
  43746. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  43747. * @param ui The transform node that should be attched to the mesh
  43748. */
  43749. constructor(ui: TransformNode);
  43750. /**
  43751. * Initializes the behavior
  43752. */
  43753. init(): void;
  43754. private _closestFace;
  43755. private _zeroVector;
  43756. private _lookAtTmpMatrix;
  43757. private _lookAtToRef;
  43758. /**
  43759. * Attaches the AttachToBoxBehavior to the passed in mesh
  43760. * @param target The mesh that the specified node will be attached to
  43761. */
  43762. attach(target: Mesh): void;
  43763. /**
  43764. * Detaches the behavior from the mesh
  43765. */
  43766. detach(): void;
  43767. }
  43768. }
  43769. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  43770. import { Behavior } from "babylonjs/Behaviors/behavior";
  43771. import { Mesh } from "babylonjs/Meshes/mesh";
  43772. /**
  43773. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  43774. */
  43775. export class FadeInOutBehavior implements Behavior<Mesh> {
  43776. /**
  43777. * Time in milliseconds to delay before fading in (Default: 0)
  43778. */
  43779. delay: number;
  43780. /**
  43781. * Time in milliseconds for the mesh to fade in (Default: 300)
  43782. */
  43783. fadeInTime: number;
  43784. private _millisecondsPerFrame;
  43785. private _hovered;
  43786. private _hoverValue;
  43787. private _ownerNode;
  43788. /**
  43789. * Instatiates the FadeInOutBehavior
  43790. */
  43791. constructor();
  43792. /**
  43793. * The name of the behavior
  43794. */
  43795. get name(): string;
  43796. /**
  43797. * Initializes the behavior
  43798. */
  43799. init(): void;
  43800. /**
  43801. * Attaches the fade behavior on the passed in mesh
  43802. * @param ownerNode The mesh that will be faded in/out once attached
  43803. */
  43804. attach(ownerNode: Mesh): void;
  43805. /**
  43806. * Detaches the behavior from the mesh
  43807. */
  43808. detach(): void;
  43809. /**
  43810. * Triggers the mesh to begin fading in or out
  43811. * @param value if the object should fade in or out (true to fade in)
  43812. */
  43813. fadeIn(value: boolean): void;
  43814. private _update;
  43815. private _setAllVisibility;
  43816. }
  43817. }
  43818. declare module "babylonjs/Misc/pivotTools" {
  43819. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43820. /**
  43821. * Class containing a set of static utilities functions for managing Pivots
  43822. * @hidden
  43823. */
  43824. export class PivotTools {
  43825. private static _PivotCached;
  43826. private static _OldPivotPoint;
  43827. private static _PivotTranslation;
  43828. private static _PivotTmpVector;
  43829. /** @hidden */
  43830. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  43831. /** @hidden */
  43832. static _RestorePivotPoint(mesh: AbstractMesh): void;
  43833. }
  43834. }
  43835. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  43836. import { Scene } from "babylonjs/scene";
  43837. import { Vector4 } from "babylonjs/Maths/math.vector";
  43838. import { Mesh } from "babylonjs/Meshes/mesh";
  43839. import { Nullable } from "babylonjs/types";
  43840. import { Plane } from "babylonjs/Maths/math.plane";
  43841. /**
  43842. * Class containing static functions to help procedurally build meshes
  43843. */
  43844. export class PlaneBuilder {
  43845. /**
  43846. * Creates a plane mesh
  43847. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  43848. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  43849. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  43850. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  43851. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  43852. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  43853. * @param name defines the name of the mesh
  43854. * @param options defines the options used to create the mesh
  43855. * @param scene defines the hosting scene
  43856. * @returns the plane mesh
  43857. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  43858. */
  43859. static CreatePlane(name: string, options: {
  43860. size?: number;
  43861. width?: number;
  43862. height?: number;
  43863. sideOrientation?: number;
  43864. frontUVs?: Vector4;
  43865. backUVs?: Vector4;
  43866. updatable?: boolean;
  43867. sourcePlane?: Plane;
  43868. }, scene?: Nullable<Scene>): Mesh;
  43869. }
  43870. }
  43871. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  43872. import { Behavior } from "babylonjs/Behaviors/behavior";
  43873. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43874. import { Observable } from "babylonjs/Misc/observable";
  43875. import { Vector3 } from "babylonjs/Maths/math.vector";
  43876. import { Ray } from "babylonjs/Culling/ray";
  43877. import "babylonjs/Meshes/Builders/planeBuilder";
  43878. /**
  43879. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  43880. */
  43881. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  43882. private static _AnyMouseID;
  43883. /**
  43884. * Abstract mesh the behavior is set on
  43885. */
  43886. attachedNode: AbstractMesh;
  43887. private _dragPlane;
  43888. private _scene;
  43889. private _pointerObserver;
  43890. private _beforeRenderObserver;
  43891. private static _planeScene;
  43892. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  43893. /**
  43894. * 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)
  43895. */
  43896. maxDragAngle: number;
  43897. /**
  43898. * @hidden
  43899. */
  43900. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  43901. /**
  43902. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  43903. */
  43904. currentDraggingPointerID: number;
  43905. /**
  43906. * The last position where the pointer hit the drag plane in world space
  43907. */
  43908. lastDragPosition: Vector3;
  43909. /**
  43910. * If the behavior is currently in a dragging state
  43911. */
  43912. dragging: boolean;
  43913. /**
  43914. * 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)
  43915. */
  43916. dragDeltaRatio: number;
  43917. /**
  43918. * If the drag plane orientation should be updated during the dragging (Default: true)
  43919. */
  43920. updateDragPlane: boolean;
  43921. private _debugMode;
  43922. private _moving;
  43923. /**
  43924. * Fires each time the attached mesh is dragged with the pointer
  43925. * * delta between last drag position and current drag position in world space
  43926. * * dragDistance along the drag axis
  43927. * * dragPlaneNormal normal of the current drag plane used during the drag
  43928. * * dragPlanePoint in world space where the drag intersects the drag plane
  43929. */
  43930. onDragObservable: Observable<{
  43931. delta: Vector3;
  43932. dragPlanePoint: Vector3;
  43933. dragPlaneNormal: Vector3;
  43934. dragDistance: number;
  43935. pointerId: number;
  43936. }>;
  43937. /**
  43938. * Fires each time a drag begins (eg. mouse down on mesh)
  43939. */
  43940. onDragStartObservable: Observable<{
  43941. dragPlanePoint: Vector3;
  43942. pointerId: number;
  43943. }>;
  43944. /**
  43945. * Fires each time a drag ends (eg. mouse release after drag)
  43946. */
  43947. onDragEndObservable: Observable<{
  43948. dragPlanePoint: Vector3;
  43949. pointerId: number;
  43950. }>;
  43951. /**
  43952. * If the attached mesh should be moved when dragged
  43953. */
  43954. moveAttached: boolean;
  43955. /**
  43956. * If the drag behavior will react to drag events (Default: true)
  43957. */
  43958. enabled: boolean;
  43959. /**
  43960. * If pointer events should start and release the drag (Default: true)
  43961. */
  43962. startAndReleaseDragOnPointerEvents: boolean;
  43963. /**
  43964. * If camera controls should be detached during the drag
  43965. */
  43966. detachCameraControls: boolean;
  43967. /**
  43968. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  43969. */
  43970. useObjectOrientationForDragging: boolean;
  43971. private _options;
  43972. /**
  43973. * Gets the options used by the behavior
  43974. */
  43975. get options(): {
  43976. dragAxis?: Vector3;
  43977. dragPlaneNormal?: Vector3;
  43978. };
  43979. /**
  43980. * Sets the options used by the behavior
  43981. */
  43982. set options(options: {
  43983. dragAxis?: Vector3;
  43984. dragPlaneNormal?: Vector3;
  43985. });
  43986. /**
  43987. * Creates a pointer drag behavior that can be attached to a mesh
  43988. * @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)
  43989. */
  43990. constructor(options?: {
  43991. dragAxis?: Vector3;
  43992. dragPlaneNormal?: Vector3;
  43993. });
  43994. /**
  43995. * Predicate to determine if it is valid to move the object to a new position when it is moved
  43996. */
  43997. validateDrag: (targetPosition: Vector3) => boolean;
  43998. /**
  43999. * The name of the behavior
  44000. */
  44001. get name(): string;
  44002. /**
  44003. * Initializes the behavior
  44004. */
  44005. init(): void;
  44006. private _tmpVector;
  44007. private _alternatePickedPoint;
  44008. private _worldDragAxis;
  44009. private _targetPosition;
  44010. private _attachedElement;
  44011. /**
  44012. * Attaches the drag behavior the passed in mesh
  44013. * @param ownerNode The mesh that will be dragged around once attached
  44014. * @param predicate Predicate to use for pick filtering
  44015. */
  44016. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  44017. /**
  44018. * Force relase the drag action by code.
  44019. */
  44020. releaseDrag(): void;
  44021. private _startDragRay;
  44022. private _lastPointerRay;
  44023. /**
  44024. * Simulates the start of a pointer drag event on the behavior
  44025. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  44026. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  44027. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  44028. */
  44029. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  44030. private _startDrag;
  44031. private _dragDelta;
  44032. private _moveDrag;
  44033. private _pickWithRayOnDragPlane;
  44034. private _pointA;
  44035. private _pointB;
  44036. private _pointC;
  44037. private _lineA;
  44038. private _lineB;
  44039. private _localAxis;
  44040. private _lookAt;
  44041. private _updateDragPlanePosition;
  44042. /**
  44043. * Detaches the behavior from the mesh
  44044. */
  44045. detach(): void;
  44046. }
  44047. }
  44048. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  44049. import { Mesh } from "babylonjs/Meshes/mesh";
  44050. import { Behavior } from "babylonjs/Behaviors/behavior";
  44051. /**
  44052. * A behavior that when attached to a mesh will allow the mesh to be scaled
  44053. */
  44054. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  44055. private _dragBehaviorA;
  44056. private _dragBehaviorB;
  44057. private _startDistance;
  44058. private _initialScale;
  44059. private _targetScale;
  44060. private _ownerNode;
  44061. private _sceneRenderObserver;
  44062. /**
  44063. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  44064. */
  44065. constructor();
  44066. /**
  44067. * The name of the behavior
  44068. */
  44069. get name(): string;
  44070. /**
  44071. * Initializes the behavior
  44072. */
  44073. init(): void;
  44074. private _getCurrentDistance;
  44075. /**
  44076. * Attaches the scale behavior the passed in mesh
  44077. * @param ownerNode The mesh that will be scaled around once attached
  44078. */
  44079. attach(ownerNode: Mesh): void;
  44080. /**
  44081. * Detaches the behavior from the mesh
  44082. */
  44083. detach(): void;
  44084. }
  44085. }
  44086. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  44087. import { Behavior } from "babylonjs/Behaviors/behavior";
  44088. import { Mesh } from "babylonjs/Meshes/mesh";
  44089. import { Observable } from "babylonjs/Misc/observable";
  44090. /**
  44091. * 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
  44092. */
  44093. export class SixDofDragBehavior implements Behavior<Mesh> {
  44094. private static _virtualScene;
  44095. private _ownerNode;
  44096. private _sceneRenderObserver;
  44097. private _scene;
  44098. private _targetPosition;
  44099. private _virtualOriginMesh;
  44100. private _virtualDragMesh;
  44101. private _pointerObserver;
  44102. private _moving;
  44103. private _startingOrientation;
  44104. private _attachedElement;
  44105. /**
  44106. * 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)
  44107. */
  44108. private zDragFactor;
  44109. /**
  44110. * If the object should rotate to face the drag origin
  44111. */
  44112. rotateDraggedObject: boolean;
  44113. /**
  44114. * If the behavior is currently in a dragging state
  44115. */
  44116. dragging: boolean;
  44117. /**
  44118. * 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)
  44119. */
  44120. dragDeltaRatio: number;
  44121. /**
  44122. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44123. */
  44124. currentDraggingPointerID: number;
  44125. /**
  44126. * If camera controls should be detached during the drag
  44127. */
  44128. detachCameraControls: boolean;
  44129. /**
  44130. * Fires each time a drag starts
  44131. */
  44132. onDragStartObservable: Observable<{}>;
  44133. /**
  44134. * Fires each time a drag ends (eg. mouse release after drag)
  44135. */
  44136. onDragEndObservable: Observable<{}>;
  44137. /**
  44138. * 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
  44139. */
  44140. constructor();
  44141. /**
  44142. * The name of the behavior
  44143. */
  44144. get name(): string;
  44145. /**
  44146. * Initializes the behavior
  44147. */
  44148. init(): void;
  44149. /**
  44150. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  44151. */
  44152. private get _pointerCamera();
  44153. /**
  44154. * Attaches the scale behavior the passed in mesh
  44155. * @param ownerNode The mesh that will be scaled around once attached
  44156. */
  44157. attach(ownerNode: Mesh): void;
  44158. /**
  44159. * Detaches the behavior from the mesh
  44160. */
  44161. detach(): void;
  44162. }
  44163. }
  44164. declare module "babylonjs/Behaviors/Meshes/index" {
  44165. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  44166. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  44167. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  44168. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44169. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  44170. }
  44171. declare module "babylonjs/Behaviors/index" {
  44172. export * from "babylonjs/Behaviors/behavior";
  44173. export * from "babylonjs/Behaviors/Cameras/index";
  44174. export * from "babylonjs/Behaviors/Meshes/index";
  44175. }
  44176. declare module "babylonjs/Bones/boneIKController" {
  44177. import { Bone } from "babylonjs/Bones/bone";
  44178. import { Vector3 } from "babylonjs/Maths/math.vector";
  44179. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44180. import { Nullable } from "babylonjs/types";
  44181. /**
  44182. * Class used to apply inverse kinematics to bones
  44183. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  44184. */
  44185. export class BoneIKController {
  44186. private static _tmpVecs;
  44187. private static _tmpQuat;
  44188. private static _tmpMats;
  44189. /**
  44190. * Gets or sets the target mesh
  44191. */
  44192. targetMesh: AbstractMesh;
  44193. /** Gets or sets the mesh used as pole */
  44194. poleTargetMesh: AbstractMesh;
  44195. /**
  44196. * Gets or sets the bone used as pole
  44197. */
  44198. poleTargetBone: Nullable<Bone>;
  44199. /**
  44200. * Gets or sets the target position
  44201. */
  44202. targetPosition: Vector3;
  44203. /**
  44204. * Gets or sets the pole target position
  44205. */
  44206. poleTargetPosition: Vector3;
  44207. /**
  44208. * Gets or sets the pole target local offset
  44209. */
  44210. poleTargetLocalOffset: Vector3;
  44211. /**
  44212. * Gets or sets the pole angle
  44213. */
  44214. poleAngle: number;
  44215. /**
  44216. * Gets or sets the mesh associated with the controller
  44217. */
  44218. mesh: AbstractMesh;
  44219. /**
  44220. * 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)
  44221. */
  44222. slerpAmount: number;
  44223. private _bone1Quat;
  44224. private _bone1Mat;
  44225. private _bone2Ang;
  44226. private _bone1;
  44227. private _bone2;
  44228. private _bone1Length;
  44229. private _bone2Length;
  44230. private _maxAngle;
  44231. private _maxReach;
  44232. private _rightHandedSystem;
  44233. private _bendAxis;
  44234. private _slerping;
  44235. private _adjustRoll;
  44236. /**
  44237. * Gets or sets maximum allowed angle
  44238. */
  44239. get maxAngle(): number;
  44240. set maxAngle(value: number);
  44241. /**
  44242. * Creates a new BoneIKController
  44243. * @param mesh defines the mesh to control
  44244. * @param bone defines the bone to control
  44245. * @param options defines options to set up the controller
  44246. */
  44247. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  44248. targetMesh?: AbstractMesh;
  44249. poleTargetMesh?: AbstractMesh;
  44250. poleTargetBone?: Bone;
  44251. poleTargetLocalOffset?: Vector3;
  44252. poleAngle?: number;
  44253. bendAxis?: Vector3;
  44254. maxAngle?: number;
  44255. slerpAmount?: number;
  44256. });
  44257. private _setMaxAngle;
  44258. /**
  44259. * Force the controller to update the bones
  44260. */
  44261. update(): void;
  44262. }
  44263. }
  44264. declare module "babylonjs/Bones/boneLookController" {
  44265. import { Vector3 } from "babylonjs/Maths/math.vector";
  44266. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44267. import { Bone } from "babylonjs/Bones/bone";
  44268. import { Space } from "babylonjs/Maths/math.axis";
  44269. /**
  44270. * Class used to make a bone look toward a point in space
  44271. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  44272. */
  44273. export class BoneLookController {
  44274. private static _tmpVecs;
  44275. private static _tmpQuat;
  44276. private static _tmpMats;
  44277. /**
  44278. * The target Vector3 that the bone will look at
  44279. */
  44280. target: Vector3;
  44281. /**
  44282. * The mesh that the bone is attached to
  44283. */
  44284. mesh: AbstractMesh;
  44285. /**
  44286. * The bone that will be looking to the target
  44287. */
  44288. bone: Bone;
  44289. /**
  44290. * The up axis of the coordinate system that is used when the bone is rotated
  44291. */
  44292. upAxis: Vector3;
  44293. /**
  44294. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  44295. */
  44296. upAxisSpace: Space;
  44297. /**
  44298. * Used to make an adjustment to the yaw of the bone
  44299. */
  44300. adjustYaw: number;
  44301. /**
  44302. * Used to make an adjustment to the pitch of the bone
  44303. */
  44304. adjustPitch: number;
  44305. /**
  44306. * Used to make an adjustment to the roll of the bone
  44307. */
  44308. adjustRoll: number;
  44309. /**
  44310. * 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)
  44311. */
  44312. slerpAmount: number;
  44313. private _minYaw;
  44314. private _maxYaw;
  44315. private _minPitch;
  44316. private _maxPitch;
  44317. private _minYawSin;
  44318. private _minYawCos;
  44319. private _maxYawSin;
  44320. private _maxYawCos;
  44321. private _midYawConstraint;
  44322. private _minPitchTan;
  44323. private _maxPitchTan;
  44324. private _boneQuat;
  44325. private _slerping;
  44326. private _transformYawPitch;
  44327. private _transformYawPitchInv;
  44328. private _firstFrameSkipped;
  44329. private _yawRange;
  44330. private _fowardAxis;
  44331. /**
  44332. * Gets or sets the minimum yaw angle that the bone can look to
  44333. */
  44334. get minYaw(): number;
  44335. set minYaw(value: number);
  44336. /**
  44337. * Gets or sets the maximum yaw angle that the bone can look to
  44338. */
  44339. get maxYaw(): number;
  44340. set maxYaw(value: number);
  44341. /**
  44342. * Gets or sets the minimum pitch angle that the bone can look to
  44343. */
  44344. get minPitch(): number;
  44345. set minPitch(value: number);
  44346. /**
  44347. * Gets or sets the maximum pitch angle that the bone can look to
  44348. */
  44349. get maxPitch(): number;
  44350. set maxPitch(value: number);
  44351. /**
  44352. * Create a BoneLookController
  44353. * @param mesh the mesh that the bone belongs to
  44354. * @param bone the bone that will be looking to the target
  44355. * @param target the target Vector3 to look at
  44356. * @param options optional settings:
  44357. * * maxYaw: the maximum angle the bone will yaw to
  44358. * * minYaw: the minimum angle the bone will yaw to
  44359. * * maxPitch: the maximum angle the bone will pitch to
  44360. * * minPitch: the minimum angle the bone will yaw to
  44361. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  44362. * * upAxis: the up axis of the coordinate system
  44363. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  44364. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  44365. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  44366. * * adjustYaw: used to make an adjustment to the yaw of the bone
  44367. * * adjustPitch: used to make an adjustment to the pitch of the bone
  44368. * * adjustRoll: used to make an adjustment to the roll of the bone
  44369. **/
  44370. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  44371. maxYaw?: number;
  44372. minYaw?: number;
  44373. maxPitch?: number;
  44374. minPitch?: number;
  44375. slerpAmount?: number;
  44376. upAxis?: Vector3;
  44377. upAxisSpace?: Space;
  44378. yawAxis?: Vector3;
  44379. pitchAxis?: Vector3;
  44380. adjustYaw?: number;
  44381. adjustPitch?: number;
  44382. adjustRoll?: number;
  44383. });
  44384. /**
  44385. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  44386. */
  44387. update(): void;
  44388. private _getAngleDiff;
  44389. private _getAngleBetween;
  44390. private _isAngleBetween;
  44391. }
  44392. }
  44393. declare module "babylonjs/Bones/index" {
  44394. export * from "babylonjs/Bones/bone";
  44395. export * from "babylonjs/Bones/boneIKController";
  44396. export * from "babylonjs/Bones/boneLookController";
  44397. export * from "babylonjs/Bones/skeleton";
  44398. }
  44399. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  44400. import { Nullable } from "babylonjs/types";
  44401. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44402. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44403. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  44404. /**
  44405. * Manage the gamepad inputs to control an arc rotate camera.
  44406. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  44407. */
  44408. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  44409. /**
  44410. * Defines the camera the input is attached to.
  44411. */
  44412. camera: ArcRotateCamera;
  44413. /**
  44414. * Defines the gamepad the input is gathering event from.
  44415. */
  44416. gamepad: Nullable<Gamepad>;
  44417. /**
  44418. * Defines the gamepad rotation sensiblity.
  44419. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  44420. */
  44421. gamepadRotationSensibility: number;
  44422. /**
  44423. * Defines the gamepad move sensiblity.
  44424. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  44425. */
  44426. gamepadMoveSensibility: number;
  44427. private _yAxisScale;
  44428. /**
  44429. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  44430. */
  44431. get invertYAxis(): boolean;
  44432. set invertYAxis(value: boolean);
  44433. private _onGamepadConnectedObserver;
  44434. private _onGamepadDisconnectedObserver;
  44435. /**
  44436. * Attach the input controls to a specific dom element to get the input from.
  44437. * @param element Defines the element the controls should be listened from
  44438. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44439. */
  44440. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44441. /**
  44442. * Detach the current controls from the specified dom element.
  44443. * @param element Defines the element to stop listening the inputs from
  44444. */
  44445. detachControl(element: Nullable<HTMLElement>): void;
  44446. /**
  44447. * Update the current camera state depending on the inputs that have been used this frame.
  44448. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44449. */
  44450. checkInputs(): void;
  44451. /**
  44452. * Gets the class name of the current intput.
  44453. * @returns the class name
  44454. */
  44455. getClassName(): string;
  44456. /**
  44457. * Get the friendly name associated with the input class.
  44458. * @returns the input friendly name
  44459. */
  44460. getSimpleName(): string;
  44461. }
  44462. }
  44463. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  44464. import { Nullable } from "babylonjs/types";
  44465. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44466. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44467. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44468. interface ArcRotateCameraInputsManager {
  44469. /**
  44470. * Add orientation input support to the input manager.
  44471. * @returns the current input manager
  44472. */
  44473. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  44474. }
  44475. }
  44476. /**
  44477. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  44478. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  44479. */
  44480. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  44481. /**
  44482. * Defines the camera the input is attached to.
  44483. */
  44484. camera: ArcRotateCamera;
  44485. /**
  44486. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  44487. */
  44488. alphaCorrection: number;
  44489. /**
  44490. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  44491. */
  44492. gammaCorrection: number;
  44493. private _alpha;
  44494. private _gamma;
  44495. private _dirty;
  44496. private _deviceOrientationHandler;
  44497. /**
  44498. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  44499. */
  44500. constructor();
  44501. /**
  44502. * Attach the input controls to a specific dom element to get the input from.
  44503. * @param element Defines the element the controls should be listened from
  44504. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44505. */
  44506. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44507. /** @hidden */
  44508. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  44509. /**
  44510. * Update the current camera state depending on the inputs that have been used this frame.
  44511. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44512. */
  44513. checkInputs(): void;
  44514. /**
  44515. * Detach the current controls from the specified dom element.
  44516. * @param element Defines the element to stop listening the inputs from
  44517. */
  44518. detachControl(element: Nullable<HTMLElement>): void;
  44519. /**
  44520. * Gets the class name of the current intput.
  44521. * @returns the class name
  44522. */
  44523. getClassName(): string;
  44524. /**
  44525. * Get the friendly name associated with the input class.
  44526. * @returns the input friendly name
  44527. */
  44528. getSimpleName(): string;
  44529. }
  44530. }
  44531. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  44532. import { Nullable } from "babylonjs/types";
  44533. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44534. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  44535. /**
  44536. * Listen to mouse events to control the camera.
  44537. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  44538. */
  44539. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  44540. /**
  44541. * Defines the camera the input is attached to.
  44542. */
  44543. camera: FlyCamera;
  44544. /**
  44545. * Defines if touch is enabled. (Default is true.)
  44546. */
  44547. touchEnabled: boolean;
  44548. /**
  44549. * Defines the buttons associated with the input to handle camera rotation.
  44550. */
  44551. buttons: number[];
  44552. /**
  44553. * Assign buttons for Yaw control.
  44554. */
  44555. buttonsYaw: number[];
  44556. /**
  44557. * Assign buttons for Pitch control.
  44558. */
  44559. buttonsPitch: number[];
  44560. /**
  44561. * Assign buttons for Roll control.
  44562. */
  44563. buttonsRoll: number[];
  44564. /**
  44565. * Detect if any button is being pressed while mouse is moved.
  44566. * -1 = Mouse locked.
  44567. * 0 = Left button.
  44568. * 1 = Middle Button.
  44569. * 2 = Right Button.
  44570. */
  44571. activeButton: number;
  44572. /**
  44573. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  44574. * Higher values reduce its sensitivity.
  44575. */
  44576. angularSensibility: number;
  44577. private _mousemoveCallback;
  44578. private _observer;
  44579. private _rollObserver;
  44580. private previousPosition;
  44581. private noPreventDefault;
  44582. private element;
  44583. /**
  44584. * Listen to mouse events to control the camera.
  44585. * @param touchEnabled Define if touch is enabled. (Default is true.)
  44586. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  44587. */
  44588. constructor(touchEnabled?: boolean);
  44589. /**
  44590. * Attach the mouse control to the HTML DOM element.
  44591. * @param element Defines the element that listens to the input events.
  44592. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  44593. */
  44594. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44595. /**
  44596. * Detach the current controls from the specified dom element.
  44597. * @param element Defines the element to stop listening the inputs from
  44598. */
  44599. detachControl(element: Nullable<HTMLElement>): void;
  44600. /**
  44601. * Gets the class name of the current input.
  44602. * @returns the class name.
  44603. */
  44604. getClassName(): string;
  44605. /**
  44606. * Get the friendly name associated with the input class.
  44607. * @returns the input's friendly name.
  44608. */
  44609. getSimpleName(): string;
  44610. private _pointerInput;
  44611. private _onMouseMove;
  44612. /**
  44613. * Rotate camera by mouse offset.
  44614. */
  44615. private rotateCamera;
  44616. }
  44617. }
  44618. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  44619. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  44620. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44621. /**
  44622. * Default Inputs manager for the FlyCamera.
  44623. * It groups all the default supported inputs for ease of use.
  44624. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  44625. */
  44626. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  44627. /**
  44628. * Instantiates a new FlyCameraInputsManager.
  44629. * @param camera Defines the camera the inputs belong to.
  44630. */
  44631. constructor(camera: FlyCamera);
  44632. /**
  44633. * Add keyboard input support to the input manager.
  44634. * @returns the new FlyCameraKeyboardMoveInput().
  44635. */
  44636. addKeyboard(): FlyCameraInputsManager;
  44637. /**
  44638. * Add mouse input support to the input manager.
  44639. * @param touchEnabled Enable touch screen support.
  44640. * @returns the new FlyCameraMouseInput().
  44641. */
  44642. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  44643. }
  44644. }
  44645. declare module "babylonjs/Cameras/flyCamera" {
  44646. import { Scene } from "babylonjs/scene";
  44647. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  44648. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44649. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44650. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  44651. /**
  44652. * This is a flying camera, designed for 3D movement and rotation in all directions,
  44653. * such as in a 3D Space Shooter or a Flight Simulator.
  44654. */
  44655. export class FlyCamera extends TargetCamera {
  44656. /**
  44657. * Define the collision ellipsoid of the camera.
  44658. * This is helpful for simulating a camera body, like a player's body.
  44659. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44660. */
  44661. ellipsoid: Vector3;
  44662. /**
  44663. * Define an offset for the position of the ellipsoid around the camera.
  44664. * This can be helpful if the camera is attached away from the player's body center,
  44665. * such as at its head.
  44666. */
  44667. ellipsoidOffset: Vector3;
  44668. /**
  44669. * Enable or disable collisions of the camera with the rest of the scene objects.
  44670. */
  44671. checkCollisions: boolean;
  44672. /**
  44673. * Enable or disable gravity on the camera.
  44674. */
  44675. applyGravity: boolean;
  44676. /**
  44677. * Define the current direction the camera is moving to.
  44678. */
  44679. cameraDirection: Vector3;
  44680. /**
  44681. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  44682. * This overrides and empties cameraRotation.
  44683. */
  44684. rotationQuaternion: Quaternion;
  44685. /**
  44686. * Track Roll to maintain the wanted Rolling when looking around.
  44687. */
  44688. _trackRoll: number;
  44689. /**
  44690. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  44691. */
  44692. rollCorrect: number;
  44693. /**
  44694. * Mimic a banked turn, Rolling the camera when Yawing.
  44695. * It's recommended to use rollCorrect = 10 for faster banking correction.
  44696. */
  44697. bankedTurn: boolean;
  44698. /**
  44699. * Limit in radians for how much Roll banking will add. (Default: 90°)
  44700. */
  44701. bankedTurnLimit: number;
  44702. /**
  44703. * Value of 0 disables the banked Roll.
  44704. * Value of 1 is equal to the Yaw angle in radians.
  44705. */
  44706. bankedTurnMultiplier: number;
  44707. /**
  44708. * The inputs manager loads all the input sources, such as keyboard and mouse.
  44709. */
  44710. inputs: FlyCameraInputsManager;
  44711. /**
  44712. * Gets the input sensibility for mouse input.
  44713. * Higher values reduce sensitivity.
  44714. */
  44715. get angularSensibility(): number;
  44716. /**
  44717. * Sets the input sensibility for a mouse input.
  44718. * Higher values reduce sensitivity.
  44719. */
  44720. set angularSensibility(value: number);
  44721. /**
  44722. * Get the keys for camera movement forward.
  44723. */
  44724. get keysForward(): number[];
  44725. /**
  44726. * Set the keys for camera movement forward.
  44727. */
  44728. set keysForward(value: number[]);
  44729. /**
  44730. * Get the keys for camera movement backward.
  44731. */
  44732. get keysBackward(): number[];
  44733. set keysBackward(value: number[]);
  44734. /**
  44735. * Get the keys for camera movement up.
  44736. */
  44737. get keysUp(): number[];
  44738. /**
  44739. * Set the keys for camera movement up.
  44740. */
  44741. set keysUp(value: number[]);
  44742. /**
  44743. * Get the keys for camera movement down.
  44744. */
  44745. get keysDown(): number[];
  44746. /**
  44747. * Set the keys for camera movement down.
  44748. */
  44749. set keysDown(value: number[]);
  44750. /**
  44751. * Get the keys for camera movement left.
  44752. */
  44753. get keysLeft(): number[];
  44754. /**
  44755. * Set the keys for camera movement left.
  44756. */
  44757. set keysLeft(value: number[]);
  44758. /**
  44759. * Set the keys for camera movement right.
  44760. */
  44761. get keysRight(): number[];
  44762. /**
  44763. * Set the keys for camera movement right.
  44764. */
  44765. set keysRight(value: number[]);
  44766. /**
  44767. * Event raised when the camera collides with a mesh in the scene.
  44768. */
  44769. onCollide: (collidedMesh: AbstractMesh) => void;
  44770. private _collider;
  44771. private _needMoveForGravity;
  44772. private _oldPosition;
  44773. private _diffPosition;
  44774. private _newPosition;
  44775. /** @hidden */
  44776. _localDirection: Vector3;
  44777. /** @hidden */
  44778. _transformedDirection: Vector3;
  44779. /**
  44780. * Instantiates a FlyCamera.
  44781. * This is a flying camera, designed for 3D movement and rotation in all directions,
  44782. * such as in a 3D Space Shooter or a Flight Simulator.
  44783. * @param name Define the name of the camera in the scene.
  44784. * @param position Define the starting position of the camera in the scene.
  44785. * @param scene Define the scene the camera belongs to.
  44786. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  44787. */
  44788. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44789. /**
  44790. * Attach a control to the HTML DOM element.
  44791. * @param element Defines the element that listens to the input events.
  44792. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  44793. */
  44794. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44795. /**
  44796. * Detach a control from the HTML DOM element.
  44797. * The camera will stop reacting to that input.
  44798. * @param element Defines the element that listens to the input events.
  44799. */
  44800. detachControl(element: HTMLElement): void;
  44801. private _collisionMask;
  44802. /**
  44803. * Get the mask that the camera ignores in collision events.
  44804. */
  44805. get collisionMask(): number;
  44806. /**
  44807. * Set the mask that the camera ignores in collision events.
  44808. */
  44809. set collisionMask(mask: number);
  44810. /** @hidden */
  44811. _collideWithWorld(displacement: Vector3): void;
  44812. /** @hidden */
  44813. private _onCollisionPositionChange;
  44814. /** @hidden */
  44815. _checkInputs(): void;
  44816. /** @hidden */
  44817. _decideIfNeedsToMove(): boolean;
  44818. /** @hidden */
  44819. _updatePosition(): void;
  44820. /**
  44821. * Restore the Roll to its target value at the rate specified.
  44822. * @param rate - Higher means slower restoring.
  44823. * @hidden
  44824. */
  44825. restoreRoll(rate: number): void;
  44826. /**
  44827. * Destroy the camera and release the current resources held by it.
  44828. */
  44829. dispose(): void;
  44830. /**
  44831. * Get the current object class name.
  44832. * @returns the class name.
  44833. */
  44834. getClassName(): string;
  44835. }
  44836. }
  44837. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  44838. import { Nullable } from "babylonjs/types";
  44839. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44840. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  44841. /**
  44842. * Listen to keyboard events to control the camera.
  44843. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  44844. */
  44845. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  44846. /**
  44847. * Defines the camera the input is attached to.
  44848. */
  44849. camera: FlyCamera;
  44850. /**
  44851. * The list of keyboard keys used to control the forward move of the camera.
  44852. */
  44853. keysForward: number[];
  44854. /**
  44855. * The list of keyboard keys used to control the backward move of the camera.
  44856. */
  44857. keysBackward: number[];
  44858. /**
  44859. * The list of keyboard keys used to control the forward move of the camera.
  44860. */
  44861. keysUp: number[];
  44862. /**
  44863. * The list of keyboard keys used to control the backward move of the camera.
  44864. */
  44865. keysDown: number[];
  44866. /**
  44867. * The list of keyboard keys used to control the right strafe move of the camera.
  44868. */
  44869. keysRight: number[];
  44870. /**
  44871. * The list of keyboard keys used to control the left strafe move of the camera.
  44872. */
  44873. keysLeft: number[];
  44874. private _keys;
  44875. private _onCanvasBlurObserver;
  44876. private _onKeyboardObserver;
  44877. private _engine;
  44878. private _scene;
  44879. /**
  44880. * Attach the input controls to a specific dom element to get the input from.
  44881. * @param element Defines the element the controls should be listened from
  44882. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44883. */
  44884. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44885. /**
  44886. * Detach the current controls from the specified dom element.
  44887. * @param element Defines the element to stop listening the inputs from
  44888. */
  44889. detachControl(element: Nullable<HTMLElement>): void;
  44890. /**
  44891. * Gets the class name of the current intput.
  44892. * @returns the class name
  44893. */
  44894. getClassName(): string;
  44895. /** @hidden */
  44896. _onLostFocus(e: FocusEvent): void;
  44897. /**
  44898. * Get the friendly name associated with the input class.
  44899. * @returns the input friendly name
  44900. */
  44901. getSimpleName(): string;
  44902. /**
  44903. * Update the current camera state depending on the inputs that have been used this frame.
  44904. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44905. */
  44906. checkInputs(): void;
  44907. }
  44908. }
  44909. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  44910. import { Nullable } from "babylonjs/types";
  44911. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  44912. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44913. /**
  44914. * Manage the mouse wheel inputs to control a follow camera.
  44915. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  44916. */
  44917. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  44918. /**
  44919. * Defines the camera the input is attached to.
  44920. */
  44921. camera: FollowCamera;
  44922. /**
  44923. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  44924. */
  44925. axisControlRadius: boolean;
  44926. /**
  44927. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  44928. */
  44929. axisControlHeight: boolean;
  44930. /**
  44931. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  44932. */
  44933. axisControlRotation: boolean;
  44934. /**
  44935. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  44936. * relation to mouseWheel events.
  44937. */
  44938. wheelPrecision: number;
  44939. /**
  44940. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44941. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44942. */
  44943. wheelDeltaPercentage: number;
  44944. private _wheel;
  44945. private _observer;
  44946. /**
  44947. * Attach the input controls to a specific dom element to get the input from.
  44948. * @param element Defines the element the controls should be listened from
  44949. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44950. */
  44951. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44952. /**
  44953. * Detach the current controls from the specified dom element.
  44954. * @param element Defines the element to stop listening the inputs from
  44955. */
  44956. detachControl(element: Nullable<HTMLElement>): void;
  44957. /**
  44958. * Gets the class name of the current intput.
  44959. * @returns the class name
  44960. */
  44961. getClassName(): string;
  44962. /**
  44963. * Get the friendly name associated with the input class.
  44964. * @returns the input friendly name
  44965. */
  44966. getSimpleName(): string;
  44967. }
  44968. }
  44969. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  44970. import { Nullable } from "babylonjs/types";
  44971. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  44972. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44973. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44974. /**
  44975. * Manage the pointers inputs to control an follow camera.
  44976. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  44977. */
  44978. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  44979. /**
  44980. * Defines the camera the input is attached to.
  44981. */
  44982. camera: FollowCamera;
  44983. /**
  44984. * Gets the class name of the current input.
  44985. * @returns the class name
  44986. */
  44987. getClassName(): string;
  44988. /**
  44989. * Defines the pointer angular sensibility along the X axis or how fast is
  44990. * the camera rotating.
  44991. * A negative number will reverse the axis direction.
  44992. */
  44993. angularSensibilityX: number;
  44994. /**
  44995. * Defines the pointer angular sensibility along the Y axis or how fast is
  44996. * the camera rotating.
  44997. * A negative number will reverse the axis direction.
  44998. */
  44999. angularSensibilityY: number;
  45000. /**
  45001. * Defines the pointer pinch precision or how fast is the camera zooming.
  45002. * A negative number will reverse the axis direction.
  45003. */
  45004. pinchPrecision: number;
  45005. /**
  45006. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  45007. * from 0.
  45008. * It defines the percentage of current camera.radius to use as delta when
  45009. * pinch zoom is used.
  45010. */
  45011. pinchDeltaPercentage: number;
  45012. /**
  45013. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  45014. */
  45015. axisXControlRadius: boolean;
  45016. /**
  45017. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  45018. */
  45019. axisXControlHeight: boolean;
  45020. /**
  45021. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  45022. */
  45023. axisXControlRotation: boolean;
  45024. /**
  45025. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  45026. */
  45027. axisYControlRadius: boolean;
  45028. /**
  45029. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  45030. */
  45031. axisYControlHeight: boolean;
  45032. /**
  45033. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  45034. */
  45035. axisYControlRotation: boolean;
  45036. /**
  45037. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  45038. */
  45039. axisPinchControlRadius: boolean;
  45040. /**
  45041. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  45042. */
  45043. axisPinchControlHeight: boolean;
  45044. /**
  45045. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  45046. */
  45047. axisPinchControlRotation: boolean;
  45048. /**
  45049. * Log error messages if basic misconfiguration has occurred.
  45050. */
  45051. warningEnable: boolean;
  45052. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  45053. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  45054. private _warningCounter;
  45055. private _warning;
  45056. }
  45057. }
  45058. declare module "babylonjs/Cameras/followCameraInputsManager" {
  45059. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45060. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45061. /**
  45062. * Default Inputs manager for the FollowCamera.
  45063. * It groups all the default supported inputs for ease of use.
  45064. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  45065. */
  45066. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  45067. /**
  45068. * Instantiates a new FollowCameraInputsManager.
  45069. * @param camera Defines the camera the inputs belong to
  45070. */
  45071. constructor(camera: FollowCamera);
  45072. /**
  45073. * Add keyboard input support to the input manager.
  45074. * @returns the current input manager
  45075. */
  45076. addKeyboard(): FollowCameraInputsManager;
  45077. /**
  45078. * Add mouse wheel input support to the input manager.
  45079. * @returns the current input manager
  45080. */
  45081. addMouseWheel(): FollowCameraInputsManager;
  45082. /**
  45083. * Add pointers input support to the input manager.
  45084. * @returns the current input manager
  45085. */
  45086. addPointers(): FollowCameraInputsManager;
  45087. /**
  45088. * Add orientation input support to the input manager.
  45089. * @returns the current input manager
  45090. */
  45091. addVRDeviceOrientation(): FollowCameraInputsManager;
  45092. }
  45093. }
  45094. declare module "babylonjs/Cameras/followCamera" {
  45095. import { Nullable } from "babylonjs/types";
  45096. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45097. import { Scene } from "babylonjs/scene";
  45098. import { Vector3 } from "babylonjs/Maths/math.vector";
  45099. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45100. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  45101. /**
  45102. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  45103. * an arc rotate version arcFollowCamera are available.
  45104. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  45105. */
  45106. export class FollowCamera extends TargetCamera {
  45107. /**
  45108. * Distance the follow camera should follow an object at
  45109. */
  45110. radius: number;
  45111. /**
  45112. * Minimum allowed distance of the camera to the axis of rotation
  45113. * (The camera can not get closer).
  45114. * This can help limiting how the Camera is able to move in the scene.
  45115. */
  45116. lowerRadiusLimit: Nullable<number>;
  45117. /**
  45118. * Maximum allowed distance of the camera to the axis of rotation
  45119. * (The camera can not get further).
  45120. * This can help limiting how the Camera is able to move in the scene.
  45121. */
  45122. upperRadiusLimit: Nullable<number>;
  45123. /**
  45124. * Define a rotation offset between the camera and the object it follows
  45125. */
  45126. rotationOffset: number;
  45127. /**
  45128. * Minimum allowed angle to camera position relative to target object.
  45129. * This can help limiting how the Camera is able to move in the scene.
  45130. */
  45131. lowerRotationOffsetLimit: Nullable<number>;
  45132. /**
  45133. * Maximum allowed angle to camera position relative to target object.
  45134. * This can help limiting how the Camera is able to move in the scene.
  45135. */
  45136. upperRotationOffsetLimit: Nullable<number>;
  45137. /**
  45138. * Define a height offset between the camera and the object it follows.
  45139. * It can help following an object from the top (like a car chaing a plane)
  45140. */
  45141. heightOffset: number;
  45142. /**
  45143. * Minimum allowed height of camera position relative to target object.
  45144. * This can help limiting how the Camera is able to move in the scene.
  45145. */
  45146. lowerHeightOffsetLimit: Nullable<number>;
  45147. /**
  45148. * Maximum allowed height of camera position relative to target object.
  45149. * This can help limiting how the Camera is able to move in the scene.
  45150. */
  45151. upperHeightOffsetLimit: Nullable<number>;
  45152. /**
  45153. * Define how fast the camera can accelerate to follow it s target.
  45154. */
  45155. cameraAcceleration: number;
  45156. /**
  45157. * Define the speed limit of the camera following an object.
  45158. */
  45159. maxCameraSpeed: number;
  45160. /**
  45161. * Define the target of the camera.
  45162. */
  45163. lockedTarget: Nullable<AbstractMesh>;
  45164. /**
  45165. * Defines the input associated with the camera.
  45166. */
  45167. inputs: FollowCameraInputsManager;
  45168. /**
  45169. * Instantiates the follow camera.
  45170. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  45171. * @param name Define the name of the camera in the scene
  45172. * @param position Define the position of the camera
  45173. * @param scene Define the scene the camera belong to
  45174. * @param lockedTarget Define the target of the camera
  45175. */
  45176. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  45177. private _follow;
  45178. /**
  45179. * Attached controls to the current camera.
  45180. * @param element Defines the element the controls should be listened from
  45181. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45182. */
  45183. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45184. /**
  45185. * Detach the current controls from the camera.
  45186. * The camera will stop reacting to inputs.
  45187. * @param element Defines the element to stop listening the inputs from
  45188. */
  45189. detachControl(element: HTMLElement): void;
  45190. /** @hidden */
  45191. _checkInputs(): void;
  45192. private _checkLimits;
  45193. /**
  45194. * Gets the camera class name.
  45195. * @returns the class name
  45196. */
  45197. getClassName(): string;
  45198. }
  45199. /**
  45200. * Arc Rotate version of the follow camera.
  45201. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  45202. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  45203. */
  45204. export class ArcFollowCamera extends TargetCamera {
  45205. /** The longitudinal angle of the camera */
  45206. alpha: number;
  45207. /** The latitudinal angle of the camera */
  45208. beta: number;
  45209. /** The radius of the camera from its target */
  45210. radius: number;
  45211. /** Define the camera target (the mesh it should follow) */
  45212. target: Nullable<AbstractMesh>;
  45213. private _cartesianCoordinates;
  45214. /**
  45215. * Instantiates a new ArcFollowCamera
  45216. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  45217. * @param name Define the name of the camera
  45218. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  45219. * @param beta Define the rotation angle of the camera around the elevation axis
  45220. * @param radius Define the radius of the camera from its target point
  45221. * @param target Define the target of the camera
  45222. * @param scene Define the scene the camera belongs to
  45223. */
  45224. constructor(name: string,
  45225. /** The longitudinal angle of the camera */
  45226. alpha: number,
  45227. /** The latitudinal angle of the camera */
  45228. beta: number,
  45229. /** The radius of the camera from its target */
  45230. radius: number,
  45231. /** Define the camera target (the mesh it should follow) */
  45232. target: Nullable<AbstractMesh>, scene: Scene);
  45233. private _follow;
  45234. /** @hidden */
  45235. _checkInputs(): void;
  45236. /**
  45237. * Returns the class name of the object.
  45238. * It is mostly used internally for serialization purposes.
  45239. */
  45240. getClassName(): string;
  45241. }
  45242. }
  45243. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  45244. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45245. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45246. import { Nullable } from "babylonjs/types";
  45247. /**
  45248. * Manage the keyboard inputs to control the movement of a follow camera.
  45249. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  45250. */
  45251. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  45252. /**
  45253. * Defines the camera the input is attached to.
  45254. */
  45255. camera: FollowCamera;
  45256. /**
  45257. * Defines the list of key codes associated with the up action (increase heightOffset)
  45258. */
  45259. keysHeightOffsetIncr: number[];
  45260. /**
  45261. * Defines the list of key codes associated with the down action (decrease heightOffset)
  45262. */
  45263. keysHeightOffsetDecr: number[];
  45264. /**
  45265. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  45266. */
  45267. keysHeightOffsetModifierAlt: boolean;
  45268. /**
  45269. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  45270. */
  45271. keysHeightOffsetModifierCtrl: boolean;
  45272. /**
  45273. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  45274. */
  45275. keysHeightOffsetModifierShift: boolean;
  45276. /**
  45277. * Defines the list of key codes associated with the left action (increase rotationOffset)
  45278. */
  45279. keysRotationOffsetIncr: number[];
  45280. /**
  45281. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  45282. */
  45283. keysRotationOffsetDecr: number[];
  45284. /**
  45285. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  45286. */
  45287. keysRotationOffsetModifierAlt: boolean;
  45288. /**
  45289. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  45290. */
  45291. keysRotationOffsetModifierCtrl: boolean;
  45292. /**
  45293. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  45294. */
  45295. keysRotationOffsetModifierShift: boolean;
  45296. /**
  45297. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  45298. */
  45299. keysRadiusIncr: number[];
  45300. /**
  45301. * Defines the list of key codes associated with the zoom-out action (increase radius)
  45302. */
  45303. keysRadiusDecr: number[];
  45304. /**
  45305. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  45306. */
  45307. keysRadiusModifierAlt: boolean;
  45308. /**
  45309. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  45310. */
  45311. keysRadiusModifierCtrl: boolean;
  45312. /**
  45313. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  45314. */
  45315. keysRadiusModifierShift: boolean;
  45316. /**
  45317. * Defines the rate of change of heightOffset.
  45318. */
  45319. heightSensibility: number;
  45320. /**
  45321. * Defines the rate of change of rotationOffset.
  45322. */
  45323. rotationSensibility: number;
  45324. /**
  45325. * Defines the rate of change of radius.
  45326. */
  45327. radiusSensibility: number;
  45328. private _keys;
  45329. private _ctrlPressed;
  45330. private _altPressed;
  45331. private _shiftPressed;
  45332. private _onCanvasBlurObserver;
  45333. private _onKeyboardObserver;
  45334. private _engine;
  45335. private _scene;
  45336. /**
  45337. * Attach the input controls to a specific dom element to get the input from.
  45338. * @param element Defines the element the controls should be listened from
  45339. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45340. */
  45341. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45342. /**
  45343. * Detach the current controls from the specified dom element.
  45344. * @param element Defines the element to stop listening the inputs from
  45345. */
  45346. detachControl(element: Nullable<HTMLElement>): void;
  45347. /**
  45348. * Update the current camera state depending on the inputs that have been used this frame.
  45349. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45350. */
  45351. checkInputs(): void;
  45352. /**
  45353. * Gets the class name of the current input.
  45354. * @returns the class name
  45355. */
  45356. getClassName(): string;
  45357. /**
  45358. * Get the friendly name associated with the input class.
  45359. * @returns the input friendly name
  45360. */
  45361. getSimpleName(): string;
  45362. /**
  45363. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  45364. * allow modification of the heightOffset value.
  45365. */
  45366. private _modifierHeightOffset;
  45367. /**
  45368. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  45369. * allow modification of the rotationOffset value.
  45370. */
  45371. private _modifierRotationOffset;
  45372. /**
  45373. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  45374. * allow modification of the radius value.
  45375. */
  45376. private _modifierRadius;
  45377. }
  45378. }
  45379. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  45380. import { Nullable } from "babylonjs/types";
  45381. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45382. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  45383. import { Observable } from "babylonjs/Misc/observable";
  45384. module "babylonjs/Cameras/freeCameraInputsManager" {
  45385. interface FreeCameraInputsManager {
  45386. /**
  45387. * @hidden
  45388. */
  45389. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  45390. /**
  45391. * Add orientation input support to the input manager.
  45392. * @returns the current input manager
  45393. */
  45394. addDeviceOrientation(): FreeCameraInputsManager;
  45395. }
  45396. }
  45397. /**
  45398. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  45399. * Screen rotation is taken into account.
  45400. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  45401. */
  45402. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  45403. private _camera;
  45404. private _screenOrientationAngle;
  45405. private _constantTranform;
  45406. private _screenQuaternion;
  45407. private _alpha;
  45408. private _beta;
  45409. private _gamma;
  45410. /**
  45411. * Can be used to detect if a device orientation sensor is available on a device
  45412. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  45413. * @returns a promise that will resolve on orientation change
  45414. */
  45415. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  45416. /**
  45417. * @hidden
  45418. */
  45419. _onDeviceOrientationChangedObservable: Observable<void>;
  45420. /**
  45421. * Instantiates a new input
  45422. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  45423. */
  45424. constructor();
  45425. /**
  45426. * Define the camera controlled by the input.
  45427. */
  45428. get camera(): FreeCamera;
  45429. set camera(camera: FreeCamera);
  45430. /**
  45431. * Attach the input controls to a specific dom element to get the input from.
  45432. * @param element Defines the element the controls should be listened from
  45433. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45434. */
  45435. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45436. private _orientationChanged;
  45437. private _deviceOrientation;
  45438. /**
  45439. * Detach the current controls from the specified dom element.
  45440. * @param element Defines the element to stop listening the inputs from
  45441. */
  45442. detachControl(element: Nullable<HTMLElement>): void;
  45443. /**
  45444. * Update the current camera state depending on the inputs that have been used this frame.
  45445. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45446. */
  45447. checkInputs(): void;
  45448. /**
  45449. * Gets the class name of the current intput.
  45450. * @returns the class name
  45451. */
  45452. getClassName(): string;
  45453. /**
  45454. * Get the friendly name associated with the input class.
  45455. * @returns the input friendly name
  45456. */
  45457. getSimpleName(): string;
  45458. }
  45459. }
  45460. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  45461. import { Nullable } from "babylonjs/types";
  45462. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45463. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  45464. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45465. /**
  45466. * Manage the gamepad inputs to control a free camera.
  45467. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  45468. */
  45469. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  45470. /**
  45471. * Define the camera the input is attached to.
  45472. */
  45473. camera: FreeCamera;
  45474. /**
  45475. * Define the Gamepad controlling the input
  45476. */
  45477. gamepad: Nullable<Gamepad>;
  45478. /**
  45479. * Defines the gamepad rotation sensiblity.
  45480. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45481. */
  45482. gamepadAngularSensibility: number;
  45483. /**
  45484. * Defines the gamepad move sensiblity.
  45485. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45486. */
  45487. gamepadMoveSensibility: number;
  45488. private _yAxisScale;
  45489. /**
  45490. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45491. */
  45492. get invertYAxis(): boolean;
  45493. set invertYAxis(value: boolean);
  45494. private _onGamepadConnectedObserver;
  45495. private _onGamepadDisconnectedObserver;
  45496. private _cameraTransform;
  45497. private _deltaTransform;
  45498. private _vector3;
  45499. private _vector2;
  45500. /**
  45501. * Attach the input controls to a specific dom element to get the input from.
  45502. * @param element Defines the element the controls should be listened from
  45503. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45504. */
  45505. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45506. /**
  45507. * Detach the current controls from the specified dom element.
  45508. * @param element Defines the element to stop listening the inputs from
  45509. */
  45510. detachControl(element: Nullable<HTMLElement>): void;
  45511. /**
  45512. * Update the current camera state depending on the inputs that have been used this frame.
  45513. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45514. */
  45515. checkInputs(): void;
  45516. /**
  45517. * Gets the class name of the current intput.
  45518. * @returns the class name
  45519. */
  45520. getClassName(): string;
  45521. /**
  45522. * Get the friendly name associated with the input class.
  45523. * @returns the input friendly name
  45524. */
  45525. getSimpleName(): string;
  45526. }
  45527. }
  45528. declare module "babylonjs/Misc/virtualJoystick" {
  45529. import { Nullable } from "babylonjs/types";
  45530. import { Vector3 } from "babylonjs/Maths/math.vector";
  45531. /**
  45532. * Defines the potential axis of a Joystick
  45533. */
  45534. export enum JoystickAxis {
  45535. /** X axis */
  45536. X = 0,
  45537. /** Y axis */
  45538. Y = 1,
  45539. /** Z axis */
  45540. Z = 2
  45541. }
  45542. /**
  45543. * Represents the different customization options available
  45544. * for VirtualJoystick
  45545. */
  45546. interface VirtualJoystickCustomizations {
  45547. /**
  45548. * Size of the joystick's puck
  45549. */
  45550. puckSize: number;
  45551. /**
  45552. * Size of the joystick's container
  45553. */
  45554. containerSize: number;
  45555. /**
  45556. * Color of the joystick && puck
  45557. */
  45558. color: string;
  45559. /**
  45560. * Image URL for the joystick's puck
  45561. */
  45562. puckImage?: string;
  45563. /**
  45564. * Image URL for the joystick's container
  45565. */
  45566. containerImage?: string;
  45567. /**
  45568. * Defines the unmoving position of the joystick container
  45569. */
  45570. position?: {
  45571. x: number;
  45572. y: number;
  45573. };
  45574. /**
  45575. * Defines whether or not the joystick container is always visible
  45576. */
  45577. alwaysVisible: boolean;
  45578. /**
  45579. * Defines whether or not to limit the movement of the puck to the joystick's container
  45580. */
  45581. limitToContainer: boolean;
  45582. }
  45583. /**
  45584. * Class used to define virtual joystick (used in touch mode)
  45585. */
  45586. export class VirtualJoystick {
  45587. /**
  45588. * Gets or sets a boolean indicating that left and right values must be inverted
  45589. */
  45590. reverseLeftRight: boolean;
  45591. /**
  45592. * Gets or sets a boolean indicating that up and down values must be inverted
  45593. */
  45594. reverseUpDown: boolean;
  45595. /**
  45596. * Gets the offset value for the position (ie. the change of the position value)
  45597. */
  45598. deltaPosition: Vector3;
  45599. /**
  45600. * Gets a boolean indicating if the virtual joystick was pressed
  45601. */
  45602. pressed: boolean;
  45603. /**
  45604. * Canvas the virtual joystick will render onto, default z-index of this is 5
  45605. */
  45606. static Canvas: Nullable<HTMLCanvasElement>;
  45607. /**
  45608. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  45609. */
  45610. limitToContainer: boolean;
  45611. private static _globalJoystickIndex;
  45612. private static _alwaysVisibleSticks;
  45613. private static vjCanvasContext;
  45614. private static vjCanvasWidth;
  45615. private static vjCanvasHeight;
  45616. private static halfWidth;
  45617. private static _GetDefaultOptions;
  45618. private _action;
  45619. private _axisTargetedByLeftAndRight;
  45620. private _axisTargetedByUpAndDown;
  45621. private _joystickSensibility;
  45622. private _inversedSensibility;
  45623. private _joystickPointerID;
  45624. private _joystickColor;
  45625. private _joystickPointerPos;
  45626. private _joystickPreviousPointerPos;
  45627. private _joystickPointerStartPos;
  45628. private _deltaJoystickVector;
  45629. private _leftJoystick;
  45630. private _touches;
  45631. private _joystickPosition;
  45632. private _alwaysVisible;
  45633. private _puckImage;
  45634. private _containerImage;
  45635. private _joystickPuckSize;
  45636. private _joystickContainerSize;
  45637. private _clearPuckSize;
  45638. private _clearContainerSize;
  45639. private _clearPuckSizeOffset;
  45640. private _clearContainerSizeOffset;
  45641. private _onPointerDownHandlerRef;
  45642. private _onPointerMoveHandlerRef;
  45643. private _onPointerUpHandlerRef;
  45644. private _onResize;
  45645. /**
  45646. * Creates a new virtual joystick
  45647. * @param leftJoystick defines that the joystick is for left hand (false by default)
  45648. * @param customizations Defines the options we want to customize the VirtualJoystick
  45649. */
  45650. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  45651. /**
  45652. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  45653. * @param newJoystickSensibility defines the new sensibility
  45654. */
  45655. setJoystickSensibility(newJoystickSensibility: number): void;
  45656. private _onPointerDown;
  45657. private _onPointerMove;
  45658. private _onPointerUp;
  45659. /**
  45660. * Change the color of the virtual joystick
  45661. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  45662. */
  45663. setJoystickColor(newColor: string): void;
  45664. /**
  45665. * Size of the joystick's container
  45666. */
  45667. set containerSize(newSize: number);
  45668. get containerSize(): number;
  45669. /**
  45670. * Size of the joystick's puck
  45671. */
  45672. set puckSize(newSize: number);
  45673. get puckSize(): number;
  45674. /**
  45675. * Clears the set position of the joystick
  45676. */
  45677. clearPosition(): void;
  45678. /**
  45679. * Defines whether or not the joystick container is always visible
  45680. */
  45681. set alwaysVisible(value: boolean);
  45682. get alwaysVisible(): boolean;
  45683. /**
  45684. * Sets the constant position of the Joystick container
  45685. * @param x X axis coordinate
  45686. * @param y Y axis coordinate
  45687. */
  45688. setPosition(x: number, y: number): void;
  45689. /**
  45690. * Defines a callback to call when the joystick is touched
  45691. * @param action defines the callback
  45692. */
  45693. setActionOnTouch(action: () => any): void;
  45694. /**
  45695. * Defines which axis you'd like to control for left & right
  45696. * @param axis defines the axis to use
  45697. */
  45698. setAxisForLeftRight(axis: JoystickAxis): void;
  45699. /**
  45700. * Defines which axis you'd like to control for up & down
  45701. * @param axis defines the axis to use
  45702. */
  45703. setAxisForUpDown(axis: JoystickAxis): void;
  45704. /**
  45705. * Clears the canvas from the previous puck / container draw
  45706. */
  45707. private _clearPreviousDraw;
  45708. /**
  45709. * Loads `urlPath` to be used for the container's image
  45710. * @param urlPath defines the urlPath of an image to use
  45711. */
  45712. setContainerImage(urlPath: string): void;
  45713. /**
  45714. * Loads `urlPath` to be used for the puck's image
  45715. * @param urlPath defines the urlPath of an image to use
  45716. */
  45717. setPuckImage(urlPath: string): void;
  45718. /**
  45719. * Draws the Virtual Joystick's container
  45720. */
  45721. private _drawContainer;
  45722. /**
  45723. * Draws the Virtual Joystick's puck
  45724. */
  45725. private _drawPuck;
  45726. private _drawVirtualJoystick;
  45727. /**
  45728. * Release internal HTML canvas
  45729. */
  45730. releaseCanvas(): void;
  45731. }
  45732. }
  45733. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  45734. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  45735. import { Nullable } from "babylonjs/types";
  45736. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45737. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  45738. module "babylonjs/Cameras/freeCameraInputsManager" {
  45739. interface FreeCameraInputsManager {
  45740. /**
  45741. * Add virtual joystick input support to the input manager.
  45742. * @returns the current input manager
  45743. */
  45744. addVirtualJoystick(): FreeCameraInputsManager;
  45745. }
  45746. }
  45747. /**
  45748. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  45749. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  45750. */
  45751. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  45752. /**
  45753. * Defines the camera the input is attached to.
  45754. */
  45755. camera: FreeCamera;
  45756. private _leftjoystick;
  45757. private _rightjoystick;
  45758. /**
  45759. * Gets the left stick of the virtual joystick.
  45760. * @returns The virtual Joystick
  45761. */
  45762. getLeftJoystick(): VirtualJoystick;
  45763. /**
  45764. * Gets the right stick of the virtual joystick.
  45765. * @returns The virtual Joystick
  45766. */
  45767. getRightJoystick(): VirtualJoystick;
  45768. /**
  45769. * Update the current camera state depending on the inputs that have been used this frame.
  45770. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45771. */
  45772. checkInputs(): void;
  45773. /**
  45774. * Attach the input controls to a specific dom element to get the input from.
  45775. * @param element Defines the element the controls should be listened from
  45776. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45777. */
  45778. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45779. /**
  45780. * Detach the current controls from the specified dom element.
  45781. * @param element Defines the element to stop listening the inputs from
  45782. */
  45783. detachControl(element: Nullable<HTMLElement>): void;
  45784. /**
  45785. * Gets the class name of the current intput.
  45786. * @returns the class name
  45787. */
  45788. getClassName(): string;
  45789. /**
  45790. * Get the friendly name associated with the input class.
  45791. * @returns the input friendly name
  45792. */
  45793. getSimpleName(): string;
  45794. }
  45795. }
  45796. declare module "babylonjs/Cameras/Inputs/index" {
  45797. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  45798. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  45799. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  45800. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  45801. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  45802. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  45803. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  45804. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  45805. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  45806. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  45807. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  45808. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  45809. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  45810. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  45811. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  45812. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  45813. }
  45814. declare module "babylonjs/Cameras/touchCamera" {
  45815. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  45816. import { Scene } from "babylonjs/scene";
  45817. import { Vector3 } from "babylonjs/Maths/math.vector";
  45818. /**
  45819. * This represents a FPS type of camera controlled by touch.
  45820. * This is like a universal camera minus the Gamepad controls.
  45821. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  45822. */
  45823. export class TouchCamera extends FreeCamera {
  45824. /**
  45825. * Defines the touch sensibility for rotation.
  45826. * The higher the faster.
  45827. */
  45828. get touchAngularSensibility(): number;
  45829. set touchAngularSensibility(value: number);
  45830. /**
  45831. * Defines the touch sensibility for move.
  45832. * The higher the faster.
  45833. */
  45834. get touchMoveSensibility(): number;
  45835. set touchMoveSensibility(value: number);
  45836. /**
  45837. * Instantiates a new touch camera.
  45838. * This represents a FPS type of camera controlled by touch.
  45839. * This is like a universal camera minus the Gamepad controls.
  45840. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  45841. * @param name Define the name of the camera in the scene
  45842. * @param position Define the start position of the camera in the scene
  45843. * @param scene Define the scene the camera belongs to
  45844. */
  45845. constructor(name: string, position: Vector3, scene: Scene);
  45846. /**
  45847. * Gets the current object class name.
  45848. * @return the class name
  45849. */
  45850. getClassName(): string;
  45851. /** @hidden */
  45852. _setupInputs(): void;
  45853. }
  45854. }
  45855. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  45856. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  45857. import { Scene } from "babylonjs/scene";
  45858. import { Vector3 } from "babylonjs/Maths/math.vector";
  45859. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  45860. import { Axis } from "babylonjs/Maths/math.axis";
  45861. /**
  45862. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  45863. * being tilted forward or back and left or right.
  45864. */
  45865. export class DeviceOrientationCamera extends FreeCamera {
  45866. private _initialQuaternion;
  45867. private _quaternionCache;
  45868. private _tmpDragQuaternion;
  45869. private _disablePointerInputWhenUsingDeviceOrientation;
  45870. /**
  45871. * Creates a new device orientation camera
  45872. * @param name The name of the camera
  45873. * @param position The start position camera
  45874. * @param scene The scene the camera belongs to
  45875. */
  45876. constructor(name: string, position: Vector3, scene: Scene);
  45877. /**
  45878. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  45879. */
  45880. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  45881. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  45882. private _dragFactor;
  45883. /**
  45884. * Enabled turning on the y axis when the orientation sensor is active
  45885. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  45886. */
  45887. enableHorizontalDragging(dragFactor?: number): void;
  45888. /**
  45889. * Gets the current instance class name ("DeviceOrientationCamera").
  45890. * This helps avoiding instanceof at run time.
  45891. * @returns the class name
  45892. */
  45893. getClassName(): string;
  45894. /**
  45895. * @hidden
  45896. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  45897. */
  45898. _checkInputs(): void;
  45899. /**
  45900. * Reset the camera to its default orientation on the specified axis only.
  45901. * @param axis The axis to reset
  45902. */
  45903. resetToCurrentRotation(axis?: Axis): void;
  45904. }
  45905. }
  45906. declare module "babylonjs/Gamepads/xboxGamepad" {
  45907. import { Observable } from "babylonjs/Misc/observable";
  45908. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45909. /**
  45910. * Defines supported buttons for XBox360 compatible gamepads
  45911. */
  45912. export enum Xbox360Button {
  45913. /** A */
  45914. A = 0,
  45915. /** B */
  45916. B = 1,
  45917. /** X */
  45918. X = 2,
  45919. /** Y */
  45920. Y = 3,
  45921. /** Left button */
  45922. LB = 4,
  45923. /** Right button */
  45924. RB = 5,
  45925. /** Back */
  45926. Back = 8,
  45927. /** Start */
  45928. Start = 9,
  45929. /** Left stick */
  45930. LeftStick = 10,
  45931. /** Right stick */
  45932. RightStick = 11
  45933. }
  45934. /** Defines values for XBox360 DPad */
  45935. export enum Xbox360Dpad {
  45936. /** Up */
  45937. Up = 12,
  45938. /** Down */
  45939. Down = 13,
  45940. /** Left */
  45941. Left = 14,
  45942. /** Right */
  45943. Right = 15
  45944. }
  45945. /**
  45946. * Defines a XBox360 gamepad
  45947. */
  45948. export class Xbox360Pad extends Gamepad {
  45949. private _leftTrigger;
  45950. private _rightTrigger;
  45951. private _onlefttriggerchanged;
  45952. private _onrighttriggerchanged;
  45953. private _onbuttondown;
  45954. private _onbuttonup;
  45955. private _ondpaddown;
  45956. private _ondpadup;
  45957. /** Observable raised when a button is pressed */
  45958. onButtonDownObservable: Observable<Xbox360Button>;
  45959. /** Observable raised when a button is released */
  45960. onButtonUpObservable: Observable<Xbox360Button>;
  45961. /** Observable raised when a pad is pressed */
  45962. onPadDownObservable: Observable<Xbox360Dpad>;
  45963. /** Observable raised when a pad is released */
  45964. onPadUpObservable: Observable<Xbox360Dpad>;
  45965. private _buttonA;
  45966. private _buttonB;
  45967. private _buttonX;
  45968. private _buttonY;
  45969. private _buttonBack;
  45970. private _buttonStart;
  45971. private _buttonLB;
  45972. private _buttonRB;
  45973. private _buttonLeftStick;
  45974. private _buttonRightStick;
  45975. private _dPadUp;
  45976. private _dPadDown;
  45977. private _dPadLeft;
  45978. private _dPadRight;
  45979. private _isXboxOnePad;
  45980. /**
  45981. * Creates a new XBox360 gamepad object
  45982. * @param id defines the id of this gamepad
  45983. * @param index defines its index
  45984. * @param gamepad defines the internal HTML gamepad object
  45985. * @param xboxOne defines if it is a XBox One gamepad
  45986. */
  45987. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  45988. /**
  45989. * Defines the callback to call when left trigger is pressed
  45990. * @param callback defines the callback to use
  45991. */
  45992. onlefttriggerchanged(callback: (value: number) => void): void;
  45993. /**
  45994. * Defines the callback to call when right trigger is pressed
  45995. * @param callback defines the callback to use
  45996. */
  45997. onrighttriggerchanged(callback: (value: number) => void): void;
  45998. /**
  45999. * Gets the left trigger value
  46000. */
  46001. get leftTrigger(): number;
  46002. /**
  46003. * Sets the left trigger value
  46004. */
  46005. set leftTrigger(newValue: number);
  46006. /**
  46007. * Gets the right trigger value
  46008. */
  46009. get rightTrigger(): number;
  46010. /**
  46011. * Sets the right trigger value
  46012. */
  46013. set rightTrigger(newValue: number);
  46014. /**
  46015. * Defines the callback to call when a button is pressed
  46016. * @param callback defines the callback to use
  46017. */
  46018. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  46019. /**
  46020. * Defines the callback to call when a button is released
  46021. * @param callback defines the callback to use
  46022. */
  46023. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  46024. /**
  46025. * Defines the callback to call when a pad is pressed
  46026. * @param callback defines the callback to use
  46027. */
  46028. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  46029. /**
  46030. * Defines the callback to call when a pad is released
  46031. * @param callback defines the callback to use
  46032. */
  46033. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  46034. private _setButtonValue;
  46035. private _setDPadValue;
  46036. /**
  46037. * Gets the value of the `A` button
  46038. */
  46039. get buttonA(): number;
  46040. /**
  46041. * Sets the value of the `A` button
  46042. */
  46043. set buttonA(value: number);
  46044. /**
  46045. * Gets the value of the `B` button
  46046. */
  46047. get buttonB(): number;
  46048. /**
  46049. * Sets the value of the `B` button
  46050. */
  46051. set buttonB(value: number);
  46052. /**
  46053. * Gets the value of the `X` button
  46054. */
  46055. get buttonX(): number;
  46056. /**
  46057. * Sets the value of the `X` button
  46058. */
  46059. set buttonX(value: number);
  46060. /**
  46061. * Gets the value of the `Y` button
  46062. */
  46063. get buttonY(): number;
  46064. /**
  46065. * Sets the value of the `Y` button
  46066. */
  46067. set buttonY(value: number);
  46068. /**
  46069. * Gets the value of the `Start` button
  46070. */
  46071. get buttonStart(): number;
  46072. /**
  46073. * Sets the value of the `Start` button
  46074. */
  46075. set buttonStart(value: number);
  46076. /**
  46077. * Gets the value of the `Back` button
  46078. */
  46079. get buttonBack(): number;
  46080. /**
  46081. * Sets the value of the `Back` button
  46082. */
  46083. set buttonBack(value: number);
  46084. /**
  46085. * Gets the value of the `Left` button
  46086. */
  46087. get buttonLB(): number;
  46088. /**
  46089. * Sets the value of the `Left` button
  46090. */
  46091. set buttonLB(value: number);
  46092. /**
  46093. * Gets the value of the `Right` button
  46094. */
  46095. get buttonRB(): number;
  46096. /**
  46097. * Sets the value of the `Right` button
  46098. */
  46099. set buttonRB(value: number);
  46100. /**
  46101. * Gets the value of the Left joystick
  46102. */
  46103. get buttonLeftStick(): number;
  46104. /**
  46105. * Sets the value of the Left joystick
  46106. */
  46107. set buttonLeftStick(value: number);
  46108. /**
  46109. * Gets the value of the Right joystick
  46110. */
  46111. get buttonRightStick(): number;
  46112. /**
  46113. * Sets the value of the Right joystick
  46114. */
  46115. set buttonRightStick(value: number);
  46116. /**
  46117. * Gets the value of D-pad up
  46118. */
  46119. get dPadUp(): number;
  46120. /**
  46121. * Sets the value of D-pad up
  46122. */
  46123. set dPadUp(value: number);
  46124. /**
  46125. * Gets the value of D-pad down
  46126. */
  46127. get dPadDown(): number;
  46128. /**
  46129. * Sets the value of D-pad down
  46130. */
  46131. set dPadDown(value: number);
  46132. /**
  46133. * Gets the value of D-pad left
  46134. */
  46135. get dPadLeft(): number;
  46136. /**
  46137. * Sets the value of D-pad left
  46138. */
  46139. set dPadLeft(value: number);
  46140. /**
  46141. * Gets the value of D-pad right
  46142. */
  46143. get dPadRight(): number;
  46144. /**
  46145. * Sets the value of D-pad right
  46146. */
  46147. set dPadRight(value: number);
  46148. /**
  46149. * Force the gamepad to synchronize with device values
  46150. */
  46151. update(): void;
  46152. /**
  46153. * Disposes the gamepad
  46154. */
  46155. dispose(): void;
  46156. }
  46157. }
  46158. declare module "babylonjs/Gamepads/dualShockGamepad" {
  46159. import { Observable } from "babylonjs/Misc/observable";
  46160. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46161. /**
  46162. * Defines supported buttons for DualShock compatible gamepads
  46163. */
  46164. export enum DualShockButton {
  46165. /** Cross */
  46166. Cross = 0,
  46167. /** Circle */
  46168. Circle = 1,
  46169. /** Square */
  46170. Square = 2,
  46171. /** Triangle */
  46172. Triangle = 3,
  46173. /** L1 */
  46174. L1 = 4,
  46175. /** R1 */
  46176. R1 = 5,
  46177. /** Share */
  46178. Share = 8,
  46179. /** Options */
  46180. Options = 9,
  46181. /** Left stick */
  46182. LeftStick = 10,
  46183. /** Right stick */
  46184. RightStick = 11
  46185. }
  46186. /** Defines values for DualShock DPad */
  46187. export enum DualShockDpad {
  46188. /** Up */
  46189. Up = 12,
  46190. /** Down */
  46191. Down = 13,
  46192. /** Left */
  46193. Left = 14,
  46194. /** Right */
  46195. Right = 15
  46196. }
  46197. /**
  46198. * Defines a DualShock gamepad
  46199. */
  46200. export class DualShockPad extends Gamepad {
  46201. private _leftTrigger;
  46202. private _rightTrigger;
  46203. private _onlefttriggerchanged;
  46204. private _onrighttriggerchanged;
  46205. private _onbuttondown;
  46206. private _onbuttonup;
  46207. private _ondpaddown;
  46208. private _ondpadup;
  46209. /** Observable raised when a button is pressed */
  46210. onButtonDownObservable: Observable<DualShockButton>;
  46211. /** Observable raised when a button is released */
  46212. onButtonUpObservable: Observable<DualShockButton>;
  46213. /** Observable raised when a pad is pressed */
  46214. onPadDownObservable: Observable<DualShockDpad>;
  46215. /** Observable raised when a pad is released */
  46216. onPadUpObservable: Observable<DualShockDpad>;
  46217. private _buttonCross;
  46218. private _buttonCircle;
  46219. private _buttonSquare;
  46220. private _buttonTriangle;
  46221. private _buttonShare;
  46222. private _buttonOptions;
  46223. private _buttonL1;
  46224. private _buttonR1;
  46225. private _buttonLeftStick;
  46226. private _buttonRightStick;
  46227. private _dPadUp;
  46228. private _dPadDown;
  46229. private _dPadLeft;
  46230. private _dPadRight;
  46231. /**
  46232. * Creates a new DualShock gamepad object
  46233. * @param id defines the id of this gamepad
  46234. * @param index defines its index
  46235. * @param gamepad defines the internal HTML gamepad object
  46236. */
  46237. constructor(id: string, index: number, gamepad: any);
  46238. /**
  46239. * Defines the callback to call when left trigger is pressed
  46240. * @param callback defines the callback to use
  46241. */
  46242. onlefttriggerchanged(callback: (value: number) => void): void;
  46243. /**
  46244. * Defines the callback to call when right trigger is pressed
  46245. * @param callback defines the callback to use
  46246. */
  46247. onrighttriggerchanged(callback: (value: number) => void): void;
  46248. /**
  46249. * Gets the left trigger value
  46250. */
  46251. get leftTrigger(): number;
  46252. /**
  46253. * Sets the left trigger value
  46254. */
  46255. set leftTrigger(newValue: number);
  46256. /**
  46257. * Gets the right trigger value
  46258. */
  46259. get rightTrigger(): number;
  46260. /**
  46261. * Sets the right trigger value
  46262. */
  46263. set rightTrigger(newValue: number);
  46264. /**
  46265. * Defines the callback to call when a button is pressed
  46266. * @param callback defines the callback to use
  46267. */
  46268. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  46269. /**
  46270. * Defines the callback to call when a button is released
  46271. * @param callback defines the callback to use
  46272. */
  46273. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  46274. /**
  46275. * Defines the callback to call when a pad is pressed
  46276. * @param callback defines the callback to use
  46277. */
  46278. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  46279. /**
  46280. * Defines the callback to call when a pad is released
  46281. * @param callback defines the callback to use
  46282. */
  46283. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  46284. private _setButtonValue;
  46285. private _setDPadValue;
  46286. /**
  46287. * Gets the value of the `Cross` button
  46288. */
  46289. get buttonCross(): number;
  46290. /**
  46291. * Sets the value of the `Cross` button
  46292. */
  46293. set buttonCross(value: number);
  46294. /**
  46295. * Gets the value of the `Circle` button
  46296. */
  46297. get buttonCircle(): number;
  46298. /**
  46299. * Sets the value of the `Circle` button
  46300. */
  46301. set buttonCircle(value: number);
  46302. /**
  46303. * Gets the value of the `Square` button
  46304. */
  46305. get buttonSquare(): number;
  46306. /**
  46307. * Sets the value of the `Square` button
  46308. */
  46309. set buttonSquare(value: number);
  46310. /**
  46311. * Gets the value of the `Triangle` button
  46312. */
  46313. get buttonTriangle(): number;
  46314. /**
  46315. * Sets the value of the `Triangle` button
  46316. */
  46317. set buttonTriangle(value: number);
  46318. /**
  46319. * Gets the value of the `Options` button
  46320. */
  46321. get buttonOptions(): number;
  46322. /**
  46323. * Sets the value of the `Options` button
  46324. */
  46325. set buttonOptions(value: number);
  46326. /**
  46327. * Gets the value of the `Share` button
  46328. */
  46329. get buttonShare(): number;
  46330. /**
  46331. * Sets the value of the `Share` button
  46332. */
  46333. set buttonShare(value: number);
  46334. /**
  46335. * Gets the value of the `L1` button
  46336. */
  46337. get buttonL1(): number;
  46338. /**
  46339. * Sets the value of the `L1` button
  46340. */
  46341. set buttonL1(value: number);
  46342. /**
  46343. * Gets the value of the `R1` button
  46344. */
  46345. get buttonR1(): number;
  46346. /**
  46347. * Sets the value of the `R1` button
  46348. */
  46349. set buttonR1(value: number);
  46350. /**
  46351. * Gets the value of the Left joystick
  46352. */
  46353. get buttonLeftStick(): number;
  46354. /**
  46355. * Sets the value of the Left joystick
  46356. */
  46357. set buttonLeftStick(value: number);
  46358. /**
  46359. * Gets the value of the Right joystick
  46360. */
  46361. get buttonRightStick(): number;
  46362. /**
  46363. * Sets the value of the Right joystick
  46364. */
  46365. set buttonRightStick(value: number);
  46366. /**
  46367. * Gets the value of D-pad up
  46368. */
  46369. get dPadUp(): number;
  46370. /**
  46371. * Sets the value of D-pad up
  46372. */
  46373. set dPadUp(value: number);
  46374. /**
  46375. * Gets the value of D-pad down
  46376. */
  46377. get dPadDown(): number;
  46378. /**
  46379. * Sets the value of D-pad down
  46380. */
  46381. set dPadDown(value: number);
  46382. /**
  46383. * Gets the value of D-pad left
  46384. */
  46385. get dPadLeft(): number;
  46386. /**
  46387. * Sets the value of D-pad left
  46388. */
  46389. set dPadLeft(value: number);
  46390. /**
  46391. * Gets the value of D-pad right
  46392. */
  46393. get dPadRight(): number;
  46394. /**
  46395. * Sets the value of D-pad right
  46396. */
  46397. set dPadRight(value: number);
  46398. /**
  46399. * Force the gamepad to synchronize with device values
  46400. */
  46401. update(): void;
  46402. /**
  46403. * Disposes the gamepad
  46404. */
  46405. dispose(): void;
  46406. }
  46407. }
  46408. declare module "babylonjs/Gamepads/gamepadManager" {
  46409. import { Observable } from "babylonjs/Misc/observable";
  46410. import { Nullable } from "babylonjs/types";
  46411. import { Scene } from "babylonjs/scene";
  46412. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46413. /**
  46414. * Manager for handling gamepads
  46415. */
  46416. export class GamepadManager {
  46417. private _scene?;
  46418. private _babylonGamepads;
  46419. private _oneGamepadConnected;
  46420. /** @hidden */
  46421. _isMonitoring: boolean;
  46422. private _gamepadEventSupported;
  46423. private _gamepadSupport?;
  46424. /**
  46425. * observable to be triggered when the gamepad controller has been connected
  46426. */
  46427. onGamepadConnectedObservable: Observable<Gamepad>;
  46428. /**
  46429. * observable to be triggered when the gamepad controller has been disconnected
  46430. */
  46431. onGamepadDisconnectedObservable: Observable<Gamepad>;
  46432. private _onGamepadConnectedEvent;
  46433. private _onGamepadDisconnectedEvent;
  46434. /**
  46435. * Initializes the gamepad manager
  46436. * @param _scene BabylonJS scene
  46437. */
  46438. constructor(_scene?: Scene | undefined);
  46439. /**
  46440. * The gamepads in the game pad manager
  46441. */
  46442. get gamepads(): Gamepad[];
  46443. /**
  46444. * Get the gamepad controllers based on type
  46445. * @param type The type of gamepad controller
  46446. * @returns Nullable gamepad
  46447. */
  46448. getGamepadByType(type?: number): Nullable<Gamepad>;
  46449. /**
  46450. * Disposes the gamepad manager
  46451. */
  46452. dispose(): void;
  46453. private _addNewGamepad;
  46454. private _startMonitoringGamepads;
  46455. private _stopMonitoringGamepads;
  46456. /** @hidden */
  46457. _checkGamepadsStatus(): void;
  46458. private _updateGamepadObjects;
  46459. }
  46460. }
  46461. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  46462. import { Nullable } from "babylonjs/types";
  46463. import { Scene } from "babylonjs/scene";
  46464. import { ISceneComponent } from "babylonjs/sceneComponent";
  46465. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  46466. module "babylonjs/scene" {
  46467. interface Scene {
  46468. /** @hidden */
  46469. _gamepadManager: Nullable<GamepadManager>;
  46470. /**
  46471. * Gets the gamepad manager associated with the scene
  46472. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  46473. */
  46474. gamepadManager: GamepadManager;
  46475. }
  46476. }
  46477. module "babylonjs/Cameras/freeCameraInputsManager" {
  46478. /**
  46479. * Interface representing a free camera inputs manager
  46480. */
  46481. interface FreeCameraInputsManager {
  46482. /**
  46483. * Adds gamepad input support to the FreeCameraInputsManager.
  46484. * @returns the FreeCameraInputsManager
  46485. */
  46486. addGamepad(): FreeCameraInputsManager;
  46487. }
  46488. }
  46489. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  46490. /**
  46491. * Interface representing an arc rotate camera inputs manager
  46492. */
  46493. interface ArcRotateCameraInputsManager {
  46494. /**
  46495. * Adds gamepad input support to the ArcRotateCamera InputManager.
  46496. * @returns the camera inputs manager
  46497. */
  46498. addGamepad(): ArcRotateCameraInputsManager;
  46499. }
  46500. }
  46501. /**
  46502. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  46503. */
  46504. export class GamepadSystemSceneComponent implements ISceneComponent {
  46505. /**
  46506. * The component name helpfull to identify the component in the list of scene components.
  46507. */
  46508. readonly name: string;
  46509. /**
  46510. * The scene the component belongs to.
  46511. */
  46512. scene: Scene;
  46513. /**
  46514. * Creates a new instance of the component for the given scene
  46515. * @param scene Defines the scene to register the component in
  46516. */
  46517. constructor(scene: Scene);
  46518. /**
  46519. * Registers the component in a given scene
  46520. */
  46521. register(): void;
  46522. /**
  46523. * Rebuilds the elements related to this component in case of
  46524. * context lost for instance.
  46525. */
  46526. rebuild(): void;
  46527. /**
  46528. * Disposes the component and the associated ressources
  46529. */
  46530. dispose(): void;
  46531. private _beforeCameraUpdate;
  46532. }
  46533. }
  46534. declare module "babylonjs/Cameras/universalCamera" {
  46535. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  46536. import { Scene } from "babylonjs/scene";
  46537. import { Vector3 } from "babylonjs/Maths/math.vector";
  46538. import "babylonjs/Gamepads/gamepadSceneComponent";
  46539. /**
  46540. * 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,
  46541. * which still works and will still be found in many Playgrounds.
  46542. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  46543. */
  46544. export class UniversalCamera extends TouchCamera {
  46545. /**
  46546. * Defines the gamepad rotation sensiblity.
  46547. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46548. */
  46549. get gamepadAngularSensibility(): number;
  46550. set gamepadAngularSensibility(value: number);
  46551. /**
  46552. * Defines the gamepad move sensiblity.
  46553. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46554. */
  46555. get gamepadMoveSensibility(): number;
  46556. set gamepadMoveSensibility(value: number);
  46557. /**
  46558. * 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,
  46559. * which still works and will still be found in many Playgrounds.
  46560. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  46561. * @param name Define the name of the camera in the scene
  46562. * @param position Define the start position of the camera in the scene
  46563. * @param scene Define the scene the camera belongs to
  46564. */
  46565. constructor(name: string, position: Vector3, scene: Scene);
  46566. /**
  46567. * Gets the current object class name.
  46568. * @return the class name
  46569. */
  46570. getClassName(): string;
  46571. }
  46572. }
  46573. declare module "babylonjs/Cameras/gamepadCamera" {
  46574. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  46575. import { Scene } from "babylonjs/scene";
  46576. import { Vector3 } from "babylonjs/Maths/math.vector";
  46577. /**
  46578. * This represents a FPS type of camera. This is only here for back compat purpose.
  46579. * Please use the UniversalCamera instead as both are identical.
  46580. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  46581. */
  46582. export class GamepadCamera extends UniversalCamera {
  46583. /**
  46584. * Instantiates a new Gamepad Camera
  46585. * This represents a FPS type of camera. This is only here for back compat purpose.
  46586. * Please use the UniversalCamera instead as both are identical.
  46587. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  46588. * @param name Define the name of the camera in the scene
  46589. * @param position Define the start position of the camera in the scene
  46590. * @param scene Define the scene the camera belongs to
  46591. */
  46592. constructor(name: string, position: Vector3, scene: Scene);
  46593. /**
  46594. * Gets the current object class name.
  46595. * @return the class name
  46596. */
  46597. getClassName(): string;
  46598. }
  46599. }
  46600. declare module "babylonjs/Shaders/pass.fragment" {
  46601. /** @hidden */
  46602. export var passPixelShader: {
  46603. name: string;
  46604. shader: string;
  46605. };
  46606. }
  46607. declare module "babylonjs/Shaders/passCube.fragment" {
  46608. /** @hidden */
  46609. export var passCubePixelShader: {
  46610. name: string;
  46611. shader: string;
  46612. };
  46613. }
  46614. declare module "babylonjs/PostProcesses/passPostProcess" {
  46615. import { Nullable } from "babylonjs/types";
  46616. import { Camera } from "babylonjs/Cameras/camera";
  46617. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  46618. import { Engine } from "babylonjs/Engines/engine";
  46619. import "babylonjs/Shaders/pass.fragment";
  46620. import "babylonjs/Shaders/passCube.fragment";
  46621. /**
  46622. * PassPostProcess which produces an output the same as it's input
  46623. */
  46624. export class PassPostProcess extends PostProcess {
  46625. /**
  46626. * Creates the PassPostProcess
  46627. * @param name The name of the effect.
  46628. * @param options The required width/height ratio to downsize to before computing the render pass.
  46629. * @param camera The camera to apply the render pass to.
  46630. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  46631. * @param engine The engine which the post process will be applied. (default: current engine)
  46632. * @param reusable If the post process can be reused on the same frame. (default: false)
  46633. * @param textureType The type of texture to be used when performing the post processing.
  46634. * @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)
  46635. */
  46636. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  46637. }
  46638. /**
  46639. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  46640. */
  46641. export class PassCubePostProcess extends PostProcess {
  46642. private _face;
  46643. /**
  46644. * Gets or sets the cube face to display.
  46645. * * 0 is +X
  46646. * * 1 is -X
  46647. * * 2 is +Y
  46648. * * 3 is -Y
  46649. * * 4 is +Z
  46650. * * 5 is -Z
  46651. */
  46652. get face(): number;
  46653. set face(value: number);
  46654. /**
  46655. * Creates the PassCubePostProcess
  46656. * @param name The name of the effect.
  46657. * @param options The required width/height ratio to downsize to before computing the render pass.
  46658. * @param camera The camera to apply the render pass to.
  46659. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  46660. * @param engine The engine which the post process will be applied. (default: current engine)
  46661. * @param reusable If the post process can be reused on the same frame. (default: false)
  46662. * @param textureType The type of texture to be used when performing the post processing.
  46663. * @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)
  46664. */
  46665. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  46666. }
  46667. }
  46668. declare module "babylonjs/Shaders/anaglyph.fragment" {
  46669. /** @hidden */
  46670. export var anaglyphPixelShader: {
  46671. name: string;
  46672. shader: string;
  46673. };
  46674. }
  46675. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  46676. import { Engine } from "babylonjs/Engines/engine";
  46677. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  46678. import { Camera } from "babylonjs/Cameras/camera";
  46679. import "babylonjs/Shaders/anaglyph.fragment";
  46680. /**
  46681. * Postprocess used to generate anaglyphic rendering
  46682. */
  46683. export class AnaglyphPostProcess extends PostProcess {
  46684. private _passedProcess;
  46685. /**
  46686. * Creates a new AnaglyphPostProcess
  46687. * @param name defines postprocess name
  46688. * @param options defines creation options or target ratio scale
  46689. * @param rigCameras defines cameras using this postprocess
  46690. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  46691. * @param engine defines hosting engine
  46692. * @param reusable defines if the postprocess will be reused multiple times per frame
  46693. */
  46694. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  46695. }
  46696. }
  46697. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  46698. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  46699. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  46700. import { Scene } from "babylonjs/scene";
  46701. import { Vector3 } from "babylonjs/Maths/math.vector";
  46702. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  46703. /**
  46704. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  46705. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  46706. */
  46707. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  46708. /**
  46709. * Creates a new AnaglyphArcRotateCamera
  46710. * @param name defines camera name
  46711. * @param alpha defines alpha angle (in radians)
  46712. * @param beta defines beta angle (in radians)
  46713. * @param radius defines radius
  46714. * @param target defines camera target
  46715. * @param interaxialDistance defines distance between each color axis
  46716. * @param scene defines the hosting scene
  46717. */
  46718. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  46719. /**
  46720. * Gets camera class name
  46721. * @returns AnaglyphArcRotateCamera
  46722. */
  46723. getClassName(): string;
  46724. }
  46725. }
  46726. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  46727. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46728. import { Scene } from "babylonjs/scene";
  46729. import { Vector3 } from "babylonjs/Maths/math.vector";
  46730. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  46731. /**
  46732. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  46733. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  46734. */
  46735. export class AnaglyphFreeCamera extends FreeCamera {
  46736. /**
  46737. * Creates a new AnaglyphFreeCamera
  46738. * @param name defines camera name
  46739. * @param position defines initial position
  46740. * @param interaxialDistance defines distance between each color axis
  46741. * @param scene defines the hosting scene
  46742. */
  46743. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  46744. /**
  46745. * Gets camera class name
  46746. * @returns AnaglyphFreeCamera
  46747. */
  46748. getClassName(): string;
  46749. }
  46750. }
  46751. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  46752. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  46753. import { Scene } from "babylonjs/scene";
  46754. import { Vector3 } from "babylonjs/Maths/math.vector";
  46755. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  46756. /**
  46757. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  46758. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  46759. */
  46760. export class AnaglyphGamepadCamera extends GamepadCamera {
  46761. /**
  46762. * Creates a new AnaglyphGamepadCamera
  46763. * @param name defines camera name
  46764. * @param position defines initial position
  46765. * @param interaxialDistance defines distance between each color axis
  46766. * @param scene defines the hosting scene
  46767. */
  46768. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  46769. /**
  46770. * Gets camera class name
  46771. * @returns AnaglyphGamepadCamera
  46772. */
  46773. getClassName(): string;
  46774. }
  46775. }
  46776. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  46777. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  46778. import { Scene } from "babylonjs/scene";
  46779. import { Vector3 } from "babylonjs/Maths/math.vector";
  46780. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  46781. /**
  46782. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  46783. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  46784. */
  46785. export class AnaglyphUniversalCamera extends UniversalCamera {
  46786. /**
  46787. * Creates a new AnaglyphUniversalCamera
  46788. * @param name defines camera name
  46789. * @param position defines initial position
  46790. * @param interaxialDistance defines distance between each color axis
  46791. * @param scene defines the hosting scene
  46792. */
  46793. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  46794. /**
  46795. * Gets camera class name
  46796. * @returns AnaglyphUniversalCamera
  46797. */
  46798. getClassName(): string;
  46799. }
  46800. }
  46801. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  46802. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  46803. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  46804. import { Scene } from "babylonjs/scene";
  46805. import { Vector3 } from "babylonjs/Maths/math.vector";
  46806. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  46807. /**
  46808. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  46809. * @see http://doc.babylonjs.com/features/cameras
  46810. */
  46811. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  46812. /**
  46813. * Creates a new StereoscopicArcRotateCamera
  46814. * @param name defines camera name
  46815. * @param alpha defines alpha angle (in radians)
  46816. * @param beta defines beta angle (in radians)
  46817. * @param radius defines radius
  46818. * @param target defines camera target
  46819. * @param interaxialDistance defines distance between each color axis
  46820. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  46821. * @param scene defines the hosting scene
  46822. */
  46823. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  46824. /**
  46825. * Gets camera class name
  46826. * @returns StereoscopicArcRotateCamera
  46827. */
  46828. getClassName(): string;
  46829. }
  46830. }
  46831. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  46832. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46833. import { Scene } from "babylonjs/scene";
  46834. import { Vector3 } from "babylonjs/Maths/math.vector";
  46835. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  46836. /**
  46837. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  46838. * @see http://doc.babylonjs.com/features/cameras
  46839. */
  46840. export class StereoscopicFreeCamera extends FreeCamera {
  46841. /**
  46842. * Creates a new StereoscopicFreeCamera
  46843. * @param name defines camera name
  46844. * @param position defines initial position
  46845. * @param interaxialDistance defines distance between each color axis
  46846. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  46847. * @param scene defines the hosting scene
  46848. */
  46849. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  46850. /**
  46851. * Gets camera class name
  46852. * @returns StereoscopicFreeCamera
  46853. */
  46854. getClassName(): string;
  46855. }
  46856. }
  46857. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  46858. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  46859. import { Scene } from "babylonjs/scene";
  46860. import { Vector3 } from "babylonjs/Maths/math.vector";
  46861. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  46862. /**
  46863. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  46864. * @see http://doc.babylonjs.com/features/cameras
  46865. */
  46866. export class StereoscopicGamepadCamera extends GamepadCamera {
  46867. /**
  46868. * Creates a new StereoscopicGamepadCamera
  46869. * @param name defines camera name
  46870. * @param position defines initial position
  46871. * @param interaxialDistance defines distance between each color axis
  46872. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  46873. * @param scene defines the hosting scene
  46874. */
  46875. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  46876. /**
  46877. * Gets camera class name
  46878. * @returns StereoscopicGamepadCamera
  46879. */
  46880. getClassName(): string;
  46881. }
  46882. }
  46883. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  46884. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  46885. import { Scene } from "babylonjs/scene";
  46886. import { Vector3 } from "babylonjs/Maths/math.vector";
  46887. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  46888. /**
  46889. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  46890. * @see http://doc.babylonjs.com/features/cameras
  46891. */
  46892. export class StereoscopicUniversalCamera extends UniversalCamera {
  46893. /**
  46894. * Creates a new StereoscopicUniversalCamera
  46895. * @param name defines camera name
  46896. * @param position defines initial position
  46897. * @param interaxialDistance defines distance between each color axis
  46898. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  46899. * @param scene defines the hosting scene
  46900. */
  46901. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  46902. /**
  46903. * Gets camera class name
  46904. * @returns StereoscopicUniversalCamera
  46905. */
  46906. getClassName(): string;
  46907. }
  46908. }
  46909. declare module "babylonjs/Cameras/Stereoscopic/index" {
  46910. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  46911. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  46912. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  46913. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  46914. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  46915. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  46916. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  46917. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  46918. }
  46919. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  46920. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46921. import { Scene } from "babylonjs/scene";
  46922. import { Vector3 } from "babylonjs/Maths/math.vector";
  46923. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46924. /**
  46925. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  46926. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  46927. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  46928. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  46929. */
  46930. export class VirtualJoysticksCamera extends FreeCamera {
  46931. /**
  46932. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  46933. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  46934. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  46935. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  46936. * @param name Define the name of the camera in the scene
  46937. * @param position Define the start position of the camera in the scene
  46938. * @param scene Define the scene the camera belongs to
  46939. */
  46940. constructor(name: string, position: Vector3, scene: Scene);
  46941. /**
  46942. * Gets the current object class name.
  46943. * @return the class name
  46944. */
  46945. getClassName(): string;
  46946. }
  46947. }
  46948. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  46949. import { Matrix } from "babylonjs/Maths/math.vector";
  46950. /**
  46951. * This represents all the required metrics to create a VR camera.
  46952. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  46953. */
  46954. export class VRCameraMetrics {
  46955. /**
  46956. * Define the horizontal resolution off the screen.
  46957. */
  46958. hResolution: number;
  46959. /**
  46960. * Define the vertical resolution off the screen.
  46961. */
  46962. vResolution: number;
  46963. /**
  46964. * Define the horizontal screen size.
  46965. */
  46966. hScreenSize: number;
  46967. /**
  46968. * Define the vertical screen size.
  46969. */
  46970. vScreenSize: number;
  46971. /**
  46972. * Define the vertical screen center position.
  46973. */
  46974. vScreenCenter: number;
  46975. /**
  46976. * Define the distance of the eyes to the screen.
  46977. */
  46978. eyeToScreenDistance: number;
  46979. /**
  46980. * Define the distance between both lenses
  46981. */
  46982. lensSeparationDistance: number;
  46983. /**
  46984. * Define the distance between both viewer's eyes.
  46985. */
  46986. interpupillaryDistance: number;
  46987. /**
  46988. * Define the distortion factor of the VR postprocess.
  46989. * Please, touch with care.
  46990. */
  46991. distortionK: number[];
  46992. /**
  46993. * Define the chromatic aberration correction factors for the VR post process.
  46994. */
  46995. chromaAbCorrection: number[];
  46996. /**
  46997. * Define the scale factor of the post process.
  46998. * The smaller the better but the slower.
  46999. */
  47000. postProcessScaleFactor: number;
  47001. /**
  47002. * Define an offset for the lens center.
  47003. */
  47004. lensCenterOffset: number;
  47005. /**
  47006. * Define if the current vr camera should compensate the distortion of the lense or not.
  47007. */
  47008. compensateDistortion: boolean;
  47009. /**
  47010. * Defines if multiview should be enabled when rendering (Default: false)
  47011. */
  47012. multiviewEnabled: boolean;
  47013. /**
  47014. * Gets the rendering aspect ratio based on the provided resolutions.
  47015. */
  47016. get aspectRatio(): number;
  47017. /**
  47018. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  47019. */
  47020. get aspectRatioFov(): number;
  47021. /**
  47022. * @hidden
  47023. */
  47024. get leftHMatrix(): Matrix;
  47025. /**
  47026. * @hidden
  47027. */
  47028. get rightHMatrix(): Matrix;
  47029. /**
  47030. * @hidden
  47031. */
  47032. get leftPreViewMatrix(): Matrix;
  47033. /**
  47034. * @hidden
  47035. */
  47036. get rightPreViewMatrix(): Matrix;
  47037. /**
  47038. * Get the default VRMetrics based on the most generic setup.
  47039. * @returns the default vr metrics
  47040. */
  47041. static GetDefault(): VRCameraMetrics;
  47042. }
  47043. }
  47044. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  47045. /** @hidden */
  47046. export var vrDistortionCorrectionPixelShader: {
  47047. name: string;
  47048. shader: string;
  47049. };
  47050. }
  47051. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  47052. import { Camera } from "babylonjs/Cameras/camera";
  47053. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47054. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  47055. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  47056. /**
  47057. * VRDistortionCorrectionPostProcess used for mobile VR
  47058. */
  47059. export class VRDistortionCorrectionPostProcess extends PostProcess {
  47060. private _isRightEye;
  47061. private _distortionFactors;
  47062. private _postProcessScaleFactor;
  47063. private _lensCenterOffset;
  47064. private _scaleIn;
  47065. private _scaleFactor;
  47066. private _lensCenter;
  47067. /**
  47068. * Initializes the VRDistortionCorrectionPostProcess
  47069. * @param name The name of the effect.
  47070. * @param camera The camera to apply the render pass to.
  47071. * @param isRightEye If this is for the right eye distortion
  47072. * @param vrMetrics All the required metrics for the VR camera
  47073. */
  47074. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  47075. }
  47076. }
  47077. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  47078. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  47079. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47080. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47081. import { Scene } from "babylonjs/scene";
  47082. import { Vector3 } from "babylonjs/Maths/math.vector";
  47083. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  47084. import "babylonjs/Cameras/RigModes/vrRigMode";
  47085. /**
  47086. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  47087. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  47088. */
  47089. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  47090. /**
  47091. * Creates a new VRDeviceOrientationArcRotateCamera
  47092. * @param name defines camera name
  47093. * @param alpha defines the camera rotation along the logitudinal axis
  47094. * @param beta defines the camera rotation along the latitudinal axis
  47095. * @param radius defines the camera distance from its target
  47096. * @param target defines the camera target
  47097. * @param scene defines the scene the camera belongs to
  47098. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  47099. * @param vrCameraMetrics defines the vr metrics associated to the camera
  47100. */
  47101. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  47102. /**
  47103. * Gets camera class name
  47104. * @returns VRDeviceOrientationArcRotateCamera
  47105. */
  47106. getClassName(): string;
  47107. }
  47108. }
  47109. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  47110. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  47111. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47112. import { Scene } from "babylonjs/scene";
  47113. import { Vector3 } from "babylonjs/Maths/math.vector";
  47114. import "babylonjs/Cameras/RigModes/vrRigMode";
  47115. /**
  47116. * Camera used to simulate VR rendering (based on FreeCamera)
  47117. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  47118. */
  47119. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  47120. /**
  47121. * Creates a new VRDeviceOrientationFreeCamera
  47122. * @param name defines camera name
  47123. * @param position defines the start position of the camera
  47124. * @param scene defines the scene the camera belongs to
  47125. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  47126. * @param vrCameraMetrics defines the vr metrics associated to the camera
  47127. */
  47128. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  47129. /**
  47130. * Gets camera class name
  47131. * @returns VRDeviceOrientationFreeCamera
  47132. */
  47133. getClassName(): string;
  47134. }
  47135. }
  47136. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  47137. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  47138. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47139. import { Scene } from "babylonjs/scene";
  47140. import { Vector3 } from "babylonjs/Maths/math.vector";
  47141. import "babylonjs/Gamepads/gamepadSceneComponent";
  47142. /**
  47143. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  47144. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  47145. */
  47146. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  47147. /**
  47148. * Creates a new VRDeviceOrientationGamepadCamera
  47149. * @param name defines camera name
  47150. * @param position defines the start position of the camera
  47151. * @param scene defines the scene the camera belongs to
  47152. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  47153. * @param vrCameraMetrics defines the vr metrics associated to the camera
  47154. */
  47155. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  47156. /**
  47157. * Gets camera class name
  47158. * @returns VRDeviceOrientationGamepadCamera
  47159. */
  47160. getClassName(): string;
  47161. }
  47162. }
  47163. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  47164. import { Scene } from "babylonjs/scene";
  47165. import { Texture } from "babylonjs/Materials/Textures/texture";
  47166. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  47167. /**
  47168. * A class extending Texture allowing drawing on a texture
  47169. * @see http://doc.babylonjs.com/how_to/dynamictexture
  47170. */
  47171. export class DynamicTexture extends Texture {
  47172. private _generateMipMaps;
  47173. private _canvas;
  47174. private _context;
  47175. /**
  47176. * Creates a DynamicTexture
  47177. * @param name defines the name of the texture
  47178. * @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
  47179. * @param scene defines the scene where you want the texture
  47180. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  47181. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  47182. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  47183. */
  47184. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  47185. /**
  47186. * Get the current class name of the texture useful for serialization or dynamic coding.
  47187. * @returns "DynamicTexture"
  47188. */
  47189. getClassName(): string;
  47190. /**
  47191. * Gets the current state of canRescale
  47192. */
  47193. get canRescale(): boolean;
  47194. private _recreate;
  47195. /**
  47196. * Scales the texture
  47197. * @param ratio the scale factor to apply to both width and height
  47198. */
  47199. scale(ratio: number): void;
  47200. /**
  47201. * Resizes the texture
  47202. * @param width the new width
  47203. * @param height the new height
  47204. */
  47205. scaleTo(width: number, height: number): void;
  47206. /**
  47207. * Gets the context of the canvas used by the texture
  47208. * @returns the canvas context of the dynamic texture
  47209. */
  47210. getContext(): CanvasRenderingContext2D;
  47211. /**
  47212. * Clears the texture
  47213. */
  47214. clear(): void;
  47215. /**
  47216. * Updates the texture
  47217. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  47218. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  47219. */
  47220. update(invertY?: boolean, premulAlpha?: boolean): void;
  47221. /**
  47222. * Draws text onto the texture
  47223. * @param text defines the text to be drawn
  47224. * @param x defines the placement of the text from the left
  47225. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  47226. * @param font defines the font to be used with font-style, font-size, font-name
  47227. * @param color defines the color used for the text
  47228. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  47229. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  47230. * @param update defines whether texture is immediately update (default is true)
  47231. */
  47232. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  47233. /**
  47234. * Clones the texture
  47235. * @returns the clone of the texture.
  47236. */
  47237. clone(): DynamicTexture;
  47238. /**
  47239. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  47240. * @returns a serialized dynamic texture object
  47241. */
  47242. serialize(): any;
  47243. private _IsCanvasElement;
  47244. /** @hidden */
  47245. _rebuild(): void;
  47246. }
  47247. }
  47248. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  47249. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  47250. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  47251. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  47252. /** @hidden */
  47253. export var imageProcessingPixelShader: {
  47254. name: string;
  47255. shader: string;
  47256. };
  47257. }
  47258. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  47259. import { Nullable } from "babylonjs/types";
  47260. import { Color4 } from "babylonjs/Maths/math.color";
  47261. import { Camera } from "babylonjs/Cameras/camera";
  47262. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47263. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  47264. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  47265. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47266. import { Engine } from "babylonjs/Engines/engine";
  47267. import "babylonjs/Shaders/imageProcessing.fragment";
  47268. import "babylonjs/Shaders/postprocess.vertex";
  47269. /**
  47270. * ImageProcessingPostProcess
  47271. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  47272. */
  47273. export class ImageProcessingPostProcess extends PostProcess {
  47274. /**
  47275. * Default configuration related to image processing available in the PBR Material.
  47276. */
  47277. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  47278. /**
  47279. * Gets the image processing configuration used either in this material.
  47280. */
  47281. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  47282. /**
  47283. * Sets the Default image processing configuration used either in the this material.
  47284. *
  47285. * If sets to null, the scene one is in use.
  47286. */
  47287. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  47288. /**
  47289. * Keep track of the image processing observer to allow dispose and replace.
  47290. */
  47291. private _imageProcessingObserver;
  47292. /**
  47293. * Attaches a new image processing configuration to the PBR Material.
  47294. * @param configuration
  47295. */
  47296. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  47297. /**
  47298. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  47299. */
  47300. get colorCurves(): Nullable<ColorCurves>;
  47301. /**
  47302. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  47303. */
  47304. set colorCurves(value: Nullable<ColorCurves>);
  47305. /**
  47306. * Gets wether the color curves effect is enabled.
  47307. */
  47308. get colorCurvesEnabled(): boolean;
  47309. /**
  47310. * Sets wether the color curves effect is enabled.
  47311. */
  47312. set colorCurvesEnabled(value: boolean);
  47313. /**
  47314. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  47315. */
  47316. get colorGradingTexture(): Nullable<BaseTexture>;
  47317. /**
  47318. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  47319. */
  47320. set colorGradingTexture(value: Nullable<BaseTexture>);
  47321. /**
  47322. * Gets wether the color grading effect is enabled.
  47323. */
  47324. get colorGradingEnabled(): boolean;
  47325. /**
  47326. * Gets wether the color grading effect is enabled.
  47327. */
  47328. set colorGradingEnabled(value: boolean);
  47329. /**
  47330. * Gets exposure used in the effect.
  47331. */
  47332. get exposure(): number;
  47333. /**
  47334. * Sets exposure used in the effect.
  47335. */
  47336. set exposure(value: number);
  47337. /**
  47338. * Gets wether tonemapping is enabled or not.
  47339. */
  47340. get toneMappingEnabled(): boolean;
  47341. /**
  47342. * Sets wether tonemapping is enabled or not
  47343. */
  47344. set toneMappingEnabled(value: boolean);
  47345. /**
  47346. * Gets the type of tone mapping effect.
  47347. */
  47348. get toneMappingType(): number;
  47349. /**
  47350. * Sets the type of tone mapping effect.
  47351. */
  47352. set toneMappingType(value: number);
  47353. /**
  47354. * Gets contrast used in the effect.
  47355. */
  47356. get contrast(): number;
  47357. /**
  47358. * Sets contrast used in the effect.
  47359. */
  47360. set contrast(value: number);
  47361. /**
  47362. * Gets Vignette stretch size.
  47363. */
  47364. get vignetteStretch(): number;
  47365. /**
  47366. * Sets Vignette stretch size.
  47367. */
  47368. set vignetteStretch(value: number);
  47369. /**
  47370. * Gets Vignette centre X Offset.
  47371. */
  47372. get vignetteCentreX(): number;
  47373. /**
  47374. * Sets Vignette centre X Offset.
  47375. */
  47376. set vignetteCentreX(value: number);
  47377. /**
  47378. * Gets Vignette centre Y Offset.
  47379. */
  47380. get vignetteCentreY(): number;
  47381. /**
  47382. * Sets Vignette centre Y Offset.
  47383. */
  47384. set vignetteCentreY(value: number);
  47385. /**
  47386. * Gets Vignette weight or intensity of the vignette effect.
  47387. */
  47388. get vignetteWeight(): number;
  47389. /**
  47390. * Sets Vignette weight or intensity of the vignette effect.
  47391. */
  47392. set vignetteWeight(value: number);
  47393. /**
  47394. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  47395. * if vignetteEnabled is set to true.
  47396. */
  47397. get vignetteColor(): Color4;
  47398. /**
  47399. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  47400. * if vignetteEnabled is set to true.
  47401. */
  47402. set vignetteColor(value: Color4);
  47403. /**
  47404. * Gets Camera field of view used by the Vignette effect.
  47405. */
  47406. get vignetteCameraFov(): number;
  47407. /**
  47408. * Sets Camera field of view used by the Vignette effect.
  47409. */
  47410. set vignetteCameraFov(value: number);
  47411. /**
  47412. * Gets the vignette blend mode allowing different kind of effect.
  47413. */
  47414. get vignetteBlendMode(): number;
  47415. /**
  47416. * Sets the vignette blend mode allowing different kind of effect.
  47417. */
  47418. set vignetteBlendMode(value: number);
  47419. /**
  47420. * Gets wether the vignette effect is enabled.
  47421. */
  47422. get vignetteEnabled(): boolean;
  47423. /**
  47424. * Sets wether the vignette effect is enabled.
  47425. */
  47426. set vignetteEnabled(value: boolean);
  47427. private _fromLinearSpace;
  47428. /**
  47429. * Gets wether the input of the processing is in Gamma or Linear Space.
  47430. */
  47431. get fromLinearSpace(): boolean;
  47432. /**
  47433. * Sets wether the input of the processing is in Gamma or Linear Space.
  47434. */
  47435. set fromLinearSpace(value: boolean);
  47436. /**
  47437. * Defines cache preventing GC.
  47438. */
  47439. private _defines;
  47440. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  47441. /**
  47442. * "ImageProcessingPostProcess"
  47443. * @returns "ImageProcessingPostProcess"
  47444. */
  47445. getClassName(): string;
  47446. protected _updateParameters(): void;
  47447. dispose(camera?: Camera): void;
  47448. }
  47449. }
  47450. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  47451. import { Scene } from "babylonjs/scene";
  47452. import { Color3 } from "babylonjs/Maths/math.color";
  47453. import { Mesh } from "babylonjs/Meshes/mesh";
  47454. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  47455. import { Nullable } from "babylonjs/types";
  47456. /**
  47457. * Class containing static functions to help procedurally build meshes
  47458. */
  47459. export class GroundBuilder {
  47460. /**
  47461. * Creates a ground mesh
  47462. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  47463. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  47464. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  47465. * @param name defines the name of the mesh
  47466. * @param options defines the options used to create the mesh
  47467. * @param scene defines the hosting scene
  47468. * @returns the ground mesh
  47469. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  47470. */
  47471. static CreateGround(name: string, options: {
  47472. width?: number;
  47473. height?: number;
  47474. subdivisions?: number;
  47475. subdivisionsX?: number;
  47476. subdivisionsY?: number;
  47477. updatable?: boolean;
  47478. }, scene: any): Mesh;
  47479. /**
  47480. * Creates a tiled ground mesh
  47481. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  47482. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  47483. * * 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
  47484. * * 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
  47485. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  47486. * @param name defines the name of the mesh
  47487. * @param options defines the options used to create the mesh
  47488. * @param scene defines the hosting scene
  47489. * @returns the tiled ground mesh
  47490. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  47491. */
  47492. static CreateTiledGround(name: string, options: {
  47493. xmin: number;
  47494. zmin: number;
  47495. xmax: number;
  47496. zmax: number;
  47497. subdivisions?: {
  47498. w: number;
  47499. h: number;
  47500. };
  47501. precision?: {
  47502. w: number;
  47503. h: number;
  47504. };
  47505. updatable?: boolean;
  47506. }, scene?: Nullable<Scene>): Mesh;
  47507. /**
  47508. * Creates a ground mesh from a height map
  47509. * * The parameter `url` sets the URL of the height map image resource.
  47510. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  47511. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  47512. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  47513. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  47514. * * 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.
  47515. * * 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).
  47516. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  47517. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  47518. * @param name defines the name of the mesh
  47519. * @param url defines the url to the height map
  47520. * @param options defines the options used to create the mesh
  47521. * @param scene defines the hosting scene
  47522. * @returns the ground mesh
  47523. * @see https://doc.babylonjs.com/babylon101/height_map
  47524. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  47525. */
  47526. static CreateGroundFromHeightMap(name: string, url: string, options: {
  47527. width?: number;
  47528. height?: number;
  47529. subdivisions?: number;
  47530. minHeight?: number;
  47531. maxHeight?: number;
  47532. colorFilter?: Color3;
  47533. alphaFilter?: number;
  47534. updatable?: boolean;
  47535. onReady?: (mesh: GroundMesh) => void;
  47536. }, scene?: Nullable<Scene>): GroundMesh;
  47537. }
  47538. }
  47539. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  47540. import { Vector4 } from "babylonjs/Maths/math.vector";
  47541. import { Mesh } from "babylonjs/Meshes/mesh";
  47542. /**
  47543. * Class containing static functions to help procedurally build meshes
  47544. */
  47545. export class TorusBuilder {
  47546. /**
  47547. * Creates a torus mesh
  47548. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  47549. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  47550. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  47551. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  47552. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  47553. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  47554. * @param name defines the name of the mesh
  47555. * @param options defines the options used to create the mesh
  47556. * @param scene defines the hosting scene
  47557. * @returns the torus mesh
  47558. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  47559. */
  47560. static CreateTorus(name: string, options: {
  47561. diameter?: number;
  47562. thickness?: number;
  47563. tessellation?: number;
  47564. updatable?: boolean;
  47565. sideOrientation?: number;
  47566. frontUVs?: Vector4;
  47567. backUVs?: Vector4;
  47568. }, scene: any): Mesh;
  47569. }
  47570. }
  47571. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  47572. import { Vector4 } from "babylonjs/Maths/math.vector";
  47573. import { Color4 } from "babylonjs/Maths/math.color";
  47574. import { Mesh } from "babylonjs/Meshes/mesh";
  47575. /**
  47576. * Class containing static functions to help procedurally build meshes
  47577. */
  47578. export class CylinderBuilder {
  47579. /**
  47580. * Creates a cylinder or a cone mesh
  47581. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  47582. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  47583. * * 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.
  47584. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  47585. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  47586. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  47587. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  47588. * * 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).
  47589. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  47590. * * 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).
  47591. * * 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
  47592. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  47593. * * 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
  47594. * * 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.
  47595. * * If `enclose` is false, a ring surface is one element.
  47596. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  47597. * * 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
  47598. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  47599. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  47600. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  47601. * @param name defines the name of the mesh
  47602. * @param options defines the options used to create the mesh
  47603. * @param scene defines the hosting scene
  47604. * @returns the cylinder mesh
  47605. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  47606. */
  47607. static CreateCylinder(name: string, options: {
  47608. height?: number;
  47609. diameterTop?: number;
  47610. diameterBottom?: number;
  47611. diameter?: number;
  47612. tessellation?: number;
  47613. subdivisions?: number;
  47614. arc?: number;
  47615. faceColors?: Color4[];
  47616. faceUV?: Vector4[];
  47617. updatable?: boolean;
  47618. hasRings?: boolean;
  47619. enclose?: boolean;
  47620. cap?: number;
  47621. sideOrientation?: number;
  47622. frontUVs?: Vector4;
  47623. backUVs?: Vector4;
  47624. }, scene: any): Mesh;
  47625. }
  47626. }
  47627. declare module "babylonjs/XR/webXRTypes" {
  47628. import { Nullable } from "babylonjs/types";
  47629. import { IDisposable } from "babylonjs/scene";
  47630. /**
  47631. * States of the webXR experience
  47632. */
  47633. export enum WebXRState {
  47634. /**
  47635. * Transitioning to being in XR mode
  47636. */
  47637. ENTERING_XR = 0,
  47638. /**
  47639. * Transitioning to non XR mode
  47640. */
  47641. EXITING_XR = 1,
  47642. /**
  47643. * In XR mode and presenting
  47644. */
  47645. IN_XR = 2,
  47646. /**
  47647. * Not entered XR mode
  47648. */
  47649. NOT_IN_XR = 3
  47650. }
  47651. /**
  47652. * Abstraction of the XR render target
  47653. */
  47654. export interface WebXRRenderTarget extends IDisposable {
  47655. /**
  47656. * xrpresent context of the canvas which can be used to display/mirror xr content
  47657. */
  47658. canvasContext: WebGLRenderingContext;
  47659. /**
  47660. * xr layer for the canvas
  47661. */
  47662. xrLayer: Nullable<XRWebGLLayer>;
  47663. /**
  47664. * Initializes the xr layer for the session
  47665. * @param xrSession xr session
  47666. * @returns a promise that will resolve once the XR Layer has been created
  47667. */
  47668. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  47669. }
  47670. }
  47671. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  47672. import { Nullable } from "babylonjs/types";
  47673. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  47674. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  47675. /**
  47676. * COnfiguration object for WebXR output canvas
  47677. */
  47678. export class WebXRManagedOutputCanvasOptions {
  47679. /**
  47680. * An optional canvas in case you wish to create it yourself and provide it here.
  47681. * If not provided, a new canvas will be created
  47682. */
  47683. canvasElement?: HTMLCanvasElement;
  47684. /**
  47685. * Options for this XR Layer output
  47686. */
  47687. canvasOptions?: XRWebGLLayerOptions;
  47688. /**
  47689. * CSS styling for a newly created canvas (if not provided)
  47690. */
  47691. newCanvasCssStyle?: string;
  47692. /**
  47693. * Get the default values of the configuration object
  47694. * @returns default values of this configuration object
  47695. */
  47696. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  47697. }
  47698. /**
  47699. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  47700. */
  47701. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  47702. private _options;
  47703. private _canvas;
  47704. private _engine;
  47705. /**
  47706. * Rendering context of the canvas which can be used to display/mirror xr content
  47707. */
  47708. canvasContext: WebGLRenderingContext;
  47709. /**
  47710. * xr layer for the canvas
  47711. */
  47712. xrLayer: Nullable<XRWebGLLayer>;
  47713. /**
  47714. * Initializes the canvas to be added/removed upon entering/exiting xr
  47715. * @param _xrSessionManager The XR Session manager
  47716. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  47717. */
  47718. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  47719. /**
  47720. * Disposes of the object
  47721. */
  47722. dispose(): void;
  47723. /**
  47724. * Initializes the xr layer for the session
  47725. * @param xrSession xr session
  47726. * @returns a promise that will resolve once the XR Layer has been created
  47727. */
  47728. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  47729. private _addCanvas;
  47730. private _removeCanvas;
  47731. private _setManagedOutputCanvas;
  47732. }
  47733. }
  47734. declare module "babylonjs/XR/webXRSessionManager" {
  47735. import { Observable } from "babylonjs/Misc/observable";
  47736. import { Nullable } from "babylonjs/types";
  47737. import { IDisposable, Scene } from "babylonjs/scene";
  47738. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  47739. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  47740. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  47741. /**
  47742. * Manages an XRSession to work with Babylon's engine
  47743. * @see https://doc.babylonjs.com/how_to/webxr
  47744. */
  47745. export class WebXRSessionManager implements IDisposable {
  47746. /** The scene which the session should be created for */
  47747. scene: Scene;
  47748. private _referenceSpace;
  47749. private _rttProvider;
  47750. private _sessionEnded;
  47751. private _xrNavigator;
  47752. private baseLayer;
  47753. /**
  47754. * The base reference space from which the session started. good if you want to reset your
  47755. * reference space
  47756. */
  47757. baseReferenceSpace: XRReferenceSpace;
  47758. /**
  47759. * Current XR frame
  47760. */
  47761. currentFrame: Nullable<XRFrame>;
  47762. /** WebXR timestamp updated every frame */
  47763. currentTimestamp: number;
  47764. /**
  47765. * Used just in case of a failure to initialize an immersive session.
  47766. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  47767. */
  47768. defaultHeightCompensation: number;
  47769. /**
  47770. * Fires every time a new xrFrame arrives which can be used to update the camera
  47771. */
  47772. onXRFrameObservable: Observable<XRFrame>;
  47773. /**
  47774. * Fires when the reference space changed
  47775. */
  47776. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  47777. /**
  47778. * Fires when the xr session is ended either by the device or manually done
  47779. */
  47780. onXRSessionEnded: Observable<any>;
  47781. /**
  47782. * Fires when the xr session is ended either by the device or manually done
  47783. */
  47784. onXRSessionInit: Observable<XRSession>;
  47785. /**
  47786. * Underlying xr session
  47787. */
  47788. session: XRSession;
  47789. /**
  47790. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  47791. * or get the offset the player is currently at.
  47792. */
  47793. viewerReferenceSpace: XRReferenceSpace;
  47794. /**
  47795. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  47796. * @param scene The scene which the session should be created for
  47797. */
  47798. constructor(
  47799. /** The scene which the session should be created for */
  47800. scene: Scene);
  47801. /**
  47802. * The current reference space used in this session. This reference space can constantly change!
  47803. * It is mainly used to offset the camera's position.
  47804. */
  47805. get referenceSpace(): XRReferenceSpace;
  47806. /**
  47807. * Set a new reference space and triggers the observable
  47808. */
  47809. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  47810. /**
  47811. * Disposes of the session manager
  47812. */
  47813. dispose(): void;
  47814. /**
  47815. * Stops the xrSession and restores the render loop
  47816. * @returns Promise which resolves after it exits XR
  47817. */
  47818. exitXRAsync(): Promise<void>;
  47819. /**
  47820. * Gets the correct render target texture to be rendered this frame for this eye
  47821. * @param eye the eye for which to get the render target
  47822. * @returns the render target for the specified eye
  47823. */
  47824. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  47825. /**
  47826. * Creates a WebXRRenderTarget object for the XR session
  47827. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  47828. * @param options optional options to provide when creating a new render target
  47829. * @returns a WebXR render target to which the session can render
  47830. */
  47831. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  47832. /**
  47833. * Initializes the manager
  47834. * After initialization enterXR can be called to start an XR session
  47835. * @returns Promise which resolves after it is initialized
  47836. */
  47837. initializeAsync(): Promise<void>;
  47838. /**
  47839. * Initializes an xr session
  47840. * @param xrSessionMode mode to initialize
  47841. * @param xrSessionInit defines optional and required values to pass to the session builder
  47842. * @returns a promise which will resolve once the session has been initialized
  47843. */
  47844. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  47845. /**
  47846. * Checks if a session would be supported for the creation options specified
  47847. * @param sessionMode session mode to check if supported eg. immersive-vr
  47848. * @returns A Promise that resolves to true if supported and false if not
  47849. */
  47850. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  47851. /**
  47852. * Resets the reference space to the one started the session
  47853. */
  47854. resetReferenceSpace(): void;
  47855. /**
  47856. * Starts rendering to the xr layer
  47857. */
  47858. runXRRenderLoop(): void;
  47859. /**
  47860. * Sets the reference space on the xr session
  47861. * @param referenceSpaceType space to set
  47862. * @returns a promise that will resolve once the reference space has been set
  47863. */
  47864. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  47865. /**
  47866. * Updates the render state of the session
  47867. * @param state state to set
  47868. * @returns a promise that resolves once the render state has been updated
  47869. */
  47870. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  47871. /**
  47872. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  47873. * @param sessionMode defines the session to test
  47874. * @returns a promise with boolean as final value
  47875. */
  47876. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  47877. private _createRenderTargetTexture;
  47878. }
  47879. }
  47880. declare module "babylonjs/XR/webXRCamera" {
  47881. import { Matrix } from "babylonjs/Maths/math.vector";
  47882. import { Scene } from "babylonjs/scene";
  47883. import { Camera } from "babylonjs/Cameras/camera";
  47884. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47885. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  47886. /**
  47887. * WebXR Camera which holds the views for the xrSession
  47888. * @see https://doc.babylonjs.com/how_to/webxr_camera
  47889. */
  47890. export class WebXRCamera extends FreeCamera {
  47891. private _xrSessionManager;
  47892. private _firstFrame;
  47893. private _referenceQuaternion;
  47894. private _referencedPosition;
  47895. private _xrInvPositionCache;
  47896. private _xrInvQuaternionCache;
  47897. /**
  47898. * Should position compensation execute on first frame.
  47899. * This is used when copying the position from a native (non XR) camera
  47900. */
  47901. compensateOnFirstFrame: boolean;
  47902. /**
  47903. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  47904. * @param name the name of the camera
  47905. * @param scene the scene to add the camera to
  47906. * @param _xrSessionManager a constructed xr session manager
  47907. */
  47908. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  47909. /**
  47910. * Return the user's height, unrelated to the current ground.
  47911. * This will be the y position of this camera, when ground level is 0.
  47912. */
  47913. get realWorldHeight(): number;
  47914. /** @hidden */
  47915. _updateForDualEyeDebugging(): void;
  47916. /**
  47917. * Sets this camera's transformation based on a non-vr camera
  47918. * @param otherCamera the non-vr camera to copy the transformation from
  47919. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  47920. */
  47921. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  47922. /**
  47923. * Gets the current instance class name ("WebXRCamera").
  47924. * @returns the class name
  47925. */
  47926. getClassName(): string;
  47927. /**
  47928. * Overriding the _getViewMatrix function, as it is computed by WebXR
  47929. */
  47930. _getViewMatrix(): Matrix;
  47931. private _updateFromXRSession;
  47932. private _updateNumberOfRigCameras;
  47933. private _updateReferenceSpace;
  47934. private _updateReferenceSpaceOffset;
  47935. }
  47936. }
  47937. declare module "babylonjs/XR/webXRFeaturesManager" {
  47938. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  47939. import { IDisposable } from "babylonjs/scene";
  47940. /**
  47941. * Defining the interface required for a (webxr) feature
  47942. */
  47943. export interface IWebXRFeature extends IDisposable {
  47944. /**
  47945. * Is this feature attached
  47946. */
  47947. attached: boolean;
  47948. /**
  47949. * Should auto-attach be disabled?
  47950. */
  47951. disableAutoAttach: boolean;
  47952. /**
  47953. * Attach the feature to the session
  47954. * Will usually be called by the features manager
  47955. *
  47956. * @param force should attachment be forced (even when already attached)
  47957. * @returns true if successful.
  47958. */
  47959. attach(force?: boolean): boolean;
  47960. /**
  47961. * Detach the feature from the session
  47962. * Will usually be called by the features manager
  47963. *
  47964. * @returns true if successful.
  47965. */
  47966. detach(): boolean;
  47967. }
  47968. /**
  47969. * A list of the currently available features without referencing them
  47970. */
  47971. export class WebXRFeatureName {
  47972. /**
  47973. * The name of the anchor system feature
  47974. */
  47975. static ANCHOR_SYSTEM: string;
  47976. /**
  47977. * The name of the background remover feature
  47978. */
  47979. static BACKGROUND_REMOVER: string;
  47980. /**
  47981. * The name of the hit test feature
  47982. */
  47983. static HIT_TEST: string;
  47984. /**
  47985. * physics impostors for xr controllers feature
  47986. */
  47987. static PHYSICS_CONTROLLERS: string;
  47988. /**
  47989. * The name of the plane detection feature
  47990. */
  47991. static PLANE_DETECTION: string;
  47992. /**
  47993. * The name of the pointer selection feature
  47994. */
  47995. static POINTER_SELECTION: string;
  47996. /**
  47997. * The name of the teleportation feature
  47998. */
  47999. static TELEPORTATION: string;
  48000. }
  48001. /**
  48002. * Defining the constructor of a feature. Used to register the modules.
  48003. */
  48004. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => (() => IWebXRFeature);
  48005. /**
  48006. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48007. * It is mainly used in AR sessions.
  48008. *
  48009. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48010. */
  48011. export class WebXRFeaturesManager implements IDisposable {
  48012. private _xrSessionManager;
  48013. private static readonly _AvailableFeatures;
  48014. private _features;
  48015. /**
  48016. * constructs a new features manages.
  48017. *
  48018. * @param _xrSessionManager an instance of WebXRSessionManager
  48019. */
  48020. constructor(_xrSessionManager: WebXRSessionManager);
  48021. /**
  48022. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48023. * Mainly used internally.
  48024. *
  48025. * @param featureName the name of the feature to register
  48026. * @param constructorFunction the function used to construct the module
  48027. * @param version the (babylon) version of the module
  48028. * @param stable is that a stable version of this module
  48029. */
  48030. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48031. /**
  48032. * Returns a constructor of a specific feature.
  48033. *
  48034. * @param featureName the name of the feature to construct
  48035. * @param version the version of the feature to load
  48036. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48037. * @param options optional options provided to the module.
  48038. * @returns a function that, when called, will return a new instance of this feature
  48039. */
  48040. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): (() => IWebXRFeature);
  48041. /**
  48042. * Can be used to return the list of features currently registered
  48043. *
  48044. * @returns an Array of available features
  48045. */
  48046. static GetAvailableFeatures(): string[];
  48047. /**
  48048. * Gets the versions available for a specific feature
  48049. * @param featureName the name of the feature
  48050. * @returns an array with the available versions
  48051. */
  48052. static GetAvailableVersions(featureName: string): string[];
  48053. /**
  48054. * Return the latest unstable version of this feature
  48055. * @param featureName the name of the feature to search
  48056. * @returns the version number. if not found will return -1
  48057. */
  48058. static GetLatestVersionOfFeature(featureName: string): number;
  48059. /**
  48060. * Return the latest stable version of this feature
  48061. * @param featureName the name of the feature to search
  48062. * @returns the version number. if not found will return -1
  48063. */
  48064. static GetStableVersionOfFeature(featureName: string): number;
  48065. /**
  48066. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  48067. * Can be used during a session to start a feature
  48068. * @param featureName the name of feature to attach
  48069. */
  48070. attachFeature(featureName: string): void;
  48071. /**
  48072. * Can be used inside a session or when the session ends to detach a specific feature
  48073. * @param featureName the name of the feature to detach
  48074. */
  48075. detachFeature(featureName: string): void;
  48076. /**
  48077. * Used to disable an already-enabled feature
  48078. * The feature will be disposed and will be recreated once enabled.
  48079. * @param featureName the feature to disable
  48080. * @returns true if disable was successful
  48081. */
  48082. disableFeature(featureName: string | {
  48083. Name: string;
  48084. }): boolean;
  48085. /**
  48086. * dispose this features manager
  48087. */
  48088. dispose(): void;
  48089. /**
  48090. * Enable a feature using its name and a version. This will enable it in the scene, and will be responsible to attach it when the session starts.
  48091. * If used twice, the old version will be disposed and a new one will be constructed. This way you can re-enable with different configuration.
  48092. *
  48093. * @param featureName the name of the feature to load or the class of the feature
  48094. * @param version optional version to load. if not provided the latest version will be enabled
  48095. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  48096. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  48097. * @returns a new constructed feature or throws an error if feature not found.
  48098. */
  48099. enableFeature(featureName: string | {
  48100. Name: string;
  48101. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean): IWebXRFeature;
  48102. /**
  48103. * get the implementation of an enabled feature.
  48104. * @param featureName the name of the feature to load
  48105. * @returns the feature class, if found
  48106. */
  48107. getEnabledFeature(featureName: string): IWebXRFeature;
  48108. /**
  48109. * Get the list of enabled features
  48110. * @returns an array of enabled features
  48111. */
  48112. getEnabledFeatures(): string[];
  48113. }
  48114. }
  48115. declare module "babylonjs/XR/webXRExperienceHelper" {
  48116. import { Observable } from "babylonjs/Misc/observable";
  48117. import { IDisposable, Scene } from "babylonjs/scene";
  48118. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48119. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  48120. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48121. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  48122. /**
  48123. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  48124. * @see https://doc.babylonjs.com/how_to/webxr
  48125. */
  48126. export class WebXRExperienceHelper implements IDisposable {
  48127. private scene;
  48128. private _nonVRCamera;
  48129. private _originalSceneAutoClear;
  48130. private _supported;
  48131. /**
  48132. * Camera used to render xr content
  48133. */
  48134. camera: WebXRCamera;
  48135. /** A features manager for this xr session */
  48136. featuresManager: WebXRFeaturesManager;
  48137. /**
  48138. * Observers registered here will be triggered after the camera's initial transformation is set
  48139. * This can be used to set a different ground level or an extra rotation.
  48140. *
  48141. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  48142. * to the position set after this observable is done executing.
  48143. */
  48144. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  48145. /**
  48146. * Fires when the state of the experience helper has changed
  48147. */
  48148. onStateChangedObservable: Observable<WebXRState>;
  48149. /** Session manager used to keep track of xr session */
  48150. sessionManager: WebXRSessionManager;
  48151. /**
  48152. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  48153. */
  48154. state: WebXRState;
  48155. /**
  48156. * Creates a WebXRExperienceHelper
  48157. * @param scene The scene the helper should be created in
  48158. */
  48159. private constructor();
  48160. /**
  48161. * Creates the experience helper
  48162. * @param scene the scene to attach the experience helper to
  48163. * @returns a promise for the experience helper
  48164. */
  48165. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  48166. /**
  48167. * Disposes of the experience helper
  48168. */
  48169. dispose(): void;
  48170. /**
  48171. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  48172. * @param sessionMode options for the XR session
  48173. * @param referenceSpaceType frame of reference of the XR session
  48174. * @param renderTarget the output canvas that will be used to enter XR mode
  48175. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  48176. * @returns promise that resolves after xr mode has entered
  48177. */
  48178. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  48179. /**
  48180. * Exits XR mode and returns the scene to its original state
  48181. * @returns promise that resolves after xr mode has exited
  48182. */
  48183. exitXRAsync(): Promise<void>;
  48184. private _nonXRToXRCamera;
  48185. private _setState;
  48186. }
  48187. }
  48188. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  48189. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  48190. import { Observable } from "babylonjs/Misc/observable";
  48191. import { IDisposable } from "babylonjs/scene";
  48192. /**
  48193. * X-Y values for axes in WebXR
  48194. */
  48195. export interface IWebXRMotionControllerAxesValue {
  48196. /**
  48197. * The value of the x axis
  48198. */
  48199. x: number;
  48200. /**
  48201. * The value of the y-axis
  48202. */
  48203. y: number;
  48204. }
  48205. /**
  48206. * changed / previous values for the values of this component
  48207. */
  48208. export interface IWebXRMotionControllerComponentChangesValues<T> {
  48209. /**
  48210. * current (this frame) value
  48211. */
  48212. current: T;
  48213. /**
  48214. * previous (last change) value
  48215. */
  48216. previous: T;
  48217. }
  48218. /**
  48219. * Represents changes in the component between current frame and last values recorded
  48220. */
  48221. export interface IWebXRMotionControllerComponentChanges {
  48222. /**
  48223. * will be populated with previous and current values if axes changed
  48224. */
  48225. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  48226. /**
  48227. * will be populated with previous and current values if pressed changed
  48228. */
  48229. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  48230. /**
  48231. * will be populated with previous and current values if touched changed
  48232. */
  48233. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  48234. /**
  48235. * will be populated with previous and current values if value changed
  48236. */
  48237. value?: IWebXRMotionControllerComponentChangesValues<number>;
  48238. }
  48239. /**
  48240. * This class represents a single component (for example button or thumbstick) of a motion controller
  48241. */
  48242. export class WebXRControllerComponent implements IDisposable {
  48243. /**
  48244. * the id of this component
  48245. */
  48246. id: string;
  48247. /**
  48248. * the type of the component
  48249. */
  48250. type: MotionControllerComponentType;
  48251. private _buttonIndex;
  48252. private _axesIndices;
  48253. private _axes;
  48254. private _changes;
  48255. private _currentValue;
  48256. private _hasChanges;
  48257. private _pressed;
  48258. private _touched;
  48259. /**
  48260. * button component type
  48261. */
  48262. static BUTTON_TYPE: MotionControllerComponentType;
  48263. /**
  48264. * squeeze component type
  48265. */
  48266. static SQUEEZE_TYPE: MotionControllerComponentType;
  48267. /**
  48268. * Thumbstick component type
  48269. */
  48270. static THUMBSTICK_TYPE: MotionControllerComponentType;
  48271. /**
  48272. * Touchpad component type
  48273. */
  48274. static TOUCHPAD_TYPE: MotionControllerComponentType;
  48275. /**
  48276. * trigger component type
  48277. */
  48278. static TRIGGER_TYPE: MotionControllerComponentType;
  48279. /**
  48280. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  48281. * the axes data changes
  48282. */
  48283. onAxisValueChangedObservable: Observable<{
  48284. x: number;
  48285. y: number;
  48286. }>;
  48287. /**
  48288. * Observers registered here will be triggered when the state of a button changes
  48289. * State change is either pressed / touched / value
  48290. */
  48291. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  48292. /**
  48293. * Creates a new component for a motion controller.
  48294. * It is created by the motion controller itself
  48295. *
  48296. * @param id the id of this component
  48297. * @param type the type of the component
  48298. * @param _buttonIndex index in the buttons array of the gamepad
  48299. * @param _axesIndices indices of the values in the axes array of the gamepad
  48300. */
  48301. constructor(
  48302. /**
  48303. * the id of this component
  48304. */
  48305. id: string,
  48306. /**
  48307. * the type of the component
  48308. */
  48309. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  48310. /**
  48311. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  48312. */
  48313. get axes(): IWebXRMotionControllerAxesValue;
  48314. /**
  48315. * Get the changes. Elements will be populated only if they changed with their previous and current value
  48316. */
  48317. get changes(): IWebXRMotionControllerComponentChanges;
  48318. /**
  48319. * Return whether or not the component changed the last frame
  48320. */
  48321. get hasChanges(): boolean;
  48322. /**
  48323. * is the button currently pressed
  48324. */
  48325. get pressed(): boolean;
  48326. /**
  48327. * is the button currently touched
  48328. */
  48329. get touched(): boolean;
  48330. /**
  48331. * Get the current value of this component
  48332. */
  48333. get value(): number;
  48334. /**
  48335. * Dispose this component
  48336. */
  48337. dispose(): void;
  48338. /**
  48339. * Are there axes correlating to this component
  48340. * @return true is axes data is available
  48341. */
  48342. isAxes(): boolean;
  48343. /**
  48344. * Is this component a button (hence - pressable)
  48345. * @returns true if can be pressed
  48346. */
  48347. isButton(): boolean;
  48348. /**
  48349. * update this component using the gamepad object it is in. Called on every frame
  48350. * @param nativeController the native gamepad controller object
  48351. */
  48352. update(nativeController: IMinimalMotionControllerObject): void;
  48353. }
  48354. }
  48355. declare module "babylonjs/Loading/sceneLoader" {
  48356. import { Observable } from "babylonjs/Misc/observable";
  48357. import { Nullable } from "babylonjs/types";
  48358. import { Scene } from "babylonjs/scene";
  48359. import { Engine } from "babylonjs/Engines/engine";
  48360. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48361. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  48362. import { AssetContainer } from "babylonjs/assetContainer";
  48363. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  48364. import { Skeleton } from "babylonjs/Bones/skeleton";
  48365. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  48366. import { WebRequest } from "babylonjs/Misc/webRequest";
  48367. /**
  48368. * Interface used to represent data loading progression
  48369. */
  48370. export interface ISceneLoaderProgressEvent {
  48371. /**
  48372. * Defines if data length to load can be evaluated
  48373. */
  48374. readonly lengthComputable: boolean;
  48375. /**
  48376. * Defines the loaded data length
  48377. */
  48378. readonly loaded: number;
  48379. /**
  48380. * Defines the data length to load
  48381. */
  48382. readonly total: number;
  48383. }
  48384. /**
  48385. * Interface used by SceneLoader plugins to define supported file extensions
  48386. */
  48387. export interface ISceneLoaderPluginExtensions {
  48388. /**
  48389. * Defines the list of supported extensions
  48390. */
  48391. [extension: string]: {
  48392. isBinary: boolean;
  48393. };
  48394. }
  48395. /**
  48396. * Interface used by SceneLoader plugin factory
  48397. */
  48398. export interface ISceneLoaderPluginFactory {
  48399. /**
  48400. * Defines the name of the factory
  48401. */
  48402. name: string;
  48403. /**
  48404. * Function called to create a new plugin
  48405. * @return the new plugin
  48406. */
  48407. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  48408. /**
  48409. * The callback that returns true if the data can be directly loaded.
  48410. * @param data string containing the file data
  48411. * @returns if the data can be loaded directly
  48412. */
  48413. canDirectLoad?(data: string): boolean;
  48414. }
  48415. /**
  48416. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  48417. */
  48418. export interface ISceneLoaderPluginBase {
  48419. /**
  48420. * The friendly name of this plugin.
  48421. */
  48422. name: string;
  48423. /**
  48424. * The file extensions supported by this plugin.
  48425. */
  48426. extensions: string | ISceneLoaderPluginExtensions;
  48427. /**
  48428. * The callback called when loading from a url.
  48429. * @param scene scene loading this url
  48430. * @param url url to load
  48431. * @param onSuccess callback called when the file successfully loads
  48432. * @param onProgress callback called while file is loading (if the server supports this mode)
  48433. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  48434. * @param onError callback called when the file fails to load
  48435. * @returns a file request object
  48436. */
  48437. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  48438. /**
  48439. * The callback called when loading from a file object.
  48440. * @param scene scene loading this file
  48441. * @param file defines the file to load
  48442. * @param onSuccess defines the callback to call when data is loaded
  48443. * @param onProgress defines the callback to call during loading process
  48444. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  48445. * @param onError defines the callback to call when an error occurs
  48446. * @returns a file request object
  48447. */
  48448. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  48449. /**
  48450. * The callback that returns true if the data can be directly loaded.
  48451. * @param data string containing the file data
  48452. * @returns if the data can be loaded directly
  48453. */
  48454. canDirectLoad?(data: string): boolean;
  48455. /**
  48456. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  48457. * @param scene scene loading this data
  48458. * @param data string containing the data
  48459. * @returns data to pass to the plugin
  48460. */
  48461. directLoad?(scene: Scene, data: string): any;
  48462. /**
  48463. * The callback that allows custom handling of the root url based on the response url.
  48464. * @param rootUrl the original root url
  48465. * @param responseURL the response url if available
  48466. * @returns the new root url
  48467. */
  48468. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  48469. }
  48470. /**
  48471. * Interface used to define a SceneLoader plugin
  48472. */
  48473. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  48474. /**
  48475. * Import meshes into a scene.
  48476. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  48477. * @param scene The scene to import into
  48478. * @param data The data to import
  48479. * @param rootUrl The root url for scene and resources
  48480. * @param meshes The meshes array to import into
  48481. * @param particleSystems The particle systems array to import into
  48482. * @param skeletons The skeletons array to import into
  48483. * @param onError The callback when import fails
  48484. * @returns True if successful or false otherwise
  48485. */
  48486. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  48487. /**
  48488. * Load into a scene.
  48489. * @param scene The scene to load into
  48490. * @param data The data to import
  48491. * @param rootUrl The root url for scene and resources
  48492. * @param onError The callback when import fails
  48493. * @returns True if successful or false otherwise
  48494. */
  48495. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  48496. /**
  48497. * Load into an asset container.
  48498. * @param scene The scene to load into
  48499. * @param data The data to import
  48500. * @param rootUrl The root url for scene and resources
  48501. * @param onError The callback when import fails
  48502. * @returns The loaded asset container
  48503. */
  48504. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  48505. }
  48506. /**
  48507. * Interface used to define an async SceneLoader plugin
  48508. */
  48509. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  48510. /**
  48511. * Import meshes into a scene.
  48512. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  48513. * @param scene The scene to import into
  48514. * @param data The data to import
  48515. * @param rootUrl The root url for scene and resources
  48516. * @param onProgress The callback when the load progresses
  48517. * @param fileName Defines the name of the file to load
  48518. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  48519. */
  48520. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  48521. meshes: AbstractMesh[];
  48522. particleSystems: IParticleSystem[];
  48523. skeletons: Skeleton[];
  48524. animationGroups: AnimationGroup[];
  48525. }>;
  48526. /**
  48527. * Load into a scene.
  48528. * @param scene The scene to load into
  48529. * @param data The data to import
  48530. * @param rootUrl The root url for scene and resources
  48531. * @param onProgress The callback when the load progresses
  48532. * @param fileName Defines the name of the file to load
  48533. * @returns Nothing
  48534. */
  48535. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  48536. /**
  48537. * Load into an asset container.
  48538. * @param scene The scene to load into
  48539. * @param data The data to import
  48540. * @param rootUrl The root url for scene and resources
  48541. * @param onProgress The callback when the load progresses
  48542. * @param fileName Defines the name of the file to load
  48543. * @returns The loaded asset container
  48544. */
  48545. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  48546. }
  48547. /**
  48548. * Mode that determines how to handle old animation groups before loading new ones.
  48549. */
  48550. export enum SceneLoaderAnimationGroupLoadingMode {
  48551. /**
  48552. * Reset all old animations to initial state then dispose them.
  48553. */
  48554. Clean = 0,
  48555. /**
  48556. * Stop all old animations.
  48557. */
  48558. Stop = 1,
  48559. /**
  48560. * Restart old animations from first frame.
  48561. */
  48562. Sync = 2,
  48563. /**
  48564. * Old animations remains untouched.
  48565. */
  48566. NoSync = 3
  48567. }
  48568. /**
  48569. * Class used to load scene from various file formats using registered plugins
  48570. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  48571. */
  48572. export class SceneLoader {
  48573. /**
  48574. * No logging while loading
  48575. */
  48576. static readonly NO_LOGGING: number;
  48577. /**
  48578. * Minimal logging while loading
  48579. */
  48580. static readonly MINIMAL_LOGGING: number;
  48581. /**
  48582. * Summary logging while loading
  48583. */
  48584. static readonly SUMMARY_LOGGING: number;
  48585. /**
  48586. * Detailled logging while loading
  48587. */
  48588. static readonly DETAILED_LOGGING: number;
  48589. /**
  48590. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  48591. */
  48592. static get ForceFullSceneLoadingForIncremental(): boolean;
  48593. static set ForceFullSceneLoadingForIncremental(value: boolean);
  48594. /**
  48595. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  48596. */
  48597. static get ShowLoadingScreen(): boolean;
  48598. static set ShowLoadingScreen(value: boolean);
  48599. /**
  48600. * Defines the current logging level (while loading the scene)
  48601. * @ignorenaming
  48602. */
  48603. static get loggingLevel(): number;
  48604. static set loggingLevel(value: number);
  48605. /**
  48606. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  48607. */
  48608. static get CleanBoneMatrixWeights(): boolean;
  48609. static set CleanBoneMatrixWeights(value: boolean);
  48610. /**
  48611. * Event raised when a plugin is used to load a scene
  48612. */
  48613. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  48614. private static _registeredPlugins;
  48615. private static _getDefaultPlugin;
  48616. private static _getPluginForExtension;
  48617. private static _getPluginForDirectLoad;
  48618. private static _getPluginForFilename;
  48619. private static _getDirectLoad;
  48620. private static _loadData;
  48621. private static _getFileInfo;
  48622. /**
  48623. * Gets a plugin that can load the given extension
  48624. * @param extension defines the extension to load
  48625. * @returns a plugin or null if none works
  48626. */
  48627. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  48628. /**
  48629. * Gets a boolean indicating that the given extension can be loaded
  48630. * @param extension defines the extension to load
  48631. * @returns true if the extension is supported
  48632. */
  48633. static IsPluginForExtensionAvailable(extension: string): boolean;
  48634. /**
  48635. * Adds a new plugin to the list of registered plugins
  48636. * @param plugin defines the plugin to add
  48637. */
  48638. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  48639. /**
  48640. * Import meshes into a scene
  48641. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  48642. * @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)
  48643. * @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)
  48644. * @param scene the instance of BABYLON.Scene to append to
  48645. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  48646. * @param onProgress a callback with a progress event for each file being loaded
  48647. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  48648. * @param pluginExtension the extension used to determine the plugin
  48649. * @returns The loaded plugin
  48650. */
  48651. static ImportMesh(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], animationGroups: AnimationGroup[]) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  48652. /**
  48653. * Import meshes into a scene
  48654. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  48655. * @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)
  48656. * @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)
  48657. * @param scene the instance of BABYLON.Scene to append to
  48658. * @param onProgress a callback with a progress event for each file being loaded
  48659. * @param pluginExtension the extension used to determine the plugin
  48660. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  48661. */
  48662. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  48663. meshes: AbstractMesh[];
  48664. particleSystems: IParticleSystem[];
  48665. skeletons: Skeleton[];
  48666. animationGroups: AnimationGroup[];
  48667. }>;
  48668. /**
  48669. * Load a scene
  48670. * @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)
  48671. * @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)
  48672. * @param engine is the instance of BABYLON.Engine to use to create the scene
  48673. * @param onSuccess a callback with the scene when import succeeds
  48674. * @param onProgress a callback with a progress event for each file being loaded
  48675. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  48676. * @param pluginExtension the extension used to determine the plugin
  48677. * @returns The loaded plugin
  48678. */
  48679. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  48680. /**
  48681. * Load a scene
  48682. * @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)
  48683. * @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)
  48684. * @param engine is the instance of BABYLON.Engine to use to create the scene
  48685. * @param onProgress a callback with a progress event for each file being loaded
  48686. * @param pluginExtension the extension used to determine the plugin
  48687. * @returns The loaded scene
  48688. */
  48689. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  48690. /**
  48691. * Append a scene
  48692. * @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)
  48693. * @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)
  48694. * @param scene is the instance of BABYLON.Scene to append to
  48695. * @param onSuccess a callback with the scene when import succeeds
  48696. * @param onProgress a callback with a progress event for each file being loaded
  48697. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  48698. * @param pluginExtension the extension used to determine the plugin
  48699. * @returns The loaded plugin
  48700. */
  48701. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  48702. /**
  48703. * Append a scene
  48704. * @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)
  48705. * @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)
  48706. * @param scene is the instance of BABYLON.Scene to append to
  48707. * @param onProgress a callback with a progress event for each file being loaded
  48708. * @param pluginExtension the extension used to determine the plugin
  48709. * @returns The given scene
  48710. */
  48711. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  48712. /**
  48713. * Load a scene into an asset container
  48714. * @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)
  48715. * @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)
  48716. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  48717. * @param onSuccess a callback with the scene when import succeeds
  48718. * @param onProgress a callback with a progress event for each file being loaded
  48719. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  48720. * @param pluginExtension the extension used to determine the plugin
  48721. * @returns The loaded plugin
  48722. */
  48723. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  48724. /**
  48725. * Load a scene into an asset container
  48726. * @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)
  48727. * @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)
  48728. * @param scene is the instance of Scene to append to
  48729. * @param onProgress a callback with a progress event for each file being loaded
  48730. * @param pluginExtension the extension used to determine the plugin
  48731. * @returns The loaded asset container
  48732. */
  48733. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  48734. /**
  48735. * Import animations from a file into a scene
  48736. * @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)
  48737. * @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)
  48738. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  48739. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  48740. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  48741. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  48742. * @param onSuccess a callback with the scene when import succeeds
  48743. * @param onProgress a callback with a progress event for each file being loaded
  48744. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  48745. */
  48746. static ImportAnimations(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>): void;
  48747. /**
  48748. * Import animations from a file into a scene
  48749. * @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)
  48750. * @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)
  48751. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  48752. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  48753. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  48754. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  48755. * @param onSuccess a callback with the scene when import succeeds
  48756. * @param onProgress a callback with a progress event for each file being loaded
  48757. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  48758. * @returns the updated scene with imported animations
  48759. */
  48760. static ImportAnimationsAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>): Promise<Scene>;
  48761. }
  48762. }
  48763. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  48764. import { IDisposable, Scene } from "babylonjs/scene";
  48765. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  48766. import { Observable } from "babylonjs/Misc/observable";
  48767. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48768. import { Nullable } from "babylonjs/types";
  48769. /**
  48770. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  48771. */
  48772. export type MotionControllerHandedness = "none" | "left" | "right";
  48773. /**
  48774. * The type of components available in motion controllers.
  48775. * This is not the name of the component.
  48776. */
  48777. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  48778. /**
  48779. * The state of a controller component
  48780. */
  48781. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  48782. /**
  48783. * The schema of motion controller layout.
  48784. * No object will be initialized using this interface
  48785. * This is used just to define the profile.
  48786. */
  48787. export interface IMotionControllerLayout {
  48788. /**
  48789. * Path to load the assets. Usually relative to the base path
  48790. */
  48791. assetPath: string;
  48792. /**
  48793. * Available components (unsorted)
  48794. */
  48795. components: {
  48796. /**
  48797. * A map of component Ids
  48798. */
  48799. [componentId: string]: {
  48800. /**
  48801. * The type of input the component outputs
  48802. */
  48803. type: MotionControllerComponentType;
  48804. /**
  48805. * The indices of this component in the gamepad object
  48806. */
  48807. gamepadIndices: {
  48808. /**
  48809. * Index of button
  48810. */
  48811. button?: number;
  48812. /**
  48813. * If available, index of x-axis
  48814. */
  48815. xAxis?: number;
  48816. /**
  48817. * If available, index of y-axis
  48818. */
  48819. yAxis?: number;
  48820. };
  48821. /**
  48822. * The mesh's root node name
  48823. */
  48824. rootNodeName: string;
  48825. /**
  48826. * Animation definitions for this model
  48827. */
  48828. visualResponses: {
  48829. [stateKey: string]: {
  48830. /**
  48831. * What property will be animated
  48832. */
  48833. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  48834. /**
  48835. * What states influence this visual response
  48836. */
  48837. states: MotionControllerComponentStateType[];
  48838. /**
  48839. * Type of animation - movement or visibility
  48840. */
  48841. valueNodeProperty: "transform" | "visibility";
  48842. /**
  48843. * Base node name to move. Its position will be calculated according to the min and max nodes
  48844. */
  48845. valueNodeName?: string;
  48846. /**
  48847. * Minimum movement node
  48848. */
  48849. minNodeName?: string;
  48850. /**
  48851. * Max movement node
  48852. */
  48853. maxNodeName?: string;
  48854. };
  48855. };
  48856. /**
  48857. * If touch enabled, what is the name of node to display user feedback
  48858. */
  48859. touchPointNodeName?: string;
  48860. };
  48861. };
  48862. /**
  48863. * Is it xr standard mapping or not
  48864. */
  48865. gamepadMapping: "" | "xr-standard";
  48866. /**
  48867. * Base root node of this entire model
  48868. */
  48869. rootNodeName: string;
  48870. /**
  48871. * Defines the main button component id
  48872. */
  48873. selectComponentId: string;
  48874. }
  48875. /**
  48876. * A definition for the layout map in the input profile
  48877. */
  48878. export interface IMotionControllerLayoutMap {
  48879. /**
  48880. * Layouts with handedness type as a key
  48881. */
  48882. [handedness: string]: IMotionControllerLayout;
  48883. }
  48884. /**
  48885. * The XR Input profile schema
  48886. * Profiles can be found here:
  48887. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  48888. */
  48889. export interface IMotionControllerProfile {
  48890. /**
  48891. * fallback profiles for this profileId
  48892. */
  48893. fallbackProfileIds: string[];
  48894. /**
  48895. * The layout map, with handedness as key
  48896. */
  48897. layouts: IMotionControllerLayoutMap;
  48898. /**
  48899. * The id of this profile
  48900. * correlates to the profile(s) in the xrInput.profiles array
  48901. */
  48902. profileId: string;
  48903. }
  48904. /**
  48905. * A helper-interface for the 3 meshes needed for controller button animation
  48906. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  48907. */
  48908. export interface IMotionControllerButtonMeshMap {
  48909. /**
  48910. * the mesh that defines the pressed value mesh position.
  48911. * This is used to find the max-position of this button
  48912. */
  48913. pressedMesh: AbstractMesh;
  48914. /**
  48915. * the mesh that defines the unpressed value mesh position.
  48916. * This is used to find the min (or initial) position of this button
  48917. */
  48918. unpressedMesh: AbstractMesh;
  48919. /**
  48920. * The mesh that will be changed when value changes
  48921. */
  48922. valueMesh: AbstractMesh;
  48923. }
  48924. /**
  48925. * A helper-interface for the 3 meshes needed for controller axis animation.
  48926. * This will be expanded when touchpad animations are fully supported
  48927. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  48928. */
  48929. export interface IMotionControllerMeshMap {
  48930. /**
  48931. * the mesh that defines the maximum value mesh position.
  48932. */
  48933. maxMesh?: AbstractMesh;
  48934. /**
  48935. * the mesh that defines the minimum value mesh position.
  48936. */
  48937. minMesh?: AbstractMesh;
  48938. /**
  48939. * The mesh that will be changed when axis value changes
  48940. */
  48941. valueMesh: AbstractMesh;
  48942. }
  48943. /**
  48944. * The elements needed for change-detection of the gamepad objects in motion controllers
  48945. */
  48946. export interface IMinimalMotionControllerObject {
  48947. /**
  48948. * Available axes of this controller
  48949. */
  48950. axes: number[];
  48951. /**
  48952. * An array of available buttons
  48953. */
  48954. buttons: Array<{
  48955. /**
  48956. * Value of the button/trigger
  48957. */
  48958. value: number;
  48959. /**
  48960. * If the button/trigger is currently touched
  48961. */
  48962. touched: boolean;
  48963. /**
  48964. * If the button/trigger is currently pressed
  48965. */
  48966. pressed: boolean;
  48967. }>;
  48968. /**
  48969. * EXPERIMENTAL haptic support.
  48970. */
  48971. hapticActuators?: Array<{
  48972. pulse: (value: number, duration: number) => Promise<boolean>;
  48973. }>;
  48974. }
  48975. /**
  48976. * An Abstract Motion controller
  48977. * This class receives an xrInput and a profile layout and uses those to initialize the components
  48978. * Each component has an observable to check for changes in value and state
  48979. */
  48980. export abstract class WebXRAbstractMotionController implements IDisposable {
  48981. protected scene: Scene;
  48982. protected layout: IMotionControllerLayout;
  48983. /**
  48984. * The gamepad object correlating to this controller
  48985. */
  48986. gamepadObject: IMinimalMotionControllerObject;
  48987. /**
  48988. * handedness (left/right/none) of this controller
  48989. */
  48990. handedness: MotionControllerHandedness;
  48991. private _initComponent;
  48992. private _modelReady;
  48993. /**
  48994. * A map of components (WebXRControllerComponent) in this motion controller
  48995. * Components have a ComponentType and can also have both button and axis definitions
  48996. */
  48997. readonly components: {
  48998. [id: string]: WebXRControllerComponent;
  48999. };
  49000. /**
  49001. * Disable the model's animation. Can be set at any time.
  49002. */
  49003. disableAnimation: boolean;
  49004. /**
  49005. * Observers registered here will be triggered when the model of this controller is done loading
  49006. */
  49007. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49008. /**
  49009. * The profile id of this motion controller
  49010. */
  49011. abstract profileId: string;
  49012. /**
  49013. * The root mesh of the model. It is null if the model was not yet initialized
  49014. */
  49015. rootMesh: Nullable<AbstractMesh>;
  49016. /**
  49017. * constructs a new abstract motion controller
  49018. * @param scene the scene to which the model of the controller will be added
  49019. * @param layout The profile layout to load
  49020. * @param gamepadObject The gamepad object correlating to this controller
  49021. * @param handedness handedness (left/right/none) of this controller
  49022. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49023. */
  49024. constructor(scene: Scene, layout: IMotionControllerLayout,
  49025. /**
  49026. * The gamepad object correlating to this controller
  49027. */
  49028. gamepadObject: IMinimalMotionControllerObject,
  49029. /**
  49030. * handedness (left/right/none) of this controller
  49031. */
  49032. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  49033. /**
  49034. * Dispose this controller, the model mesh and all its components
  49035. */
  49036. dispose(): void;
  49037. /**
  49038. * Returns all components of specific type
  49039. * @param type the type to search for
  49040. * @return an array of components with this type
  49041. */
  49042. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  49043. /**
  49044. * get a component based an its component id as defined in layout.components
  49045. * @param id the id of the component
  49046. * @returns the component correlates to the id or undefined if not found
  49047. */
  49048. getComponent(id: string): WebXRControllerComponent;
  49049. /**
  49050. * Get the list of components available in this motion controller
  49051. * @returns an array of strings correlating to available components
  49052. */
  49053. getComponentIds(): string[];
  49054. /**
  49055. * Get the first component of specific type
  49056. * @param type type of component to find
  49057. * @return a controller component or null if not found
  49058. */
  49059. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  49060. /**
  49061. * Get the main (Select) component of this controller as defined in the layout
  49062. * @returns the main component of this controller
  49063. */
  49064. getMainComponent(): WebXRControllerComponent;
  49065. /**
  49066. * Loads the model correlating to this controller
  49067. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  49068. * @returns A promise fulfilled with the result of the model loading
  49069. */
  49070. loadModel(): Promise<boolean>;
  49071. /**
  49072. * Update this model using the current XRFrame
  49073. * @param xrFrame the current xr frame to use and update the model
  49074. */
  49075. updateFromXRFrame(xrFrame: XRFrame): void;
  49076. /**
  49077. * Backwards compatibility due to a deeply-integrated typo
  49078. */
  49079. get handness(): XREye;
  49080. /**
  49081. * Pulse (vibrate) this controller
  49082. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  49083. * Consecutive calls to this function will cancel the last pulse call
  49084. *
  49085. * @param value the strength of the pulse in 0.0...1.0 range
  49086. * @param duration Duration of the pulse in milliseconds
  49087. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  49088. * @returns a promise that will send true when the pulse has ended and false if the device doesn't support pulse or an error accrued
  49089. */
  49090. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  49091. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh;
  49092. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh;
  49093. /**
  49094. * Moves the axis on the controller mesh based on its current state
  49095. * @param axis the index of the axis
  49096. * @param axisValue the value of the axis which determines the meshes new position
  49097. * @hidden
  49098. */
  49099. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  49100. /**
  49101. * Update the model itself with the current frame data
  49102. * @param xrFrame the frame to use for updating the model mesh
  49103. */
  49104. protected updateModel(xrFrame: XRFrame): void;
  49105. /**
  49106. * Get the filename and path for this controller's model
  49107. * @returns a map of filename and path
  49108. */
  49109. protected abstract _getFilenameAndPath(): {
  49110. filename: string;
  49111. path: string;
  49112. };
  49113. /**
  49114. * This function is called before the mesh is loaded. It checks for loading constraints.
  49115. * For example, this function can check if the GLB loader is available
  49116. * If this function returns false, the generic controller will be loaded instead
  49117. * @returns Is the client ready to load the mesh
  49118. */
  49119. protected abstract _getModelLoadingConstraints(): boolean;
  49120. /**
  49121. * This function will be called after the model was successfully loaded and can be used
  49122. * for mesh transformations before it is available for the user
  49123. * @param meshes the loaded meshes
  49124. */
  49125. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  49126. /**
  49127. * Set the root mesh for this controller. Important for the WebXR controller class
  49128. * @param meshes the loaded meshes
  49129. */
  49130. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  49131. /**
  49132. * A function executed each frame that updates the mesh (if needed)
  49133. * @param xrFrame the current xrFrame
  49134. */
  49135. protected abstract _updateModel(xrFrame: XRFrame): void;
  49136. private _getGenericFilenameAndPath;
  49137. private _getGenericParentMesh;
  49138. }
  49139. }
  49140. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  49141. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49142. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49143. import { Scene } from "babylonjs/scene";
  49144. /**
  49145. * A generic trigger-only motion controller for WebXR
  49146. */
  49147. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  49148. /**
  49149. * Static version of the profile id of this controller
  49150. */
  49151. static ProfileId: string;
  49152. profileId: string;
  49153. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  49154. protected _getFilenameAndPath(): {
  49155. filename: string;
  49156. path: string;
  49157. };
  49158. protected _getModelLoadingConstraints(): boolean;
  49159. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  49160. protected _setRootMesh(meshes: AbstractMesh[]): void;
  49161. protected _updateModel(): void;
  49162. }
  49163. }
  49164. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  49165. import { Vector4 } from "babylonjs/Maths/math.vector";
  49166. import { Mesh } from "babylonjs/Meshes/mesh";
  49167. import { Scene } from "babylonjs/scene";
  49168. import { Nullable } from "babylonjs/types";
  49169. /**
  49170. * Class containing static functions to help procedurally build meshes
  49171. */
  49172. export class SphereBuilder {
  49173. /**
  49174. * Creates a sphere mesh
  49175. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  49176. * * 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`)
  49177. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  49178. * * 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
  49179. * * 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)
  49180. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  49181. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  49182. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  49183. * @param name defines the name of the mesh
  49184. * @param options defines the options used to create the mesh
  49185. * @param scene defines the hosting scene
  49186. * @returns the sphere mesh
  49187. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  49188. */
  49189. static CreateSphere(name: string, options: {
  49190. segments?: number;
  49191. diameter?: number;
  49192. diameterX?: number;
  49193. diameterY?: number;
  49194. diameterZ?: number;
  49195. arc?: number;
  49196. slice?: number;
  49197. sideOrientation?: number;
  49198. frontUVs?: Vector4;
  49199. backUVs?: Vector4;
  49200. updatable?: boolean;
  49201. }, scene?: Nullable<Scene>): Mesh;
  49202. }
  49203. }
  49204. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  49205. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49206. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49207. import { Scene } from "babylonjs/scene";
  49208. /**
  49209. * A profiled motion controller has its profile loaded from an online repository.
  49210. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  49211. */
  49212. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  49213. private _repositoryUrl;
  49214. private _buttonMeshMapping;
  49215. private _touchDots;
  49216. /**
  49217. * The profile ID of this controller. Will be populated when the controller initializes.
  49218. */
  49219. profileId: string;
  49220. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  49221. dispose(): void;
  49222. protected _getFilenameAndPath(): {
  49223. filename: string;
  49224. path: string;
  49225. };
  49226. protected _getModelLoadingConstraints(): boolean;
  49227. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  49228. protected _setRootMesh(meshes: AbstractMesh[]): void;
  49229. protected _updateModel(_xrFrame: XRFrame): void;
  49230. }
  49231. }
  49232. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  49233. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49234. import { Scene } from "babylonjs/scene";
  49235. /**
  49236. * A construction function type to create a new controller based on an xrInput object
  49237. */
  49238. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  49239. /**
  49240. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  49241. *
  49242. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  49243. * it should be replaced with auto-loaded controllers.
  49244. *
  49245. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  49246. */
  49247. export class WebXRMotionControllerManager {
  49248. private static _AvailableControllers;
  49249. private static _Fallbacks;
  49250. private static _ProfileLoadingPromises;
  49251. private static _ProfilesList;
  49252. /**
  49253. * The base URL of the online controller repository. Can be changed at any time.
  49254. */
  49255. static BaseRepositoryUrl: string;
  49256. /**
  49257. * Which repository gets priority - local or online
  49258. */
  49259. static PrioritizeOnlineRepository: boolean;
  49260. /**
  49261. * Use the online repository, or use only locally-defined controllers
  49262. */
  49263. static UseOnlineRepository: boolean;
  49264. /**
  49265. * Clear the cache used for profile loading and reload when requested again
  49266. */
  49267. static ClearProfilesCache(): void;
  49268. /**
  49269. * Register the default fallbacks.
  49270. * This function is called automatically when this file is imported.
  49271. */
  49272. static DefaultFallbacks(): void;
  49273. /**
  49274. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  49275. * @param profileId the profile to which a fallback needs to be found
  49276. * @return an array with corresponding fallback profiles
  49277. */
  49278. static FindFallbackWithProfileId(profileId: string): string[];
  49279. /**
  49280. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  49281. * The order of search:
  49282. *
  49283. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  49284. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  49285. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  49286. * 4) return the generic trigger controller if none were found
  49287. *
  49288. * @param xrInput the xrInput to which a new controller is initialized
  49289. * @param scene the scene to which the model will be added
  49290. * @param forceProfile force a certain profile for this controller
  49291. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  49292. */
  49293. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  49294. /**
  49295. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  49296. *
  49297. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  49298. *
  49299. * @param type the profile type to register
  49300. * @param constructFunction the function to be called when loading this profile
  49301. */
  49302. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  49303. /**
  49304. * Register a fallback to a specific profile.
  49305. * @param profileId the profileId that will receive the fallbacks
  49306. * @param fallbacks A list of fallback profiles
  49307. */
  49308. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  49309. /**
  49310. * Will update the list of profiles available in the repository
  49311. * @return a promise that resolves to a map of profiles available online
  49312. */
  49313. static UpdateProfilesList(): Promise<{
  49314. [profile: string]: string;
  49315. }>;
  49316. private static _LoadProfileFromRepository;
  49317. private static _LoadProfilesFromAvailableControllers;
  49318. }
  49319. }
  49320. declare module "babylonjs/XR/webXRInputSource" {
  49321. import { Observable } from "babylonjs/Misc/observable";
  49322. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49323. import { Ray } from "babylonjs/Culling/ray";
  49324. import { Scene } from "babylonjs/scene";
  49325. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49326. /**
  49327. * Configuration options for the WebXR controller creation
  49328. */
  49329. export interface IWebXRControllerOptions {
  49330. /**
  49331. * Should the controller mesh be animated when a user interacts with it
  49332. * The pressed buttons / thumbstick and touchpad animations will be disabled
  49333. */
  49334. disableMotionControllerAnimation?: boolean;
  49335. /**
  49336. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  49337. */
  49338. doNotLoadControllerMesh?: boolean;
  49339. /**
  49340. * Force a specific controller type for this controller.
  49341. * This can be used when creating your own profile or when testing different controllers
  49342. */
  49343. forceControllerProfile?: string;
  49344. /**
  49345. * Defines a rendering group ID for meshes that will be loaded.
  49346. * This is for the default controllers only.
  49347. */
  49348. renderingGroupId?: number;
  49349. }
  49350. /**
  49351. * Represents an XR controller
  49352. */
  49353. export class WebXRInputSource {
  49354. private _scene;
  49355. /** The underlying input source for the controller */
  49356. inputSource: XRInputSource;
  49357. private _options;
  49358. private _tmpVector;
  49359. private _uniqueId;
  49360. /**
  49361. * 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
  49362. */
  49363. grip?: AbstractMesh;
  49364. /**
  49365. * If available, this is the gamepad object related to this controller.
  49366. * Using this object it is possible to get click events and trackpad changes of the
  49367. * webxr controller that is currently being used.
  49368. */
  49369. motionController?: WebXRAbstractMotionController;
  49370. /**
  49371. * Event that fires when the controller is removed/disposed.
  49372. * The object provided as event data is this controller, after associated assets were disposed.
  49373. * uniqueId is still available.
  49374. */
  49375. onDisposeObservable: Observable<WebXRInputSource>;
  49376. /**
  49377. * Will be triggered when the mesh associated with the motion controller is done loading.
  49378. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  49379. * A shortened version of controller -> motion controller -> on mesh loaded.
  49380. */
  49381. onMeshLoadedObservable: Observable<AbstractMesh>;
  49382. /**
  49383. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  49384. */
  49385. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  49386. /**
  49387. * Pointer which can be used to select objects or attach a visible laser to
  49388. */
  49389. pointer: AbstractMesh;
  49390. /**
  49391. * Creates the controller
  49392. * @see https://doc.babylonjs.com/how_to/webxr
  49393. * @param _scene the scene which the controller should be associated to
  49394. * @param inputSource the underlying input source for the controller
  49395. * @param _options options for this controller creation
  49396. */
  49397. constructor(_scene: Scene,
  49398. /** The underlying input source for the controller */
  49399. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  49400. /**
  49401. * Get this controllers unique id
  49402. */
  49403. get uniqueId(): string;
  49404. /**
  49405. * Disposes of the object
  49406. */
  49407. dispose(): void;
  49408. /**
  49409. * Gets a world space ray coming from the pointer or grip
  49410. * @param result the resulting ray
  49411. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  49412. */
  49413. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  49414. /**
  49415. * Updates the controller pose based on the given XRFrame
  49416. * @param xrFrame xr frame to update the pose with
  49417. * @param referenceSpace reference space to use
  49418. */
  49419. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  49420. }
  49421. }
  49422. declare module "babylonjs/XR/webXRInput" {
  49423. import { Observable } from "babylonjs/Misc/observable";
  49424. import { IDisposable } from "babylonjs/scene";
  49425. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  49426. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49427. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49428. /**
  49429. * The schema for initialization options of the XR Input class
  49430. */
  49431. export interface IWebXRInputOptions {
  49432. /**
  49433. * If set to true no model will be automatically loaded
  49434. */
  49435. doNotLoadControllerMeshes?: boolean;
  49436. /**
  49437. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  49438. * If not found, the xr input profile data will be used.
  49439. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  49440. */
  49441. forceInputProfile?: string;
  49442. /**
  49443. * Do not send a request to the controller repository to load the profile.
  49444. *
  49445. * Instead, use the controllers available in babylon itself.
  49446. */
  49447. disableOnlineControllerRepository?: boolean;
  49448. /**
  49449. * A custom URL for the controllers repository
  49450. */
  49451. customControllersRepositoryURL?: string;
  49452. /**
  49453. * Should the controller model's components not move according to the user input
  49454. */
  49455. disableControllerAnimation?: boolean;
  49456. /**
  49457. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  49458. */
  49459. controllerOptions?: IWebXRControllerOptions;
  49460. }
  49461. /**
  49462. * XR input used to track XR inputs such as controllers/rays
  49463. */
  49464. export class WebXRInput implements IDisposable {
  49465. /**
  49466. * the xr session manager for this session
  49467. */
  49468. xrSessionManager: WebXRSessionManager;
  49469. /**
  49470. * the WebXR camera for this session. Mainly used for teleportation
  49471. */
  49472. xrCamera: WebXRCamera;
  49473. private readonly options;
  49474. /**
  49475. * XR controllers being tracked
  49476. */
  49477. controllers: Array<WebXRInputSource>;
  49478. private _frameObserver;
  49479. private _sessionEndedObserver;
  49480. private _sessionInitObserver;
  49481. /**
  49482. * Event when a controller has been connected/added
  49483. */
  49484. onControllerAddedObservable: Observable<WebXRInputSource>;
  49485. /**
  49486. * Event when a controller has been removed/disconnected
  49487. */
  49488. onControllerRemovedObservable: Observable<WebXRInputSource>;
  49489. /**
  49490. * Initializes the WebXRInput
  49491. * @param xrSessionManager the xr session manager for this session
  49492. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  49493. * @param options = initialization options for this xr input
  49494. */
  49495. constructor(
  49496. /**
  49497. * the xr session manager for this session
  49498. */
  49499. xrSessionManager: WebXRSessionManager,
  49500. /**
  49501. * the WebXR camera for this session. Mainly used for teleportation
  49502. */
  49503. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  49504. private _onInputSourcesChange;
  49505. private _addAndRemoveControllers;
  49506. /**
  49507. * Disposes of the object
  49508. */
  49509. dispose(): void;
  49510. }
  49511. }
  49512. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  49513. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  49514. import { Observable, EventState } from "babylonjs/Misc/observable";
  49515. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49516. /**
  49517. * This is the base class for all WebXR features.
  49518. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  49519. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  49520. */
  49521. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  49522. protected _xrSessionManager: WebXRSessionManager;
  49523. private _attached;
  49524. private _removeOnDetach;
  49525. /**
  49526. * Should auto-attach be disabled?
  49527. */
  49528. disableAutoAttach: boolean;
  49529. /**
  49530. * Construct a new (abstract) WebXR feature
  49531. * @param _xrSessionManager the xr session manager for this feature
  49532. */
  49533. constructor(_xrSessionManager: WebXRSessionManager);
  49534. /**
  49535. * Is this feature attached
  49536. */
  49537. get attached(): boolean;
  49538. /**
  49539. * attach this feature
  49540. *
  49541. * @param force should attachment be forced (even when already attached)
  49542. * @returns true if successful, false is failed or already attached
  49543. */
  49544. attach(force?: boolean): boolean;
  49545. /**
  49546. * detach this feature.
  49547. *
  49548. * @returns true if successful, false if failed or already detached
  49549. */
  49550. detach(): boolean;
  49551. /**
  49552. * Dispose this feature and all of the resources attached
  49553. */
  49554. dispose(): void;
  49555. /**
  49556. * This is used to register callbacks that will automatically be removed when detach is called.
  49557. * @param observable the observable to which the observer will be attached
  49558. * @param callback the callback to register
  49559. */
  49560. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  49561. /**
  49562. * Code in this function will be executed on each xrFrame received from the browser.
  49563. * This function will not execute after the feature is detached.
  49564. * @param _xrFrame the current frame
  49565. */
  49566. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  49567. }
  49568. }
  49569. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  49570. import { IDisposable, Scene } from "babylonjs/scene";
  49571. import { Nullable } from "babylonjs/types";
  49572. import { Observable } from "babylonjs/Misc/observable";
  49573. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49574. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  49575. import { Camera } from "babylonjs/Cameras/camera";
  49576. /**
  49577. * Renders a layer on top of an existing scene
  49578. */
  49579. export class UtilityLayerRenderer implements IDisposable {
  49580. /** the original scene that will be rendered on top of */
  49581. originalScene: Scene;
  49582. private _pointerCaptures;
  49583. private _lastPointerEvents;
  49584. private static _DefaultUtilityLayer;
  49585. private static _DefaultKeepDepthUtilityLayer;
  49586. private _sharedGizmoLight;
  49587. private _renderCamera;
  49588. /**
  49589. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  49590. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  49591. * @returns the camera that is used when rendering the utility layer
  49592. */
  49593. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  49594. /**
  49595. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  49596. * @param cam the camera that should be used when rendering the utility layer
  49597. */
  49598. setRenderCamera(cam: Nullable<Camera>): void;
  49599. /**
  49600. * @hidden
  49601. * Light which used by gizmos to get light shading
  49602. */
  49603. _getSharedGizmoLight(): HemisphericLight;
  49604. /**
  49605. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  49606. */
  49607. pickUtilitySceneFirst: boolean;
  49608. /**
  49609. * 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)
  49610. */
  49611. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  49612. /**
  49613. * 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)
  49614. */
  49615. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  49616. /**
  49617. * The scene that is rendered on top of the original scene
  49618. */
  49619. utilityLayerScene: Scene;
  49620. /**
  49621. * If the utility layer should automatically be rendered on top of existing scene
  49622. */
  49623. shouldRender: boolean;
  49624. /**
  49625. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  49626. */
  49627. onlyCheckPointerDownEvents: boolean;
  49628. /**
  49629. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  49630. */
  49631. processAllEvents: boolean;
  49632. /**
  49633. * Observable raised when the pointer move from the utility layer scene to the main scene
  49634. */
  49635. onPointerOutObservable: Observable<number>;
  49636. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  49637. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  49638. private _afterRenderObserver;
  49639. private _sceneDisposeObserver;
  49640. private _originalPointerObserver;
  49641. /**
  49642. * Instantiates a UtilityLayerRenderer
  49643. * @param originalScene the original scene that will be rendered on top of
  49644. * @param handleEvents boolean indicating if the utility layer should handle events
  49645. */
  49646. constructor(
  49647. /** the original scene that will be rendered on top of */
  49648. originalScene: Scene, handleEvents?: boolean);
  49649. private _notifyObservers;
  49650. /**
  49651. * Renders the utility layers scene on top of the original scene
  49652. */
  49653. render(): void;
  49654. /**
  49655. * Disposes of the renderer
  49656. */
  49657. dispose(): void;
  49658. private _updateCamera;
  49659. }
  49660. }
  49661. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  49662. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49663. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49664. import { WebXRInput } from "babylonjs/XR/webXRInput";
  49665. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  49666. import { Scene } from "babylonjs/scene";
  49667. import { Nullable } from "babylonjs/types";
  49668. import { Color3 } from "babylonjs/Maths/math.color";
  49669. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  49670. /**
  49671. * Options interface for the pointer selection module
  49672. */
  49673. export interface IWebXRControllerPointerSelectionOptions {
  49674. /**
  49675. * if provided, this scene will be used to render meshes.
  49676. */
  49677. customUtilityLayerScene?: Scene;
  49678. /**
  49679. * Disable the pointer up event when the xr controller in screen and gaze mode is disposed (meaning - when the user removed the finger from the screen)
  49680. * If not disabled, the last picked point will be used to execute a pointer up event
  49681. * If disabled, pointer up event will be triggered right after the pointer down event.
  49682. * Used in screen and gaze target ray mode only
  49683. */
  49684. disablePointerUpOnTouchOut: boolean;
  49685. /**
  49686. * For gaze mode (time to select instead of press)
  49687. */
  49688. forceGazeMode: boolean;
  49689. /**
  49690. * Factor to be applied to the pointer-moved function in the gaze mode. How sensitive should the gaze mode be when checking if the pointer moved
  49691. * to start a new countdown to the pointer down event.
  49692. * Defaults to 1.
  49693. */
  49694. gazeModePointerMovedFactor?: number;
  49695. /**
  49696. * Different button type to use instead of the main component
  49697. */
  49698. overrideButtonId?: string;
  49699. /**
  49700. * use this rendering group id for the meshes (optional)
  49701. */
  49702. renderingGroupId?: number;
  49703. /**
  49704. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  49705. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  49706. * 3000 means 3 seconds between pointing at something and selecting it
  49707. */
  49708. timeToSelect?: number;
  49709. /**
  49710. * Should meshes created here be added to a utility layer or the main scene
  49711. */
  49712. useUtilityLayer?: boolean;
  49713. /**
  49714. * the xr input to use with this pointer selection
  49715. */
  49716. xrInput: WebXRInput;
  49717. }
  49718. /**
  49719. * A module that will enable pointer selection for motion controllers of XR Input Sources
  49720. */
  49721. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  49722. private readonly _options;
  49723. private static _idCounter;
  49724. private _attachController;
  49725. private _controllers;
  49726. private _scene;
  49727. private _tmpVectorForPickCompare;
  49728. /**
  49729. * The module's name
  49730. */
  49731. static readonly Name: string;
  49732. /**
  49733. * The (Babylon) version of this module.
  49734. * This is an integer representing the implementation version.
  49735. * This number does not correspond to the WebXR specs version
  49736. */
  49737. static readonly Version: number;
  49738. /**
  49739. * Disable lighting on the laser pointer (so it will always be visible)
  49740. */
  49741. disablePointerLighting: boolean;
  49742. /**
  49743. * Disable lighting on the selection mesh (so it will always be visible)
  49744. */
  49745. disableSelectionMeshLighting: boolean;
  49746. /**
  49747. * Should the laser pointer be displayed
  49748. */
  49749. displayLaserPointer: boolean;
  49750. /**
  49751. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  49752. */
  49753. displaySelectionMesh: boolean;
  49754. /**
  49755. * This color will be set to the laser pointer when selection is triggered
  49756. */
  49757. laserPointerPickedColor: Color3;
  49758. /**
  49759. * Default color of the laser pointer
  49760. */
  49761. laserPointerDefaultColor: Color3;
  49762. /**
  49763. * default color of the selection ring
  49764. */
  49765. selectionMeshDefaultColor: Color3;
  49766. /**
  49767. * This color will be applied to the selection ring when selection is triggered
  49768. */
  49769. selectionMeshPickedColor: Color3;
  49770. /**
  49771. * Optional filter to be used for ray selection. This predicate shares behavior with
  49772. * scene.pointerMovePredicate which takes priority if it is also assigned.
  49773. */
  49774. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  49775. /**
  49776. * constructs a new background remover module
  49777. * @param _xrSessionManager the session manager for this module
  49778. * @param _options read-only options to be used in this module
  49779. */
  49780. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  49781. /**
  49782. * attach this feature
  49783. * Will usually be called by the features manager
  49784. *
  49785. * @returns true if successful.
  49786. */
  49787. attach(): boolean;
  49788. /**
  49789. * detach this feature.
  49790. * Will usually be called by the features manager
  49791. *
  49792. * @returns true if successful.
  49793. */
  49794. detach(): boolean;
  49795. /**
  49796. * Will get the mesh under a specific pointer.
  49797. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  49798. * @param controllerId the controllerId to check
  49799. * @returns The mesh under pointer or null if no mesh is under the pointer
  49800. */
  49801. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  49802. /**
  49803. * Get the xr controller that correlates to the pointer id in the pointer event
  49804. *
  49805. * @param id the pointer id to search for
  49806. * @returns the controller that correlates to this id or null if not found
  49807. */
  49808. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  49809. protected _onXRFrame(_xrFrame: XRFrame): void;
  49810. private _attachGazeMode;
  49811. private _attachScreenRayMode;
  49812. private _attachTrackedPointerRayMode;
  49813. private _convertNormalToDirectionOfRay;
  49814. private _detachController;
  49815. private _generateNewMeshPair;
  49816. private _pickingMoved;
  49817. private _updatePointerDistance;
  49818. /** @hidden */
  49819. get lasterPointerDefaultColor(): Color3;
  49820. }
  49821. }
  49822. declare module "babylonjs/XR/webXREnterExitUI" {
  49823. import { Nullable } from "babylonjs/types";
  49824. import { Observable } from "babylonjs/Misc/observable";
  49825. import { IDisposable, Scene } from "babylonjs/scene";
  49826. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  49827. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49828. /**
  49829. * Button which can be used to enter a different mode of XR
  49830. */
  49831. export class WebXREnterExitUIButton {
  49832. /** button element */
  49833. element: HTMLElement;
  49834. /** XR initialization options for the button */
  49835. sessionMode: XRSessionMode;
  49836. /** Reference space type */
  49837. referenceSpaceType: XRReferenceSpaceType;
  49838. /**
  49839. * Creates a WebXREnterExitUIButton
  49840. * @param element button element
  49841. * @param sessionMode XR initialization session mode
  49842. * @param referenceSpaceType the type of reference space to be used
  49843. */
  49844. constructor(
  49845. /** button element */
  49846. element: HTMLElement,
  49847. /** XR initialization options for the button */
  49848. sessionMode: XRSessionMode,
  49849. /** Reference space type */
  49850. referenceSpaceType: XRReferenceSpaceType);
  49851. /**
  49852. * Extendable function which can be used to update the button's visuals when the state changes
  49853. * @param activeButton the current active button in the UI
  49854. */
  49855. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  49856. }
  49857. /**
  49858. * Options to create the webXR UI
  49859. */
  49860. export class WebXREnterExitUIOptions {
  49861. /**
  49862. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  49863. */
  49864. customButtons?: Array<WebXREnterExitUIButton>;
  49865. /**
  49866. * A reference space type to use when creating the default button.
  49867. * Default is local-floor
  49868. */
  49869. referenceSpaceType?: XRReferenceSpaceType;
  49870. /**
  49871. * Context to enter xr with
  49872. */
  49873. renderTarget?: Nullable<WebXRRenderTarget>;
  49874. /**
  49875. * A session mode to use when creating the default button.
  49876. * Default is immersive-vr
  49877. */
  49878. sessionMode?: XRSessionMode;
  49879. /**
  49880. * A list of optional features to init the session with
  49881. */
  49882. optionalFeatures?: string[];
  49883. }
  49884. /**
  49885. * UI to allow the user to enter/exit XR mode
  49886. */
  49887. export class WebXREnterExitUI implements IDisposable {
  49888. private scene;
  49889. /** version of the options passed to this UI */
  49890. options: WebXREnterExitUIOptions;
  49891. private _activeButton;
  49892. private _buttons;
  49893. private _overlay;
  49894. /**
  49895. * Fired every time the active button is changed.
  49896. *
  49897. * When xr is entered via a button that launches xr that button will be the callback parameter
  49898. *
  49899. * When exiting xr the callback parameter will be null)
  49900. */
  49901. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  49902. /**
  49903. *
  49904. * @param scene babylon scene object to use
  49905. * @param options (read-only) version of the options passed to this UI
  49906. */
  49907. private constructor();
  49908. /**
  49909. * Creates UI to allow the user to enter/exit XR mode
  49910. * @param scene the scene to add the ui to
  49911. * @param helper the xr experience helper to enter/exit xr with
  49912. * @param options options to configure the UI
  49913. * @returns the created ui
  49914. */
  49915. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  49916. /**
  49917. * Disposes of the XR UI component
  49918. */
  49919. dispose(): void;
  49920. private _updateButtons;
  49921. }
  49922. }
  49923. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  49924. import { Vector3 } from "babylonjs/Maths/math.vector";
  49925. import { Color4 } from "babylonjs/Maths/math.color";
  49926. import { Nullable } from "babylonjs/types";
  49927. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  49928. import { Scene } from "babylonjs/scene";
  49929. /**
  49930. * Class containing static functions to help procedurally build meshes
  49931. */
  49932. export class LinesBuilder {
  49933. /**
  49934. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  49935. * * 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
  49936. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  49937. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  49938. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  49939. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  49940. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  49941. * * 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
  49942. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  49943. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  49944. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  49945. * @param name defines the name of the new line system
  49946. * @param options defines the options used to create the line system
  49947. * @param scene defines the hosting scene
  49948. * @returns a new line system mesh
  49949. */
  49950. static CreateLineSystem(name: string, options: {
  49951. lines: Vector3[][];
  49952. updatable?: boolean;
  49953. instance?: Nullable<LinesMesh>;
  49954. colors?: Nullable<Color4[][]>;
  49955. useVertexAlpha?: boolean;
  49956. }, scene: Nullable<Scene>): LinesMesh;
  49957. /**
  49958. * Creates a line mesh
  49959. * 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
  49960. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  49961. * * The parameter `points` is an array successive Vector3
  49962. * * 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
  49963. * * The optional parameter `colors` is an array of successive Color4, one per line point
  49964. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  49965. * * When updating an instance, remember that only point positions can change, not the number of points
  49966. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  49967. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  49968. * @param name defines the name of the new line system
  49969. * @param options defines the options used to create the line system
  49970. * @param scene defines the hosting scene
  49971. * @returns a new line mesh
  49972. */
  49973. static CreateLines(name: string, options: {
  49974. points: Vector3[];
  49975. updatable?: boolean;
  49976. instance?: Nullable<LinesMesh>;
  49977. colors?: Color4[];
  49978. useVertexAlpha?: boolean;
  49979. }, scene?: Nullable<Scene>): LinesMesh;
  49980. /**
  49981. * Creates a dashed line mesh
  49982. * * 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
  49983. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  49984. * * The parameter `points` is an array successive Vector3
  49985. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  49986. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  49987. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  49988. * * 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
  49989. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  49990. * * When updating an instance, remember that only point positions can change, not the number of points
  49991. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  49992. * @param name defines the name of the mesh
  49993. * @param options defines the options used to create the mesh
  49994. * @param scene defines the hosting scene
  49995. * @returns the dashed line mesh
  49996. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  49997. */
  49998. static CreateDashedLines(name: string, options: {
  49999. points: Vector3[];
  50000. dashSize?: number;
  50001. gapSize?: number;
  50002. dashNb?: number;
  50003. updatable?: boolean;
  50004. instance?: LinesMesh;
  50005. useVertexAlpha?: boolean;
  50006. }, scene?: Nullable<Scene>): LinesMesh;
  50007. }
  50008. }
  50009. declare module "babylonjs/Misc/timer" {
  50010. import { Observable, Observer } from "babylonjs/Misc/observable";
  50011. import { Nullable } from "babylonjs/types";
  50012. import { IDisposable } from "babylonjs/scene";
  50013. /**
  50014. * Construction options for a timer
  50015. */
  50016. export interface ITimerOptions<T> {
  50017. /**
  50018. * Time-to-end
  50019. */
  50020. timeout: number;
  50021. /**
  50022. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  50023. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  50024. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  50025. */
  50026. contextObservable: Observable<T>;
  50027. /**
  50028. * Optional parameters when adding an observer to the observable
  50029. */
  50030. observableParameters?: {
  50031. mask?: number;
  50032. insertFirst?: boolean;
  50033. scope?: any;
  50034. };
  50035. /**
  50036. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  50037. */
  50038. breakCondition?: (data?: ITimerData<T>) => boolean;
  50039. /**
  50040. * Will be triggered when the time condition has met
  50041. */
  50042. onEnded?: (data: ITimerData<any>) => void;
  50043. /**
  50044. * Will be triggered when the break condition has met (prematurely ended)
  50045. */
  50046. onAborted?: (data: ITimerData<any>) => void;
  50047. /**
  50048. * Optional function to execute on each tick (or count)
  50049. */
  50050. onTick?: (data: ITimerData<any>) => void;
  50051. }
  50052. /**
  50053. * An interface defining the data sent by the timer
  50054. */
  50055. export interface ITimerData<T> {
  50056. /**
  50057. * When did it start
  50058. */
  50059. startTime: number;
  50060. /**
  50061. * Time now
  50062. */
  50063. currentTime: number;
  50064. /**
  50065. * Time passed since started
  50066. */
  50067. deltaTime: number;
  50068. /**
  50069. * How much is completed, in [0.0...1.0].
  50070. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  50071. */
  50072. completeRate: number;
  50073. /**
  50074. * What the registered observable sent in the last count
  50075. */
  50076. payload: T;
  50077. }
  50078. /**
  50079. * The current state of the timer
  50080. */
  50081. export enum TimerState {
  50082. /**
  50083. * Timer initialized, not yet started
  50084. */
  50085. INIT = 0,
  50086. /**
  50087. * Timer started and counting
  50088. */
  50089. STARTED = 1,
  50090. /**
  50091. * Timer ended (whether aborted or time reached)
  50092. */
  50093. ENDED = 2
  50094. }
  50095. /**
  50096. * A simple version of the timer. Will take options and start the timer immediately after calling it
  50097. *
  50098. * @param options options with which to initialize this timer
  50099. */
  50100. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  50101. /**
  50102. * An advanced implementation of a timer class
  50103. */
  50104. export class AdvancedTimer<T = any> implements IDisposable {
  50105. /**
  50106. * Will notify each time the timer calculates the remaining time
  50107. */
  50108. onEachCountObservable: Observable<ITimerData<T>>;
  50109. /**
  50110. * Will trigger when the timer was aborted due to the break condition
  50111. */
  50112. onTimerAbortedObservable: Observable<ITimerData<T>>;
  50113. /**
  50114. * Will trigger when the timer ended successfully
  50115. */
  50116. onTimerEndedObservable: Observable<ITimerData<T>>;
  50117. /**
  50118. * Will trigger when the timer state has changed
  50119. */
  50120. onStateChangedObservable: Observable<TimerState>;
  50121. private _observer;
  50122. private _contextObservable;
  50123. private _observableParameters;
  50124. private _startTime;
  50125. private _timer;
  50126. private _state;
  50127. private _breakCondition;
  50128. private _timeToEnd;
  50129. private _breakOnNextTick;
  50130. /**
  50131. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  50132. * @param options construction options for this advanced timer
  50133. */
  50134. constructor(options: ITimerOptions<T>);
  50135. /**
  50136. * set a breaking condition for this timer. Default is to never break during count
  50137. * @param predicate the new break condition. Returns true to break, false otherwise
  50138. */
  50139. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  50140. /**
  50141. * Reset ALL associated observables in this advanced timer
  50142. */
  50143. clearObservables(): void;
  50144. /**
  50145. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  50146. *
  50147. * @param timeToEnd how much time to measure until timer ended
  50148. */
  50149. start(timeToEnd?: number): void;
  50150. /**
  50151. * Will force a stop on the next tick.
  50152. */
  50153. stop(): void;
  50154. /**
  50155. * Dispose this timer, clearing all resources
  50156. */
  50157. dispose(): void;
  50158. private _setState;
  50159. private _tick;
  50160. private _stop;
  50161. }
  50162. }
  50163. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  50164. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50165. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50166. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50167. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50168. import { Vector3 } from "babylonjs/Maths/math.vector";
  50169. import { Material } from "babylonjs/Materials/material";
  50170. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50171. import { Scene } from "babylonjs/scene";
  50172. /**
  50173. * The options container for the teleportation module
  50174. */
  50175. export interface IWebXRTeleportationOptions {
  50176. /**
  50177. * if provided, this scene will be used to render meshes.
  50178. */
  50179. customUtilityLayerScene?: Scene;
  50180. /**
  50181. * Values to configure the default target mesh
  50182. */
  50183. defaultTargetMeshOptions?: {
  50184. /**
  50185. * Fill color of the teleportation area
  50186. */
  50187. teleportationFillColor?: string;
  50188. /**
  50189. * Border color for the teleportation area
  50190. */
  50191. teleportationBorderColor?: string;
  50192. /**
  50193. * Disable the mesh's animation sequence
  50194. */
  50195. disableAnimation?: boolean;
  50196. /**
  50197. * Disable lighting on the material or the ring and arrow
  50198. */
  50199. disableLighting?: boolean;
  50200. /**
  50201. * Override the default material of the torus and arrow
  50202. */
  50203. torusArrowMaterial?: Material;
  50204. };
  50205. /**
  50206. * A list of meshes to use as floor meshes.
  50207. * Meshes can be added and removed after initializing the feature using the
  50208. * addFloorMesh and removeFloorMesh functions
  50209. * If empty, rotation will still work
  50210. */
  50211. floorMeshes?: AbstractMesh[];
  50212. /**
  50213. * use this rendering group id for the meshes (optional)
  50214. */
  50215. renderingGroupId?: number;
  50216. /**
  50217. * Should teleportation move only to snap points
  50218. */
  50219. snapPointsOnly?: boolean;
  50220. /**
  50221. * An array of points to which the teleportation will snap to.
  50222. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  50223. */
  50224. snapPositions?: Vector3[];
  50225. /**
  50226. * How close should the teleportation ray be in order to snap to position.
  50227. * Default to 0.8 units (meters)
  50228. */
  50229. snapToPositionRadius?: number;
  50230. /**
  50231. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  50232. * If you want to support rotation, make sure your mesh has a direction indicator.
  50233. *
  50234. * When left untouched, the default mesh will be initialized.
  50235. */
  50236. teleportationTargetMesh?: AbstractMesh;
  50237. /**
  50238. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  50239. */
  50240. timeToTeleport?: number;
  50241. /**
  50242. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  50243. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  50244. */
  50245. useMainComponentOnly?: boolean;
  50246. /**
  50247. * Should meshes created here be added to a utility layer or the main scene
  50248. */
  50249. useUtilityLayer?: boolean;
  50250. /**
  50251. * Babylon XR Input class for controller
  50252. */
  50253. xrInput: WebXRInput;
  50254. }
  50255. /**
  50256. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  50257. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  50258. * the input of the attached controllers.
  50259. */
  50260. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  50261. private _options;
  50262. private _controllers;
  50263. private _currentTeleportationControllerId;
  50264. private _floorMeshes;
  50265. private _quadraticBezierCurve;
  50266. private _selectionFeature;
  50267. private _snapToPositions;
  50268. private _snappedToPoint;
  50269. private _teleportationRingMaterial?;
  50270. private _tmpRay;
  50271. private _tmpVector;
  50272. /**
  50273. * The module's name
  50274. */
  50275. static readonly Name: string;
  50276. /**
  50277. * The (Babylon) version of this module.
  50278. * This is an integer representing the implementation version.
  50279. * This number does not correspond to the webxr specs version
  50280. */
  50281. static readonly Version: number;
  50282. /**
  50283. * Is movement backwards enabled
  50284. */
  50285. backwardsMovementEnabled: boolean;
  50286. /**
  50287. * Distance to travel when moving backwards
  50288. */
  50289. backwardsTeleportationDistance: number;
  50290. /**
  50291. * The distance from the user to the inspection point in the direction of the controller
  50292. * A higher number will allow the user to move further
  50293. * defaults to 5 (meters, in xr units)
  50294. */
  50295. parabolicCheckRadius: number;
  50296. /**
  50297. * Should the module support parabolic ray on top of direct ray
  50298. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  50299. * Very helpful when moving between floors / different heights
  50300. */
  50301. parabolicRayEnabled: boolean;
  50302. /**
  50303. * How much rotation should be applied when rotating right and left
  50304. */
  50305. rotationAngle: number;
  50306. /**
  50307. * Is rotation enabled when moving forward?
  50308. * Disabling this feature will prevent the user from deciding the direction when teleporting
  50309. */
  50310. rotationEnabled: boolean;
  50311. /**
  50312. * constructs a new anchor system
  50313. * @param _xrSessionManager an instance of WebXRSessionManager
  50314. * @param _options configuration object for this feature
  50315. */
  50316. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  50317. /**
  50318. * Get the snapPointsOnly flag
  50319. */
  50320. get snapPointsOnly(): boolean;
  50321. /**
  50322. * Sets the snapPointsOnly flag
  50323. * @param snapToPoints should teleportation be exclusively to snap points
  50324. */
  50325. set snapPointsOnly(snapToPoints: boolean);
  50326. /**
  50327. * Add a new mesh to the floor meshes array
  50328. * @param mesh the mesh to use as floor mesh
  50329. */
  50330. addFloorMesh(mesh: AbstractMesh): void;
  50331. /**
  50332. * Add a new snap-to point to fix teleportation to this position
  50333. * @param newSnapPoint The new Snap-To point
  50334. */
  50335. addSnapPoint(newSnapPoint: Vector3): void;
  50336. attach(): boolean;
  50337. detach(): boolean;
  50338. dispose(): void;
  50339. /**
  50340. * Remove a mesh from the floor meshes array
  50341. * @param mesh the mesh to remove
  50342. */
  50343. removeFloorMesh(mesh: AbstractMesh): void;
  50344. /**
  50345. * Remove a mesh from the floor meshes array using its name
  50346. * @param name the mesh name to remove
  50347. */
  50348. removeFloorMeshByName(name: string): void;
  50349. /**
  50350. * This function will iterate through the array, searching for this point or equal to it. It will then remove it from the snap-to array
  50351. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  50352. * @returns was the point found and removed or not
  50353. */
  50354. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  50355. /**
  50356. * This function sets a selection feature that will be disabled when
  50357. * the forward ray is shown and will be reattached when hidden.
  50358. * This is used to remove the selection rays when moving.
  50359. * @param selectionFeature the feature to disable when forward movement is enabled
  50360. */
  50361. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  50362. protected _onXRFrame(_xrFrame: XRFrame): void;
  50363. private _attachController;
  50364. private _createDefaultTargetMesh;
  50365. private _detachController;
  50366. private _findClosestSnapPointWithRadius;
  50367. private _setTargetMeshPosition;
  50368. private _setTargetMeshVisibility;
  50369. private _showParabolicPath;
  50370. private _teleportForward;
  50371. }
  50372. }
  50373. declare module "babylonjs/XR/webXRDefaultExperience" {
  50374. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50375. import { Scene } from "babylonjs/scene";
  50376. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  50377. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  50378. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50379. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  50380. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50381. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  50382. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  50383. /**
  50384. * Options for the default xr helper
  50385. */
  50386. export class WebXRDefaultExperienceOptions {
  50387. /**
  50388. * Enable or disable default UI to enter XR
  50389. */
  50390. disableDefaultUI?: boolean;
  50391. /**
  50392. * Should teleportation not initialize. defaults to false.
  50393. */
  50394. disableTeleportation?: boolean;
  50395. /**
  50396. * Floor meshes that will be used for teleport
  50397. */
  50398. floorMeshes?: Array<AbstractMesh>;
  50399. /**
  50400. * If set to true, the first frame will not be used to reset position
  50401. * The first frame is mainly used when copying transformation from the old camera
  50402. * Mainly used in AR
  50403. */
  50404. ignoreNativeCameraTransformation?: boolean;
  50405. /**
  50406. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  50407. */
  50408. inputOptions?: IWebXRInputOptions;
  50409. /**
  50410. * optional configuration for the output canvas
  50411. */
  50412. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  50413. /**
  50414. * optional UI options. This can be used among other to change session mode and reference space type
  50415. */
  50416. uiOptions?: WebXREnterExitUIOptions;
  50417. /**
  50418. * When loading teleportation and pointer select, use stable versions instead of latest.
  50419. */
  50420. useStablePlugins?: boolean;
  50421. /**
  50422. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  50423. */
  50424. renderingGroupId?: number;
  50425. /**
  50426. * A list of optional features to init the session with
  50427. * If set to true, all features we support will be added
  50428. */
  50429. optionalFeatures?: boolean | string[];
  50430. }
  50431. /**
  50432. * Default experience which provides a similar setup to the previous webVRExperience
  50433. */
  50434. export class WebXRDefaultExperience {
  50435. /**
  50436. * Base experience
  50437. */
  50438. baseExperience: WebXRExperienceHelper;
  50439. /**
  50440. * Enables ui for entering/exiting xr
  50441. */
  50442. enterExitUI: WebXREnterExitUI;
  50443. /**
  50444. * Input experience extension
  50445. */
  50446. input: WebXRInput;
  50447. /**
  50448. * Enables laser pointer and selection
  50449. */
  50450. pointerSelection: WebXRControllerPointerSelection;
  50451. /**
  50452. * Default target xr should render to
  50453. */
  50454. renderTarget: WebXRRenderTarget;
  50455. /**
  50456. * Enables teleportation
  50457. */
  50458. teleportation: WebXRMotionControllerTeleportation;
  50459. private constructor();
  50460. /**
  50461. * Creates the default xr experience
  50462. * @param scene scene
  50463. * @param options options for basic configuration
  50464. * @returns resulting WebXRDefaultExperience
  50465. */
  50466. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  50467. /**
  50468. * DIsposes of the experience helper
  50469. */
  50470. dispose(): void;
  50471. }
  50472. }
  50473. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  50474. import { Observable } from "babylonjs/Misc/observable";
  50475. import { Nullable } from "babylonjs/types";
  50476. import { Camera } from "babylonjs/Cameras/camera";
  50477. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  50478. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  50479. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  50480. import { Scene } from "babylonjs/scene";
  50481. import { Vector3 } from "babylonjs/Maths/math.vector";
  50482. import { Color3 } from "babylonjs/Maths/math.color";
  50483. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  50484. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50485. import { Mesh } from "babylonjs/Meshes/mesh";
  50486. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  50487. import { EasingFunction } from "babylonjs/Animations/easing";
  50488. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  50489. import "babylonjs/Meshes/Builders/groundBuilder";
  50490. import "babylonjs/Meshes/Builders/torusBuilder";
  50491. import "babylonjs/Meshes/Builders/cylinderBuilder";
  50492. import "babylonjs/Gamepads/gamepadSceneComponent";
  50493. import "babylonjs/Animations/animatable";
  50494. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  50495. /**
  50496. * Options to modify the vr teleportation behavior.
  50497. */
  50498. export interface VRTeleportationOptions {
  50499. /**
  50500. * The name of the mesh which should be used as the teleportation floor. (default: null)
  50501. */
  50502. floorMeshName?: string;
  50503. /**
  50504. * A list of meshes to be used as the teleportation floor. (default: empty)
  50505. */
  50506. floorMeshes?: Mesh[];
  50507. /**
  50508. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  50509. */
  50510. teleportationMode?: number;
  50511. /**
  50512. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  50513. */
  50514. teleportationTime?: number;
  50515. /**
  50516. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  50517. */
  50518. teleportationSpeed?: number;
  50519. /**
  50520. * The easing function used in the animation or null for Linear. (default CircleEase)
  50521. */
  50522. easingFunction?: EasingFunction;
  50523. }
  50524. /**
  50525. * Options to modify the vr experience helper's behavior.
  50526. */
  50527. export interface VRExperienceHelperOptions extends WebVROptions {
  50528. /**
  50529. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  50530. */
  50531. createDeviceOrientationCamera?: boolean;
  50532. /**
  50533. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  50534. */
  50535. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  50536. /**
  50537. * Uses the main button on the controller to toggle the laser casted. (default: true)
  50538. */
  50539. laserToggle?: boolean;
  50540. /**
  50541. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  50542. */
  50543. floorMeshes?: Mesh[];
  50544. /**
  50545. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  50546. */
  50547. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  50548. /**
  50549. * Defines if WebXR should be used instead of WebVR (if available)
  50550. */
  50551. useXR?: boolean;
  50552. }
  50553. /**
  50554. * Event containing information after VR has been entered
  50555. */
  50556. export class OnAfterEnteringVRObservableEvent {
  50557. /**
  50558. * If entering vr was successful
  50559. */
  50560. success: boolean;
  50561. }
  50562. /**
  50563. * Helps to quickly add VR support to an existing scene.
  50564. * See http://doc.babylonjs.com/how_to/webvr_helper
  50565. */
  50566. export class VRExperienceHelper {
  50567. /** Options to modify the vr experience helper's behavior. */
  50568. webVROptions: VRExperienceHelperOptions;
  50569. private _scene;
  50570. private _position;
  50571. private _btnVR;
  50572. private _btnVRDisplayed;
  50573. private _webVRsupported;
  50574. private _webVRready;
  50575. private _webVRrequesting;
  50576. private _webVRpresenting;
  50577. private _hasEnteredVR;
  50578. private _fullscreenVRpresenting;
  50579. private _inputElement;
  50580. private _webVRCamera;
  50581. private _vrDeviceOrientationCamera;
  50582. private _deviceOrientationCamera;
  50583. private _existingCamera;
  50584. private _onKeyDown;
  50585. private _onVrDisplayPresentChange;
  50586. private _onVRDisplayChanged;
  50587. private _onVRRequestPresentStart;
  50588. private _onVRRequestPresentComplete;
  50589. /**
  50590. * 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)
  50591. */
  50592. enableGazeEvenWhenNoPointerLock: boolean;
  50593. /**
  50594. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  50595. */
  50596. exitVROnDoubleTap: boolean;
  50597. /**
  50598. * Observable raised right before entering VR.
  50599. */
  50600. onEnteringVRObservable: Observable<VRExperienceHelper>;
  50601. /**
  50602. * Observable raised when entering VR has completed.
  50603. */
  50604. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  50605. /**
  50606. * Observable raised when exiting VR.
  50607. */
  50608. onExitingVRObservable: Observable<VRExperienceHelper>;
  50609. /**
  50610. * Observable raised when controller mesh is loaded.
  50611. */
  50612. onControllerMeshLoadedObservable: Observable<WebVRController>;
  50613. /** Return this.onEnteringVRObservable
  50614. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  50615. */
  50616. get onEnteringVR(): Observable<VRExperienceHelper>;
  50617. /** Return this.onExitingVRObservable
  50618. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  50619. */
  50620. get onExitingVR(): Observable<VRExperienceHelper>;
  50621. /** Return this.onControllerMeshLoadedObservable
  50622. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  50623. */
  50624. get onControllerMeshLoaded(): Observable<WebVRController>;
  50625. private _rayLength;
  50626. private _useCustomVRButton;
  50627. private _teleportationRequested;
  50628. private _teleportActive;
  50629. private _floorMeshName;
  50630. private _floorMeshesCollection;
  50631. private _teleportationMode;
  50632. private _teleportationTime;
  50633. private _teleportationSpeed;
  50634. private _teleportationEasing;
  50635. private _rotationAllowed;
  50636. private _teleportBackwardsVector;
  50637. private _teleportationTarget;
  50638. private _isDefaultTeleportationTarget;
  50639. private _postProcessMove;
  50640. private _teleportationFillColor;
  50641. private _teleportationBorderColor;
  50642. private _rotationAngle;
  50643. private _haloCenter;
  50644. private _cameraGazer;
  50645. private _padSensibilityUp;
  50646. private _padSensibilityDown;
  50647. private _leftController;
  50648. private _rightController;
  50649. private _gazeColor;
  50650. private _laserColor;
  50651. private _pickedLaserColor;
  50652. private _pickedGazeColor;
  50653. /**
  50654. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  50655. */
  50656. onNewMeshSelected: Observable<AbstractMesh>;
  50657. /**
  50658. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  50659. * This observable will provide the mesh and the controller used to select the mesh
  50660. */
  50661. onMeshSelectedWithController: Observable<{
  50662. mesh: AbstractMesh;
  50663. controller: WebVRController;
  50664. }>;
  50665. /**
  50666. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  50667. */
  50668. onNewMeshPicked: Observable<PickingInfo>;
  50669. private _circleEase;
  50670. /**
  50671. * Observable raised before camera teleportation
  50672. */
  50673. onBeforeCameraTeleport: Observable<Vector3>;
  50674. /**
  50675. * Observable raised after camera teleportation
  50676. */
  50677. onAfterCameraTeleport: Observable<Vector3>;
  50678. /**
  50679. * Observable raised when current selected mesh gets unselected
  50680. */
  50681. onSelectedMeshUnselected: Observable<AbstractMesh>;
  50682. private _raySelectionPredicate;
  50683. /**
  50684. * To be optionaly changed by user to define custom ray selection
  50685. */
  50686. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50687. /**
  50688. * To be optionaly changed by user to define custom selection logic (after ray selection)
  50689. */
  50690. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  50691. /**
  50692. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  50693. */
  50694. teleportationEnabled: boolean;
  50695. private _defaultHeight;
  50696. private _teleportationInitialized;
  50697. private _interactionsEnabled;
  50698. private _interactionsRequested;
  50699. private _displayGaze;
  50700. private _displayLaserPointer;
  50701. /**
  50702. * The mesh used to display where the user is going to teleport.
  50703. */
  50704. get teleportationTarget(): Mesh;
  50705. /**
  50706. * Sets the mesh to be used to display where the user is going to teleport.
  50707. */
  50708. set teleportationTarget(value: Mesh);
  50709. /**
  50710. * 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
  50711. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  50712. * See http://doc.babylonjs.com/resources/baking_transformations
  50713. */
  50714. get gazeTrackerMesh(): Mesh;
  50715. set gazeTrackerMesh(value: Mesh);
  50716. /**
  50717. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  50718. */
  50719. updateGazeTrackerScale: boolean;
  50720. /**
  50721. * If the gaze trackers color should be updated when selecting meshes
  50722. */
  50723. updateGazeTrackerColor: boolean;
  50724. /**
  50725. * If the controller laser color should be updated when selecting meshes
  50726. */
  50727. updateControllerLaserColor: boolean;
  50728. /**
  50729. * The gaze tracking mesh corresponding to the left controller
  50730. */
  50731. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  50732. /**
  50733. * The gaze tracking mesh corresponding to the right controller
  50734. */
  50735. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  50736. /**
  50737. * If the ray of the gaze should be displayed.
  50738. */
  50739. get displayGaze(): boolean;
  50740. /**
  50741. * Sets if the ray of the gaze should be displayed.
  50742. */
  50743. set displayGaze(value: boolean);
  50744. /**
  50745. * If the ray of the LaserPointer should be displayed.
  50746. */
  50747. get displayLaserPointer(): boolean;
  50748. /**
  50749. * Sets if the ray of the LaserPointer should be displayed.
  50750. */
  50751. set displayLaserPointer(value: boolean);
  50752. /**
  50753. * The deviceOrientationCamera used as the camera when not in VR.
  50754. */
  50755. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  50756. /**
  50757. * Based on the current WebVR support, returns the current VR camera used.
  50758. */
  50759. get currentVRCamera(): Nullable<Camera>;
  50760. /**
  50761. * The webVRCamera which is used when in VR.
  50762. */
  50763. get webVRCamera(): WebVRFreeCamera;
  50764. /**
  50765. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  50766. */
  50767. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  50768. /**
  50769. * The html button that is used to trigger entering into VR.
  50770. */
  50771. get vrButton(): Nullable<HTMLButtonElement>;
  50772. private get _teleportationRequestInitiated();
  50773. /**
  50774. * Defines whether or not Pointer lock should be requested when switching to
  50775. * full screen.
  50776. */
  50777. requestPointerLockOnFullScreen: boolean;
  50778. /**
  50779. * If asking to force XR, this will be populated with the default xr experience
  50780. */
  50781. xr: WebXRDefaultExperience;
  50782. /**
  50783. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  50784. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  50785. */
  50786. xrTestDone: boolean;
  50787. /**
  50788. * Instantiates a VRExperienceHelper.
  50789. * Helps to quickly add VR support to an existing scene.
  50790. * @param scene The scene the VRExperienceHelper belongs to.
  50791. * @param webVROptions Options to modify the vr experience helper's behavior.
  50792. */
  50793. constructor(scene: Scene,
  50794. /** Options to modify the vr experience helper's behavior. */
  50795. webVROptions?: VRExperienceHelperOptions);
  50796. private completeVRInit;
  50797. private _onDefaultMeshLoaded;
  50798. private _onResize;
  50799. private _onFullscreenChange;
  50800. /**
  50801. * Gets a value indicating if we are currently in VR mode.
  50802. */
  50803. get isInVRMode(): boolean;
  50804. private onVrDisplayPresentChange;
  50805. private onVRDisplayChanged;
  50806. private moveButtonToBottomRight;
  50807. private displayVRButton;
  50808. private updateButtonVisibility;
  50809. private _cachedAngularSensibility;
  50810. /**
  50811. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  50812. * Otherwise, will use the fullscreen API.
  50813. */
  50814. enterVR(): void;
  50815. /**
  50816. * Attempt to exit VR, or fullscreen.
  50817. */
  50818. exitVR(): void;
  50819. /**
  50820. * The position of the vr experience helper.
  50821. */
  50822. get position(): Vector3;
  50823. /**
  50824. * Sets the position of the vr experience helper.
  50825. */
  50826. set position(value: Vector3);
  50827. /**
  50828. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  50829. */
  50830. enableInteractions(): void;
  50831. private get _noControllerIsActive();
  50832. private beforeRender;
  50833. private _isTeleportationFloor;
  50834. /**
  50835. * Adds a floor mesh to be used for teleportation.
  50836. * @param floorMesh the mesh to be used for teleportation.
  50837. */
  50838. addFloorMesh(floorMesh: Mesh): void;
  50839. /**
  50840. * Removes a floor mesh from being used for teleportation.
  50841. * @param floorMesh the mesh to be removed.
  50842. */
  50843. removeFloorMesh(floorMesh: Mesh): void;
  50844. /**
  50845. * Enables interactions and teleportation using the VR controllers and gaze.
  50846. * @param vrTeleportationOptions options to modify teleportation behavior.
  50847. */
  50848. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  50849. private _onNewGamepadConnected;
  50850. private _tryEnableInteractionOnController;
  50851. private _onNewGamepadDisconnected;
  50852. private _enableInteractionOnController;
  50853. private _checkTeleportWithRay;
  50854. private _checkRotate;
  50855. private _checkTeleportBackwards;
  50856. private _enableTeleportationOnController;
  50857. private _createTeleportationCircles;
  50858. private _displayTeleportationTarget;
  50859. private _hideTeleportationTarget;
  50860. private _rotateCamera;
  50861. private _moveTeleportationSelectorTo;
  50862. private _workingVector;
  50863. private _workingQuaternion;
  50864. private _workingMatrix;
  50865. /**
  50866. * Time Constant Teleportation Mode
  50867. */
  50868. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  50869. /**
  50870. * Speed Constant Teleportation Mode
  50871. */
  50872. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  50873. /**
  50874. * Teleports the users feet to the desired location
  50875. * @param location The location where the user's feet should be placed
  50876. */
  50877. teleportCamera(location: Vector3): void;
  50878. private _convertNormalToDirectionOfRay;
  50879. private _castRayAndSelectObject;
  50880. private _notifySelectedMeshUnselected;
  50881. /**
  50882. * Permanently set new colors for the laser pointer
  50883. * @param color the new laser color
  50884. * @param pickedColor the new laser color when picked mesh detected
  50885. */
  50886. setLaserColor(color: Color3, pickedColor?: Color3): void;
  50887. /**
  50888. * Set lighting enabled / disabled on the laser pointer of both controllers
  50889. * @param enabled should the lighting be enabled on the laser pointer
  50890. */
  50891. setLaserLightingState(enabled?: boolean): void;
  50892. /**
  50893. * Permanently set new colors for the gaze pointer
  50894. * @param color the new gaze color
  50895. * @param pickedColor the new gaze color when picked mesh detected
  50896. */
  50897. setGazeColor(color: Color3, pickedColor?: Color3): void;
  50898. /**
  50899. * Sets the color of the laser ray from the vr controllers.
  50900. * @param color new color for the ray.
  50901. */
  50902. changeLaserColor(color: Color3): void;
  50903. /**
  50904. * Sets the color of the ray from the vr headsets gaze.
  50905. * @param color new color for the ray.
  50906. */
  50907. changeGazeColor(color: Color3): void;
  50908. /**
  50909. * Exits VR and disposes of the vr experience helper
  50910. */
  50911. dispose(): void;
  50912. /**
  50913. * Gets the name of the VRExperienceHelper class
  50914. * @returns "VRExperienceHelper"
  50915. */
  50916. getClassName(): string;
  50917. }
  50918. }
  50919. declare module "babylonjs/Cameras/VR/index" {
  50920. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  50921. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  50922. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  50923. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  50924. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  50925. export * from "babylonjs/Cameras/VR/webVRCamera";
  50926. }
  50927. declare module "babylonjs/Cameras/RigModes/index" {
  50928. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  50929. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  50930. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  50931. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  50932. }
  50933. declare module "babylonjs/Cameras/index" {
  50934. export * from "babylonjs/Cameras/Inputs/index";
  50935. export * from "babylonjs/Cameras/cameraInputsManager";
  50936. export * from "babylonjs/Cameras/camera";
  50937. export * from "babylonjs/Cameras/targetCamera";
  50938. export * from "babylonjs/Cameras/freeCamera";
  50939. export * from "babylonjs/Cameras/freeCameraInputsManager";
  50940. export * from "babylonjs/Cameras/touchCamera";
  50941. export * from "babylonjs/Cameras/arcRotateCamera";
  50942. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  50943. export * from "babylonjs/Cameras/deviceOrientationCamera";
  50944. export * from "babylonjs/Cameras/flyCamera";
  50945. export * from "babylonjs/Cameras/flyCameraInputsManager";
  50946. export * from "babylonjs/Cameras/followCamera";
  50947. export * from "babylonjs/Cameras/followCameraInputsManager";
  50948. export * from "babylonjs/Cameras/gamepadCamera";
  50949. export * from "babylonjs/Cameras/Stereoscopic/index";
  50950. export * from "babylonjs/Cameras/universalCamera";
  50951. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  50952. export * from "babylonjs/Cameras/VR/index";
  50953. export * from "babylonjs/Cameras/RigModes/index";
  50954. }
  50955. declare module "babylonjs/Collisions/index" {
  50956. export * from "babylonjs/Collisions/collider";
  50957. export * from "babylonjs/Collisions/collisionCoordinator";
  50958. export * from "babylonjs/Collisions/pickingInfo";
  50959. export * from "babylonjs/Collisions/intersectionInfo";
  50960. export * from "babylonjs/Collisions/meshCollisionData";
  50961. }
  50962. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  50963. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  50964. import { Vector3 } from "babylonjs/Maths/math.vector";
  50965. import { Ray } from "babylonjs/Culling/ray";
  50966. import { Plane } from "babylonjs/Maths/math.plane";
  50967. /**
  50968. * Contains an array of blocks representing the octree
  50969. */
  50970. export interface IOctreeContainer<T> {
  50971. /**
  50972. * Blocks within the octree
  50973. */
  50974. blocks: Array<OctreeBlock<T>>;
  50975. }
  50976. /**
  50977. * Class used to store a cell in an octree
  50978. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  50979. */
  50980. export class OctreeBlock<T> {
  50981. /**
  50982. * Gets the content of the current block
  50983. */
  50984. entries: T[];
  50985. /**
  50986. * Gets the list of block children
  50987. */
  50988. blocks: Array<OctreeBlock<T>>;
  50989. private _depth;
  50990. private _maxDepth;
  50991. private _capacity;
  50992. private _minPoint;
  50993. private _maxPoint;
  50994. private _boundingVectors;
  50995. private _creationFunc;
  50996. /**
  50997. * Creates a new block
  50998. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  50999. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  51000. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51001. * @param depth defines the current depth of this block in the octree
  51002. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  51003. * @param creationFunc defines a callback to call when an element is added to the block
  51004. */
  51005. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  51006. /**
  51007. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51008. */
  51009. get capacity(): number;
  51010. /**
  51011. * Gets the minimum vector (in world space) of the block's bounding box
  51012. */
  51013. get minPoint(): Vector3;
  51014. /**
  51015. * Gets the maximum vector (in world space) of the block's bounding box
  51016. */
  51017. get maxPoint(): Vector3;
  51018. /**
  51019. * Add a new element to this block
  51020. * @param entry defines the element to add
  51021. */
  51022. addEntry(entry: T): void;
  51023. /**
  51024. * Remove an element from this block
  51025. * @param entry defines the element to remove
  51026. */
  51027. removeEntry(entry: T): void;
  51028. /**
  51029. * Add an array of elements to this block
  51030. * @param entries defines the array of elements to add
  51031. */
  51032. addEntries(entries: T[]): void;
  51033. /**
  51034. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  51035. * @param frustumPlanes defines the frustum planes to test
  51036. * @param selection defines the array to store current content if selection is positive
  51037. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51038. */
  51039. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  51040. /**
  51041. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  51042. * @param sphereCenter defines the bounding sphere center
  51043. * @param sphereRadius defines the bounding sphere radius
  51044. * @param selection defines the array to store current content if selection is positive
  51045. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51046. */
  51047. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  51048. /**
  51049. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  51050. * @param ray defines the ray to test with
  51051. * @param selection defines the array to store current content if selection is positive
  51052. */
  51053. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  51054. /**
  51055. * Subdivide the content into child blocks (this block will then be empty)
  51056. */
  51057. createInnerBlocks(): void;
  51058. /**
  51059. * @hidden
  51060. */
  51061. 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;
  51062. }
  51063. }
  51064. declare module "babylonjs/Culling/Octrees/octree" {
  51065. import { SmartArray } from "babylonjs/Misc/smartArray";
  51066. import { Vector3 } from "babylonjs/Maths/math.vector";
  51067. import { SubMesh } from "babylonjs/Meshes/subMesh";
  51068. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51069. import { Ray } from "babylonjs/Culling/ray";
  51070. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  51071. import { Plane } from "babylonjs/Maths/math.plane";
  51072. /**
  51073. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  51074. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51075. */
  51076. export class Octree<T> {
  51077. /** 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.) */
  51078. maxDepth: number;
  51079. /**
  51080. * Blocks within the octree containing objects
  51081. */
  51082. blocks: Array<OctreeBlock<T>>;
  51083. /**
  51084. * Content stored in the octree
  51085. */
  51086. dynamicContent: T[];
  51087. private _maxBlockCapacity;
  51088. private _selectionContent;
  51089. private _creationFunc;
  51090. /**
  51091. * Creates a octree
  51092. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51093. * @param creationFunc function to be used to instatiate the octree
  51094. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  51095. * @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.)
  51096. */
  51097. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  51098. /** 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.) */
  51099. maxDepth?: number);
  51100. /**
  51101. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  51102. * @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);
  51103. * @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);
  51104. * @param entries meshes to be added to the octree blocks
  51105. */
  51106. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  51107. /**
  51108. * Adds a mesh to the octree
  51109. * @param entry Mesh to add to the octree
  51110. */
  51111. addMesh(entry: T): void;
  51112. /**
  51113. * Remove an element from the octree
  51114. * @param entry defines the element to remove
  51115. */
  51116. removeMesh(entry: T): void;
  51117. /**
  51118. * Selects an array of meshes within the frustum
  51119. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  51120. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  51121. * @returns array of meshes within the frustum
  51122. */
  51123. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  51124. /**
  51125. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  51126. * @param sphereCenter defines the bounding sphere center
  51127. * @param sphereRadius defines the bounding sphere radius
  51128. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51129. * @returns an array of objects that intersect the sphere
  51130. */
  51131. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  51132. /**
  51133. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  51134. * @param ray defines the ray to test with
  51135. * @returns array of intersected objects
  51136. */
  51137. intersectsRay(ray: Ray): SmartArray<T>;
  51138. /**
  51139. * Adds a mesh into the octree block if it intersects the block
  51140. */
  51141. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  51142. /**
  51143. * Adds a submesh into the octree block if it intersects the block
  51144. */
  51145. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  51146. }
  51147. }
  51148. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  51149. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  51150. import { Scene } from "babylonjs/scene";
  51151. import { SubMesh } from "babylonjs/Meshes/subMesh";
  51152. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51153. import { Ray } from "babylonjs/Culling/ray";
  51154. import { Octree } from "babylonjs/Culling/Octrees/octree";
  51155. import { Collider } from "babylonjs/Collisions/collider";
  51156. module "babylonjs/scene" {
  51157. interface Scene {
  51158. /**
  51159. * @hidden
  51160. * Backing Filed
  51161. */
  51162. _selectionOctree: Octree<AbstractMesh>;
  51163. /**
  51164. * Gets the octree used to boost mesh selection (picking)
  51165. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51166. */
  51167. selectionOctree: Octree<AbstractMesh>;
  51168. /**
  51169. * Creates or updates the octree used to boost selection (picking)
  51170. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51171. * @param maxCapacity defines the maximum capacity per leaf
  51172. * @param maxDepth defines the maximum depth of the octree
  51173. * @returns an octree of AbstractMesh
  51174. */
  51175. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  51176. }
  51177. }
  51178. module "babylonjs/Meshes/abstractMesh" {
  51179. interface AbstractMesh {
  51180. /**
  51181. * @hidden
  51182. * Backing Field
  51183. */
  51184. _submeshesOctree: Octree<SubMesh>;
  51185. /**
  51186. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  51187. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  51188. * @param maxCapacity defines the maximum size of each block (64 by default)
  51189. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  51190. * @returns the new octree
  51191. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  51192. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51193. */
  51194. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  51195. }
  51196. }
  51197. /**
  51198. * Defines the octree scene component responsible to manage any octrees
  51199. * in a given scene.
  51200. */
  51201. export class OctreeSceneComponent {
  51202. /**
  51203. * The component name help to identify the component in the list of scene components.
  51204. */
  51205. readonly name: string;
  51206. /**
  51207. * The scene the component belongs to.
  51208. */
  51209. scene: Scene;
  51210. /**
  51211. * Indicates if the meshes have been checked to make sure they are isEnabled()
  51212. */
  51213. readonly checksIsEnabled: boolean;
  51214. /**
  51215. * Creates a new instance of the component for the given scene
  51216. * @param scene Defines the scene to register the component in
  51217. */
  51218. constructor(scene: Scene);
  51219. /**
  51220. * Registers the component in a given scene
  51221. */
  51222. register(): void;
  51223. /**
  51224. * Return the list of active meshes
  51225. * @returns the list of active meshes
  51226. */
  51227. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  51228. /**
  51229. * Return the list of active sub meshes
  51230. * @param mesh The mesh to get the candidates sub meshes from
  51231. * @returns the list of active sub meshes
  51232. */
  51233. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  51234. private _tempRay;
  51235. /**
  51236. * Return the list of sub meshes intersecting with a given local ray
  51237. * @param mesh defines the mesh to find the submesh for
  51238. * @param localRay defines the ray in local space
  51239. * @returns the list of intersecting sub meshes
  51240. */
  51241. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  51242. /**
  51243. * Return the list of sub meshes colliding with a collider
  51244. * @param mesh defines the mesh to find the submesh for
  51245. * @param collider defines the collider to evaluate the collision against
  51246. * @returns the list of colliding sub meshes
  51247. */
  51248. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  51249. /**
  51250. * Rebuilds the elements related to this component in case of
  51251. * context lost for instance.
  51252. */
  51253. rebuild(): void;
  51254. /**
  51255. * Disposes the component and the associated ressources.
  51256. */
  51257. dispose(): void;
  51258. }
  51259. }
  51260. declare module "babylonjs/Culling/Octrees/index" {
  51261. export * from "babylonjs/Culling/Octrees/octree";
  51262. export * from "babylonjs/Culling/Octrees/octreeBlock";
  51263. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  51264. }
  51265. declare module "babylonjs/Culling/index" {
  51266. export * from "babylonjs/Culling/boundingBox";
  51267. export * from "babylonjs/Culling/boundingInfo";
  51268. export * from "babylonjs/Culling/boundingSphere";
  51269. export * from "babylonjs/Culling/Octrees/index";
  51270. export * from "babylonjs/Culling/ray";
  51271. }
  51272. declare module "babylonjs/Gizmos/gizmo" {
  51273. import { Nullable } from "babylonjs/types";
  51274. import { IDisposable } from "babylonjs/scene";
  51275. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51276. import { Mesh } from "babylonjs/Meshes/mesh";
  51277. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  51278. /**
  51279. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  51280. */
  51281. export class Gizmo implements IDisposable {
  51282. /** The utility layer the gizmo will be added to */
  51283. gizmoLayer: UtilityLayerRenderer;
  51284. /**
  51285. * The root mesh of the gizmo
  51286. */
  51287. _rootMesh: Mesh;
  51288. private _attachedMesh;
  51289. /**
  51290. * Ratio for the scale of the gizmo (Default: 1)
  51291. */
  51292. scaleRatio: number;
  51293. /**
  51294. * If a custom mesh has been set (Default: false)
  51295. */
  51296. protected _customMeshSet: boolean;
  51297. /**
  51298. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  51299. * * When set, interactions will be enabled
  51300. */
  51301. get attachedMesh(): Nullable<AbstractMesh>;
  51302. set attachedMesh(value: Nullable<AbstractMesh>);
  51303. /**
  51304. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  51305. * @param mesh The mesh to replace the default mesh of the gizmo
  51306. */
  51307. setCustomMesh(mesh: Mesh): void;
  51308. /**
  51309. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  51310. */
  51311. updateGizmoRotationToMatchAttachedMesh: boolean;
  51312. /**
  51313. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  51314. */
  51315. updateGizmoPositionToMatchAttachedMesh: boolean;
  51316. /**
  51317. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  51318. */
  51319. updateScale: boolean;
  51320. protected _interactionsEnabled: boolean;
  51321. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  51322. private _beforeRenderObserver;
  51323. private _tempVector;
  51324. /**
  51325. * Creates a gizmo
  51326. * @param gizmoLayer The utility layer the gizmo will be added to
  51327. */
  51328. constructor(
  51329. /** The utility layer the gizmo will be added to */
  51330. gizmoLayer?: UtilityLayerRenderer);
  51331. /**
  51332. * Updates the gizmo to match the attached mesh's position/rotation
  51333. */
  51334. protected _update(): void;
  51335. /**
  51336. * Disposes of the gizmo
  51337. */
  51338. dispose(): void;
  51339. }
  51340. }
  51341. declare module "babylonjs/Gizmos/planeDragGizmo" {
  51342. import { Observable } from "babylonjs/Misc/observable";
  51343. import { Nullable } from "babylonjs/types";
  51344. import { Vector3 } from "babylonjs/Maths/math.vector";
  51345. import { Color3 } from "babylonjs/Maths/math.color";
  51346. import { TransformNode } from "babylonjs/Meshes/transformNode";
  51347. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51348. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  51349. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  51350. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  51351. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  51352. import { Scene } from "babylonjs/scene";
  51353. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  51354. /**
  51355. * Single plane drag gizmo
  51356. */
  51357. export class PlaneDragGizmo extends Gizmo {
  51358. /**
  51359. * Drag behavior responsible for the gizmos dragging interactions
  51360. */
  51361. dragBehavior: PointerDragBehavior;
  51362. private _pointerObserver;
  51363. /**
  51364. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  51365. */
  51366. snapDistance: number;
  51367. /**
  51368. * Event that fires each time the gizmo snaps to a new location.
  51369. * * snapDistance is the the change in distance
  51370. */
  51371. onSnapObservable: Observable<{
  51372. snapDistance: number;
  51373. }>;
  51374. private _plane;
  51375. private _coloredMaterial;
  51376. private _hoverMaterial;
  51377. private _isEnabled;
  51378. private _parent;
  51379. /** @hidden */
  51380. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  51381. /** @hidden */
  51382. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  51383. /**
  51384. * Creates a PlaneDragGizmo
  51385. * @param gizmoLayer The utility layer the gizmo will be added to
  51386. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  51387. * @param color The color of the gizmo
  51388. */
  51389. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  51390. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  51391. /**
  51392. * If the gizmo is enabled
  51393. */
  51394. set isEnabled(value: boolean);
  51395. get isEnabled(): boolean;
  51396. /**
  51397. * Disposes of the gizmo
  51398. */
  51399. dispose(): void;
  51400. }
  51401. }
  51402. declare module "babylonjs/Gizmos/positionGizmo" {
  51403. import { Observable } from "babylonjs/Misc/observable";
  51404. import { Nullable } from "babylonjs/types";
  51405. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51406. import { Mesh } from "babylonjs/Meshes/mesh";
  51407. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  51408. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  51409. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  51410. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  51411. /**
  51412. * Gizmo that enables dragging a mesh along 3 axis
  51413. */
  51414. export class PositionGizmo extends Gizmo {
  51415. /**
  51416. * Internal gizmo used for interactions on the x axis
  51417. */
  51418. xGizmo: AxisDragGizmo;
  51419. /**
  51420. * Internal gizmo used for interactions on the y axis
  51421. */
  51422. yGizmo: AxisDragGizmo;
  51423. /**
  51424. * Internal gizmo used for interactions on the z axis
  51425. */
  51426. zGizmo: AxisDragGizmo;
  51427. /**
  51428. * Internal gizmo used for interactions on the yz plane
  51429. */
  51430. xPlaneGizmo: PlaneDragGizmo;
  51431. /**
  51432. * Internal gizmo used for interactions on the xz plane
  51433. */
  51434. yPlaneGizmo: PlaneDragGizmo;
  51435. /**
  51436. * Internal gizmo used for interactions on the xy plane
  51437. */
  51438. zPlaneGizmo: PlaneDragGizmo;
  51439. /**
  51440. * private variables
  51441. */
  51442. private _meshAttached;
  51443. private _updateGizmoRotationToMatchAttachedMesh;
  51444. private _snapDistance;
  51445. private _scaleRatio;
  51446. /** Fires an event when any of it's sub gizmos are dragged */
  51447. onDragStartObservable: Observable<unknown>;
  51448. /** Fires an event when any of it's sub gizmos are released from dragging */
  51449. onDragEndObservable: Observable<unknown>;
  51450. /**
  51451. * If set to true, planar drag is enabled
  51452. */
  51453. private _planarGizmoEnabled;
  51454. get attachedMesh(): Nullable<AbstractMesh>;
  51455. set attachedMesh(mesh: Nullable<AbstractMesh>);
  51456. /**
  51457. * Creates a PositionGizmo
  51458. * @param gizmoLayer The utility layer the gizmo will be added to
  51459. */
  51460. constructor(gizmoLayer?: UtilityLayerRenderer);
  51461. /**
  51462. * If the planar drag gizmo is enabled
  51463. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  51464. */
  51465. set planarGizmoEnabled(value: boolean);
  51466. get planarGizmoEnabled(): boolean;
  51467. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  51468. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  51469. /**
  51470. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  51471. */
  51472. set snapDistance(value: number);
  51473. get snapDistance(): number;
  51474. /**
  51475. * Ratio for the scale of the gizmo (Default: 1)
  51476. */
  51477. set scaleRatio(value: number);
  51478. get scaleRatio(): number;
  51479. /**
  51480. * Disposes of the gizmo
  51481. */
  51482. dispose(): void;
  51483. /**
  51484. * CustomMeshes are not supported by this gizmo
  51485. * @param mesh The mesh to replace the default mesh of the gizmo
  51486. */
  51487. setCustomMesh(mesh: Mesh): void;
  51488. }
  51489. }
  51490. declare module "babylonjs/Gizmos/axisDragGizmo" {
  51491. import { Observable } from "babylonjs/Misc/observable";
  51492. import { Nullable } from "babylonjs/types";
  51493. import { Vector3 } from "babylonjs/Maths/math.vector";
  51494. import { TransformNode } from "babylonjs/Meshes/transformNode";
  51495. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51496. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  51497. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  51498. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  51499. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  51500. import { Scene } from "babylonjs/scene";
  51501. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  51502. import { Color3 } from "babylonjs/Maths/math.color";
  51503. /**
  51504. * Single axis drag gizmo
  51505. */
  51506. export class AxisDragGizmo extends Gizmo {
  51507. /**
  51508. * Drag behavior responsible for the gizmos dragging interactions
  51509. */
  51510. dragBehavior: PointerDragBehavior;
  51511. private _pointerObserver;
  51512. /**
  51513. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  51514. */
  51515. snapDistance: number;
  51516. /**
  51517. * Event that fires each time the gizmo snaps to a new location.
  51518. * * snapDistance is the the change in distance
  51519. */
  51520. onSnapObservable: Observable<{
  51521. snapDistance: number;
  51522. }>;
  51523. private _isEnabled;
  51524. private _parent;
  51525. private _arrow;
  51526. private _coloredMaterial;
  51527. private _hoverMaterial;
  51528. /** @hidden */
  51529. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  51530. /** @hidden */
  51531. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  51532. /**
  51533. * Creates an AxisDragGizmo
  51534. * @param gizmoLayer The utility layer the gizmo will be added to
  51535. * @param dragAxis The axis which the gizmo will be able to drag on
  51536. * @param color The color of the gizmo
  51537. */
  51538. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  51539. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  51540. /**
  51541. * If the gizmo is enabled
  51542. */
  51543. set isEnabled(value: boolean);
  51544. get isEnabled(): boolean;
  51545. /**
  51546. * Disposes of the gizmo
  51547. */
  51548. dispose(): void;
  51549. }
  51550. }
  51551. declare module "babylonjs/Debug/axesViewer" {
  51552. import { Vector3 } from "babylonjs/Maths/math.vector";
  51553. import { Nullable } from "babylonjs/types";
  51554. import { Scene } from "babylonjs/scene";
  51555. import { TransformNode } from "babylonjs/Meshes/transformNode";
  51556. /**
  51557. * The Axes viewer will show 3 axes in a specific point in space
  51558. */
  51559. export class AxesViewer {
  51560. private _xAxis;
  51561. private _yAxis;
  51562. private _zAxis;
  51563. private _scaleLinesFactor;
  51564. private _instanced;
  51565. /**
  51566. * Gets the hosting scene
  51567. */
  51568. scene: Scene;
  51569. /**
  51570. * Gets or sets a number used to scale line length
  51571. */
  51572. scaleLines: number;
  51573. /** Gets the node hierarchy used to render x-axis */
  51574. get xAxis(): TransformNode;
  51575. /** Gets the node hierarchy used to render y-axis */
  51576. get yAxis(): TransformNode;
  51577. /** Gets the node hierarchy used to render z-axis */
  51578. get zAxis(): TransformNode;
  51579. /**
  51580. * Creates a new AxesViewer
  51581. * @param scene defines the hosting scene
  51582. * @param scaleLines defines a number used to scale line length (1 by default)
  51583. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  51584. * @param xAxis defines the node hierarchy used to render the x-axis
  51585. * @param yAxis defines the node hierarchy used to render the y-axis
  51586. * @param zAxis defines the node hierarchy used to render the z-axis
  51587. */
  51588. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  51589. /**
  51590. * Force the viewer to update
  51591. * @param position defines the position of the viewer
  51592. * @param xaxis defines the x axis of the viewer
  51593. * @param yaxis defines the y axis of the viewer
  51594. * @param zaxis defines the z axis of the viewer
  51595. */
  51596. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  51597. /**
  51598. * Creates an instance of this axes viewer.
  51599. * @returns a new axes viewer with instanced meshes
  51600. */
  51601. createInstance(): AxesViewer;
  51602. /** Releases resources */
  51603. dispose(): void;
  51604. private static _SetRenderingGroupId;
  51605. }
  51606. }
  51607. declare module "babylonjs/Debug/boneAxesViewer" {
  51608. import { Nullable } from "babylonjs/types";
  51609. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  51610. import { Vector3 } from "babylonjs/Maths/math.vector";
  51611. import { Mesh } from "babylonjs/Meshes/mesh";
  51612. import { Bone } from "babylonjs/Bones/bone";
  51613. import { Scene } from "babylonjs/scene";
  51614. /**
  51615. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  51616. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  51617. */
  51618. export class BoneAxesViewer extends AxesViewer {
  51619. /**
  51620. * Gets or sets the target mesh where to display the axes viewer
  51621. */
  51622. mesh: Nullable<Mesh>;
  51623. /**
  51624. * Gets or sets the target bone where to display the axes viewer
  51625. */
  51626. bone: Nullable<Bone>;
  51627. /** Gets current position */
  51628. pos: Vector3;
  51629. /** Gets direction of X axis */
  51630. xaxis: Vector3;
  51631. /** Gets direction of Y axis */
  51632. yaxis: Vector3;
  51633. /** Gets direction of Z axis */
  51634. zaxis: Vector3;
  51635. /**
  51636. * Creates a new BoneAxesViewer
  51637. * @param scene defines the hosting scene
  51638. * @param bone defines the target bone
  51639. * @param mesh defines the target mesh
  51640. * @param scaleLines defines a scaling factor for line length (1 by default)
  51641. */
  51642. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  51643. /**
  51644. * Force the viewer to update
  51645. */
  51646. update(): void;
  51647. /** Releases resources */
  51648. dispose(): void;
  51649. }
  51650. }
  51651. declare module "babylonjs/Debug/debugLayer" {
  51652. import { Scene } from "babylonjs/scene";
  51653. /**
  51654. * Interface used to define scene explorer extensibility option
  51655. */
  51656. export interface IExplorerExtensibilityOption {
  51657. /**
  51658. * Define the option label
  51659. */
  51660. label: string;
  51661. /**
  51662. * Defines the action to execute on click
  51663. */
  51664. action: (entity: any) => void;
  51665. }
  51666. /**
  51667. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  51668. */
  51669. export interface IExplorerExtensibilityGroup {
  51670. /**
  51671. * Defines a predicate to test if a given type mut be extended
  51672. */
  51673. predicate: (entity: any) => boolean;
  51674. /**
  51675. * Gets the list of options added to a type
  51676. */
  51677. entries: IExplorerExtensibilityOption[];
  51678. }
  51679. /**
  51680. * Interface used to define the options to use to create the Inspector
  51681. */
  51682. export interface IInspectorOptions {
  51683. /**
  51684. * Display in overlay mode (default: false)
  51685. */
  51686. overlay?: boolean;
  51687. /**
  51688. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  51689. */
  51690. globalRoot?: HTMLElement;
  51691. /**
  51692. * Display the Scene explorer
  51693. */
  51694. showExplorer?: boolean;
  51695. /**
  51696. * Display the property inspector
  51697. */
  51698. showInspector?: boolean;
  51699. /**
  51700. * Display in embed mode (both panes on the right)
  51701. */
  51702. embedMode?: boolean;
  51703. /**
  51704. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  51705. */
  51706. handleResize?: boolean;
  51707. /**
  51708. * Allow the panes to popup (default: true)
  51709. */
  51710. enablePopup?: boolean;
  51711. /**
  51712. * Allow the panes to be closed by users (default: true)
  51713. */
  51714. enableClose?: boolean;
  51715. /**
  51716. * Optional list of extensibility entries
  51717. */
  51718. explorerExtensibility?: IExplorerExtensibilityGroup[];
  51719. /**
  51720. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  51721. */
  51722. inspectorURL?: string;
  51723. /**
  51724. * Optional initial tab (default to DebugLayerTab.Properties)
  51725. */
  51726. initialTab?: DebugLayerTab;
  51727. }
  51728. module "babylonjs/scene" {
  51729. interface Scene {
  51730. /**
  51731. * @hidden
  51732. * Backing field
  51733. */
  51734. _debugLayer: DebugLayer;
  51735. /**
  51736. * Gets the debug layer (aka Inspector) associated with the scene
  51737. * @see http://doc.babylonjs.com/features/playground_debuglayer
  51738. */
  51739. debugLayer: DebugLayer;
  51740. }
  51741. }
  51742. /**
  51743. * Enum of inspector action tab
  51744. */
  51745. export enum DebugLayerTab {
  51746. /**
  51747. * Properties tag (default)
  51748. */
  51749. Properties = 0,
  51750. /**
  51751. * Debug tab
  51752. */
  51753. Debug = 1,
  51754. /**
  51755. * Statistics tab
  51756. */
  51757. Statistics = 2,
  51758. /**
  51759. * Tools tab
  51760. */
  51761. Tools = 3,
  51762. /**
  51763. * Settings tab
  51764. */
  51765. Settings = 4
  51766. }
  51767. /**
  51768. * The debug layer (aka Inspector) is the go to tool in order to better understand
  51769. * what is happening in your scene
  51770. * @see http://doc.babylonjs.com/features/playground_debuglayer
  51771. */
  51772. export class DebugLayer {
  51773. /**
  51774. * Define the url to get the inspector script from.
  51775. * By default it uses the babylonjs CDN.
  51776. * @ignoreNaming
  51777. */
  51778. static InspectorURL: string;
  51779. private _scene;
  51780. private BJSINSPECTOR;
  51781. private _onPropertyChangedObservable?;
  51782. /**
  51783. * Observable triggered when a property is changed through the inspector.
  51784. */
  51785. get onPropertyChangedObservable(): any;
  51786. /**
  51787. * Instantiates a new debug layer.
  51788. * The debug layer (aka Inspector) is the go to tool in order to better understand
  51789. * what is happening in your scene
  51790. * @see http://doc.babylonjs.com/features/playground_debuglayer
  51791. * @param scene Defines the scene to inspect
  51792. */
  51793. constructor(scene: Scene);
  51794. /** Creates the inspector window. */
  51795. private _createInspector;
  51796. /**
  51797. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  51798. * @param entity defines the entity to select
  51799. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  51800. */
  51801. select(entity: any, lineContainerTitles?: string | string[]): void;
  51802. /** Get the inspector from bundle or global */
  51803. private _getGlobalInspector;
  51804. /**
  51805. * Get if the inspector is visible or not.
  51806. * @returns true if visible otherwise, false
  51807. */
  51808. isVisible(): boolean;
  51809. /**
  51810. * Hide the inspector and close its window.
  51811. */
  51812. hide(): void;
  51813. /**
  51814. * Update the scene in the inspector
  51815. */
  51816. setAsActiveScene(): void;
  51817. /**
  51818. * Launch the debugLayer.
  51819. * @param config Define the configuration of the inspector
  51820. * @return a promise fulfilled when the debug layer is visible
  51821. */
  51822. show(config?: IInspectorOptions): Promise<DebugLayer>;
  51823. }
  51824. }
  51825. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  51826. import { Nullable } from "babylonjs/types";
  51827. import { Scene } from "babylonjs/scene";
  51828. import { Vector4 } from "babylonjs/Maths/math.vector";
  51829. import { Color4 } from "babylonjs/Maths/math.color";
  51830. import { Mesh } from "babylonjs/Meshes/mesh";
  51831. /**
  51832. * Class containing static functions to help procedurally build meshes
  51833. */
  51834. export class BoxBuilder {
  51835. /**
  51836. * Creates a box mesh
  51837. * * The parameter `size` sets the size (float) of each box side (default 1)
  51838. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  51839. * * 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)
  51840. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  51841. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  51842. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  51843. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  51844. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  51845. * @param name defines the name of the mesh
  51846. * @param options defines the options used to create the mesh
  51847. * @param scene defines the hosting scene
  51848. * @returns the box mesh
  51849. */
  51850. static CreateBox(name: string, options: {
  51851. size?: number;
  51852. width?: number;
  51853. height?: number;
  51854. depth?: number;
  51855. faceUV?: Vector4[];
  51856. faceColors?: Color4[];
  51857. sideOrientation?: number;
  51858. frontUVs?: Vector4;
  51859. backUVs?: Vector4;
  51860. wrap?: boolean;
  51861. topBaseAt?: number;
  51862. bottomBaseAt?: number;
  51863. updatable?: boolean;
  51864. }, scene?: Nullable<Scene>): Mesh;
  51865. }
  51866. }
  51867. declare module "babylonjs/Debug/physicsViewer" {
  51868. import { Nullable } from "babylonjs/types";
  51869. import { Scene } from "babylonjs/scene";
  51870. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51871. import { Mesh } from "babylonjs/Meshes/mesh";
  51872. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  51873. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  51874. /**
  51875. * Used to show the physics impostor around the specific mesh
  51876. */
  51877. export class PhysicsViewer {
  51878. /** @hidden */
  51879. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  51880. /** @hidden */
  51881. protected _meshes: Array<Nullable<AbstractMesh>>;
  51882. /** @hidden */
  51883. protected _scene: Nullable<Scene>;
  51884. /** @hidden */
  51885. protected _numMeshes: number;
  51886. /** @hidden */
  51887. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  51888. private _renderFunction;
  51889. private _utilityLayer;
  51890. private _debugBoxMesh;
  51891. private _debugSphereMesh;
  51892. private _debugCylinderMesh;
  51893. private _debugMaterial;
  51894. private _debugMeshMeshes;
  51895. /**
  51896. * Creates a new PhysicsViewer
  51897. * @param scene defines the hosting scene
  51898. */
  51899. constructor(scene: Scene);
  51900. /** @hidden */
  51901. protected _updateDebugMeshes(): void;
  51902. /**
  51903. * Renders a specified physic impostor
  51904. * @param impostor defines the impostor to render
  51905. * @param targetMesh defines the mesh represented by the impostor
  51906. * @returns the new debug mesh used to render the impostor
  51907. */
  51908. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  51909. /**
  51910. * Hides a specified physic impostor
  51911. * @param impostor defines the impostor to hide
  51912. */
  51913. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  51914. private _getDebugMaterial;
  51915. private _getDebugBoxMesh;
  51916. private _getDebugSphereMesh;
  51917. private _getDebugCylinderMesh;
  51918. private _getDebugMeshMesh;
  51919. private _getDebugMesh;
  51920. /** Releases all resources */
  51921. dispose(): void;
  51922. }
  51923. }
  51924. declare module "babylonjs/Debug/rayHelper" {
  51925. import { Nullable } from "babylonjs/types";
  51926. import { Ray } from "babylonjs/Culling/ray";
  51927. import { Vector3 } from "babylonjs/Maths/math.vector";
  51928. import { Color3 } from "babylonjs/Maths/math.color";
  51929. import { Scene } from "babylonjs/scene";
  51930. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51931. import "babylonjs/Meshes/Builders/linesBuilder";
  51932. /**
  51933. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  51934. * in order to better appreciate the issue one might have.
  51935. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  51936. */
  51937. export class RayHelper {
  51938. /**
  51939. * Defines the ray we are currently tryin to visualize.
  51940. */
  51941. ray: Nullable<Ray>;
  51942. private _renderPoints;
  51943. private _renderLine;
  51944. private _renderFunction;
  51945. private _scene;
  51946. private _updateToMeshFunction;
  51947. private _attachedToMesh;
  51948. private _meshSpaceDirection;
  51949. private _meshSpaceOrigin;
  51950. /**
  51951. * Helper function to create a colored helper in a scene in one line.
  51952. * @param ray Defines the ray we are currently tryin to visualize
  51953. * @param scene Defines the scene the ray is used in
  51954. * @param color Defines the color we want to see the ray in
  51955. * @returns The newly created ray helper.
  51956. */
  51957. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  51958. /**
  51959. * Instantiate a new ray helper.
  51960. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  51961. * in order to better appreciate the issue one might have.
  51962. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  51963. * @param ray Defines the ray we are currently tryin to visualize
  51964. */
  51965. constructor(ray: Ray);
  51966. /**
  51967. * Shows the ray we are willing to debug.
  51968. * @param scene Defines the scene the ray needs to be rendered in
  51969. * @param color Defines the color the ray needs to be rendered in
  51970. */
  51971. show(scene: Scene, color?: Color3): void;
  51972. /**
  51973. * Hides the ray we are debugging.
  51974. */
  51975. hide(): void;
  51976. private _render;
  51977. /**
  51978. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  51979. * @param mesh Defines the mesh we want the helper attached to
  51980. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  51981. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  51982. * @param length Defines the length of the ray
  51983. */
  51984. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  51985. /**
  51986. * Detach the ray helper from the mesh it has previously been attached to.
  51987. */
  51988. detachFromMesh(): void;
  51989. private _updateToMesh;
  51990. /**
  51991. * Dispose the helper and release its associated resources.
  51992. */
  51993. dispose(): void;
  51994. }
  51995. }
  51996. declare module "babylonjs/Debug/skeletonViewer" {
  51997. import { Color3 } from "babylonjs/Maths/math.color";
  51998. import { Scene } from "babylonjs/scene";
  51999. import { Nullable } from "babylonjs/types";
  52000. import { Skeleton } from "babylonjs/Bones/skeleton";
  52001. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52002. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  52003. /**
  52004. * Class used to render a debug view of a given skeleton
  52005. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  52006. */
  52007. export class SkeletonViewer {
  52008. /** defines the skeleton to render */
  52009. skeleton: Skeleton;
  52010. /** defines the mesh attached to the skeleton */
  52011. mesh: AbstractMesh;
  52012. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  52013. autoUpdateBonesMatrices: boolean;
  52014. /** defines the rendering group id to use with the viewer */
  52015. renderingGroupId: number;
  52016. /** Gets or sets the color used to render the skeleton */
  52017. color: Color3;
  52018. private _scene;
  52019. private _debugLines;
  52020. private _debugMesh;
  52021. private _isEnabled;
  52022. private _renderFunction;
  52023. private _utilityLayer;
  52024. /**
  52025. * Returns the mesh used to render the bones
  52026. */
  52027. get debugMesh(): Nullable<LinesMesh>;
  52028. /**
  52029. * Creates a new SkeletonViewer
  52030. * @param skeleton defines the skeleton to render
  52031. * @param mesh defines the mesh attached to the skeleton
  52032. * @param scene defines the hosting scene
  52033. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  52034. * @param renderingGroupId defines the rendering group id to use with the viewer
  52035. */
  52036. constructor(
  52037. /** defines the skeleton to render */
  52038. skeleton: Skeleton,
  52039. /** defines the mesh attached to the skeleton */
  52040. mesh: AbstractMesh, scene: Scene,
  52041. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  52042. autoUpdateBonesMatrices?: boolean,
  52043. /** defines the rendering group id to use with the viewer */
  52044. renderingGroupId?: number);
  52045. /** Gets or sets a boolean indicating if the viewer is enabled */
  52046. set isEnabled(value: boolean);
  52047. get isEnabled(): boolean;
  52048. private _getBonePosition;
  52049. private _getLinesForBonesWithLength;
  52050. private _getLinesForBonesNoLength;
  52051. /** Update the viewer to sync with current skeleton state */
  52052. update(): void;
  52053. /** Release associated resources */
  52054. dispose(): void;
  52055. }
  52056. }
  52057. declare module "babylonjs/Debug/index" {
  52058. export * from "babylonjs/Debug/axesViewer";
  52059. export * from "babylonjs/Debug/boneAxesViewer";
  52060. export * from "babylonjs/Debug/debugLayer";
  52061. export * from "babylonjs/Debug/physicsViewer";
  52062. export * from "babylonjs/Debug/rayHelper";
  52063. export * from "babylonjs/Debug/skeletonViewer";
  52064. }
  52065. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  52066. /**
  52067. * Enum for Device Types
  52068. */
  52069. export enum DeviceType {
  52070. /** Generic */
  52071. Generic = 0,
  52072. /** Keyboard */
  52073. Keyboard = 1,
  52074. /** Mouse */
  52075. Mouse = 2,
  52076. /** Touch Pointers */
  52077. Touch = 3,
  52078. /** PS4 Dual Shock */
  52079. DualShock = 4,
  52080. /** Xbox */
  52081. Xbox = 5,
  52082. /** Switch Controller */
  52083. Switch = 6
  52084. }
  52085. /**
  52086. * Enum for All Pointers (Touch/Mouse)
  52087. */
  52088. export enum PointerInput {
  52089. /** Horizontal Axis */
  52090. Horizontal = 0,
  52091. /** Vertical Axis */
  52092. Vertical = 1,
  52093. /** Left Click or Touch */
  52094. LeftClick = 2,
  52095. /** Middle Click */
  52096. MiddleClick = 3,
  52097. /** Right Click */
  52098. RightClick = 4,
  52099. /** Browser Back */
  52100. BrowserBack = 5,
  52101. /** Browser Forward */
  52102. BrowserForward = 6
  52103. }
  52104. /**
  52105. * Enum for Dual Shock Gamepad
  52106. */
  52107. export enum DualShockInput {
  52108. /** Cross */
  52109. Cross = 0,
  52110. /** Circle */
  52111. Circle = 1,
  52112. /** Square */
  52113. Square = 2,
  52114. /** Triangle */
  52115. Triangle = 3,
  52116. /** L1 */
  52117. L1 = 4,
  52118. /** R1 */
  52119. R1 = 5,
  52120. /** L2 */
  52121. L2 = 6,
  52122. /** R2 */
  52123. R2 = 7,
  52124. /** Share */
  52125. Share = 8,
  52126. /** Options */
  52127. Options = 9,
  52128. /** L3 */
  52129. L3 = 10,
  52130. /** R3 */
  52131. R3 = 11,
  52132. /** DPadUp */
  52133. DPadUp = 12,
  52134. /** DPadDown */
  52135. DPadDown = 13,
  52136. /** DPadLeft */
  52137. DPadLeft = 14,
  52138. /** DRight */
  52139. DPadRight = 15,
  52140. /** Home */
  52141. Home = 16,
  52142. /** TouchPad */
  52143. TouchPad = 17,
  52144. /** LStickXAxis */
  52145. LStickXAxis = 18,
  52146. /** LStickYAxis */
  52147. LStickYAxis = 19,
  52148. /** RStickXAxis */
  52149. RStickXAxis = 20,
  52150. /** RStickYAxis */
  52151. RStickYAxis = 21
  52152. }
  52153. /**
  52154. * Enum for Xbox Gamepad
  52155. */
  52156. export enum XboxInput {
  52157. /** A */
  52158. A = 0,
  52159. /** B */
  52160. B = 1,
  52161. /** X */
  52162. X = 2,
  52163. /** Y */
  52164. Y = 3,
  52165. /** LB */
  52166. LB = 4,
  52167. /** RB */
  52168. RB = 5,
  52169. /** LT */
  52170. LT = 6,
  52171. /** RT */
  52172. RT = 7,
  52173. /** Back */
  52174. Back = 8,
  52175. /** Start */
  52176. Start = 9,
  52177. /** LS */
  52178. LS = 10,
  52179. /** RS */
  52180. RS = 11,
  52181. /** DPadUp */
  52182. DPadUp = 12,
  52183. /** DPadDown */
  52184. DPadDown = 13,
  52185. /** DPadLeft */
  52186. DPadLeft = 14,
  52187. /** DRight */
  52188. DPadRight = 15,
  52189. /** Home */
  52190. Home = 16,
  52191. /** LStickXAxis */
  52192. LStickXAxis = 17,
  52193. /** LStickYAxis */
  52194. LStickYAxis = 18,
  52195. /** RStickXAxis */
  52196. RStickXAxis = 19,
  52197. /** RStickYAxis */
  52198. RStickYAxis = 20
  52199. }
  52200. /**
  52201. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  52202. */
  52203. export enum SwitchInput {
  52204. /** B */
  52205. B = 0,
  52206. /** A */
  52207. A = 1,
  52208. /** Y */
  52209. Y = 2,
  52210. /** X */
  52211. X = 3,
  52212. /** L */
  52213. L = 4,
  52214. /** R */
  52215. R = 5,
  52216. /** ZL */
  52217. ZL = 6,
  52218. /** ZR */
  52219. ZR = 7,
  52220. /** Minus */
  52221. Minus = 8,
  52222. /** Plus */
  52223. Plus = 9,
  52224. /** LS */
  52225. LS = 10,
  52226. /** RS */
  52227. RS = 11,
  52228. /** DPadUp */
  52229. DPadUp = 12,
  52230. /** DPadDown */
  52231. DPadDown = 13,
  52232. /** DPadLeft */
  52233. DPadLeft = 14,
  52234. /** DRight */
  52235. DPadRight = 15,
  52236. /** Home */
  52237. Home = 16,
  52238. /** Capture */
  52239. Capture = 17,
  52240. /** LStickXAxis */
  52241. LStickXAxis = 18,
  52242. /** LStickYAxis */
  52243. LStickYAxis = 19,
  52244. /** RStickXAxis */
  52245. RStickXAxis = 20,
  52246. /** RStickYAxis */
  52247. RStickYAxis = 21
  52248. }
  52249. }
  52250. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  52251. import { Engine } from "babylonjs/Engines/engine";
  52252. import { IDisposable } from "babylonjs/scene";
  52253. import { Nullable } from "babylonjs/types";
  52254. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  52255. /**
  52256. * This class will take all inputs from Keyboard, Pointer, and
  52257. * any Gamepads and provide a polling system that all devices
  52258. * will use. This class assumes that there will only be one
  52259. * pointer device and one keyboard.
  52260. */
  52261. export class DeviceInputSystem implements IDisposable {
  52262. /**
  52263. * Callback to be triggered when a device is connected
  52264. */
  52265. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  52266. /**
  52267. * Callback to be triggered when a device is disconnected
  52268. */
  52269. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  52270. /**
  52271. * Callback to be triggered when event driven input is updated
  52272. */
  52273. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  52274. private _inputs;
  52275. private _gamepads;
  52276. private _keyboardActive;
  52277. private _pointerActive;
  52278. private _elementToAttachTo;
  52279. private _keyboardDownEvent;
  52280. private _keyboardUpEvent;
  52281. private _pointerMoveEvent;
  52282. private _pointerDownEvent;
  52283. private _pointerUpEvent;
  52284. private _gamepadConnectedEvent;
  52285. private _gamepadDisconnectedEvent;
  52286. private static _MAX_KEYCODES;
  52287. private static _MAX_POINTER_INPUTS;
  52288. private constructor();
  52289. /**
  52290. * Creates a new DeviceInputSystem instance
  52291. * @param engine Engine to pull input element from
  52292. * @returns The new instance
  52293. */
  52294. static Create(engine: Engine): DeviceInputSystem;
  52295. /**
  52296. * Checks for current device input value, given an id and input index
  52297. * @param deviceName Id of connected device
  52298. * @param inputIndex Index of device input
  52299. * @returns Current value of input
  52300. */
  52301. /**
  52302. * Checks for current device input value, given an id and input index
  52303. * @param deviceType Enum specifiying device type
  52304. * @param deviceSlot "Slot" or index that device is referenced in
  52305. * @param inputIndex Id of input to be checked
  52306. * @returns Current value of input
  52307. */
  52308. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): Nullable<number>;
  52309. /**
  52310. * Dispose of all the eventlisteners
  52311. */
  52312. dispose(): void;
  52313. /**
  52314. * Add device and inputs to device array
  52315. * @param deviceType Enum specifiying device type
  52316. * @param deviceSlot "Slot" or index that device is referenced in
  52317. * @param numberOfInputs Number of input entries to create for given device
  52318. */
  52319. private _registerDevice;
  52320. /**
  52321. * Given a specific device name, remove that device from the device map
  52322. * @param deviceType Enum specifiying device type
  52323. * @param deviceSlot "Slot" or index that device is referenced in
  52324. */
  52325. private _unregisterDevice;
  52326. /**
  52327. * Handle all actions that come from keyboard interaction
  52328. */
  52329. private _handleKeyActions;
  52330. /**
  52331. * Handle all actions that come from pointer interaction
  52332. */
  52333. private _handlePointerActions;
  52334. /**
  52335. * Handle all actions that come from gamepad interaction
  52336. */
  52337. private _handleGamepadActions;
  52338. /**
  52339. * Update all non-event based devices with each frame
  52340. * @param deviceType Enum specifiying device type
  52341. * @param deviceSlot "Slot" or index that device is referenced in
  52342. * @param inputIndex Id of input to be checked
  52343. */
  52344. private _updateDevice;
  52345. /**
  52346. * Gets DeviceType from the device name
  52347. * @param deviceName Name of Device from DeviceInputSystem
  52348. * @returns DeviceType enum value
  52349. */
  52350. private _getGamepadDeviceType;
  52351. }
  52352. }
  52353. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  52354. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  52355. /**
  52356. * Type to handle enforcement of inputs
  52357. */
  52358. export type DeviceInput<T extends DeviceType> = T extends DeviceType.Keyboard | DeviceType.Generic ? number : T extends DeviceType.Mouse | DeviceType.Touch ? PointerInput : T extends DeviceType.DualShock ? DualShockInput : T extends DeviceType.Xbox ? XboxInput : T extends DeviceType.Switch ? SwitchInput : never;
  52359. }
  52360. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  52361. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  52362. import { Engine } from "babylonjs/Engines/engine";
  52363. import { IDisposable } from "babylonjs/scene";
  52364. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  52365. import { Nullable } from "babylonjs/types";
  52366. import { Observable } from "babylonjs/Misc/observable";
  52367. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  52368. /**
  52369. * Class that handles all input for a specific device
  52370. */
  52371. export class DeviceSource<T extends DeviceType> {
  52372. /** Type of device */
  52373. readonly deviceType: DeviceType;
  52374. /** "Slot" or index that device is referenced in */
  52375. readonly deviceSlot: number;
  52376. /**
  52377. * Observable to handle device input changes per device
  52378. */
  52379. readonly onInputChangedObservable: Observable<{
  52380. inputIndex: DeviceInput<T>;
  52381. previousState: Nullable<number>;
  52382. currentState: Nullable<number>;
  52383. }>;
  52384. private readonly _deviceInputSystem;
  52385. /**
  52386. * Default Constructor
  52387. * @param deviceInputSystem Reference to DeviceInputSystem
  52388. * @param deviceType Type of device
  52389. * @param deviceSlot "Slot" or index that device is referenced in
  52390. */
  52391. constructor(deviceInputSystem: DeviceInputSystem,
  52392. /** Type of device */
  52393. deviceType: DeviceType,
  52394. /** "Slot" or index that device is referenced in */
  52395. deviceSlot?: number);
  52396. /**
  52397. * Get input for specific input
  52398. * @param inputIndex index of specific input on device
  52399. * @returns Input value from DeviceInputSystem
  52400. */
  52401. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  52402. }
  52403. /**
  52404. * Class to keep track of devices
  52405. */
  52406. export class DeviceSourceManager implements IDisposable {
  52407. /**
  52408. * Observable to be triggered when before a device is connected
  52409. */
  52410. readonly onBeforeDeviceConnectedObservable: Observable<{
  52411. deviceType: DeviceType;
  52412. deviceSlot: number;
  52413. }>;
  52414. /**
  52415. * Observable to be triggered when before a device is disconnected
  52416. */
  52417. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  52418. deviceType: DeviceType;
  52419. deviceSlot: number;
  52420. }>;
  52421. /**
  52422. * Observable to be triggered when after a device is connected
  52423. */
  52424. readonly onAfterDeviceConnectedObservable: Observable<{
  52425. deviceType: DeviceType;
  52426. deviceSlot: number;
  52427. }>;
  52428. /**
  52429. * Observable to be triggered when after a device is disconnected
  52430. */
  52431. readonly onAfterDeviceDisconnectedObservable: Observable<{
  52432. deviceType: DeviceType;
  52433. deviceSlot: number;
  52434. }>;
  52435. private readonly _devices;
  52436. private readonly _firstDevice;
  52437. private readonly _deviceInputSystem;
  52438. /**
  52439. * Default Constructor
  52440. * @param engine engine to pull input element from
  52441. */
  52442. constructor(engine: Engine);
  52443. /**
  52444. * Gets a DeviceSource, given a type and slot
  52445. * @param deviceType Enum specifying device type
  52446. * @param deviceSlot "Slot" or index that device is referenced in
  52447. * @returns DeviceSource object
  52448. */
  52449. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  52450. /**
  52451. * Gets an array of DeviceSource objects for a given device type
  52452. * @param deviceType Enum specifying device type
  52453. * @returns Array of DeviceSource objects
  52454. */
  52455. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  52456. /**
  52457. * Dispose of DeviceInputSystem and other parts
  52458. */
  52459. dispose(): void;
  52460. /**
  52461. * Function to add device name to device list
  52462. * @param deviceType Enum specifying device type
  52463. * @param deviceSlot "Slot" or index that device is referenced in
  52464. */
  52465. private _addDevice;
  52466. /**
  52467. * Function to remove device name to device list
  52468. * @param deviceType Enum specifying device type
  52469. * @param deviceSlot "Slot" or index that device is referenced in
  52470. */
  52471. private _removeDevice;
  52472. /**
  52473. * Updates array storing first connected device of each type
  52474. * @param type Type of Device
  52475. */
  52476. private _updateFirstDevices;
  52477. }
  52478. }
  52479. declare module "babylonjs/DeviceInput/index" {
  52480. export * from "babylonjs/DeviceInput/deviceInputSystem";
  52481. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  52482. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  52483. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  52484. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  52485. }
  52486. declare module "babylonjs/Engines/nullEngine" {
  52487. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  52488. import { Engine } from "babylonjs/Engines/engine";
  52489. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  52490. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  52491. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  52492. import { Effect } from "babylonjs/Materials/effect";
  52493. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  52494. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  52495. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  52496. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  52497. /**
  52498. * Options to create the null engine
  52499. */
  52500. export class NullEngineOptions {
  52501. /**
  52502. * Render width (Default: 512)
  52503. */
  52504. renderWidth: number;
  52505. /**
  52506. * Render height (Default: 256)
  52507. */
  52508. renderHeight: number;
  52509. /**
  52510. * Texture size (Default: 512)
  52511. */
  52512. textureSize: number;
  52513. /**
  52514. * If delta time between frames should be constant
  52515. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  52516. */
  52517. deterministicLockstep: boolean;
  52518. /**
  52519. * Maximum about of steps between frames (Default: 4)
  52520. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  52521. */
  52522. lockstepMaxSteps: number;
  52523. }
  52524. /**
  52525. * The null engine class provides support for headless version of babylon.js.
  52526. * This can be used in server side scenario or for testing purposes
  52527. */
  52528. export class NullEngine extends Engine {
  52529. private _options;
  52530. /**
  52531. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  52532. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  52533. * @returns true if engine is in deterministic lock step mode
  52534. */
  52535. isDeterministicLockStep(): boolean;
  52536. /**
  52537. * Gets the max steps when engine is running in deterministic lock step
  52538. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  52539. * @returns the max steps
  52540. */
  52541. getLockstepMaxSteps(): number;
  52542. /**
  52543. * Gets the current hardware scaling level.
  52544. * By default the hardware scaling level is computed from the window device ratio.
  52545. * 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.
  52546. * @returns a number indicating the current hardware scaling level
  52547. */
  52548. getHardwareScalingLevel(): number;
  52549. constructor(options?: NullEngineOptions);
  52550. /**
  52551. * Creates a vertex buffer
  52552. * @param vertices the data for the vertex buffer
  52553. * @returns the new WebGL static buffer
  52554. */
  52555. createVertexBuffer(vertices: FloatArray): DataBuffer;
  52556. /**
  52557. * Creates a new index buffer
  52558. * @param indices defines the content of the index buffer
  52559. * @param updatable defines if the index buffer must be updatable
  52560. * @returns a new webGL buffer
  52561. */
  52562. createIndexBuffer(indices: IndicesArray): DataBuffer;
  52563. /**
  52564. * Clear the current render buffer or the current render target (if any is set up)
  52565. * @param color defines the color to use
  52566. * @param backBuffer defines if the back buffer must be cleared
  52567. * @param depth defines if the depth buffer must be cleared
  52568. * @param stencil defines if the stencil buffer must be cleared
  52569. */
  52570. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  52571. /**
  52572. * Gets the current render width
  52573. * @param useScreen defines if screen size must be used (or the current render target if any)
  52574. * @returns a number defining the current render width
  52575. */
  52576. getRenderWidth(useScreen?: boolean): number;
  52577. /**
  52578. * Gets the current render height
  52579. * @param useScreen defines if screen size must be used (or the current render target if any)
  52580. * @returns a number defining the current render height
  52581. */
  52582. getRenderHeight(useScreen?: boolean): number;
  52583. /**
  52584. * Set the WebGL's viewport
  52585. * @param viewport defines the viewport element to be used
  52586. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  52587. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  52588. */
  52589. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  52590. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  52591. /**
  52592. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  52593. * @param pipelineContext defines the pipeline context to use
  52594. * @param uniformsNames defines the list of uniform names
  52595. * @returns an array of webGL uniform locations
  52596. */
  52597. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  52598. /**
  52599. * Gets the lsit of active attributes for a given webGL program
  52600. * @param pipelineContext defines the pipeline context to use
  52601. * @param attributesNames defines the list of attribute names to get
  52602. * @returns an array of indices indicating the offset of each attribute
  52603. */
  52604. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  52605. /**
  52606. * Binds an effect to the webGL context
  52607. * @param effect defines the effect to bind
  52608. */
  52609. bindSamplers(effect: Effect): void;
  52610. /**
  52611. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  52612. * @param effect defines the effect to activate
  52613. */
  52614. enableEffect(effect: Effect): void;
  52615. /**
  52616. * Set various states to the webGL context
  52617. * @param culling defines backface culling state
  52618. * @param zOffset defines the value to apply to zOffset (0 by default)
  52619. * @param force defines if states must be applied even if cache is up to date
  52620. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  52621. */
  52622. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  52623. /**
  52624. * Set the value of an uniform to an array of int32
  52625. * @param uniform defines the webGL uniform location where to store the value
  52626. * @param array defines the array of int32 to store
  52627. */
  52628. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  52629. /**
  52630. * Set the value of an uniform to an array of int32 (stored as vec2)
  52631. * @param uniform defines the webGL uniform location where to store the value
  52632. * @param array defines the array of int32 to store
  52633. */
  52634. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  52635. /**
  52636. * Set the value of an uniform to an array of int32 (stored as vec3)
  52637. * @param uniform defines the webGL uniform location where to store the value
  52638. * @param array defines the array of int32 to store
  52639. */
  52640. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  52641. /**
  52642. * Set the value of an uniform to an array of int32 (stored as vec4)
  52643. * @param uniform defines the webGL uniform location where to store the value
  52644. * @param array defines the array of int32 to store
  52645. */
  52646. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  52647. /**
  52648. * Set the value of an uniform to an array of float32
  52649. * @param uniform defines the webGL uniform location where to store the value
  52650. * @param array defines the array of float32 to store
  52651. */
  52652. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  52653. /**
  52654. * Set the value of an uniform to an array of float32 (stored as vec2)
  52655. * @param uniform defines the webGL uniform location where to store the value
  52656. * @param array defines the array of float32 to store
  52657. */
  52658. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  52659. /**
  52660. * Set the value of an uniform to an array of float32 (stored as vec3)
  52661. * @param uniform defines the webGL uniform location where to store the value
  52662. * @param array defines the array of float32 to store
  52663. */
  52664. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  52665. /**
  52666. * Set the value of an uniform to an array of float32 (stored as vec4)
  52667. * @param uniform defines the webGL uniform location where to store the value
  52668. * @param array defines the array of float32 to store
  52669. */
  52670. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  52671. /**
  52672. * Set the value of an uniform to an array of number
  52673. * @param uniform defines the webGL uniform location where to store the value
  52674. * @param array defines the array of number to store
  52675. */
  52676. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  52677. /**
  52678. * Set the value of an uniform to an array of number (stored as vec2)
  52679. * @param uniform defines the webGL uniform location where to store the value
  52680. * @param array defines the array of number to store
  52681. */
  52682. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  52683. /**
  52684. * Set the value of an uniform to an array of number (stored as vec3)
  52685. * @param uniform defines the webGL uniform location where to store the value
  52686. * @param array defines the array of number to store
  52687. */
  52688. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  52689. /**
  52690. * Set the value of an uniform to an array of number (stored as vec4)
  52691. * @param uniform defines the webGL uniform location where to store the value
  52692. * @param array defines the array of number to store
  52693. */
  52694. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  52695. /**
  52696. * Set the value of an uniform to an array of float32 (stored as matrices)
  52697. * @param uniform defines the webGL uniform location where to store the value
  52698. * @param matrices defines the array of float32 to store
  52699. */
  52700. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  52701. /**
  52702. * Set the value of an uniform to a matrix (3x3)
  52703. * @param uniform defines the webGL uniform location where to store the value
  52704. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  52705. */
  52706. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  52707. /**
  52708. * Set the value of an uniform to a matrix (2x2)
  52709. * @param uniform defines the webGL uniform location where to store the value
  52710. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  52711. */
  52712. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  52713. /**
  52714. * Set the value of an uniform to a number (float)
  52715. * @param uniform defines the webGL uniform location where to store the value
  52716. * @param value defines the float number to store
  52717. */
  52718. setFloat(uniform: WebGLUniformLocation, value: number): void;
  52719. /**
  52720. * Set the value of an uniform to a vec2
  52721. * @param uniform defines the webGL uniform location where to store the value
  52722. * @param x defines the 1st component of the value
  52723. * @param y defines the 2nd component of the value
  52724. */
  52725. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  52726. /**
  52727. * Set the value of an uniform to a vec3
  52728. * @param uniform defines the webGL uniform location where to store the value
  52729. * @param x defines the 1st component of the value
  52730. * @param y defines the 2nd component of the value
  52731. * @param z defines the 3rd component of the value
  52732. */
  52733. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  52734. /**
  52735. * Set the value of an uniform to a boolean
  52736. * @param uniform defines the webGL uniform location where to store the value
  52737. * @param bool defines the boolean to store
  52738. */
  52739. setBool(uniform: WebGLUniformLocation, bool: number): void;
  52740. /**
  52741. * Set the value of an uniform to a vec4
  52742. * @param uniform defines the webGL uniform location where to store the value
  52743. * @param x defines the 1st component of the value
  52744. * @param y defines the 2nd component of the value
  52745. * @param z defines the 3rd component of the value
  52746. * @param w defines the 4th component of the value
  52747. */
  52748. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  52749. /**
  52750. * Sets the current alpha mode
  52751. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  52752. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  52753. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  52754. */
  52755. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  52756. /**
  52757. * Bind webGl buffers directly to the webGL context
  52758. * @param vertexBuffers defines the vertex buffer to bind
  52759. * @param indexBuffer defines the index buffer to bind
  52760. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  52761. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  52762. * @param effect defines the effect associated with the vertex buffer
  52763. */
  52764. bindBuffers(vertexBuffers: {
  52765. [key: string]: VertexBuffer;
  52766. }, indexBuffer: DataBuffer, effect: Effect): void;
  52767. /**
  52768. * Force the entire cache to be cleared
  52769. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  52770. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  52771. */
  52772. wipeCaches(bruteForce?: boolean): void;
  52773. /**
  52774. * Send a draw order
  52775. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  52776. * @param indexStart defines the starting index
  52777. * @param indexCount defines the number of index to draw
  52778. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  52779. */
  52780. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  52781. /**
  52782. * Draw a list of indexed primitives
  52783. * @param fillMode defines the primitive to use
  52784. * @param indexStart defines the starting index
  52785. * @param indexCount defines the number of index to draw
  52786. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  52787. */
  52788. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  52789. /**
  52790. * Draw a list of unindexed primitives
  52791. * @param fillMode defines the primitive to use
  52792. * @param verticesStart defines the index of first vertex to draw
  52793. * @param verticesCount defines the count of vertices to draw
  52794. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  52795. */
  52796. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  52797. /** @hidden */
  52798. _createTexture(): WebGLTexture;
  52799. /** @hidden */
  52800. _releaseTexture(texture: InternalTexture): void;
  52801. /**
  52802. * Usually called from Texture.ts.
  52803. * Passed information to create a WebGLTexture
  52804. * @param urlArg defines a value which contains one of the following:
  52805. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  52806. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  52807. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  52808. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  52809. * @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)
  52810. * @param scene needed for loading to the correct scene
  52811. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  52812. * @param onLoad optional callback to be called upon successful completion
  52813. * @param onError optional callback to be called upon failure
  52814. * @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
  52815. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  52816. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  52817. * @param forcedExtension defines the extension to use to pick the right loader
  52818. * @param mimeType defines an optional mime type
  52819. * @returns a InternalTexture for assignment back into BABYLON.Texture
  52820. */
  52821. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string): InternalTexture;
  52822. /**
  52823. * Creates a new render target texture
  52824. * @param size defines the size of the texture
  52825. * @param options defines the options used to create the texture
  52826. * @returns a new render target texture stored in an InternalTexture
  52827. */
  52828. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  52829. /**
  52830. * Update the sampling mode of a given texture
  52831. * @param samplingMode defines the required sampling mode
  52832. * @param texture defines the texture to update
  52833. */
  52834. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  52835. /**
  52836. * Binds the frame buffer to the specified texture.
  52837. * @param texture The texture to render to or null for the default canvas
  52838. * @param faceIndex The face of the texture to render to in case of cube texture
  52839. * @param requiredWidth The width of the target to render to
  52840. * @param requiredHeight The height of the target to render to
  52841. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  52842. * @param lodLevel defines le lod level to bind to the frame buffer
  52843. */
  52844. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  52845. /**
  52846. * Unbind the current render target texture from the webGL context
  52847. * @param texture defines the render target texture to unbind
  52848. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  52849. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  52850. */
  52851. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  52852. /**
  52853. * Creates a dynamic vertex buffer
  52854. * @param vertices the data for the dynamic vertex buffer
  52855. * @returns the new WebGL dynamic buffer
  52856. */
  52857. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  52858. /**
  52859. * Update the content of a dynamic texture
  52860. * @param texture defines the texture to update
  52861. * @param canvas defines the canvas containing the source
  52862. * @param invertY defines if data must be stored with Y axis inverted
  52863. * @param premulAlpha defines if alpha is stored as premultiplied
  52864. * @param format defines the format of the data
  52865. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  52866. */
  52867. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  52868. /**
  52869. * Gets a boolean indicating if all created effects are ready
  52870. * @returns true if all effects are ready
  52871. */
  52872. areAllEffectsReady(): boolean;
  52873. /**
  52874. * @hidden
  52875. * Get the current error code of the webGL context
  52876. * @returns the error code
  52877. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  52878. */
  52879. getError(): number;
  52880. /** @hidden */
  52881. _getUnpackAlignement(): number;
  52882. /** @hidden */
  52883. _unpackFlipY(value: boolean): void;
  52884. /**
  52885. * Update a dynamic index buffer
  52886. * @param indexBuffer defines the target index buffer
  52887. * @param indices defines the data to update
  52888. * @param offset defines the offset in the target index buffer where update should start
  52889. */
  52890. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  52891. /**
  52892. * Updates a dynamic vertex buffer.
  52893. * @param vertexBuffer the vertex buffer to update
  52894. * @param vertices the data used to update the vertex buffer
  52895. * @param byteOffset the byte offset of the data (optional)
  52896. * @param byteLength the byte length of the data (optional)
  52897. */
  52898. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  52899. /** @hidden */
  52900. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  52901. /** @hidden */
  52902. _bindTexture(channel: number, texture: InternalTexture): void;
  52903. protected _deleteBuffer(buffer: WebGLBuffer): void;
  52904. /**
  52905. * 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
  52906. */
  52907. releaseEffects(): void;
  52908. displayLoadingUI(): void;
  52909. hideLoadingUI(): void;
  52910. /** @hidden */
  52911. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  52912. /** @hidden */
  52913. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  52914. /** @hidden */
  52915. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  52916. /** @hidden */
  52917. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  52918. }
  52919. }
  52920. declare module "babylonjs/Instrumentation/timeToken" {
  52921. import { Nullable } from "babylonjs/types";
  52922. /**
  52923. * @hidden
  52924. **/
  52925. export class _TimeToken {
  52926. _startTimeQuery: Nullable<WebGLQuery>;
  52927. _endTimeQuery: Nullable<WebGLQuery>;
  52928. _timeElapsedQuery: Nullable<WebGLQuery>;
  52929. _timeElapsedQueryEnded: boolean;
  52930. }
  52931. }
  52932. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  52933. import { Nullable, int } from "babylonjs/types";
  52934. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  52935. /** @hidden */
  52936. export class _OcclusionDataStorage {
  52937. /** @hidden */
  52938. occlusionInternalRetryCounter: number;
  52939. /** @hidden */
  52940. isOcclusionQueryInProgress: boolean;
  52941. /** @hidden */
  52942. isOccluded: boolean;
  52943. /** @hidden */
  52944. occlusionRetryCount: number;
  52945. /** @hidden */
  52946. occlusionType: number;
  52947. /** @hidden */
  52948. occlusionQueryAlgorithmType: number;
  52949. }
  52950. module "babylonjs/Engines/engine" {
  52951. interface Engine {
  52952. /**
  52953. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  52954. * @return the new query
  52955. */
  52956. createQuery(): WebGLQuery;
  52957. /**
  52958. * Delete and release a webGL query
  52959. * @param query defines the query to delete
  52960. * @return the current engine
  52961. */
  52962. deleteQuery(query: WebGLQuery): Engine;
  52963. /**
  52964. * Check if a given query has resolved and got its value
  52965. * @param query defines the query to check
  52966. * @returns true if the query got its value
  52967. */
  52968. isQueryResultAvailable(query: WebGLQuery): boolean;
  52969. /**
  52970. * Gets the value of a given query
  52971. * @param query defines the query to check
  52972. * @returns the value of the query
  52973. */
  52974. getQueryResult(query: WebGLQuery): number;
  52975. /**
  52976. * Initiates an occlusion query
  52977. * @param algorithmType defines the algorithm to use
  52978. * @param query defines the query to use
  52979. * @returns the current engine
  52980. * @see http://doc.babylonjs.com/features/occlusionquery
  52981. */
  52982. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  52983. /**
  52984. * Ends an occlusion query
  52985. * @see http://doc.babylonjs.com/features/occlusionquery
  52986. * @param algorithmType defines the algorithm to use
  52987. * @returns the current engine
  52988. */
  52989. endOcclusionQuery(algorithmType: number): Engine;
  52990. /**
  52991. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  52992. * Please note that only one query can be issued at a time
  52993. * @returns a time token used to track the time span
  52994. */
  52995. startTimeQuery(): Nullable<_TimeToken>;
  52996. /**
  52997. * Ends a time query
  52998. * @param token defines the token used to measure the time span
  52999. * @returns the time spent (in ns)
  53000. */
  53001. endTimeQuery(token: _TimeToken): int;
  53002. /** @hidden */
  53003. _currentNonTimestampToken: Nullable<_TimeToken>;
  53004. /** @hidden */
  53005. _createTimeQuery(): WebGLQuery;
  53006. /** @hidden */
  53007. _deleteTimeQuery(query: WebGLQuery): void;
  53008. /** @hidden */
  53009. _getGlAlgorithmType(algorithmType: number): number;
  53010. /** @hidden */
  53011. _getTimeQueryResult(query: WebGLQuery): any;
  53012. /** @hidden */
  53013. _getTimeQueryAvailability(query: WebGLQuery): any;
  53014. }
  53015. }
  53016. module "babylonjs/Meshes/abstractMesh" {
  53017. interface AbstractMesh {
  53018. /**
  53019. * Backing filed
  53020. * @hidden
  53021. */
  53022. __occlusionDataStorage: _OcclusionDataStorage;
  53023. /**
  53024. * Access property
  53025. * @hidden
  53026. */
  53027. _occlusionDataStorage: _OcclusionDataStorage;
  53028. /**
  53029. * 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.
  53030. * The default value is -1 which means don't break the query and wait till the result
  53031. * @see http://doc.babylonjs.com/features/occlusionquery
  53032. */
  53033. occlusionRetryCount: number;
  53034. /**
  53035. * 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:
  53036. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  53037. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  53038. * * 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.
  53039. * @see http://doc.babylonjs.com/features/occlusionquery
  53040. */
  53041. occlusionType: number;
  53042. /**
  53043. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  53044. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  53045. * * 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.
  53046. * @see http://doc.babylonjs.com/features/occlusionquery
  53047. */
  53048. occlusionQueryAlgorithmType: number;
  53049. /**
  53050. * 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
  53051. * @see http://doc.babylonjs.com/features/occlusionquery
  53052. */
  53053. isOccluded: boolean;
  53054. /**
  53055. * Flag to check the progress status of the query
  53056. * @see http://doc.babylonjs.com/features/occlusionquery
  53057. */
  53058. isOcclusionQueryInProgress: boolean;
  53059. }
  53060. }
  53061. }
  53062. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  53063. import { Nullable } from "babylonjs/types";
  53064. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53065. /** @hidden */
  53066. export var _forceTransformFeedbackToBundle: boolean;
  53067. module "babylonjs/Engines/engine" {
  53068. interface Engine {
  53069. /**
  53070. * Creates a webGL transform feedback object
  53071. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  53072. * @returns the webGL transform feedback object
  53073. */
  53074. createTransformFeedback(): WebGLTransformFeedback;
  53075. /**
  53076. * Delete a webGL transform feedback object
  53077. * @param value defines the webGL transform feedback object to delete
  53078. */
  53079. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  53080. /**
  53081. * Bind a webGL transform feedback object to the webgl context
  53082. * @param value defines the webGL transform feedback object to bind
  53083. */
  53084. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  53085. /**
  53086. * Begins a transform feedback operation
  53087. * @param usePoints defines if points or triangles must be used
  53088. */
  53089. beginTransformFeedback(usePoints: boolean): void;
  53090. /**
  53091. * Ends a transform feedback operation
  53092. */
  53093. endTransformFeedback(): void;
  53094. /**
  53095. * Specify the varyings to use with transform feedback
  53096. * @param program defines the associated webGL program
  53097. * @param value defines the list of strings representing the varying names
  53098. */
  53099. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  53100. /**
  53101. * Bind a webGL buffer for a transform feedback operation
  53102. * @param value defines the webGL buffer to bind
  53103. */
  53104. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  53105. }
  53106. }
  53107. }
  53108. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  53109. import { Scene } from "babylonjs/scene";
  53110. import { Engine } from "babylonjs/Engines/engine";
  53111. import { Texture } from "babylonjs/Materials/Textures/texture";
  53112. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  53113. import "babylonjs/Engines/Extensions/engine.multiRender";
  53114. /**
  53115. * Creation options of the multi render target texture.
  53116. */
  53117. export interface IMultiRenderTargetOptions {
  53118. /**
  53119. * Define if the texture needs to create mip maps after render.
  53120. */
  53121. generateMipMaps?: boolean;
  53122. /**
  53123. * Define the types of all the draw buffers we want to create
  53124. */
  53125. types?: number[];
  53126. /**
  53127. * Define the sampling modes of all the draw buffers we want to create
  53128. */
  53129. samplingModes?: number[];
  53130. /**
  53131. * Define if a depth buffer is required
  53132. */
  53133. generateDepthBuffer?: boolean;
  53134. /**
  53135. * Define if a stencil buffer is required
  53136. */
  53137. generateStencilBuffer?: boolean;
  53138. /**
  53139. * Define if a depth texture is required instead of a depth buffer
  53140. */
  53141. generateDepthTexture?: boolean;
  53142. /**
  53143. * Define the number of desired draw buffers
  53144. */
  53145. textureCount?: number;
  53146. /**
  53147. * Define if aspect ratio should be adapted to the texture or stay the scene one
  53148. */
  53149. doNotChangeAspectRatio?: boolean;
  53150. /**
  53151. * Define the default type of the buffers we are creating
  53152. */
  53153. defaultType?: number;
  53154. }
  53155. /**
  53156. * A multi render target, like a render target provides the ability to render to a texture.
  53157. * Unlike the render target, it can render to several draw buffers in one draw.
  53158. * This is specially interesting in deferred rendering or for any effects requiring more than
  53159. * just one color from a single pass.
  53160. */
  53161. export class MultiRenderTarget extends RenderTargetTexture {
  53162. private _internalTextures;
  53163. private _textures;
  53164. private _multiRenderTargetOptions;
  53165. /**
  53166. * Get if draw buffers are currently supported by the used hardware and browser.
  53167. */
  53168. get isSupported(): boolean;
  53169. /**
  53170. * Get the list of textures generated by the multi render target.
  53171. */
  53172. get textures(): Texture[];
  53173. /**
  53174. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  53175. */
  53176. get depthTexture(): Texture;
  53177. /**
  53178. * Set the wrapping mode on U of all the textures we are rendering to.
  53179. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  53180. */
  53181. set wrapU(wrap: number);
  53182. /**
  53183. * Set the wrapping mode on V of all the textures we are rendering to.
  53184. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  53185. */
  53186. set wrapV(wrap: number);
  53187. /**
  53188. * Instantiate a new multi render target texture.
  53189. * A multi render target, like a render target provides the ability to render to a texture.
  53190. * Unlike the render target, it can render to several draw buffers in one draw.
  53191. * This is specially interesting in deferred rendering or for any effects requiring more than
  53192. * just one color from a single pass.
  53193. * @param name Define the name of the texture
  53194. * @param size Define the size of the buffers to render to
  53195. * @param count Define the number of target we are rendering into
  53196. * @param scene Define the scene the texture belongs to
  53197. * @param options Define the options used to create the multi render target
  53198. */
  53199. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  53200. /** @hidden */
  53201. _rebuild(): void;
  53202. private _createInternalTextures;
  53203. private _createTextures;
  53204. /**
  53205. * Define the number of samples used if MSAA is enabled.
  53206. */
  53207. get samples(): number;
  53208. set samples(value: number);
  53209. /**
  53210. * Resize all the textures in the multi render target.
  53211. * Be carrefull as it will recreate all the data in the new texture.
  53212. * @param size Define the new size
  53213. */
  53214. resize(size: any): void;
  53215. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  53216. /**
  53217. * Dispose the render targets and their associated resources
  53218. */
  53219. dispose(): void;
  53220. /**
  53221. * Release all the underlying texture used as draw buffers.
  53222. */
  53223. releaseInternalTextures(): void;
  53224. }
  53225. }
  53226. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  53227. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53228. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  53229. import { Nullable } from "babylonjs/types";
  53230. module "babylonjs/Engines/thinEngine" {
  53231. interface ThinEngine {
  53232. /**
  53233. * Unbind a list of render target textures from the webGL context
  53234. * This is used only when drawBuffer extension or webGL2 are active
  53235. * @param textures defines the render target textures to unbind
  53236. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  53237. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  53238. */
  53239. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  53240. /**
  53241. * Create a multi render target texture
  53242. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  53243. * @param size defines the size of the texture
  53244. * @param options defines the creation options
  53245. * @returns the cube texture as an InternalTexture
  53246. */
  53247. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  53248. /**
  53249. * Update the sample count for a given multiple render target texture
  53250. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  53251. * @param textures defines the textures to update
  53252. * @param samples defines the sample count to set
  53253. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  53254. */
  53255. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  53256. }
  53257. }
  53258. }
  53259. declare module "babylonjs/Engines/Extensions/engine.views" {
  53260. import { Camera } from "babylonjs/Cameras/camera";
  53261. import { Nullable } from "babylonjs/types";
  53262. /**
  53263. * Class used to define an additional view for the engine
  53264. * @see https://doc.babylonjs.com/how_to/multi_canvases
  53265. */
  53266. export class EngineView {
  53267. /** Defines the canvas where to render the view */
  53268. target: HTMLCanvasElement;
  53269. /** Defines an optional camera used to render the view (will use active camera else) */
  53270. camera?: Camera;
  53271. }
  53272. module "babylonjs/Engines/engine" {
  53273. interface Engine {
  53274. /**
  53275. * Gets or sets the HTML element to use for attaching events
  53276. */
  53277. inputElement: Nullable<HTMLElement>;
  53278. /**
  53279. * Gets the current engine view
  53280. * @see https://doc.babylonjs.com/how_to/multi_canvases
  53281. */
  53282. activeView: Nullable<EngineView>;
  53283. /** Gets or sets the list of views */
  53284. views: EngineView[];
  53285. /**
  53286. * Register a new child canvas
  53287. * @param canvas defines the canvas to register
  53288. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  53289. * @returns the associated view
  53290. */
  53291. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  53292. /**
  53293. * Remove a registered child canvas
  53294. * @param canvas defines the canvas to remove
  53295. * @returns the current engine
  53296. */
  53297. unRegisterView(canvas: HTMLCanvasElement): Engine;
  53298. }
  53299. }
  53300. }
  53301. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  53302. import { Nullable } from "babylonjs/types";
  53303. module "babylonjs/Engines/engine" {
  53304. interface Engine {
  53305. /** @hidden */
  53306. _excludedCompressedTextures: string[];
  53307. /** @hidden */
  53308. _textureFormatInUse: string;
  53309. /**
  53310. * Gets the list of texture formats supported
  53311. */
  53312. readonly texturesSupported: Array<string>;
  53313. /**
  53314. * Gets the texture format in use
  53315. */
  53316. readonly textureFormatInUse: Nullable<string>;
  53317. /**
  53318. * Set the compressed texture extensions or file names to skip.
  53319. *
  53320. * @param skippedFiles defines the list of those texture files you want to skip
  53321. * Example: [".dds", ".env", "myfile.png"]
  53322. */
  53323. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  53324. /**
  53325. * Set the compressed texture format to use, based on the formats you have, and the formats
  53326. * supported by the hardware / browser.
  53327. *
  53328. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  53329. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  53330. * to API arguments needed to compressed textures. This puts the burden on the container
  53331. * generator to house the arcane code for determining these for current & future formats.
  53332. *
  53333. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  53334. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  53335. *
  53336. * Note: The result of this call is not taken into account when a texture is base64.
  53337. *
  53338. * @param formatsAvailable defines the list of those format families you have created
  53339. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  53340. *
  53341. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  53342. * @returns The extension selected.
  53343. */
  53344. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  53345. }
  53346. }
  53347. }
  53348. declare module "babylonjs/Engines/Extensions/index" {
  53349. export * from "babylonjs/Engines/Extensions/engine.alpha";
  53350. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  53351. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  53352. export * from "babylonjs/Engines/Extensions/engine.multiview";
  53353. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  53354. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  53355. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  53356. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  53357. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  53358. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  53359. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  53360. export * from "babylonjs/Engines/Extensions/engine.webVR";
  53361. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  53362. export * from "babylonjs/Engines/Extensions/engine.views";
  53363. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  53364. import "babylonjs/Engines/Extensions/engine.textureSelector";
  53365. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  53366. }
  53367. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  53368. import { Nullable } from "babylonjs/types";
  53369. /**
  53370. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  53371. */
  53372. export interface CubeMapInfo {
  53373. /**
  53374. * The pixel array for the front face.
  53375. * This is stored in format, left to right, up to down format.
  53376. */
  53377. front: Nullable<ArrayBufferView>;
  53378. /**
  53379. * The pixel array for the back face.
  53380. * This is stored in format, left to right, up to down format.
  53381. */
  53382. back: Nullable<ArrayBufferView>;
  53383. /**
  53384. * The pixel array for the left face.
  53385. * This is stored in format, left to right, up to down format.
  53386. */
  53387. left: Nullable<ArrayBufferView>;
  53388. /**
  53389. * The pixel array for the right face.
  53390. * This is stored in format, left to right, up to down format.
  53391. */
  53392. right: Nullable<ArrayBufferView>;
  53393. /**
  53394. * The pixel array for the up face.
  53395. * This is stored in format, left to right, up to down format.
  53396. */
  53397. up: Nullable<ArrayBufferView>;
  53398. /**
  53399. * The pixel array for the down face.
  53400. * This is stored in format, left to right, up to down format.
  53401. */
  53402. down: Nullable<ArrayBufferView>;
  53403. /**
  53404. * The size of the cubemap stored.
  53405. *
  53406. * Each faces will be size * size pixels.
  53407. */
  53408. size: number;
  53409. /**
  53410. * The format of the texture.
  53411. *
  53412. * RGBA, RGB.
  53413. */
  53414. format: number;
  53415. /**
  53416. * The type of the texture data.
  53417. *
  53418. * UNSIGNED_INT, FLOAT.
  53419. */
  53420. type: number;
  53421. /**
  53422. * Specifies whether the texture is in gamma space.
  53423. */
  53424. gammaSpace: boolean;
  53425. }
  53426. /**
  53427. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  53428. */
  53429. export class PanoramaToCubeMapTools {
  53430. private static FACE_LEFT;
  53431. private static FACE_RIGHT;
  53432. private static FACE_FRONT;
  53433. private static FACE_BACK;
  53434. private static FACE_DOWN;
  53435. private static FACE_UP;
  53436. /**
  53437. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  53438. *
  53439. * @param float32Array The source data.
  53440. * @param inputWidth The width of the input panorama.
  53441. * @param inputHeight The height of the input panorama.
  53442. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  53443. * @return The cubemap data
  53444. */
  53445. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  53446. private static CreateCubemapTexture;
  53447. private static CalcProjectionSpherical;
  53448. }
  53449. }
  53450. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  53451. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  53452. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53453. import { Nullable } from "babylonjs/types";
  53454. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  53455. /**
  53456. * Helper class dealing with the extraction of spherical polynomial dataArray
  53457. * from a cube map.
  53458. */
  53459. export class CubeMapToSphericalPolynomialTools {
  53460. private static FileFaces;
  53461. /**
  53462. * Converts a texture to the according Spherical Polynomial data.
  53463. * This extracts the first 3 orders only as they are the only one used in the lighting.
  53464. *
  53465. * @param texture The texture to extract the information from.
  53466. * @return The Spherical Polynomial data.
  53467. */
  53468. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  53469. /**
  53470. * Converts a cubemap to the according Spherical Polynomial data.
  53471. * This extracts the first 3 orders only as they are the only one used in the lighting.
  53472. *
  53473. * @param cubeInfo The Cube map to extract the information from.
  53474. * @return The Spherical Polynomial data.
  53475. */
  53476. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  53477. }
  53478. }
  53479. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  53480. import { Nullable } from "babylonjs/types";
  53481. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  53482. module "babylonjs/Materials/Textures/baseTexture" {
  53483. interface BaseTexture {
  53484. /**
  53485. * Get the polynomial representation of the texture data.
  53486. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  53487. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  53488. */
  53489. sphericalPolynomial: Nullable<SphericalPolynomial>;
  53490. }
  53491. }
  53492. }
  53493. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  53494. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  53495. /** @hidden */
  53496. export var rgbdEncodePixelShader: {
  53497. name: string;
  53498. shader: string;
  53499. };
  53500. }
  53501. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  53502. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  53503. /** @hidden */
  53504. export var rgbdDecodePixelShader: {
  53505. name: string;
  53506. shader: string;
  53507. };
  53508. }
  53509. declare module "babylonjs/Misc/environmentTextureTools" {
  53510. import { Nullable } from "babylonjs/types";
  53511. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  53512. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53513. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53514. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  53515. import "babylonjs/Engines/Extensions/engine.readTexture";
  53516. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  53517. import "babylonjs/Shaders/rgbdEncode.fragment";
  53518. import "babylonjs/Shaders/rgbdDecode.fragment";
  53519. /**
  53520. * Raw texture data and descriptor sufficient for WebGL texture upload
  53521. */
  53522. export interface EnvironmentTextureInfo {
  53523. /**
  53524. * Version of the environment map
  53525. */
  53526. version: number;
  53527. /**
  53528. * Width of image
  53529. */
  53530. width: number;
  53531. /**
  53532. * Irradiance information stored in the file.
  53533. */
  53534. irradiance: any;
  53535. /**
  53536. * Specular information stored in the file.
  53537. */
  53538. specular: any;
  53539. }
  53540. /**
  53541. * Defines One Image in the file. It requires only the position in the file
  53542. * as well as the length.
  53543. */
  53544. interface BufferImageData {
  53545. /**
  53546. * Length of the image data.
  53547. */
  53548. length: number;
  53549. /**
  53550. * Position of the data from the null terminator delimiting the end of the JSON.
  53551. */
  53552. position: number;
  53553. }
  53554. /**
  53555. * Defines the specular data enclosed in the file.
  53556. * This corresponds to the version 1 of the data.
  53557. */
  53558. export interface EnvironmentTextureSpecularInfoV1 {
  53559. /**
  53560. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  53561. */
  53562. specularDataPosition?: number;
  53563. /**
  53564. * This contains all the images data needed to reconstruct the cubemap.
  53565. */
  53566. mipmaps: Array<BufferImageData>;
  53567. /**
  53568. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  53569. */
  53570. lodGenerationScale: number;
  53571. }
  53572. /**
  53573. * Sets of helpers addressing the serialization and deserialization of environment texture
  53574. * stored in a BabylonJS env file.
  53575. * Those files are usually stored as .env files.
  53576. */
  53577. export class EnvironmentTextureTools {
  53578. /**
  53579. * Magic number identifying the env file.
  53580. */
  53581. private static _MagicBytes;
  53582. /**
  53583. * Gets the environment info from an env file.
  53584. * @param data The array buffer containing the .env bytes.
  53585. * @returns the environment file info (the json header) if successfully parsed.
  53586. */
  53587. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  53588. /**
  53589. * Creates an environment texture from a loaded cube texture.
  53590. * @param texture defines the cube texture to convert in env file
  53591. * @return a promise containing the environment data if succesfull.
  53592. */
  53593. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  53594. /**
  53595. * Creates a JSON representation of the spherical data.
  53596. * @param texture defines the texture containing the polynomials
  53597. * @return the JSON representation of the spherical info
  53598. */
  53599. private static _CreateEnvTextureIrradiance;
  53600. /**
  53601. * Creates the ArrayBufferViews used for initializing environment texture image data.
  53602. * @param data the image data
  53603. * @param info parameters that determine what views will be created for accessing the underlying buffer
  53604. * @return the views described by info providing access to the underlying buffer
  53605. */
  53606. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  53607. /**
  53608. * Uploads the texture info contained in the env file to the GPU.
  53609. * @param texture defines the internal texture to upload to
  53610. * @param data defines the data to load
  53611. * @param info defines the texture info retrieved through the GetEnvInfo method
  53612. * @returns a promise
  53613. */
  53614. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  53615. private static _OnImageReadyAsync;
  53616. /**
  53617. * Uploads the levels of image data to the GPU.
  53618. * @param texture defines the internal texture to upload to
  53619. * @param imageData defines the array buffer views of image data [mipmap][face]
  53620. * @returns a promise
  53621. */
  53622. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  53623. /**
  53624. * Uploads spherical polynomials information to the texture.
  53625. * @param texture defines the texture we are trying to upload the information to
  53626. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  53627. */
  53628. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  53629. /** @hidden */
  53630. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  53631. }
  53632. }
  53633. declare module "babylonjs/Engines/Native/nativeShaderProcessor" {
  53634. import { WebGL2ShaderProcessor } from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  53635. /** @hidden */
  53636. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  53637. private _genericAttributeLocation;
  53638. private _varyingLocationCount;
  53639. private _varyingLocationMap;
  53640. private _replacements;
  53641. private _textureCount;
  53642. private _uniforms;
  53643. lineProcessor(line: string): string;
  53644. attributeProcessor(attribute: string): string;
  53645. varyingProcessor(varying: string, isFragment: boolean): string;
  53646. uniformProcessor(uniform: string): string;
  53647. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  53648. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  53649. }
  53650. }
  53651. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  53652. /**
  53653. * Class used to inline functions in shader code
  53654. */
  53655. export class ShaderCodeInliner {
  53656. private static readonly _RegexpFindFunctionNameAndType;
  53657. private _sourceCode;
  53658. private _functionDescr;
  53659. private _numMaxIterations;
  53660. /** Gets or sets the token used to mark the functions to inline */
  53661. inlineToken: string;
  53662. /** Gets or sets the debug mode */
  53663. debug: boolean;
  53664. /** Gets the code after the inlining process */
  53665. get code(): string;
  53666. /**
  53667. * Initializes the inliner
  53668. * @param sourceCode shader code source to inline
  53669. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  53670. */
  53671. constructor(sourceCode: string, numMaxIterations?: number);
  53672. /**
  53673. * Start the processing of the shader code
  53674. */
  53675. processCode(): void;
  53676. private _collectFunctions;
  53677. private _processInlining;
  53678. private _extractBetweenMarkers;
  53679. private _skipWhitespaces;
  53680. private _removeComments;
  53681. private _replaceFunctionCallsByCode;
  53682. private _findBackward;
  53683. private _escapeRegExp;
  53684. private _replaceNames;
  53685. }
  53686. }
  53687. declare module "babylonjs/Engines/nativeEngine" {
  53688. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  53689. import { Engine } from "babylonjs/Engines/engine";
  53690. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53691. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53692. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53693. import { Effect } from "babylonjs/Materials/effect";
  53694. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53695. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  53696. import { IColor4Like } from "babylonjs/Maths/math.like";
  53697. import { Scene } from "babylonjs/scene";
  53698. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53699. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53700. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53701. /**
  53702. * Container for accessors for natively-stored mesh data buffers.
  53703. */
  53704. class NativeDataBuffer extends DataBuffer {
  53705. /**
  53706. * Accessor value used to identify/retrieve a natively-stored index buffer.
  53707. */
  53708. nativeIndexBuffer?: any;
  53709. /**
  53710. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  53711. */
  53712. nativeVertexBuffer?: any;
  53713. }
  53714. /** @hidden */
  53715. class NativeTexture extends InternalTexture {
  53716. getInternalTexture(): InternalTexture;
  53717. getViewCount(): number;
  53718. }
  53719. /** @hidden */
  53720. export class NativeEngine extends Engine {
  53721. private readonly _native;
  53722. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  53723. private readonly INVALID_HANDLE;
  53724. getHardwareScalingLevel(): number;
  53725. constructor();
  53726. dispose(): void;
  53727. /**
  53728. * Can be used to override the current requestAnimationFrame requester.
  53729. * @hidden
  53730. */
  53731. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  53732. /**
  53733. * Override default engine behavior.
  53734. * @param color
  53735. * @param backBuffer
  53736. * @param depth
  53737. * @param stencil
  53738. */
  53739. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  53740. /**
  53741. * Gets host document
  53742. * @returns the host document object
  53743. */
  53744. getHostDocument(): Nullable<Document>;
  53745. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53746. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  53747. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  53748. recordVertexArrayObject(vertexBuffers: {
  53749. [key: string]: VertexBuffer;
  53750. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  53751. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  53752. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  53753. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53754. /**
  53755. * Draw a list of indexed primitives
  53756. * @param fillMode defines the primitive to use
  53757. * @param indexStart defines the starting index
  53758. * @param indexCount defines the number of index to draw
  53759. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53760. */
  53761. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  53762. /**
  53763. * Draw a list of unindexed primitives
  53764. * @param fillMode defines the primitive to use
  53765. * @param verticesStart defines the index of first vertex to draw
  53766. * @param verticesCount defines the count of vertices to draw
  53767. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53768. */
  53769. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  53770. createPipelineContext(): IPipelineContext;
  53771. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  53772. /** @hidden */
  53773. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  53774. /** @hidden */
  53775. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  53776. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  53777. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  53778. protected _setProgram(program: WebGLProgram): void;
  53779. _releaseEffect(effect: Effect): void;
  53780. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  53781. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  53782. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  53783. bindSamplers(effect: Effect): void;
  53784. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  53785. getRenderWidth(useScreen?: boolean): number;
  53786. getRenderHeight(useScreen?: boolean): number;
  53787. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  53788. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53789. /**
  53790. * Set the z offset to apply to current rendering
  53791. * @param value defines the offset to apply
  53792. */
  53793. setZOffset(value: number): void;
  53794. /**
  53795. * Gets the current value of the zOffset
  53796. * @returns the current zOffset state
  53797. */
  53798. getZOffset(): number;
  53799. /**
  53800. * Enable or disable depth buffering
  53801. * @param enable defines the state to set
  53802. */
  53803. setDepthBuffer(enable: boolean): void;
  53804. /**
  53805. * Gets a boolean indicating if depth writing is enabled
  53806. * @returns the current depth writing state
  53807. */
  53808. getDepthWrite(): boolean;
  53809. /**
  53810. * Enable or disable depth writing
  53811. * @param enable defines the state to set
  53812. */
  53813. setDepthWrite(enable: boolean): void;
  53814. /**
  53815. * Enable or disable color writing
  53816. * @param enable defines the state to set
  53817. */
  53818. setColorWrite(enable: boolean): void;
  53819. /**
  53820. * Gets a boolean indicating if color writing is enabled
  53821. * @returns the current color writing state
  53822. */
  53823. getColorWrite(): boolean;
  53824. /**
  53825. * Sets alpha constants used by some alpha blending modes
  53826. * @param r defines the red component
  53827. * @param g defines the green component
  53828. * @param b defines the blue component
  53829. * @param a defines the alpha component
  53830. */
  53831. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  53832. /**
  53833. * Sets the current alpha mode
  53834. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  53835. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  53836. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  53837. */
  53838. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  53839. /**
  53840. * Gets the current alpha mode
  53841. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  53842. * @returns the current alpha mode
  53843. */
  53844. getAlphaMode(): number;
  53845. setInt(uniform: WebGLUniformLocation, int: number): void;
  53846. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53847. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53848. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53849. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53850. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53851. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53852. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53853. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53854. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  53855. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  53856. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  53857. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  53858. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  53859. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53860. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53861. setFloat(uniform: WebGLUniformLocation, value: number): void;
  53862. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  53863. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  53864. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  53865. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  53866. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  53867. wipeCaches(bruteForce?: boolean): void;
  53868. _createTexture(): WebGLTexture;
  53869. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  53870. /**
  53871. * Usually called from Texture.ts.
  53872. * Passed information to create a WebGLTexture
  53873. * @param url defines a value which contains one of the following:
  53874. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  53875. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  53876. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  53877. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  53878. * @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)
  53879. * @param scene needed for loading to the correct scene
  53880. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  53881. * @param onLoad optional callback to be called upon successful completion
  53882. * @param onError optional callback to be called upon failure
  53883. * @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
  53884. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  53885. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  53886. * @param forcedExtension defines the extension to use to pick the right loader
  53887. * @param mimeType defines an optional mime type
  53888. * @returns a InternalTexture for assignment back into BABYLON.Texture
  53889. */
  53890. createTexture(url: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string): InternalTexture;
  53891. /**
  53892. * Creates a cube texture
  53893. * @param rootUrl defines the url where the files to load is located
  53894. * @param scene defines the current scene
  53895. * @param files defines the list of files to load (1 per face)
  53896. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  53897. * @param onLoad defines an optional callback raised when the texture is loaded
  53898. * @param onError defines an optional callback raised if there is an issue to load the texture
  53899. * @param format defines the format of the data
  53900. * @param forcedExtension defines the extension to use to pick the right loader
  53901. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  53902. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  53903. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  53904. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  53905. * @returns the cube texture as an InternalTexture
  53906. */
  53907. 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;
  53908. private _getSamplingFilter;
  53909. private static _GetNativeTextureFormat;
  53910. createRenderTargetTexture(size: number | {
  53911. width: number;
  53912. height: number;
  53913. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  53914. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  53915. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  53916. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  53917. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  53918. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  53919. /**
  53920. * Updates a dynamic vertex buffer.
  53921. * @param vertexBuffer the vertex buffer to update
  53922. * @param data the data used to update the vertex buffer
  53923. * @param byteOffset the byte offset of the data (optional)
  53924. * @param byteLength the byte length of the data (optional)
  53925. */
  53926. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  53927. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  53928. private _updateAnisotropicLevel;
  53929. private _getAddressMode;
  53930. /** @hidden */
  53931. _bindTexture(channel: number, texture: InternalTexture): void;
  53932. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  53933. releaseEffects(): void;
  53934. /** @hidden */
  53935. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  53936. /** @hidden */
  53937. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  53938. /** @hidden */
  53939. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  53940. /** @hidden */
  53941. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  53942. }
  53943. }
  53944. declare module "babylonjs/Engines/index" {
  53945. export * from "babylonjs/Engines/constants";
  53946. export * from "babylonjs/Engines/engineCapabilities";
  53947. export * from "babylonjs/Engines/instancingAttributeInfo";
  53948. export * from "babylonjs/Engines/thinEngine";
  53949. export * from "babylonjs/Engines/engine";
  53950. export * from "babylonjs/Engines/engineStore";
  53951. export * from "babylonjs/Engines/nullEngine";
  53952. export * from "babylonjs/Engines/Extensions/index";
  53953. export * from "babylonjs/Engines/IPipelineContext";
  53954. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  53955. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  53956. export * from "babylonjs/Engines/nativeEngine";
  53957. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  53958. }
  53959. declare module "babylonjs/Events/clipboardEvents" {
  53960. /**
  53961. * Gather the list of clipboard event types as constants.
  53962. */
  53963. export class ClipboardEventTypes {
  53964. /**
  53965. * The clipboard event is fired when a copy command is active (pressed).
  53966. */
  53967. static readonly COPY: number;
  53968. /**
  53969. * The clipboard event is fired when a cut command is active (pressed).
  53970. */
  53971. static readonly CUT: number;
  53972. /**
  53973. * The clipboard event is fired when a paste command is active (pressed).
  53974. */
  53975. static readonly PASTE: number;
  53976. }
  53977. /**
  53978. * This class is used to store clipboard related info for the onClipboardObservable event.
  53979. */
  53980. export class ClipboardInfo {
  53981. /**
  53982. * Defines the type of event (BABYLON.ClipboardEventTypes)
  53983. */
  53984. type: number;
  53985. /**
  53986. * Defines the related dom event
  53987. */
  53988. event: ClipboardEvent;
  53989. /**
  53990. *Creates an instance of ClipboardInfo.
  53991. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  53992. * @param event Defines the related dom event
  53993. */
  53994. constructor(
  53995. /**
  53996. * Defines the type of event (BABYLON.ClipboardEventTypes)
  53997. */
  53998. type: number,
  53999. /**
  54000. * Defines the related dom event
  54001. */
  54002. event: ClipboardEvent);
  54003. /**
  54004. * Get the clipboard event's type from the keycode.
  54005. * @param keyCode Defines the keyCode for the current keyboard event.
  54006. * @return {number}
  54007. */
  54008. static GetTypeFromCharacter(keyCode: number): number;
  54009. }
  54010. }
  54011. declare module "babylonjs/Events/index" {
  54012. export * from "babylonjs/Events/keyboardEvents";
  54013. export * from "babylonjs/Events/pointerEvents";
  54014. export * from "babylonjs/Events/clipboardEvents";
  54015. }
  54016. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  54017. import { Scene } from "babylonjs/scene";
  54018. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54019. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54020. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54021. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54022. /**
  54023. * Google Daydream controller
  54024. */
  54025. export class DaydreamController extends WebVRController {
  54026. /**
  54027. * Base Url for the controller model.
  54028. */
  54029. static MODEL_BASE_URL: string;
  54030. /**
  54031. * File name for the controller model.
  54032. */
  54033. static MODEL_FILENAME: string;
  54034. /**
  54035. * Gamepad Id prefix used to identify Daydream Controller.
  54036. */
  54037. static readonly GAMEPAD_ID_PREFIX: string;
  54038. /**
  54039. * Creates a new DaydreamController from a gamepad
  54040. * @param vrGamepad the gamepad that the controller should be created from
  54041. */
  54042. constructor(vrGamepad: any);
  54043. /**
  54044. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54045. * @param scene scene in which to add meshes
  54046. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54047. */
  54048. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54049. /**
  54050. * Called once for each button that changed state since the last frame
  54051. * @param buttonIdx Which button index changed
  54052. * @param state New state of the button
  54053. * @param changes Which properties on the state changed since last frame
  54054. */
  54055. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54056. }
  54057. }
  54058. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  54059. import { Scene } from "babylonjs/scene";
  54060. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54061. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54062. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54063. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54064. /**
  54065. * Gear VR Controller
  54066. */
  54067. export class GearVRController extends WebVRController {
  54068. /**
  54069. * Base Url for the controller model.
  54070. */
  54071. static MODEL_BASE_URL: string;
  54072. /**
  54073. * File name for the controller model.
  54074. */
  54075. static MODEL_FILENAME: string;
  54076. /**
  54077. * Gamepad Id prefix used to identify this controller.
  54078. */
  54079. static readonly GAMEPAD_ID_PREFIX: string;
  54080. private readonly _buttonIndexToObservableNameMap;
  54081. /**
  54082. * Creates a new GearVRController from a gamepad
  54083. * @param vrGamepad the gamepad that the controller should be created from
  54084. */
  54085. constructor(vrGamepad: any);
  54086. /**
  54087. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54088. * @param scene scene in which to add meshes
  54089. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54090. */
  54091. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54092. /**
  54093. * Called once for each button that changed state since the last frame
  54094. * @param buttonIdx Which button index changed
  54095. * @param state New state of the button
  54096. * @param changes Which properties on the state changed since last frame
  54097. */
  54098. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54099. }
  54100. }
  54101. declare module "babylonjs/Gamepads/Controllers/genericController" {
  54102. import { Scene } from "babylonjs/scene";
  54103. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54104. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54105. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54106. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54107. /**
  54108. * Generic Controller
  54109. */
  54110. export class GenericController extends WebVRController {
  54111. /**
  54112. * Base Url for the controller model.
  54113. */
  54114. static readonly MODEL_BASE_URL: string;
  54115. /**
  54116. * File name for the controller model.
  54117. */
  54118. static readonly MODEL_FILENAME: string;
  54119. /**
  54120. * Creates a new GenericController from a gamepad
  54121. * @param vrGamepad the gamepad that the controller should be created from
  54122. */
  54123. constructor(vrGamepad: any);
  54124. /**
  54125. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54126. * @param scene scene in which to add meshes
  54127. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54128. */
  54129. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54130. /**
  54131. * Called once for each button that changed state since the last frame
  54132. * @param buttonIdx Which button index changed
  54133. * @param state New state of the button
  54134. * @param changes Which properties on the state changed since last frame
  54135. */
  54136. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54137. }
  54138. }
  54139. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  54140. import { Observable } from "babylonjs/Misc/observable";
  54141. import { Scene } from "babylonjs/scene";
  54142. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54143. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54144. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54145. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54146. /**
  54147. * Oculus Touch Controller
  54148. */
  54149. export class OculusTouchController extends WebVRController {
  54150. /**
  54151. * Base Url for the controller model.
  54152. */
  54153. static MODEL_BASE_URL: string;
  54154. /**
  54155. * File name for the left controller model.
  54156. */
  54157. static MODEL_LEFT_FILENAME: string;
  54158. /**
  54159. * File name for the right controller model.
  54160. */
  54161. static MODEL_RIGHT_FILENAME: string;
  54162. /**
  54163. * Base Url for the Quest controller model.
  54164. */
  54165. static QUEST_MODEL_BASE_URL: string;
  54166. /**
  54167. * @hidden
  54168. * If the controllers are running on a device that needs the updated Quest controller models
  54169. */
  54170. static _IsQuest: boolean;
  54171. /**
  54172. * Fired when the secondary trigger on this controller is modified
  54173. */
  54174. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  54175. /**
  54176. * Fired when the thumb rest on this controller is modified
  54177. */
  54178. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  54179. /**
  54180. * Creates a new OculusTouchController from a gamepad
  54181. * @param vrGamepad the gamepad that the controller should be created from
  54182. */
  54183. constructor(vrGamepad: any);
  54184. /**
  54185. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54186. * @param scene scene in which to add meshes
  54187. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54188. */
  54189. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54190. /**
  54191. * Fired when the A button on this controller is modified
  54192. */
  54193. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54194. /**
  54195. * Fired when the B button on this controller is modified
  54196. */
  54197. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54198. /**
  54199. * Fired when the X button on this controller is modified
  54200. */
  54201. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54202. /**
  54203. * Fired when the Y button on this controller is modified
  54204. */
  54205. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54206. /**
  54207. * Called once for each button that changed state since the last frame
  54208. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  54209. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  54210. * 2) secondary trigger (same)
  54211. * 3) A (right) X (left), touch, pressed = value
  54212. * 4) B / Y
  54213. * 5) thumb rest
  54214. * @param buttonIdx Which button index changed
  54215. * @param state New state of the button
  54216. * @param changes Which properties on the state changed since last frame
  54217. */
  54218. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54219. }
  54220. }
  54221. declare module "babylonjs/Gamepads/Controllers/viveController" {
  54222. import { Scene } from "babylonjs/scene";
  54223. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54224. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54225. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54226. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54227. import { Observable } from "babylonjs/Misc/observable";
  54228. /**
  54229. * Vive Controller
  54230. */
  54231. export class ViveController extends WebVRController {
  54232. /**
  54233. * Base Url for the controller model.
  54234. */
  54235. static MODEL_BASE_URL: string;
  54236. /**
  54237. * File name for the controller model.
  54238. */
  54239. static MODEL_FILENAME: string;
  54240. /**
  54241. * Creates a new ViveController from a gamepad
  54242. * @param vrGamepad the gamepad that the controller should be created from
  54243. */
  54244. constructor(vrGamepad: any);
  54245. /**
  54246. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54247. * @param scene scene in which to add meshes
  54248. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54249. */
  54250. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54251. /**
  54252. * Fired when the left button on this controller is modified
  54253. */
  54254. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54255. /**
  54256. * Fired when the right button on this controller is modified
  54257. */
  54258. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54259. /**
  54260. * Fired when the menu button on this controller is modified
  54261. */
  54262. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54263. /**
  54264. * Called once for each button that changed state since the last frame
  54265. * Vive mapping:
  54266. * 0: touchpad
  54267. * 1: trigger
  54268. * 2: left AND right buttons
  54269. * 3: menu button
  54270. * @param buttonIdx Which button index changed
  54271. * @param state New state of the button
  54272. * @param changes Which properties on the state changed since last frame
  54273. */
  54274. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54275. }
  54276. }
  54277. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  54278. import { Observable } from "babylonjs/Misc/observable";
  54279. import { Scene } from "babylonjs/scene";
  54280. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54281. import { Ray } from "babylonjs/Culling/ray";
  54282. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54283. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54284. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54285. /**
  54286. * Defines the WindowsMotionController object that the state of the windows motion controller
  54287. */
  54288. export class WindowsMotionController extends WebVRController {
  54289. /**
  54290. * The base url used to load the left and right controller models
  54291. */
  54292. static MODEL_BASE_URL: string;
  54293. /**
  54294. * The name of the left controller model file
  54295. */
  54296. static MODEL_LEFT_FILENAME: string;
  54297. /**
  54298. * The name of the right controller model file
  54299. */
  54300. static MODEL_RIGHT_FILENAME: string;
  54301. /**
  54302. * The controller name prefix for this controller type
  54303. */
  54304. static readonly GAMEPAD_ID_PREFIX: string;
  54305. /**
  54306. * The controller id pattern for this controller type
  54307. */
  54308. private static readonly GAMEPAD_ID_PATTERN;
  54309. private _loadedMeshInfo;
  54310. protected readonly _mapping: {
  54311. buttons: string[];
  54312. buttonMeshNames: {
  54313. trigger: string;
  54314. menu: string;
  54315. grip: string;
  54316. thumbstick: string;
  54317. trackpad: string;
  54318. };
  54319. buttonObservableNames: {
  54320. trigger: string;
  54321. menu: string;
  54322. grip: string;
  54323. thumbstick: string;
  54324. trackpad: string;
  54325. };
  54326. axisMeshNames: string[];
  54327. pointingPoseMeshName: string;
  54328. };
  54329. /**
  54330. * Fired when the trackpad on this controller is clicked
  54331. */
  54332. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  54333. /**
  54334. * Fired when the trackpad on this controller is modified
  54335. */
  54336. onTrackpadValuesChangedObservable: Observable<StickValues>;
  54337. /**
  54338. * The current x and y values of this controller's trackpad
  54339. */
  54340. trackpad: StickValues;
  54341. /**
  54342. * Creates a new WindowsMotionController from a gamepad
  54343. * @param vrGamepad the gamepad that the controller should be created from
  54344. */
  54345. constructor(vrGamepad: any);
  54346. /**
  54347. * Fired when the trigger on this controller is modified
  54348. */
  54349. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54350. /**
  54351. * Fired when the menu button on this controller is modified
  54352. */
  54353. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54354. /**
  54355. * Fired when the grip button on this controller is modified
  54356. */
  54357. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54358. /**
  54359. * Fired when the thumbstick button on this controller is modified
  54360. */
  54361. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54362. /**
  54363. * Fired when the touchpad button on this controller is modified
  54364. */
  54365. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54366. /**
  54367. * Fired when the touchpad values on this controller are modified
  54368. */
  54369. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  54370. protected _updateTrackpad(): void;
  54371. /**
  54372. * Called once per frame by the engine.
  54373. */
  54374. update(): void;
  54375. /**
  54376. * Called once for each button that changed state since the last frame
  54377. * @param buttonIdx Which button index changed
  54378. * @param state New state of the button
  54379. * @param changes Which properties on the state changed since last frame
  54380. */
  54381. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54382. /**
  54383. * Moves the buttons on the controller mesh based on their current state
  54384. * @param buttonName the name of the button to move
  54385. * @param buttonValue the value of the button which determines the buttons new position
  54386. */
  54387. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  54388. /**
  54389. * Moves the axis on the controller mesh based on its current state
  54390. * @param axis the index of the axis
  54391. * @param axisValue the value of the axis which determines the meshes new position
  54392. * @hidden
  54393. */
  54394. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  54395. /**
  54396. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54397. * @param scene scene in which to add meshes
  54398. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54399. */
  54400. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  54401. /**
  54402. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  54403. * can be transformed by button presses and axes values, based on this._mapping.
  54404. *
  54405. * @param scene scene in which the meshes exist
  54406. * @param meshes list of meshes that make up the controller model to process
  54407. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  54408. */
  54409. private processModel;
  54410. private createMeshInfo;
  54411. /**
  54412. * Gets the ray of the controller in the direction the controller is pointing
  54413. * @param length the length the resulting ray should be
  54414. * @returns a ray in the direction the controller is pointing
  54415. */
  54416. getForwardRay(length?: number): Ray;
  54417. /**
  54418. * Disposes of the controller
  54419. */
  54420. dispose(): void;
  54421. }
  54422. /**
  54423. * This class represents a new windows motion controller in XR.
  54424. */
  54425. export class XRWindowsMotionController extends WindowsMotionController {
  54426. /**
  54427. * Changing the original WIndowsMotionController mapping to fir the new mapping
  54428. */
  54429. protected readonly _mapping: {
  54430. buttons: string[];
  54431. buttonMeshNames: {
  54432. trigger: string;
  54433. menu: string;
  54434. grip: string;
  54435. thumbstick: string;
  54436. trackpad: string;
  54437. };
  54438. buttonObservableNames: {
  54439. trigger: string;
  54440. menu: string;
  54441. grip: string;
  54442. thumbstick: string;
  54443. trackpad: string;
  54444. };
  54445. axisMeshNames: string[];
  54446. pointingPoseMeshName: string;
  54447. };
  54448. /**
  54449. * Construct a new XR-Based windows motion controller
  54450. *
  54451. * @param gamepadInfo the gamepad object from the browser
  54452. */
  54453. constructor(gamepadInfo: any);
  54454. /**
  54455. * holds the thumbstick values (X,Y)
  54456. */
  54457. thumbstickValues: StickValues;
  54458. /**
  54459. * Fired when the thumbstick on this controller is clicked
  54460. */
  54461. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  54462. /**
  54463. * Fired when the thumbstick on this controller is modified
  54464. */
  54465. onThumbstickValuesChangedObservable: Observable<StickValues>;
  54466. /**
  54467. * Fired when the touchpad button on this controller is modified
  54468. */
  54469. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  54470. /**
  54471. * Fired when the touchpad values on this controller are modified
  54472. */
  54473. onTrackpadValuesChangedObservable: Observable<StickValues>;
  54474. /**
  54475. * Fired when the thumbstick button on this controller is modified
  54476. * here to prevent breaking changes
  54477. */
  54478. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54479. /**
  54480. * updating the thumbstick(!) and not the trackpad.
  54481. * This is named this way due to the difference between WebVR and XR and to avoid
  54482. * changing the parent class.
  54483. */
  54484. protected _updateTrackpad(): void;
  54485. /**
  54486. * Disposes the class with joy
  54487. */
  54488. dispose(): void;
  54489. }
  54490. }
  54491. declare module "babylonjs/Gamepads/Controllers/index" {
  54492. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  54493. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  54494. export * from "babylonjs/Gamepads/Controllers/genericController";
  54495. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  54496. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54497. export * from "babylonjs/Gamepads/Controllers/viveController";
  54498. export * from "babylonjs/Gamepads/Controllers/webVRController";
  54499. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  54500. }
  54501. declare module "babylonjs/Gamepads/index" {
  54502. export * from "babylonjs/Gamepads/Controllers/index";
  54503. export * from "babylonjs/Gamepads/gamepad";
  54504. export * from "babylonjs/Gamepads/gamepadManager";
  54505. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  54506. export * from "babylonjs/Gamepads/xboxGamepad";
  54507. export * from "babylonjs/Gamepads/dualShockGamepad";
  54508. }
  54509. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  54510. import { Scene } from "babylonjs/scene";
  54511. import { Vector4 } from "babylonjs/Maths/math.vector";
  54512. import { Color4 } from "babylonjs/Maths/math.color";
  54513. import { Mesh } from "babylonjs/Meshes/mesh";
  54514. import { Nullable } from "babylonjs/types";
  54515. /**
  54516. * Class containing static functions to help procedurally build meshes
  54517. */
  54518. export class PolyhedronBuilder {
  54519. /**
  54520. * Creates a polyhedron mesh
  54521. * * 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
  54522. * * The parameter `size` (positive float, default 1) sets the polygon size
  54523. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  54524. * * 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`
  54525. * * 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
  54526. * * 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)`)
  54527. * * 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
  54528. * * 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
  54529. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54530. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54531. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54532. * @param name defines the name of the mesh
  54533. * @param options defines the options used to create the mesh
  54534. * @param scene defines the hosting scene
  54535. * @returns the polyhedron mesh
  54536. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  54537. */
  54538. static CreatePolyhedron(name: string, options: {
  54539. type?: number;
  54540. size?: number;
  54541. sizeX?: number;
  54542. sizeY?: number;
  54543. sizeZ?: number;
  54544. custom?: any;
  54545. faceUV?: Vector4[];
  54546. faceColors?: Color4[];
  54547. flat?: boolean;
  54548. updatable?: boolean;
  54549. sideOrientation?: number;
  54550. frontUVs?: Vector4;
  54551. backUVs?: Vector4;
  54552. }, scene?: Nullable<Scene>): Mesh;
  54553. }
  54554. }
  54555. declare module "babylonjs/Gizmos/scaleGizmo" {
  54556. import { Observable } from "babylonjs/Misc/observable";
  54557. import { Nullable } from "babylonjs/types";
  54558. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54559. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  54560. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  54561. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  54562. /**
  54563. * Gizmo that enables scaling a mesh along 3 axis
  54564. */
  54565. export class ScaleGizmo extends Gizmo {
  54566. /**
  54567. * Internal gizmo used for interactions on the x axis
  54568. */
  54569. xGizmo: AxisScaleGizmo;
  54570. /**
  54571. * Internal gizmo used for interactions on the y axis
  54572. */
  54573. yGizmo: AxisScaleGizmo;
  54574. /**
  54575. * Internal gizmo used for interactions on the z axis
  54576. */
  54577. zGizmo: AxisScaleGizmo;
  54578. /**
  54579. * Internal gizmo used to scale all axis equally
  54580. */
  54581. uniformScaleGizmo: AxisScaleGizmo;
  54582. private _meshAttached;
  54583. private _updateGizmoRotationToMatchAttachedMesh;
  54584. private _snapDistance;
  54585. private _scaleRatio;
  54586. private _uniformScalingMesh;
  54587. private _octahedron;
  54588. private _sensitivity;
  54589. /** Fires an event when any of it's sub gizmos are dragged */
  54590. onDragStartObservable: Observable<unknown>;
  54591. /** Fires an event when any of it's sub gizmos are released from dragging */
  54592. onDragEndObservable: Observable<unknown>;
  54593. get attachedMesh(): Nullable<AbstractMesh>;
  54594. set attachedMesh(mesh: Nullable<AbstractMesh>);
  54595. /**
  54596. * Creates a ScaleGizmo
  54597. * @param gizmoLayer The utility layer the gizmo will be added to
  54598. */
  54599. constructor(gizmoLayer?: UtilityLayerRenderer);
  54600. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  54601. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  54602. /**
  54603. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  54604. */
  54605. set snapDistance(value: number);
  54606. get snapDistance(): number;
  54607. /**
  54608. * Ratio for the scale of the gizmo (Default: 1)
  54609. */
  54610. set scaleRatio(value: number);
  54611. get scaleRatio(): number;
  54612. /**
  54613. * Sensitivity factor for dragging (Default: 1)
  54614. */
  54615. set sensitivity(value: number);
  54616. get sensitivity(): number;
  54617. /**
  54618. * Disposes of the gizmo
  54619. */
  54620. dispose(): void;
  54621. }
  54622. }
  54623. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  54624. import { Observable } from "babylonjs/Misc/observable";
  54625. import { Nullable } from "babylonjs/types";
  54626. import { Vector3 } from "babylonjs/Maths/math.vector";
  54627. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54628. import { Mesh } from "babylonjs/Meshes/mesh";
  54629. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  54630. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  54631. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  54632. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  54633. import { Color3 } from "babylonjs/Maths/math.color";
  54634. /**
  54635. * Single axis scale gizmo
  54636. */
  54637. export class AxisScaleGizmo extends Gizmo {
  54638. /**
  54639. * Drag behavior responsible for the gizmos dragging interactions
  54640. */
  54641. dragBehavior: PointerDragBehavior;
  54642. private _pointerObserver;
  54643. /**
  54644. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  54645. */
  54646. snapDistance: number;
  54647. /**
  54648. * Event that fires each time the gizmo snaps to a new location.
  54649. * * snapDistance is the the change in distance
  54650. */
  54651. onSnapObservable: Observable<{
  54652. snapDistance: number;
  54653. }>;
  54654. /**
  54655. * If the scaling operation should be done on all axis (default: false)
  54656. */
  54657. uniformScaling: boolean;
  54658. /**
  54659. * Custom sensitivity value for the drag strength
  54660. */
  54661. sensitivity: number;
  54662. private _isEnabled;
  54663. private _parent;
  54664. private _arrow;
  54665. private _coloredMaterial;
  54666. private _hoverMaterial;
  54667. /**
  54668. * Creates an AxisScaleGizmo
  54669. * @param gizmoLayer The utility layer the gizmo will be added to
  54670. * @param dragAxis The axis which the gizmo will be able to scale on
  54671. * @param color The color of the gizmo
  54672. */
  54673. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  54674. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  54675. /**
  54676. * If the gizmo is enabled
  54677. */
  54678. set isEnabled(value: boolean);
  54679. get isEnabled(): boolean;
  54680. /**
  54681. * Disposes of the gizmo
  54682. */
  54683. dispose(): void;
  54684. /**
  54685. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  54686. * @param mesh The mesh to replace the default mesh of the gizmo
  54687. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  54688. */
  54689. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  54690. }
  54691. }
  54692. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  54693. import { Observable } from "babylonjs/Misc/observable";
  54694. import { Nullable } from "babylonjs/types";
  54695. import { Vector3 } from "babylonjs/Maths/math.vector";
  54696. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54697. import { Mesh } from "babylonjs/Meshes/mesh";
  54698. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  54699. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  54700. import { Color3 } from "babylonjs/Maths/math.color";
  54701. import "babylonjs/Meshes/Builders/boxBuilder";
  54702. /**
  54703. * Bounding box gizmo
  54704. */
  54705. export class BoundingBoxGizmo extends Gizmo {
  54706. private _lineBoundingBox;
  54707. private _rotateSpheresParent;
  54708. private _scaleBoxesParent;
  54709. private _boundingDimensions;
  54710. private _renderObserver;
  54711. private _pointerObserver;
  54712. private _scaleDragSpeed;
  54713. private _tmpQuaternion;
  54714. private _tmpVector;
  54715. private _tmpRotationMatrix;
  54716. /**
  54717. * 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)
  54718. */
  54719. ignoreChildren: boolean;
  54720. /**
  54721. * 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)
  54722. */
  54723. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  54724. /**
  54725. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  54726. */
  54727. rotationSphereSize: number;
  54728. /**
  54729. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  54730. */
  54731. scaleBoxSize: number;
  54732. /**
  54733. * 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)
  54734. */
  54735. fixedDragMeshScreenSize: boolean;
  54736. /**
  54737. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  54738. */
  54739. fixedDragMeshScreenSizeDistanceFactor: number;
  54740. /**
  54741. * Fired when a rotation sphere or scale box is dragged
  54742. */
  54743. onDragStartObservable: Observable<{}>;
  54744. /**
  54745. * Fired when a scale box is dragged
  54746. */
  54747. onScaleBoxDragObservable: Observable<{}>;
  54748. /**
  54749. * Fired when a scale box drag is ended
  54750. */
  54751. onScaleBoxDragEndObservable: Observable<{}>;
  54752. /**
  54753. * Fired when a rotation sphere is dragged
  54754. */
  54755. onRotationSphereDragObservable: Observable<{}>;
  54756. /**
  54757. * Fired when a rotation sphere drag is ended
  54758. */
  54759. onRotationSphereDragEndObservable: Observable<{}>;
  54760. /**
  54761. * 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)
  54762. */
  54763. scalePivot: Nullable<Vector3>;
  54764. /**
  54765. * Mesh used as a pivot to rotate the attached mesh
  54766. */
  54767. private _anchorMesh;
  54768. private _existingMeshScale;
  54769. private _dragMesh;
  54770. private pointerDragBehavior;
  54771. private coloredMaterial;
  54772. private hoverColoredMaterial;
  54773. /**
  54774. * Sets the color of the bounding box gizmo
  54775. * @param color the color to set
  54776. */
  54777. setColor(color: Color3): void;
  54778. /**
  54779. * Creates an BoundingBoxGizmo
  54780. * @param gizmoLayer The utility layer the gizmo will be added to
  54781. * @param color The color of the gizmo
  54782. */
  54783. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  54784. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  54785. private _selectNode;
  54786. /**
  54787. * Updates the bounding box information for the Gizmo
  54788. */
  54789. updateBoundingBox(): void;
  54790. private _updateRotationSpheres;
  54791. private _updateScaleBoxes;
  54792. /**
  54793. * Enables rotation on the specified axis and disables rotation on the others
  54794. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  54795. */
  54796. setEnabledRotationAxis(axis: string): void;
  54797. /**
  54798. * Enables/disables scaling
  54799. * @param enable if scaling should be enabled
  54800. * @param homogeneousScaling defines if scaling should only be homogeneous
  54801. */
  54802. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  54803. private _updateDummy;
  54804. /**
  54805. * Enables a pointer drag behavior on the bounding box of the gizmo
  54806. */
  54807. enableDragBehavior(): void;
  54808. /**
  54809. * Disposes of the gizmo
  54810. */
  54811. dispose(): void;
  54812. /**
  54813. * 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)
  54814. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  54815. * @returns the bounding box mesh with the passed in mesh as a child
  54816. */
  54817. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  54818. /**
  54819. * CustomMeshes are not supported by this gizmo
  54820. * @param mesh The mesh to replace the default mesh of the gizmo
  54821. */
  54822. setCustomMesh(mesh: Mesh): void;
  54823. }
  54824. }
  54825. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  54826. import { Observable } from "babylonjs/Misc/observable";
  54827. import { Nullable } from "babylonjs/types";
  54828. import { Vector3 } from "babylonjs/Maths/math.vector";
  54829. import { Color3 } from "babylonjs/Maths/math.color";
  54830. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54831. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  54832. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  54833. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  54834. import "babylonjs/Meshes/Builders/linesBuilder";
  54835. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  54836. /**
  54837. * Single plane rotation gizmo
  54838. */
  54839. export class PlaneRotationGizmo extends Gizmo {
  54840. /**
  54841. * Drag behavior responsible for the gizmos dragging interactions
  54842. */
  54843. dragBehavior: PointerDragBehavior;
  54844. private _pointerObserver;
  54845. /**
  54846. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  54847. */
  54848. snapDistance: number;
  54849. /**
  54850. * Event that fires each time the gizmo snaps to a new location.
  54851. * * snapDistance is the the change in distance
  54852. */
  54853. onSnapObservable: Observable<{
  54854. snapDistance: number;
  54855. }>;
  54856. private _isEnabled;
  54857. private _parent;
  54858. /**
  54859. * Creates a PlaneRotationGizmo
  54860. * @param gizmoLayer The utility layer the gizmo will be added to
  54861. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  54862. * @param color The color of the gizmo
  54863. * @param tessellation Amount of tessellation to be used when creating rotation circles
  54864. * @param useEulerRotation Use and update Euler angle instead of quaternion
  54865. */
  54866. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  54867. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  54868. /**
  54869. * If the gizmo is enabled
  54870. */
  54871. set isEnabled(value: boolean);
  54872. get isEnabled(): boolean;
  54873. /**
  54874. * Disposes of the gizmo
  54875. */
  54876. dispose(): void;
  54877. }
  54878. }
  54879. declare module "babylonjs/Gizmos/rotationGizmo" {
  54880. import { Observable } from "babylonjs/Misc/observable";
  54881. import { Nullable } from "babylonjs/types";
  54882. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54883. import { Mesh } from "babylonjs/Meshes/mesh";
  54884. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  54885. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  54886. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  54887. /**
  54888. * Gizmo that enables rotating a mesh along 3 axis
  54889. */
  54890. export class RotationGizmo extends Gizmo {
  54891. /**
  54892. * Internal gizmo used for interactions on the x axis
  54893. */
  54894. xGizmo: PlaneRotationGizmo;
  54895. /**
  54896. * Internal gizmo used for interactions on the y axis
  54897. */
  54898. yGizmo: PlaneRotationGizmo;
  54899. /**
  54900. * Internal gizmo used for interactions on the z axis
  54901. */
  54902. zGizmo: PlaneRotationGizmo;
  54903. /** Fires an event when any of it's sub gizmos are dragged */
  54904. onDragStartObservable: Observable<unknown>;
  54905. /** Fires an event when any of it's sub gizmos are released from dragging */
  54906. onDragEndObservable: Observable<unknown>;
  54907. private _meshAttached;
  54908. get attachedMesh(): Nullable<AbstractMesh>;
  54909. set attachedMesh(mesh: Nullable<AbstractMesh>);
  54910. /**
  54911. * Creates a RotationGizmo
  54912. * @param gizmoLayer The utility layer the gizmo will be added to
  54913. * @param tessellation Amount of tessellation to be used when creating rotation circles
  54914. * @param useEulerRotation Use and update Euler angle instead of quaternion
  54915. */
  54916. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  54917. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  54918. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  54919. /**
  54920. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  54921. */
  54922. set snapDistance(value: number);
  54923. get snapDistance(): number;
  54924. /**
  54925. * Ratio for the scale of the gizmo (Default: 1)
  54926. */
  54927. set scaleRatio(value: number);
  54928. get scaleRatio(): number;
  54929. /**
  54930. * Disposes of the gizmo
  54931. */
  54932. dispose(): void;
  54933. /**
  54934. * CustomMeshes are not supported by this gizmo
  54935. * @param mesh The mesh to replace the default mesh of the gizmo
  54936. */
  54937. setCustomMesh(mesh: Mesh): void;
  54938. }
  54939. }
  54940. declare module "babylonjs/Gizmos/gizmoManager" {
  54941. import { Observable } from "babylonjs/Misc/observable";
  54942. import { Nullable } from "babylonjs/types";
  54943. import { Scene, IDisposable } from "babylonjs/scene";
  54944. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54945. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  54946. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  54947. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  54948. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  54949. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  54950. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  54951. /**
  54952. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  54953. */
  54954. export class GizmoManager implements IDisposable {
  54955. private scene;
  54956. /**
  54957. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  54958. */
  54959. gizmos: {
  54960. positionGizmo: Nullable<PositionGizmo>;
  54961. rotationGizmo: Nullable<RotationGizmo>;
  54962. scaleGizmo: Nullable<ScaleGizmo>;
  54963. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  54964. };
  54965. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  54966. clearGizmoOnEmptyPointerEvent: boolean;
  54967. /** Fires an event when the manager is attached to a mesh */
  54968. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  54969. private _gizmosEnabled;
  54970. private _pointerObserver;
  54971. private _attachedMesh;
  54972. private _boundingBoxColor;
  54973. private _defaultUtilityLayer;
  54974. private _defaultKeepDepthUtilityLayer;
  54975. /**
  54976. * When bounding box gizmo is enabled, this can be used to track drag/end events
  54977. */
  54978. boundingBoxDragBehavior: SixDofDragBehavior;
  54979. /**
  54980. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  54981. */
  54982. attachableMeshes: Nullable<Array<AbstractMesh>>;
  54983. /**
  54984. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  54985. */
  54986. usePointerToAttachGizmos: boolean;
  54987. /**
  54988. * Utility layer that the bounding box gizmo belongs to
  54989. */
  54990. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  54991. /**
  54992. * Utility layer that all gizmos besides bounding box belong to
  54993. */
  54994. get utilityLayer(): UtilityLayerRenderer;
  54995. /**
  54996. * Instatiates a gizmo manager
  54997. * @param scene the scene to overlay the gizmos on top of
  54998. */
  54999. constructor(scene: Scene);
  55000. /**
  55001. * Attaches a set of gizmos to the specified mesh
  55002. * @param mesh The mesh the gizmo's should be attached to
  55003. */
  55004. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  55005. /**
  55006. * If the position gizmo is enabled
  55007. */
  55008. set positionGizmoEnabled(value: boolean);
  55009. get positionGizmoEnabled(): boolean;
  55010. /**
  55011. * If the rotation gizmo is enabled
  55012. */
  55013. set rotationGizmoEnabled(value: boolean);
  55014. get rotationGizmoEnabled(): boolean;
  55015. /**
  55016. * If the scale gizmo is enabled
  55017. */
  55018. set scaleGizmoEnabled(value: boolean);
  55019. get scaleGizmoEnabled(): boolean;
  55020. /**
  55021. * If the boundingBox gizmo is enabled
  55022. */
  55023. set boundingBoxGizmoEnabled(value: boolean);
  55024. get boundingBoxGizmoEnabled(): boolean;
  55025. /**
  55026. * Disposes of the gizmo manager
  55027. */
  55028. dispose(): void;
  55029. }
  55030. }
  55031. declare module "babylonjs/Lights/directionalLight" {
  55032. import { Camera } from "babylonjs/Cameras/camera";
  55033. import { Scene } from "babylonjs/scene";
  55034. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  55035. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55036. import { Light } from "babylonjs/Lights/light";
  55037. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  55038. import { Effect } from "babylonjs/Materials/effect";
  55039. /**
  55040. * A directional light is defined by a direction (what a surprise!).
  55041. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  55042. * 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.
  55043. * Documentation: https://doc.babylonjs.com/babylon101/lights
  55044. */
  55045. export class DirectionalLight extends ShadowLight {
  55046. private _shadowFrustumSize;
  55047. /**
  55048. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  55049. */
  55050. get shadowFrustumSize(): number;
  55051. /**
  55052. * Specifies a fix frustum size for the shadow generation.
  55053. */
  55054. set shadowFrustumSize(value: number);
  55055. private _shadowOrthoScale;
  55056. /**
  55057. * Gets the shadow projection scale against the optimal computed one.
  55058. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  55059. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  55060. */
  55061. get shadowOrthoScale(): number;
  55062. /**
  55063. * Sets the shadow projection scale against the optimal computed one.
  55064. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  55065. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  55066. */
  55067. set shadowOrthoScale(value: number);
  55068. /**
  55069. * Automatically compute the projection matrix to best fit (including all the casters)
  55070. * on each frame.
  55071. */
  55072. autoUpdateExtends: boolean;
  55073. /**
  55074. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  55075. * on each frame. autoUpdateExtends must be set to true for this to work
  55076. */
  55077. autoCalcShadowZBounds: boolean;
  55078. private _orthoLeft;
  55079. private _orthoRight;
  55080. private _orthoTop;
  55081. private _orthoBottom;
  55082. /**
  55083. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  55084. * The directional light is emitted from everywhere in the given direction.
  55085. * It can cast shadows.
  55086. * Documentation : https://doc.babylonjs.com/babylon101/lights
  55087. * @param name The friendly name of the light
  55088. * @param direction The direction of the light
  55089. * @param scene The scene the light belongs to
  55090. */
  55091. constructor(name: string, direction: Vector3, scene: Scene);
  55092. /**
  55093. * Returns the string "DirectionalLight".
  55094. * @return The class name
  55095. */
  55096. getClassName(): string;
  55097. /**
  55098. * Returns the integer 1.
  55099. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  55100. */
  55101. getTypeID(): number;
  55102. /**
  55103. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  55104. * Returns the DirectionalLight Shadow projection matrix.
  55105. */
  55106. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  55107. /**
  55108. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  55109. * Returns the DirectionalLight Shadow projection matrix.
  55110. */
  55111. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  55112. /**
  55113. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  55114. * Returns the DirectionalLight Shadow projection matrix.
  55115. */
  55116. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  55117. protected _buildUniformLayout(): void;
  55118. /**
  55119. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  55120. * @param effect The effect to update
  55121. * @param lightIndex The index of the light in the effect to update
  55122. * @returns The directional light
  55123. */
  55124. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  55125. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  55126. /**
  55127. * Gets the minZ used for shadow according to both the scene and the light.
  55128. *
  55129. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  55130. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  55131. * @param activeCamera The camera we are returning the min for
  55132. * @returns the depth min z
  55133. */
  55134. getDepthMinZ(activeCamera: Camera): number;
  55135. /**
  55136. * Gets the maxZ used for shadow according to both the scene and the light.
  55137. *
  55138. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  55139. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  55140. * @param activeCamera The camera we are returning the max for
  55141. * @returns the depth max z
  55142. */
  55143. getDepthMaxZ(activeCamera: Camera): number;
  55144. /**
  55145. * Prepares the list of defines specific to the light type.
  55146. * @param defines the list of defines
  55147. * @param lightIndex defines the index of the light for the effect
  55148. */
  55149. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  55150. }
  55151. }
  55152. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  55153. import { Mesh } from "babylonjs/Meshes/mesh";
  55154. /**
  55155. * Class containing static functions to help procedurally build meshes
  55156. */
  55157. export class HemisphereBuilder {
  55158. /**
  55159. * Creates a hemisphere mesh
  55160. * @param name defines the name of the mesh
  55161. * @param options defines the options used to create the mesh
  55162. * @param scene defines the hosting scene
  55163. * @returns the hemisphere mesh
  55164. */
  55165. static CreateHemisphere(name: string, options: {
  55166. segments?: number;
  55167. diameter?: number;
  55168. sideOrientation?: number;
  55169. }, scene: any): Mesh;
  55170. }
  55171. }
  55172. declare module "babylonjs/Lights/spotLight" {
  55173. import { Nullable } from "babylonjs/types";
  55174. import { Scene } from "babylonjs/scene";
  55175. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  55176. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55177. import { Effect } from "babylonjs/Materials/effect";
  55178. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55179. import { Light } from "babylonjs/Lights/light";
  55180. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  55181. /**
  55182. * A spot light is defined by a position, a direction, an angle, and an exponent.
  55183. * These values define a cone of light starting from the position, emitting toward the direction.
  55184. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  55185. * and the exponent defines the speed of the decay of the light with distance (reach).
  55186. * Documentation: https://doc.babylonjs.com/babylon101/lights
  55187. */
  55188. export class SpotLight extends ShadowLight {
  55189. private _angle;
  55190. private _innerAngle;
  55191. private _cosHalfAngle;
  55192. private _lightAngleScale;
  55193. private _lightAngleOffset;
  55194. /**
  55195. * Gets the cone angle of the spot light in Radians.
  55196. */
  55197. get angle(): number;
  55198. /**
  55199. * Sets the cone angle of the spot light in Radians.
  55200. */
  55201. set angle(value: number);
  55202. /**
  55203. * Only used in gltf falloff mode, this defines the angle where
  55204. * the directional falloff will start before cutting at angle which could be seen
  55205. * as outer angle.
  55206. */
  55207. get innerAngle(): number;
  55208. /**
  55209. * Only used in gltf falloff mode, this defines the angle where
  55210. * the directional falloff will start before cutting at angle which could be seen
  55211. * as outer angle.
  55212. */
  55213. set innerAngle(value: number);
  55214. private _shadowAngleScale;
  55215. /**
  55216. * Allows scaling the angle of the light for shadow generation only.
  55217. */
  55218. get shadowAngleScale(): number;
  55219. /**
  55220. * Allows scaling the angle of the light for shadow generation only.
  55221. */
  55222. set shadowAngleScale(value: number);
  55223. /**
  55224. * The light decay speed with the distance from the emission spot.
  55225. */
  55226. exponent: number;
  55227. private _projectionTextureMatrix;
  55228. /**
  55229. * Allows reading the projecton texture
  55230. */
  55231. get projectionTextureMatrix(): Matrix;
  55232. protected _projectionTextureLightNear: number;
  55233. /**
  55234. * Gets the near clip of the Spotlight for texture projection.
  55235. */
  55236. get projectionTextureLightNear(): number;
  55237. /**
  55238. * Sets the near clip of the Spotlight for texture projection.
  55239. */
  55240. set projectionTextureLightNear(value: number);
  55241. protected _projectionTextureLightFar: number;
  55242. /**
  55243. * Gets the far clip of the Spotlight for texture projection.
  55244. */
  55245. get projectionTextureLightFar(): number;
  55246. /**
  55247. * Sets the far clip of the Spotlight for texture projection.
  55248. */
  55249. set projectionTextureLightFar(value: number);
  55250. protected _projectionTextureUpDirection: Vector3;
  55251. /**
  55252. * Gets the Up vector of the Spotlight for texture projection.
  55253. */
  55254. get projectionTextureUpDirection(): Vector3;
  55255. /**
  55256. * Sets the Up vector of the Spotlight for texture projection.
  55257. */
  55258. set projectionTextureUpDirection(value: Vector3);
  55259. private _projectionTexture;
  55260. /**
  55261. * Gets the projection texture of the light.
  55262. */
  55263. get projectionTexture(): Nullable<BaseTexture>;
  55264. /**
  55265. * Sets the projection texture of the light.
  55266. */
  55267. set projectionTexture(value: Nullable<BaseTexture>);
  55268. private _projectionTextureViewLightDirty;
  55269. private _projectionTextureProjectionLightDirty;
  55270. private _projectionTextureDirty;
  55271. private _projectionTextureViewTargetVector;
  55272. private _projectionTextureViewLightMatrix;
  55273. private _projectionTextureProjectionLightMatrix;
  55274. private _projectionTextureScalingMatrix;
  55275. /**
  55276. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  55277. * It can cast shadows.
  55278. * Documentation : https://doc.babylonjs.com/babylon101/lights
  55279. * @param name The light friendly name
  55280. * @param position The position of the spot light in the scene
  55281. * @param direction The direction of the light in the scene
  55282. * @param angle The cone angle of the light in Radians
  55283. * @param exponent The light decay speed with the distance from the emission spot
  55284. * @param scene The scene the lights belongs to
  55285. */
  55286. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  55287. /**
  55288. * Returns the string "SpotLight".
  55289. * @returns the class name
  55290. */
  55291. getClassName(): string;
  55292. /**
  55293. * Returns the integer 2.
  55294. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  55295. */
  55296. getTypeID(): number;
  55297. /**
  55298. * Overrides the direction setter to recompute the projection texture view light Matrix.
  55299. */
  55300. protected _setDirection(value: Vector3): void;
  55301. /**
  55302. * Overrides the position setter to recompute the projection texture view light Matrix.
  55303. */
  55304. protected _setPosition(value: Vector3): void;
  55305. /**
  55306. * 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.
  55307. * Returns the SpotLight.
  55308. */
  55309. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  55310. protected _computeProjectionTextureViewLightMatrix(): void;
  55311. protected _computeProjectionTextureProjectionLightMatrix(): void;
  55312. /**
  55313. * Main function for light texture projection matrix computing.
  55314. */
  55315. protected _computeProjectionTextureMatrix(): void;
  55316. protected _buildUniformLayout(): void;
  55317. private _computeAngleValues;
  55318. /**
  55319. * Sets the passed Effect "effect" with the Light textures.
  55320. * @param effect The effect to update
  55321. * @param lightIndex The index of the light in the effect to update
  55322. * @returns The light
  55323. */
  55324. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  55325. /**
  55326. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  55327. * @param effect The effect to update
  55328. * @param lightIndex The index of the light in the effect to update
  55329. * @returns The spot light
  55330. */
  55331. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  55332. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  55333. /**
  55334. * Disposes the light and the associated resources.
  55335. */
  55336. dispose(): void;
  55337. /**
  55338. * Prepares the list of defines specific to the light type.
  55339. * @param defines the list of defines
  55340. * @param lightIndex defines the index of the light for the effect
  55341. */
  55342. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  55343. }
  55344. }
  55345. declare module "babylonjs/Gizmos/lightGizmo" {
  55346. import { Nullable } from "babylonjs/types";
  55347. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55348. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55349. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  55350. import { Light } from "babylonjs/Lights/light";
  55351. /**
  55352. * Gizmo that enables viewing a light
  55353. */
  55354. export class LightGizmo extends Gizmo {
  55355. private _lightMesh;
  55356. private _material;
  55357. private _cachedPosition;
  55358. private _cachedForward;
  55359. private _attachedMeshParent;
  55360. /**
  55361. * Creates a LightGizmo
  55362. * @param gizmoLayer The utility layer the gizmo will be added to
  55363. */
  55364. constructor(gizmoLayer?: UtilityLayerRenderer);
  55365. private _light;
  55366. /**
  55367. * The light that the gizmo is attached to
  55368. */
  55369. set light(light: Nullable<Light>);
  55370. get light(): Nullable<Light>;
  55371. /**
  55372. * Gets the material used to render the light gizmo
  55373. */
  55374. get material(): StandardMaterial;
  55375. /**
  55376. * @hidden
  55377. * Updates the gizmo to match the attached mesh's position/rotation
  55378. */
  55379. protected _update(): void;
  55380. private static _Scale;
  55381. /**
  55382. * Creates the lines for a light mesh
  55383. */
  55384. private static _CreateLightLines;
  55385. /**
  55386. * Disposes of the light gizmo
  55387. */
  55388. dispose(): void;
  55389. private static _CreateHemisphericLightMesh;
  55390. private static _CreatePointLightMesh;
  55391. private static _CreateSpotLightMesh;
  55392. private static _CreateDirectionalLightMesh;
  55393. }
  55394. }
  55395. declare module "babylonjs/Gizmos/index" {
  55396. export * from "babylonjs/Gizmos/axisDragGizmo";
  55397. export * from "babylonjs/Gizmos/axisScaleGizmo";
  55398. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  55399. export * from "babylonjs/Gizmos/gizmo";
  55400. export * from "babylonjs/Gizmos/gizmoManager";
  55401. export * from "babylonjs/Gizmos/planeRotationGizmo";
  55402. export * from "babylonjs/Gizmos/positionGizmo";
  55403. export * from "babylonjs/Gizmos/rotationGizmo";
  55404. export * from "babylonjs/Gizmos/scaleGizmo";
  55405. export * from "babylonjs/Gizmos/lightGizmo";
  55406. export * from "babylonjs/Gizmos/planeDragGizmo";
  55407. }
  55408. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  55409. /** @hidden */
  55410. export var backgroundFragmentDeclaration: {
  55411. name: string;
  55412. shader: string;
  55413. };
  55414. }
  55415. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  55416. /** @hidden */
  55417. export var backgroundUboDeclaration: {
  55418. name: string;
  55419. shader: string;
  55420. };
  55421. }
  55422. declare module "babylonjs/Shaders/background.fragment" {
  55423. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  55424. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  55425. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  55426. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  55427. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  55428. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  55429. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  55430. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  55431. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  55432. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  55433. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  55434. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  55435. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  55436. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  55437. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  55438. /** @hidden */
  55439. export var backgroundPixelShader: {
  55440. name: string;
  55441. shader: string;
  55442. };
  55443. }
  55444. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  55445. /** @hidden */
  55446. export var backgroundVertexDeclaration: {
  55447. name: string;
  55448. shader: string;
  55449. };
  55450. }
  55451. declare module "babylonjs/Shaders/background.vertex" {
  55452. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  55453. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  55454. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  55455. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  55456. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  55457. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  55458. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  55459. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  55460. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  55461. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  55462. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  55463. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  55464. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  55465. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  55466. /** @hidden */
  55467. export var backgroundVertexShader: {
  55468. name: string;
  55469. shader: string;
  55470. };
  55471. }
  55472. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  55473. import { Nullable, int, float } from "babylonjs/types";
  55474. import { Scene } from "babylonjs/scene";
  55475. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  55476. import { SubMesh } from "babylonjs/Meshes/subMesh";
  55477. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55478. import { Mesh } from "babylonjs/Meshes/mesh";
  55479. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  55480. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  55481. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  55482. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55483. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  55484. import { Color3 } from "babylonjs/Maths/math.color";
  55485. import "babylonjs/Shaders/background.fragment";
  55486. import "babylonjs/Shaders/background.vertex";
  55487. /**
  55488. * Background material used to create an efficient environement around your scene.
  55489. */
  55490. export class BackgroundMaterial extends PushMaterial {
  55491. /**
  55492. * Standard reflectance value at parallel view angle.
  55493. */
  55494. static StandardReflectance0: number;
  55495. /**
  55496. * Standard reflectance value at grazing angle.
  55497. */
  55498. static StandardReflectance90: number;
  55499. protected _primaryColor: Color3;
  55500. /**
  55501. * Key light Color (multiply against the environement texture)
  55502. */
  55503. primaryColor: Color3;
  55504. protected __perceptualColor: Nullable<Color3>;
  55505. /**
  55506. * Experimental Internal Use Only.
  55507. *
  55508. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  55509. * This acts as a helper to set the primary color to a more "human friendly" value.
  55510. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  55511. * output color as close as possible from the chosen value.
  55512. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  55513. * part of lighting setup.)
  55514. */
  55515. get _perceptualColor(): Nullable<Color3>;
  55516. set _perceptualColor(value: Nullable<Color3>);
  55517. protected _primaryColorShadowLevel: float;
  55518. /**
  55519. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  55520. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  55521. */
  55522. get primaryColorShadowLevel(): float;
  55523. set primaryColorShadowLevel(value: float);
  55524. protected _primaryColorHighlightLevel: float;
  55525. /**
  55526. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  55527. * The primary color is used at the level chosen to define what the white area would look.
  55528. */
  55529. get primaryColorHighlightLevel(): float;
  55530. set primaryColorHighlightLevel(value: float);
  55531. protected _reflectionTexture: Nullable<BaseTexture>;
  55532. /**
  55533. * Reflection Texture used in the material.
  55534. * Should be author in a specific way for the best result (refer to the documentation).
  55535. */
  55536. reflectionTexture: Nullable<BaseTexture>;
  55537. protected _reflectionBlur: float;
  55538. /**
  55539. * Reflection Texture level of blur.
  55540. *
  55541. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  55542. * texture twice.
  55543. */
  55544. reflectionBlur: float;
  55545. protected _diffuseTexture: Nullable<BaseTexture>;
  55546. /**
  55547. * Diffuse Texture used in the material.
  55548. * Should be author in a specific way for the best result (refer to the documentation).
  55549. */
  55550. diffuseTexture: Nullable<BaseTexture>;
  55551. protected _shadowLights: Nullable<IShadowLight[]>;
  55552. /**
  55553. * Specify the list of lights casting shadow on the material.
  55554. * All scene shadow lights will be included if null.
  55555. */
  55556. shadowLights: Nullable<IShadowLight[]>;
  55557. protected _shadowLevel: float;
  55558. /**
  55559. * Helps adjusting the shadow to a softer level if required.
  55560. * 0 means black shadows and 1 means no shadows.
  55561. */
  55562. shadowLevel: float;
  55563. protected _sceneCenter: Vector3;
  55564. /**
  55565. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  55566. * It is usually zero but might be interesting to modify according to your setup.
  55567. */
  55568. sceneCenter: Vector3;
  55569. protected _opacityFresnel: boolean;
  55570. /**
  55571. * This helps specifying that the material is falling off to the sky box at grazing angle.
  55572. * This helps ensuring a nice transition when the camera goes under the ground.
  55573. */
  55574. opacityFresnel: boolean;
  55575. protected _reflectionFresnel: boolean;
  55576. /**
  55577. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  55578. * This helps adding a mirror texture on the ground.
  55579. */
  55580. reflectionFresnel: boolean;
  55581. protected _reflectionFalloffDistance: number;
  55582. /**
  55583. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  55584. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  55585. */
  55586. reflectionFalloffDistance: number;
  55587. protected _reflectionAmount: number;
  55588. /**
  55589. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  55590. */
  55591. reflectionAmount: number;
  55592. protected _reflectionReflectance0: number;
  55593. /**
  55594. * This specifies the weight of the reflection at grazing angle.
  55595. */
  55596. reflectionReflectance0: number;
  55597. protected _reflectionReflectance90: number;
  55598. /**
  55599. * This specifies the weight of the reflection at a perpendicular point of view.
  55600. */
  55601. reflectionReflectance90: number;
  55602. /**
  55603. * Sets the reflection reflectance fresnel values according to the default standard
  55604. * empirically know to work well :-)
  55605. */
  55606. set reflectionStandardFresnelWeight(value: number);
  55607. protected _useRGBColor: boolean;
  55608. /**
  55609. * Helps to directly use the maps channels instead of their level.
  55610. */
  55611. useRGBColor: boolean;
  55612. protected _enableNoise: boolean;
  55613. /**
  55614. * This helps reducing the banding effect that could occur on the background.
  55615. */
  55616. enableNoise: boolean;
  55617. /**
  55618. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  55619. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  55620. * Recommended to be keep at 1.0 except for special cases.
  55621. */
  55622. get fovMultiplier(): number;
  55623. set fovMultiplier(value: number);
  55624. private _fovMultiplier;
  55625. /**
  55626. * Enable the FOV adjustment feature controlled by fovMultiplier.
  55627. */
  55628. useEquirectangularFOV: boolean;
  55629. private _maxSimultaneousLights;
  55630. /**
  55631. * Number of Simultaneous lights allowed on the material.
  55632. */
  55633. maxSimultaneousLights: int;
  55634. /**
  55635. * Default configuration related to image processing available in the Background Material.
  55636. */
  55637. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  55638. /**
  55639. * Keep track of the image processing observer to allow dispose and replace.
  55640. */
  55641. private _imageProcessingObserver;
  55642. /**
  55643. * Attaches a new image processing configuration to the PBR Material.
  55644. * @param configuration (if null the scene configuration will be use)
  55645. */
  55646. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  55647. /**
  55648. * Gets the image processing configuration used either in this material.
  55649. */
  55650. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  55651. /**
  55652. * Sets the Default image processing configuration used either in the this material.
  55653. *
  55654. * If sets to null, the scene one is in use.
  55655. */
  55656. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  55657. /**
  55658. * Gets wether the color curves effect is enabled.
  55659. */
  55660. get cameraColorCurvesEnabled(): boolean;
  55661. /**
  55662. * Sets wether the color curves effect is enabled.
  55663. */
  55664. set cameraColorCurvesEnabled(value: boolean);
  55665. /**
  55666. * Gets wether the color grading effect is enabled.
  55667. */
  55668. get cameraColorGradingEnabled(): boolean;
  55669. /**
  55670. * Gets wether the color grading effect is enabled.
  55671. */
  55672. set cameraColorGradingEnabled(value: boolean);
  55673. /**
  55674. * Gets wether tonemapping is enabled or not.
  55675. */
  55676. get cameraToneMappingEnabled(): boolean;
  55677. /**
  55678. * Sets wether tonemapping is enabled or not
  55679. */
  55680. set cameraToneMappingEnabled(value: boolean);
  55681. /**
  55682. * The camera exposure used on this material.
  55683. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  55684. * This corresponds to a photographic exposure.
  55685. */
  55686. get cameraExposure(): float;
  55687. /**
  55688. * The camera exposure used on this material.
  55689. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  55690. * This corresponds to a photographic exposure.
  55691. */
  55692. set cameraExposure(value: float);
  55693. /**
  55694. * Gets The camera contrast used on this material.
  55695. */
  55696. get cameraContrast(): float;
  55697. /**
  55698. * Sets The camera contrast used on this material.
  55699. */
  55700. set cameraContrast(value: float);
  55701. /**
  55702. * Gets the Color Grading 2D Lookup Texture.
  55703. */
  55704. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  55705. /**
  55706. * Sets the Color Grading 2D Lookup Texture.
  55707. */
  55708. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  55709. /**
  55710. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  55711. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  55712. * 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;
  55713. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  55714. */
  55715. get cameraColorCurves(): Nullable<ColorCurves>;
  55716. /**
  55717. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  55718. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  55719. * 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;
  55720. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  55721. */
  55722. set cameraColorCurves(value: Nullable<ColorCurves>);
  55723. /**
  55724. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  55725. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  55726. */
  55727. switchToBGR: boolean;
  55728. private _renderTargets;
  55729. private _reflectionControls;
  55730. private _white;
  55731. private _primaryShadowColor;
  55732. private _primaryHighlightColor;
  55733. /**
  55734. * Instantiates a Background Material in the given scene
  55735. * @param name The friendly name of the material
  55736. * @param scene The scene to add the material to
  55737. */
  55738. constructor(name: string, scene: Scene);
  55739. /**
  55740. * Gets a boolean indicating that current material needs to register RTT
  55741. */
  55742. get hasRenderTargetTextures(): boolean;
  55743. /**
  55744. * The entire material has been created in order to prevent overdraw.
  55745. * @returns false
  55746. */
  55747. needAlphaTesting(): boolean;
  55748. /**
  55749. * The entire material has been created in order to prevent overdraw.
  55750. * @returns true if blending is enable
  55751. */
  55752. needAlphaBlending(): boolean;
  55753. /**
  55754. * Checks wether the material is ready to be rendered for a given mesh.
  55755. * @param mesh The mesh to render
  55756. * @param subMesh The submesh to check against
  55757. * @param useInstances Specify wether or not the material is used with instances
  55758. * @returns true if all the dependencies are ready (Textures, Effects...)
  55759. */
  55760. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  55761. /**
  55762. * Compute the primary color according to the chosen perceptual color.
  55763. */
  55764. private _computePrimaryColorFromPerceptualColor;
  55765. /**
  55766. * Compute the highlights and shadow colors according to their chosen levels.
  55767. */
  55768. private _computePrimaryColors;
  55769. /**
  55770. * Build the uniform buffer used in the material.
  55771. */
  55772. buildUniformLayout(): void;
  55773. /**
  55774. * Unbind the material.
  55775. */
  55776. unbind(): void;
  55777. /**
  55778. * Bind only the world matrix to the material.
  55779. * @param world The world matrix to bind.
  55780. */
  55781. bindOnlyWorldMatrix(world: Matrix): void;
  55782. /**
  55783. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  55784. * @param world The world matrix to bind.
  55785. * @param subMesh The submesh to bind for.
  55786. */
  55787. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  55788. /**
  55789. * Checks to see if a texture is used in the material.
  55790. * @param texture - Base texture to use.
  55791. * @returns - Boolean specifying if a texture is used in the material.
  55792. */
  55793. hasTexture(texture: BaseTexture): boolean;
  55794. /**
  55795. * Dispose the material.
  55796. * @param forceDisposeEffect Force disposal of the associated effect.
  55797. * @param forceDisposeTextures Force disposal of the associated textures.
  55798. */
  55799. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  55800. /**
  55801. * Clones the material.
  55802. * @param name The cloned name.
  55803. * @returns The cloned material.
  55804. */
  55805. clone(name: string): BackgroundMaterial;
  55806. /**
  55807. * Serializes the current material to its JSON representation.
  55808. * @returns The JSON representation.
  55809. */
  55810. serialize(): any;
  55811. /**
  55812. * Gets the class name of the material
  55813. * @returns "BackgroundMaterial"
  55814. */
  55815. getClassName(): string;
  55816. /**
  55817. * Parse a JSON input to create back a background material.
  55818. * @param source The JSON data to parse
  55819. * @param scene The scene to create the parsed material in
  55820. * @param rootUrl The root url of the assets the material depends upon
  55821. * @returns the instantiated BackgroundMaterial.
  55822. */
  55823. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  55824. }
  55825. }
  55826. declare module "babylonjs/Helpers/environmentHelper" {
  55827. import { Observable } from "babylonjs/Misc/observable";
  55828. import { Nullable } from "babylonjs/types";
  55829. import { Scene } from "babylonjs/scene";
  55830. import { Vector3 } from "babylonjs/Maths/math.vector";
  55831. import { Color3 } from "babylonjs/Maths/math.color";
  55832. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55833. import { Mesh } from "babylonjs/Meshes/mesh";
  55834. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55835. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  55836. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  55837. import "babylonjs/Meshes/Builders/planeBuilder";
  55838. import "babylonjs/Meshes/Builders/boxBuilder";
  55839. /**
  55840. * Represents the different options available during the creation of
  55841. * a Environment helper.
  55842. *
  55843. * This can control the default ground, skybox and image processing setup of your scene.
  55844. */
  55845. export interface IEnvironmentHelperOptions {
  55846. /**
  55847. * Specifies whether or not to create a ground.
  55848. * True by default.
  55849. */
  55850. createGround: boolean;
  55851. /**
  55852. * Specifies the ground size.
  55853. * 15 by default.
  55854. */
  55855. groundSize: number;
  55856. /**
  55857. * The texture used on the ground for the main color.
  55858. * Comes from the BabylonJS CDN by default.
  55859. *
  55860. * Remarks: Can be either a texture or a url.
  55861. */
  55862. groundTexture: string | BaseTexture;
  55863. /**
  55864. * The color mixed in the ground texture by default.
  55865. * BabylonJS clearColor by default.
  55866. */
  55867. groundColor: Color3;
  55868. /**
  55869. * Specifies the ground opacity.
  55870. * 1 by default.
  55871. */
  55872. groundOpacity: number;
  55873. /**
  55874. * Enables the ground to receive shadows.
  55875. * True by default.
  55876. */
  55877. enableGroundShadow: boolean;
  55878. /**
  55879. * Helps preventing the shadow to be fully black on the ground.
  55880. * 0.5 by default.
  55881. */
  55882. groundShadowLevel: number;
  55883. /**
  55884. * Creates a mirror texture attach to the ground.
  55885. * false by default.
  55886. */
  55887. enableGroundMirror: boolean;
  55888. /**
  55889. * Specifies the ground mirror size ratio.
  55890. * 0.3 by default as the default kernel is 64.
  55891. */
  55892. groundMirrorSizeRatio: number;
  55893. /**
  55894. * Specifies the ground mirror blur kernel size.
  55895. * 64 by default.
  55896. */
  55897. groundMirrorBlurKernel: number;
  55898. /**
  55899. * Specifies the ground mirror visibility amount.
  55900. * 1 by default
  55901. */
  55902. groundMirrorAmount: number;
  55903. /**
  55904. * Specifies the ground mirror reflectance weight.
  55905. * This uses the standard weight of the background material to setup the fresnel effect
  55906. * of the mirror.
  55907. * 1 by default.
  55908. */
  55909. groundMirrorFresnelWeight: number;
  55910. /**
  55911. * Specifies the ground mirror Falloff distance.
  55912. * This can helps reducing the size of the reflection.
  55913. * 0 by Default.
  55914. */
  55915. groundMirrorFallOffDistance: number;
  55916. /**
  55917. * Specifies the ground mirror texture type.
  55918. * Unsigned Int by Default.
  55919. */
  55920. groundMirrorTextureType: number;
  55921. /**
  55922. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  55923. * the shown objects.
  55924. */
  55925. groundYBias: number;
  55926. /**
  55927. * Specifies whether or not to create a skybox.
  55928. * True by default.
  55929. */
  55930. createSkybox: boolean;
  55931. /**
  55932. * Specifies the skybox size.
  55933. * 20 by default.
  55934. */
  55935. skyboxSize: number;
  55936. /**
  55937. * The texture used on the skybox for the main color.
  55938. * Comes from the BabylonJS CDN by default.
  55939. *
  55940. * Remarks: Can be either a texture or a url.
  55941. */
  55942. skyboxTexture: string | BaseTexture;
  55943. /**
  55944. * The color mixed in the skybox texture by default.
  55945. * BabylonJS clearColor by default.
  55946. */
  55947. skyboxColor: Color3;
  55948. /**
  55949. * The background rotation around the Y axis of the scene.
  55950. * This helps aligning the key lights of your scene with the background.
  55951. * 0 by default.
  55952. */
  55953. backgroundYRotation: number;
  55954. /**
  55955. * Compute automatically the size of the elements to best fit with the scene.
  55956. */
  55957. sizeAuto: boolean;
  55958. /**
  55959. * Default position of the rootMesh if autoSize is not true.
  55960. */
  55961. rootPosition: Vector3;
  55962. /**
  55963. * Sets up the image processing in the scene.
  55964. * true by default.
  55965. */
  55966. setupImageProcessing: boolean;
  55967. /**
  55968. * The texture used as your environment texture in the scene.
  55969. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  55970. *
  55971. * Remarks: Can be either a texture or a url.
  55972. */
  55973. environmentTexture: string | BaseTexture;
  55974. /**
  55975. * The value of the exposure to apply to the scene.
  55976. * 0.6 by default if setupImageProcessing is true.
  55977. */
  55978. cameraExposure: number;
  55979. /**
  55980. * The value of the contrast to apply to the scene.
  55981. * 1.6 by default if setupImageProcessing is true.
  55982. */
  55983. cameraContrast: number;
  55984. /**
  55985. * Specifies whether or not tonemapping should be enabled in the scene.
  55986. * true by default if setupImageProcessing is true.
  55987. */
  55988. toneMappingEnabled: boolean;
  55989. }
  55990. /**
  55991. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  55992. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  55993. * It also helps with the default setup of your imageProcessing configuration.
  55994. */
  55995. export class EnvironmentHelper {
  55996. /**
  55997. * Default ground texture URL.
  55998. */
  55999. private static _groundTextureCDNUrl;
  56000. /**
  56001. * Default skybox texture URL.
  56002. */
  56003. private static _skyboxTextureCDNUrl;
  56004. /**
  56005. * Default environment texture URL.
  56006. */
  56007. private static _environmentTextureCDNUrl;
  56008. /**
  56009. * Creates the default options for the helper.
  56010. */
  56011. private static _getDefaultOptions;
  56012. private _rootMesh;
  56013. /**
  56014. * Gets the root mesh created by the helper.
  56015. */
  56016. get rootMesh(): Mesh;
  56017. private _skybox;
  56018. /**
  56019. * Gets the skybox created by the helper.
  56020. */
  56021. get skybox(): Nullable<Mesh>;
  56022. private _skyboxTexture;
  56023. /**
  56024. * Gets the skybox texture created by the helper.
  56025. */
  56026. get skyboxTexture(): Nullable<BaseTexture>;
  56027. private _skyboxMaterial;
  56028. /**
  56029. * Gets the skybox material created by the helper.
  56030. */
  56031. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  56032. private _ground;
  56033. /**
  56034. * Gets the ground mesh created by the helper.
  56035. */
  56036. get ground(): Nullable<Mesh>;
  56037. private _groundTexture;
  56038. /**
  56039. * Gets the ground texture created by the helper.
  56040. */
  56041. get groundTexture(): Nullable<BaseTexture>;
  56042. private _groundMirror;
  56043. /**
  56044. * Gets the ground mirror created by the helper.
  56045. */
  56046. get groundMirror(): Nullable<MirrorTexture>;
  56047. /**
  56048. * Gets the ground mirror render list to helps pushing the meshes
  56049. * you wish in the ground reflection.
  56050. */
  56051. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  56052. private _groundMaterial;
  56053. /**
  56054. * Gets the ground material created by the helper.
  56055. */
  56056. get groundMaterial(): Nullable<BackgroundMaterial>;
  56057. /**
  56058. * Stores the creation options.
  56059. */
  56060. private readonly _scene;
  56061. private _options;
  56062. /**
  56063. * This observable will be notified with any error during the creation of the environment,
  56064. * mainly texture creation errors.
  56065. */
  56066. onErrorObservable: Observable<{
  56067. message?: string;
  56068. exception?: any;
  56069. }>;
  56070. /**
  56071. * constructor
  56072. * @param options Defines the options we want to customize the helper
  56073. * @param scene The scene to add the material to
  56074. */
  56075. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  56076. /**
  56077. * Updates the background according to the new options
  56078. * @param options
  56079. */
  56080. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  56081. /**
  56082. * Sets the primary color of all the available elements.
  56083. * @param color the main color to affect to the ground and the background
  56084. */
  56085. setMainColor(color: Color3): void;
  56086. /**
  56087. * Setup the image processing according to the specified options.
  56088. */
  56089. private _setupImageProcessing;
  56090. /**
  56091. * Setup the environment texture according to the specified options.
  56092. */
  56093. private _setupEnvironmentTexture;
  56094. /**
  56095. * Setup the background according to the specified options.
  56096. */
  56097. private _setupBackground;
  56098. /**
  56099. * Get the scene sizes according to the setup.
  56100. */
  56101. private _getSceneSize;
  56102. /**
  56103. * Setup the ground according to the specified options.
  56104. */
  56105. private _setupGround;
  56106. /**
  56107. * Setup the ground material according to the specified options.
  56108. */
  56109. private _setupGroundMaterial;
  56110. /**
  56111. * Setup the ground diffuse texture according to the specified options.
  56112. */
  56113. private _setupGroundDiffuseTexture;
  56114. /**
  56115. * Setup the ground mirror texture according to the specified options.
  56116. */
  56117. private _setupGroundMirrorTexture;
  56118. /**
  56119. * Setup the ground to receive the mirror texture.
  56120. */
  56121. private _setupMirrorInGroundMaterial;
  56122. /**
  56123. * Setup the skybox according to the specified options.
  56124. */
  56125. private _setupSkybox;
  56126. /**
  56127. * Setup the skybox material according to the specified options.
  56128. */
  56129. private _setupSkyboxMaterial;
  56130. /**
  56131. * Setup the skybox reflection texture according to the specified options.
  56132. */
  56133. private _setupSkyboxReflectionTexture;
  56134. private _errorHandler;
  56135. /**
  56136. * Dispose all the elements created by the Helper.
  56137. */
  56138. dispose(): void;
  56139. }
  56140. }
  56141. declare module "babylonjs/Helpers/photoDome" {
  56142. import { Observable } from "babylonjs/Misc/observable";
  56143. import { Nullable } from "babylonjs/types";
  56144. import { Scene } from "babylonjs/scene";
  56145. import { TransformNode } from "babylonjs/Meshes/transformNode";
  56146. import { Mesh } from "babylonjs/Meshes/mesh";
  56147. import { Texture } from "babylonjs/Materials/Textures/texture";
  56148. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  56149. import "babylonjs/Meshes/Builders/sphereBuilder";
  56150. /**
  56151. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  56152. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  56153. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  56154. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  56155. */
  56156. export class PhotoDome extends TransformNode {
  56157. /**
  56158. * Define the image as a Monoscopic panoramic 360 image.
  56159. */
  56160. static readonly MODE_MONOSCOPIC: number;
  56161. /**
  56162. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  56163. */
  56164. static readonly MODE_TOPBOTTOM: number;
  56165. /**
  56166. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  56167. */
  56168. static readonly MODE_SIDEBYSIDE: number;
  56169. private _useDirectMapping;
  56170. /**
  56171. * The texture being displayed on the sphere
  56172. */
  56173. protected _photoTexture: Texture;
  56174. /**
  56175. * Gets or sets the texture being displayed on the sphere
  56176. */
  56177. get photoTexture(): Texture;
  56178. set photoTexture(value: Texture);
  56179. /**
  56180. * Observable raised when an error occured while loading the 360 image
  56181. */
  56182. onLoadErrorObservable: Observable<string>;
  56183. /**
  56184. * The skybox material
  56185. */
  56186. protected _material: BackgroundMaterial;
  56187. /**
  56188. * The surface used for the skybox
  56189. */
  56190. protected _mesh: Mesh;
  56191. /**
  56192. * Gets the mesh used for the skybox.
  56193. */
  56194. get mesh(): Mesh;
  56195. /**
  56196. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56197. * Also see the options.resolution property.
  56198. */
  56199. get fovMultiplier(): number;
  56200. set fovMultiplier(value: number);
  56201. private _imageMode;
  56202. /**
  56203. * Gets or set the current video mode for the video. It can be:
  56204. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  56205. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  56206. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  56207. */
  56208. get imageMode(): number;
  56209. set imageMode(value: number);
  56210. /**
  56211. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  56212. * @param name Element's name, child elements will append suffixes for their own names.
  56213. * @param urlsOfPhoto defines the url of the photo to display
  56214. * @param options defines an object containing optional or exposed sub element properties
  56215. * @param onError defines a callback called when an error occured while loading the texture
  56216. */
  56217. constructor(name: string, urlOfPhoto: string, options: {
  56218. resolution?: number;
  56219. size?: number;
  56220. useDirectMapping?: boolean;
  56221. faceForward?: boolean;
  56222. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  56223. private _onBeforeCameraRenderObserver;
  56224. private _changeImageMode;
  56225. /**
  56226. * Releases resources associated with this node.
  56227. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  56228. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  56229. */
  56230. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  56231. }
  56232. }
  56233. declare module "babylonjs/Misc/rgbdTextureTools" {
  56234. import "babylonjs/Shaders/rgbdDecode.fragment";
  56235. import "babylonjs/Engines/Extensions/engine.renderTarget";
  56236. import { Texture } from "babylonjs/Materials/Textures/texture";
  56237. /**
  56238. * Class used to host RGBD texture specific utilities
  56239. */
  56240. export class RGBDTextureTools {
  56241. /**
  56242. * Expand the RGBD Texture from RGBD to Half Float if possible.
  56243. * @param texture the texture to expand.
  56244. */
  56245. static ExpandRGBDTexture(texture: Texture): void;
  56246. }
  56247. }
  56248. declare module "babylonjs/Misc/brdfTextureTools" {
  56249. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56250. import { Scene } from "babylonjs/scene";
  56251. /**
  56252. * Class used to host texture specific utilities
  56253. */
  56254. export class BRDFTextureTools {
  56255. /**
  56256. * Prevents texture cache collision
  56257. */
  56258. private static _instanceNumber;
  56259. /**
  56260. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  56261. * @param scene defines the hosting scene
  56262. * @returns the environment BRDF texture
  56263. */
  56264. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  56265. private static _environmentBRDFBase64Texture;
  56266. }
  56267. }
  56268. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  56269. import { Nullable } from "babylonjs/types";
  56270. import { Color3 } from "babylonjs/Maths/math.color";
  56271. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56272. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  56273. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  56274. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56275. import { Engine } from "babylonjs/Engines/engine";
  56276. import { Scene } from "babylonjs/scene";
  56277. /**
  56278. * @hidden
  56279. */
  56280. export interface IMaterialClearCoatDefines {
  56281. CLEARCOAT: boolean;
  56282. CLEARCOAT_DEFAULTIOR: boolean;
  56283. CLEARCOAT_TEXTURE: boolean;
  56284. CLEARCOAT_TEXTUREDIRECTUV: number;
  56285. CLEARCOAT_BUMP: boolean;
  56286. CLEARCOAT_BUMPDIRECTUV: number;
  56287. CLEARCOAT_TINT: boolean;
  56288. CLEARCOAT_TINT_TEXTURE: boolean;
  56289. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  56290. /** @hidden */
  56291. _areTexturesDirty: boolean;
  56292. }
  56293. /**
  56294. * Define the code related to the clear coat parameters of the pbr material.
  56295. */
  56296. export class PBRClearCoatConfiguration {
  56297. /**
  56298. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  56299. * The default fits with a polyurethane material.
  56300. */
  56301. private static readonly _DefaultIndexOfRefraction;
  56302. private _isEnabled;
  56303. /**
  56304. * Defines if the clear coat is enabled in the material.
  56305. */
  56306. isEnabled: boolean;
  56307. /**
  56308. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  56309. */
  56310. intensity: number;
  56311. /**
  56312. * Defines the clear coat layer roughness.
  56313. */
  56314. roughness: number;
  56315. private _indexOfRefraction;
  56316. /**
  56317. * Defines the index of refraction of the clear coat.
  56318. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  56319. * The default fits with a polyurethane material.
  56320. * Changing the default value is more performance intensive.
  56321. */
  56322. indexOfRefraction: number;
  56323. private _texture;
  56324. /**
  56325. * Stores the clear coat values in a texture.
  56326. */
  56327. texture: Nullable<BaseTexture>;
  56328. private _bumpTexture;
  56329. /**
  56330. * Define the clear coat specific bump texture.
  56331. */
  56332. bumpTexture: Nullable<BaseTexture>;
  56333. private _isTintEnabled;
  56334. /**
  56335. * Defines if the clear coat tint is enabled in the material.
  56336. */
  56337. isTintEnabled: boolean;
  56338. /**
  56339. * Defines the clear coat tint of the material.
  56340. * This is only use if tint is enabled
  56341. */
  56342. tintColor: Color3;
  56343. /**
  56344. * Defines the distance at which the tint color should be found in the
  56345. * clear coat media.
  56346. * This is only use if tint is enabled
  56347. */
  56348. tintColorAtDistance: number;
  56349. /**
  56350. * Defines the clear coat layer thickness.
  56351. * This is only use if tint is enabled
  56352. */
  56353. tintThickness: number;
  56354. private _tintTexture;
  56355. /**
  56356. * Stores the clear tint values in a texture.
  56357. * rgb is tint
  56358. * a is a thickness factor
  56359. */
  56360. tintTexture: Nullable<BaseTexture>;
  56361. /** @hidden */
  56362. private _internalMarkAllSubMeshesAsTexturesDirty;
  56363. /** @hidden */
  56364. _markAllSubMeshesAsTexturesDirty(): void;
  56365. /**
  56366. * Instantiate a new istance of clear coat configuration.
  56367. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  56368. */
  56369. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  56370. /**
  56371. * Gets wehter the submesh is ready to be used or not.
  56372. * @param defines the list of "defines" to update.
  56373. * @param scene defines the scene the material belongs to.
  56374. * @param engine defines the engine the material belongs to.
  56375. * @param disableBumpMap defines wether the material disables bump or not.
  56376. * @returns - boolean indicating that the submesh is ready or not.
  56377. */
  56378. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  56379. /**
  56380. * Checks to see if a texture is used in the material.
  56381. * @param defines the list of "defines" to update.
  56382. * @param scene defines the scene to the material belongs to.
  56383. */
  56384. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  56385. /**
  56386. * Binds the material data.
  56387. * @param uniformBuffer defines the Uniform buffer to fill in.
  56388. * @param scene defines the scene the material belongs to.
  56389. * @param engine defines the engine the material belongs to.
  56390. * @param disableBumpMap defines wether the material disables bump or not.
  56391. * @param isFrozen defines wether the material is frozen or not.
  56392. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  56393. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  56394. */
  56395. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  56396. /**
  56397. * Checks to see if a texture is used in the material.
  56398. * @param texture - Base texture to use.
  56399. * @returns - Boolean specifying if a texture is used in the material.
  56400. */
  56401. hasTexture(texture: BaseTexture): boolean;
  56402. /**
  56403. * Returns an array of the actively used textures.
  56404. * @param activeTextures Array of BaseTextures
  56405. */
  56406. getActiveTextures(activeTextures: BaseTexture[]): void;
  56407. /**
  56408. * Returns the animatable textures.
  56409. * @param animatables Array of animatable textures.
  56410. */
  56411. getAnimatables(animatables: IAnimatable[]): void;
  56412. /**
  56413. * Disposes the resources of the material.
  56414. * @param forceDisposeTextures - Forces the disposal of all textures.
  56415. */
  56416. dispose(forceDisposeTextures?: boolean): void;
  56417. /**
  56418. * Get the current class name of the texture useful for serialization or dynamic coding.
  56419. * @returns "PBRClearCoatConfiguration"
  56420. */
  56421. getClassName(): string;
  56422. /**
  56423. * Add fallbacks to the effect fallbacks list.
  56424. * @param defines defines the Base texture to use.
  56425. * @param fallbacks defines the current fallback list.
  56426. * @param currentRank defines the current fallback rank.
  56427. * @returns the new fallback rank.
  56428. */
  56429. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  56430. /**
  56431. * Add the required uniforms to the current list.
  56432. * @param uniforms defines the current uniform list.
  56433. */
  56434. static AddUniforms(uniforms: string[]): void;
  56435. /**
  56436. * Add the required samplers to the current list.
  56437. * @param samplers defines the current sampler list.
  56438. */
  56439. static AddSamplers(samplers: string[]): void;
  56440. /**
  56441. * Add the required uniforms to the current buffer.
  56442. * @param uniformBuffer defines the current uniform buffer.
  56443. */
  56444. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  56445. /**
  56446. * Makes a duplicate of the current configuration into another one.
  56447. * @param clearCoatConfiguration define the config where to copy the info
  56448. */
  56449. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  56450. /**
  56451. * Serializes this clear coat configuration.
  56452. * @returns - An object with the serialized config.
  56453. */
  56454. serialize(): any;
  56455. /**
  56456. * Parses a anisotropy Configuration from a serialized object.
  56457. * @param source - Serialized object.
  56458. * @param scene Defines the scene we are parsing for
  56459. * @param rootUrl Defines the rootUrl to load from
  56460. */
  56461. parse(source: any, scene: Scene, rootUrl: string): void;
  56462. }
  56463. }
  56464. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  56465. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  56466. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56467. import { Vector2 } from "babylonjs/Maths/math.vector";
  56468. import { Scene } from "babylonjs/scene";
  56469. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56470. import { Nullable } from "babylonjs/types";
  56471. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  56472. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56473. /**
  56474. * @hidden
  56475. */
  56476. export interface IMaterialAnisotropicDefines {
  56477. ANISOTROPIC: boolean;
  56478. ANISOTROPIC_TEXTURE: boolean;
  56479. ANISOTROPIC_TEXTUREDIRECTUV: number;
  56480. MAINUV1: boolean;
  56481. _areTexturesDirty: boolean;
  56482. _needUVs: boolean;
  56483. }
  56484. /**
  56485. * Define the code related to the anisotropic parameters of the pbr material.
  56486. */
  56487. export class PBRAnisotropicConfiguration {
  56488. private _isEnabled;
  56489. /**
  56490. * Defines if the anisotropy is enabled in the material.
  56491. */
  56492. isEnabled: boolean;
  56493. /**
  56494. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  56495. */
  56496. intensity: number;
  56497. /**
  56498. * Defines if the effect is along the tangents, bitangents or in between.
  56499. * By default, the effect is "strectching" the highlights along the tangents.
  56500. */
  56501. direction: Vector2;
  56502. private _texture;
  56503. /**
  56504. * Stores the anisotropy values in a texture.
  56505. * rg is direction (like normal from -1 to 1)
  56506. * b is a intensity
  56507. */
  56508. texture: Nullable<BaseTexture>;
  56509. /** @hidden */
  56510. private _internalMarkAllSubMeshesAsTexturesDirty;
  56511. /** @hidden */
  56512. _markAllSubMeshesAsTexturesDirty(): void;
  56513. /**
  56514. * Instantiate a new istance of anisotropy configuration.
  56515. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  56516. */
  56517. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  56518. /**
  56519. * Specifies that the submesh is ready to be used.
  56520. * @param defines the list of "defines" to update.
  56521. * @param scene defines the scene the material belongs to.
  56522. * @returns - boolean indicating that the submesh is ready or not.
  56523. */
  56524. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  56525. /**
  56526. * Checks to see if a texture is used in the material.
  56527. * @param defines the list of "defines" to update.
  56528. * @param mesh the mesh we are preparing the defines for.
  56529. * @param scene defines the scene the material belongs to.
  56530. */
  56531. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  56532. /**
  56533. * Binds the material data.
  56534. * @param uniformBuffer defines the Uniform buffer to fill in.
  56535. * @param scene defines the scene the material belongs to.
  56536. * @param isFrozen defines wether the material is frozen or not.
  56537. */
  56538. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  56539. /**
  56540. * Checks to see if a texture is used in the material.
  56541. * @param texture - Base texture to use.
  56542. * @returns - Boolean specifying if a texture is used in the material.
  56543. */
  56544. hasTexture(texture: BaseTexture): boolean;
  56545. /**
  56546. * Returns an array of the actively used textures.
  56547. * @param activeTextures Array of BaseTextures
  56548. */
  56549. getActiveTextures(activeTextures: BaseTexture[]): void;
  56550. /**
  56551. * Returns the animatable textures.
  56552. * @param animatables Array of animatable textures.
  56553. */
  56554. getAnimatables(animatables: IAnimatable[]): void;
  56555. /**
  56556. * Disposes the resources of the material.
  56557. * @param forceDisposeTextures - Forces the disposal of all textures.
  56558. */
  56559. dispose(forceDisposeTextures?: boolean): void;
  56560. /**
  56561. * Get the current class name of the texture useful for serialization or dynamic coding.
  56562. * @returns "PBRAnisotropicConfiguration"
  56563. */
  56564. getClassName(): string;
  56565. /**
  56566. * Add fallbacks to the effect fallbacks list.
  56567. * @param defines defines the Base texture to use.
  56568. * @param fallbacks defines the current fallback list.
  56569. * @param currentRank defines the current fallback rank.
  56570. * @returns the new fallback rank.
  56571. */
  56572. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  56573. /**
  56574. * Add the required uniforms to the current list.
  56575. * @param uniforms defines the current uniform list.
  56576. */
  56577. static AddUniforms(uniforms: string[]): void;
  56578. /**
  56579. * Add the required uniforms to the current buffer.
  56580. * @param uniformBuffer defines the current uniform buffer.
  56581. */
  56582. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  56583. /**
  56584. * Add the required samplers to the current list.
  56585. * @param samplers defines the current sampler list.
  56586. */
  56587. static AddSamplers(samplers: string[]): void;
  56588. /**
  56589. * Makes a duplicate of the current configuration into another one.
  56590. * @param anisotropicConfiguration define the config where to copy the info
  56591. */
  56592. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  56593. /**
  56594. * Serializes this anisotropy configuration.
  56595. * @returns - An object with the serialized config.
  56596. */
  56597. serialize(): any;
  56598. /**
  56599. * Parses a anisotropy Configuration from a serialized object.
  56600. * @param source - Serialized object.
  56601. * @param scene Defines the scene we are parsing for
  56602. * @param rootUrl Defines the rootUrl to load from
  56603. */
  56604. parse(source: any, scene: Scene, rootUrl: string): void;
  56605. }
  56606. }
  56607. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  56608. import { Scene } from "babylonjs/scene";
  56609. /**
  56610. * @hidden
  56611. */
  56612. export interface IMaterialBRDFDefines {
  56613. BRDF_V_HEIGHT_CORRELATED: boolean;
  56614. MS_BRDF_ENERGY_CONSERVATION: boolean;
  56615. SPHERICAL_HARMONICS: boolean;
  56616. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  56617. /** @hidden */
  56618. _areMiscDirty: boolean;
  56619. }
  56620. /**
  56621. * Define the code related to the BRDF parameters of the pbr material.
  56622. */
  56623. export class PBRBRDFConfiguration {
  56624. /**
  56625. * Default value used for the energy conservation.
  56626. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  56627. */
  56628. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  56629. /**
  56630. * Default value used for the Smith Visibility Height Correlated mode.
  56631. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  56632. */
  56633. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  56634. /**
  56635. * Default value used for the IBL diffuse part.
  56636. * This can help switching back to the polynomials mode globally which is a tiny bit
  56637. * less GPU intensive at the drawback of a lower quality.
  56638. */
  56639. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  56640. /**
  56641. * Default value used for activating energy conservation for the specular workflow.
  56642. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  56643. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  56644. */
  56645. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  56646. private _useEnergyConservation;
  56647. /**
  56648. * Defines if the material uses energy conservation.
  56649. */
  56650. useEnergyConservation: boolean;
  56651. private _useSmithVisibilityHeightCorrelated;
  56652. /**
  56653. * LEGACY Mode set to false
  56654. * Defines if the material uses height smith correlated visibility term.
  56655. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  56656. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  56657. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  56658. * Not relying on height correlated will also disable energy conservation.
  56659. */
  56660. useSmithVisibilityHeightCorrelated: boolean;
  56661. private _useSphericalHarmonics;
  56662. /**
  56663. * LEGACY Mode set to false
  56664. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  56665. * diffuse part of the IBL.
  56666. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  56667. * to the ground truth.
  56668. */
  56669. useSphericalHarmonics: boolean;
  56670. private _useSpecularGlossinessInputEnergyConservation;
  56671. /**
  56672. * Defines if the material uses energy conservation, when the specular workflow is active.
  56673. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  56674. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  56675. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  56676. */
  56677. useSpecularGlossinessInputEnergyConservation: boolean;
  56678. /** @hidden */
  56679. private _internalMarkAllSubMeshesAsMiscDirty;
  56680. /** @hidden */
  56681. _markAllSubMeshesAsMiscDirty(): void;
  56682. /**
  56683. * Instantiate a new istance of clear coat configuration.
  56684. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  56685. */
  56686. constructor(markAllSubMeshesAsMiscDirty: () => void);
  56687. /**
  56688. * Checks to see if a texture is used in the material.
  56689. * @param defines the list of "defines" to update.
  56690. */
  56691. prepareDefines(defines: IMaterialBRDFDefines): void;
  56692. /**
  56693. * Get the current class name of the texture useful for serialization or dynamic coding.
  56694. * @returns "PBRClearCoatConfiguration"
  56695. */
  56696. getClassName(): string;
  56697. /**
  56698. * Makes a duplicate of the current configuration into another one.
  56699. * @param brdfConfiguration define the config where to copy the info
  56700. */
  56701. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  56702. /**
  56703. * Serializes this BRDF configuration.
  56704. * @returns - An object with the serialized config.
  56705. */
  56706. serialize(): any;
  56707. /**
  56708. * Parses a anisotropy Configuration from a serialized object.
  56709. * @param source - Serialized object.
  56710. * @param scene Defines the scene we are parsing for
  56711. * @param rootUrl Defines the rootUrl to load from
  56712. */
  56713. parse(source: any, scene: Scene, rootUrl: string): void;
  56714. }
  56715. }
  56716. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  56717. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  56718. import { Color3 } from "babylonjs/Maths/math.color";
  56719. import { Scene } from "babylonjs/scene";
  56720. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56721. import { Nullable } from "babylonjs/types";
  56722. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  56723. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56724. /**
  56725. * @hidden
  56726. */
  56727. export interface IMaterialSheenDefines {
  56728. SHEEN: boolean;
  56729. SHEEN_TEXTURE: boolean;
  56730. SHEEN_TEXTUREDIRECTUV: number;
  56731. SHEEN_LINKWITHALBEDO: boolean;
  56732. SHEEN_ROUGHNESS: boolean;
  56733. SHEEN_ALBEDOSCALING: boolean;
  56734. /** @hidden */
  56735. _areTexturesDirty: boolean;
  56736. }
  56737. /**
  56738. * Define the code related to the Sheen parameters of the pbr material.
  56739. */
  56740. export class PBRSheenConfiguration {
  56741. private _isEnabled;
  56742. /**
  56743. * Defines if the material uses sheen.
  56744. */
  56745. isEnabled: boolean;
  56746. private _linkSheenWithAlbedo;
  56747. /**
  56748. * Defines if the sheen is linked to the sheen color.
  56749. */
  56750. linkSheenWithAlbedo: boolean;
  56751. /**
  56752. * Defines the sheen intensity.
  56753. */
  56754. intensity: number;
  56755. /**
  56756. * Defines the sheen color.
  56757. */
  56758. color: Color3;
  56759. private _texture;
  56760. /**
  56761. * Stores the sheen tint values in a texture.
  56762. * rgb is tint
  56763. * a is a intensity
  56764. */
  56765. texture: Nullable<BaseTexture>;
  56766. private _roughness;
  56767. /**
  56768. * Defines the sheen roughness.
  56769. * It is not taken into account if linkSheenWithAlbedo is true.
  56770. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  56771. */
  56772. roughness: Nullable<number>;
  56773. private _albedoScaling;
  56774. /**
  56775. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  56776. * It allows the strength of the sheen effect to not depend on the base color of the material,
  56777. * making it easier to setup and tweak the effect
  56778. */
  56779. albedoScaling: boolean;
  56780. /** @hidden */
  56781. private _internalMarkAllSubMeshesAsTexturesDirty;
  56782. /** @hidden */
  56783. _markAllSubMeshesAsTexturesDirty(): void;
  56784. /**
  56785. * Instantiate a new istance of clear coat configuration.
  56786. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  56787. */
  56788. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  56789. /**
  56790. * Specifies that the submesh is ready to be used.
  56791. * @param defines the list of "defines" to update.
  56792. * @param scene defines the scene the material belongs to.
  56793. * @returns - boolean indicating that the submesh is ready or not.
  56794. */
  56795. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  56796. /**
  56797. * Checks to see if a texture is used in the material.
  56798. * @param defines the list of "defines" to update.
  56799. * @param scene defines the scene the material belongs to.
  56800. */
  56801. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  56802. /**
  56803. * Binds the material data.
  56804. * @param uniformBuffer defines the Uniform buffer to fill in.
  56805. * @param scene defines the scene the material belongs to.
  56806. * @param isFrozen defines wether the material is frozen or not.
  56807. */
  56808. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  56809. /**
  56810. * Checks to see if a texture is used in the material.
  56811. * @param texture - Base texture to use.
  56812. * @returns - Boolean specifying if a texture is used in the material.
  56813. */
  56814. hasTexture(texture: BaseTexture): boolean;
  56815. /**
  56816. * Returns an array of the actively used textures.
  56817. * @param activeTextures Array of BaseTextures
  56818. */
  56819. getActiveTextures(activeTextures: BaseTexture[]): void;
  56820. /**
  56821. * Returns the animatable textures.
  56822. * @param animatables Array of animatable textures.
  56823. */
  56824. getAnimatables(animatables: IAnimatable[]): void;
  56825. /**
  56826. * Disposes the resources of the material.
  56827. * @param forceDisposeTextures - Forces the disposal of all textures.
  56828. */
  56829. dispose(forceDisposeTextures?: boolean): void;
  56830. /**
  56831. * Get the current class name of the texture useful for serialization or dynamic coding.
  56832. * @returns "PBRSheenConfiguration"
  56833. */
  56834. getClassName(): string;
  56835. /**
  56836. * Add fallbacks to the effect fallbacks list.
  56837. * @param defines defines the Base texture to use.
  56838. * @param fallbacks defines the current fallback list.
  56839. * @param currentRank defines the current fallback rank.
  56840. * @returns the new fallback rank.
  56841. */
  56842. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  56843. /**
  56844. * Add the required uniforms to the current list.
  56845. * @param uniforms defines the current uniform list.
  56846. */
  56847. static AddUniforms(uniforms: string[]): void;
  56848. /**
  56849. * Add the required uniforms to the current buffer.
  56850. * @param uniformBuffer defines the current uniform buffer.
  56851. */
  56852. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  56853. /**
  56854. * Add the required samplers to the current list.
  56855. * @param samplers defines the current sampler list.
  56856. */
  56857. static AddSamplers(samplers: string[]): void;
  56858. /**
  56859. * Makes a duplicate of the current configuration into another one.
  56860. * @param sheenConfiguration define the config where to copy the info
  56861. */
  56862. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  56863. /**
  56864. * Serializes this BRDF configuration.
  56865. * @returns - An object with the serialized config.
  56866. */
  56867. serialize(): any;
  56868. /**
  56869. * Parses a anisotropy Configuration from a serialized object.
  56870. * @param source - Serialized object.
  56871. * @param scene Defines the scene we are parsing for
  56872. * @param rootUrl Defines the rootUrl to load from
  56873. */
  56874. parse(source: any, scene: Scene, rootUrl: string): void;
  56875. }
  56876. }
  56877. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  56878. import { Nullable } from "babylonjs/types";
  56879. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  56880. import { Color3 } from "babylonjs/Maths/math.color";
  56881. import { SmartArray } from "babylonjs/Misc/smartArray";
  56882. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56883. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  56884. import { Effect } from "babylonjs/Materials/effect";
  56885. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  56886. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56887. import { Engine } from "babylonjs/Engines/engine";
  56888. import { Scene } from "babylonjs/scene";
  56889. /**
  56890. * @hidden
  56891. */
  56892. export interface IMaterialSubSurfaceDefines {
  56893. SUBSURFACE: boolean;
  56894. SS_REFRACTION: boolean;
  56895. SS_TRANSLUCENCY: boolean;
  56896. SS_SCATTERING: boolean;
  56897. SS_THICKNESSANDMASK_TEXTURE: boolean;
  56898. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  56899. SS_REFRACTIONMAP_3D: boolean;
  56900. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  56901. SS_LODINREFRACTIONALPHA: boolean;
  56902. SS_GAMMAREFRACTION: boolean;
  56903. SS_RGBDREFRACTION: boolean;
  56904. SS_LINEARSPECULARREFRACTION: boolean;
  56905. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  56906. SS_ALBEDOFORREFRACTIONTINT: boolean;
  56907. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  56908. /** @hidden */
  56909. _areTexturesDirty: boolean;
  56910. }
  56911. /**
  56912. * Define the code related to the sub surface parameters of the pbr material.
  56913. */
  56914. export class PBRSubSurfaceConfiguration {
  56915. private _isRefractionEnabled;
  56916. /**
  56917. * Defines if the refraction is enabled in the material.
  56918. */
  56919. isRefractionEnabled: boolean;
  56920. private _isTranslucencyEnabled;
  56921. /**
  56922. * Defines if the translucency is enabled in the material.
  56923. */
  56924. isTranslucencyEnabled: boolean;
  56925. private _isScatteringEnabled;
  56926. /**
  56927. * Defines the refraction intensity of the material.
  56928. * The refraction when enabled replaces the Diffuse part of the material.
  56929. * The intensity helps transitionning between diffuse and refraction.
  56930. */
  56931. refractionIntensity: number;
  56932. /**
  56933. * Defines the translucency intensity of the material.
  56934. * When translucency has been enabled, this defines how much of the "translucency"
  56935. * is addded to the diffuse part of the material.
  56936. */
  56937. translucencyIntensity: number;
  56938. /**
  56939. * Defines the scattering intensity of the material.
  56940. * When scattering has been enabled, this defines how much of the "scattered light"
  56941. * is addded to the diffuse part of the material.
  56942. */
  56943. scatteringIntensity: number;
  56944. /**
  56945. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  56946. */
  56947. useAlbedoToTintRefraction: boolean;
  56948. private _thicknessTexture;
  56949. /**
  56950. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  56951. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  56952. * 0 would mean minimumThickness
  56953. * 1 would mean maximumThickness
  56954. * The other channels might be use as a mask to vary the different effects intensity.
  56955. */
  56956. thicknessTexture: Nullable<BaseTexture>;
  56957. private _refractionTexture;
  56958. /**
  56959. * Defines the texture to use for refraction.
  56960. */
  56961. refractionTexture: Nullable<BaseTexture>;
  56962. private _indexOfRefraction;
  56963. /**
  56964. * Index of refraction of the material base layer.
  56965. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  56966. *
  56967. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  56968. *
  56969. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  56970. */
  56971. indexOfRefraction: number;
  56972. private _volumeIndexOfRefraction;
  56973. /**
  56974. * Index of refraction of the material's volume.
  56975. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  56976. *
  56977. * This ONLY impacts refraction. If not provided or given a non-valid value,
  56978. * the volume will use the same IOR as the surface.
  56979. */
  56980. get volumeIndexOfRefraction(): number;
  56981. set volumeIndexOfRefraction(value: number);
  56982. private _invertRefractionY;
  56983. /**
  56984. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  56985. */
  56986. invertRefractionY: boolean;
  56987. private _linkRefractionWithTransparency;
  56988. /**
  56989. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  56990. * Materials half opaque for instance using refraction could benefit from this control.
  56991. */
  56992. linkRefractionWithTransparency: boolean;
  56993. /**
  56994. * Defines the minimum thickness stored in the thickness map.
  56995. * If no thickness map is defined, this value will be used to simulate thickness.
  56996. */
  56997. minimumThickness: number;
  56998. /**
  56999. * Defines the maximum thickness stored in the thickness map.
  57000. */
  57001. maximumThickness: number;
  57002. /**
  57003. * Defines the volume tint of the material.
  57004. * This is used for both translucency and scattering.
  57005. */
  57006. tintColor: Color3;
  57007. /**
  57008. * Defines the distance at which the tint color should be found in the media.
  57009. * This is used for refraction only.
  57010. */
  57011. tintColorAtDistance: number;
  57012. /**
  57013. * Defines how far each channel transmit through the media.
  57014. * It is defined as a color to simplify it selection.
  57015. */
  57016. diffusionDistance: Color3;
  57017. private _useMaskFromThicknessTexture;
  57018. /**
  57019. * Stores the intensity of the different subsurface effects in the thickness texture.
  57020. * * the green channel is the translucency intensity.
  57021. * * the blue channel is the scattering intensity.
  57022. * * the alpha channel is the refraction intensity.
  57023. */
  57024. useMaskFromThicknessTexture: boolean;
  57025. /** @hidden */
  57026. private _internalMarkAllSubMeshesAsTexturesDirty;
  57027. /** @hidden */
  57028. _markAllSubMeshesAsTexturesDirty(): void;
  57029. /**
  57030. * Instantiate a new istance of sub surface configuration.
  57031. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57032. */
  57033. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57034. /**
  57035. * Gets wehter the submesh is ready to be used or not.
  57036. * @param defines the list of "defines" to update.
  57037. * @param scene defines the scene the material belongs to.
  57038. * @returns - boolean indicating that the submesh is ready or not.
  57039. */
  57040. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  57041. /**
  57042. * Checks to see if a texture is used in the material.
  57043. * @param defines the list of "defines" to update.
  57044. * @param scene defines the scene to the material belongs to.
  57045. */
  57046. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  57047. /**
  57048. * Binds the material data.
  57049. * @param uniformBuffer defines the Uniform buffer to fill in.
  57050. * @param scene defines the scene the material belongs to.
  57051. * @param engine defines the engine the material belongs to.
  57052. * @param isFrozen defines whether the material is frozen or not.
  57053. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  57054. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  57055. */
  57056. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  57057. /**
  57058. * Unbinds the material from the mesh.
  57059. * @param activeEffect defines the effect that should be unbound from.
  57060. * @returns true if unbound, otherwise false
  57061. */
  57062. unbind(activeEffect: Effect): boolean;
  57063. /**
  57064. * Returns the texture used for refraction or null if none is used.
  57065. * @param scene defines the scene the material belongs to.
  57066. * @returns - Refraction texture if present. If no refraction texture and refraction
  57067. * is linked with transparency, returns environment texture. Otherwise, returns null.
  57068. */
  57069. private _getRefractionTexture;
  57070. /**
  57071. * Returns true if alpha blending should be disabled.
  57072. */
  57073. get disableAlphaBlending(): boolean;
  57074. /**
  57075. * Fills the list of render target textures.
  57076. * @param renderTargets the list of render targets to update
  57077. */
  57078. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  57079. /**
  57080. * Checks to see if a texture is used in the material.
  57081. * @param texture - Base texture to use.
  57082. * @returns - Boolean specifying if a texture is used in the material.
  57083. */
  57084. hasTexture(texture: BaseTexture): boolean;
  57085. /**
  57086. * Gets a boolean indicating that current material needs to register RTT
  57087. * @returns true if this uses a render target otherwise false.
  57088. */
  57089. hasRenderTargetTextures(): boolean;
  57090. /**
  57091. * Returns an array of the actively used textures.
  57092. * @param activeTextures Array of BaseTextures
  57093. */
  57094. getActiveTextures(activeTextures: BaseTexture[]): void;
  57095. /**
  57096. * Returns the animatable textures.
  57097. * @param animatables Array of animatable textures.
  57098. */
  57099. getAnimatables(animatables: IAnimatable[]): void;
  57100. /**
  57101. * Disposes the resources of the material.
  57102. * @param forceDisposeTextures - Forces the disposal of all textures.
  57103. */
  57104. dispose(forceDisposeTextures?: boolean): void;
  57105. /**
  57106. * Get the current class name of the texture useful for serialization or dynamic coding.
  57107. * @returns "PBRSubSurfaceConfiguration"
  57108. */
  57109. getClassName(): string;
  57110. /**
  57111. * Add fallbacks to the effect fallbacks list.
  57112. * @param defines defines the Base texture to use.
  57113. * @param fallbacks defines the current fallback list.
  57114. * @param currentRank defines the current fallback rank.
  57115. * @returns the new fallback rank.
  57116. */
  57117. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57118. /**
  57119. * Add the required uniforms to the current list.
  57120. * @param uniforms defines the current uniform list.
  57121. */
  57122. static AddUniforms(uniforms: string[]): void;
  57123. /**
  57124. * Add the required samplers to the current list.
  57125. * @param samplers defines the current sampler list.
  57126. */
  57127. static AddSamplers(samplers: string[]): void;
  57128. /**
  57129. * Add the required uniforms to the current buffer.
  57130. * @param uniformBuffer defines the current uniform buffer.
  57131. */
  57132. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57133. /**
  57134. * Makes a duplicate of the current configuration into another one.
  57135. * @param configuration define the config where to copy the info
  57136. */
  57137. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  57138. /**
  57139. * Serializes this Sub Surface configuration.
  57140. * @returns - An object with the serialized config.
  57141. */
  57142. serialize(): any;
  57143. /**
  57144. * Parses a anisotropy Configuration from a serialized object.
  57145. * @param source - Serialized object.
  57146. * @param scene Defines the scene we are parsing for
  57147. * @param rootUrl Defines the rootUrl to load from
  57148. */
  57149. parse(source: any, scene: Scene, rootUrl: string): void;
  57150. }
  57151. }
  57152. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  57153. /** @hidden */
  57154. export var pbrFragmentDeclaration: {
  57155. name: string;
  57156. shader: string;
  57157. };
  57158. }
  57159. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  57160. /** @hidden */
  57161. export var pbrUboDeclaration: {
  57162. name: string;
  57163. shader: string;
  57164. };
  57165. }
  57166. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  57167. /** @hidden */
  57168. export var pbrFragmentExtraDeclaration: {
  57169. name: string;
  57170. shader: string;
  57171. };
  57172. }
  57173. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  57174. /** @hidden */
  57175. export var pbrFragmentSamplersDeclaration: {
  57176. name: string;
  57177. shader: string;
  57178. };
  57179. }
  57180. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  57181. /** @hidden */
  57182. export var importanceSampling: {
  57183. name: string;
  57184. shader: string;
  57185. };
  57186. }
  57187. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  57188. /** @hidden */
  57189. export var pbrHelperFunctions: {
  57190. name: string;
  57191. shader: string;
  57192. };
  57193. }
  57194. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  57195. /** @hidden */
  57196. export var harmonicsFunctions: {
  57197. name: string;
  57198. shader: string;
  57199. };
  57200. }
  57201. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  57202. /** @hidden */
  57203. export var pbrDirectLightingSetupFunctions: {
  57204. name: string;
  57205. shader: string;
  57206. };
  57207. }
  57208. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  57209. /** @hidden */
  57210. export var pbrDirectLightingFalloffFunctions: {
  57211. name: string;
  57212. shader: string;
  57213. };
  57214. }
  57215. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  57216. /** @hidden */
  57217. export var pbrBRDFFunctions: {
  57218. name: string;
  57219. shader: string;
  57220. };
  57221. }
  57222. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  57223. /** @hidden */
  57224. export var hdrFilteringFunctions: {
  57225. name: string;
  57226. shader: string;
  57227. };
  57228. }
  57229. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  57230. /** @hidden */
  57231. export var pbrDirectLightingFunctions: {
  57232. name: string;
  57233. shader: string;
  57234. };
  57235. }
  57236. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  57237. /** @hidden */
  57238. export var pbrIBLFunctions: {
  57239. name: string;
  57240. shader: string;
  57241. };
  57242. }
  57243. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  57244. /** @hidden */
  57245. export var pbrBlockAlbedoOpacity: {
  57246. name: string;
  57247. shader: string;
  57248. };
  57249. }
  57250. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  57251. /** @hidden */
  57252. export var pbrBlockReflectivity: {
  57253. name: string;
  57254. shader: string;
  57255. };
  57256. }
  57257. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  57258. /** @hidden */
  57259. export var pbrBlockAmbientOcclusion: {
  57260. name: string;
  57261. shader: string;
  57262. };
  57263. }
  57264. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  57265. /** @hidden */
  57266. export var pbrBlockAlphaFresnel: {
  57267. name: string;
  57268. shader: string;
  57269. };
  57270. }
  57271. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  57272. /** @hidden */
  57273. export var pbrBlockAnisotropic: {
  57274. name: string;
  57275. shader: string;
  57276. };
  57277. }
  57278. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  57279. /** @hidden */
  57280. export var pbrBlockReflection: {
  57281. name: string;
  57282. shader: string;
  57283. };
  57284. }
  57285. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  57286. /** @hidden */
  57287. export var pbrBlockSheen: {
  57288. name: string;
  57289. shader: string;
  57290. };
  57291. }
  57292. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  57293. /** @hidden */
  57294. export var pbrBlockClearcoat: {
  57295. name: string;
  57296. shader: string;
  57297. };
  57298. }
  57299. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  57300. /** @hidden */
  57301. export var pbrBlockSubSurface: {
  57302. name: string;
  57303. shader: string;
  57304. };
  57305. }
  57306. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  57307. /** @hidden */
  57308. export var pbrBlockNormalGeometric: {
  57309. name: string;
  57310. shader: string;
  57311. };
  57312. }
  57313. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  57314. /** @hidden */
  57315. export var pbrBlockNormalFinal: {
  57316. name: string;
  57317. shader: string;
  57318. };
  57319. }
  57320. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  57321. /** @hidden */
  57322. export var pbrBlockGeometryInfo: {
  57323. name: string;
  57324. shader: string;
  57325. };
  57326. }
  57327. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  57328. /** @hidden */
  57329. export var pbrBlockReflectance0: {
  57330. name: string;
  57331. shader: string;
  57332. };
  57333. }
  57334. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  57335. /** @hidden */
  57336. export var pbrBlockReflectance: {
  57337. name: string;
  57338. shader: string;
  57339. };
  57340. }
  57341. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  57342. /** @hidden */
  57343. export var pbrBlockDirectLighting: {
  57344. name: string;
  57345. shader: string;
  57346. };
  57347. }
  57348. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  57349. /** @hidden */
  57350. export var pbrBlockFinalLitComponents: {
  57351. name: string;
  57352. shader: string;
  57353. };
  57354. }
  57355. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  57356. /** @hidden */
  57357. export var pbrBlockFinalUnlitComponents: {
  57358. name: string;
  57359. shader: string;
  57360. };
  57361. }
  57362. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  57363. /** @hidden */
  57364. export var pbrBlockFinalColorComposition: {
  57365. name: string;
  57366. shader: string;
  57367. };
  57368. }
  57369. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  57370. /** @hidden */
  57371. export var pbrBlockImageProcessing: {
  57372. name: string;
  57373. shader: string;
  57374. };
  57375. }
  57376. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  57377. /** @hidden */
  57378. export var pbrDebug: {
  57379. name: string;
  57380. shader: string;
  57381. };
  57382. }
  57383. declare module "babylonjs/Shaders/pbr.fragment" {
  57384. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  57385. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  57386. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  57387. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  57388. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  57389. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  57390. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  57391. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  57392. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  57393. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  57394. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57395. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  57396. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  57397. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  57398. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  57399. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  57400. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  57401. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  57402. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  57403. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  57404. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  57405. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  57406. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  57407. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  57408. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  57409. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  57410. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  57411. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  57412. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  57413. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  57414. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  57415. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  57416. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  57417. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  57418. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  57419. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  57420. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  57421. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  57422. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  57423. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  57424. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  57425. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  57426. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  57427. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  57428. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  57429. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  57430. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  57431. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  57432. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  57433. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  57434. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  57435. /** @hidden */
  57436. export var pbrPixelShader: {
  57437. name: string;
  57438. shader: string;
  57439. };
  57440. }
  57441. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  57442. /** @hidden */
  57443. export var pbrVertexDeclaration: {
  57444. name: string;
  57445. shader: string;
  57446. };
  57447. }
  57448. declare module "babylonjs/Shaders/pbr.vertex" {
  57449. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  57450. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  57451. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57452. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  57453. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  57454. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  57455. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  57456. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  57457. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  57458. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  57459. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  57460. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  57461. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  57462. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  57463. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  57464. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  57465. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  57466. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  57467. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  57468. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  57469. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  57470. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  57471. /** @hidden */
  57472. export var pbrVertexShader: {
  57473. name: string;
  57474. shader: string;
  57475. };
  57476. }
  57477. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  57478. import { Nullable } from "babylonjs/types";
  57479. import { Scene } from "babylonjs/scene";
  57480. import { Matrix } from "babylonjs/Maths/math.vector";
  57481. import { SubMesh } from "babylonjs/Meshes/subMesh";
  57482. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57483. import { Mesh } from "babylonjs/Meshes/mesh";
  57484. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  57485. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  57486. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  57487. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  57488. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  57489. import { Color3 } from "babylonjs/Maths/math.color";
  57490. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  57491. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  57492. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  57493. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  57494. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57495. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57496. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  57497. import "babylonjs/Shaders/pbr.fragment";
  57498. import "babylonjs/Shaders/pbr.vertex";
  57499. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  57500. /**
  57501. * Manages the defines for the PBR Material.
  57502. * @hidden
  57503. */
  57504. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  57505. PBR: boolean;
  57506. NUM_SAMPLES: string;
  57507. REALTIME_FILTERING: boolean;
  57508. MAINUV1: boolean;
  57509. MAINUV2: boolean;
  57510. UV1: boolean;
  57511. UV2: boolean;
  57512. ALBEDO: boolean;
  57513. GAMMAALBEDO: boolean;
  57514. ALBEDODIRECTUV: number;
  57515. VERTEXCOLOR: boolean;
  57516. DETAIL: boolean;
  57517. DETAILDIRECTUV: number;
  57518. DETAIL_NORMALBLENDMETHOD: number;
  57519. AMBIENT: boolean;
  57520. AMBIENTDIRECTUV: number;
  57521. AMBIENTINGRAYSCALE: boolean;
  57522. OPACITY: boolean;
  57523. VERTEXALPHA: boolean;
  57524. OPACITYDIRECTUV: number;
  57525. OPACITYRGB: boolean;
  57526. ALPHATEST: boolean;
  57527. DEPTHPREPASS: boolean;
  57528. ALPHABLEND: boolean;
  57529. ALPHAFROMALBEDO: boolean;
  57530. ALPHATESTVALUE: string;
  57531. SPECULAROVERALPHA: boolean;
  57532. RADIANCEOVERALPHA: boolean;
  57533. ALPHAFRESNEL: boolean;
  57534. LINEARALPHAFRESNEL: boolean;
  57535. PREMULTIPLYALPHA: boolean;
  57536. EMISSIVE: boolean;
  57537. EMISSIVEDIRECTUV: number;
  57538. REFLECTIVITY: boolean;
  57539. REFLECTIVITYDIRECTUV: number;
  57540. SPECULARTERM: boolean;
  57541. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  57542. MICROSURFACEAUTOMATIC: boolean;
  57543. LODBASEDMICROSFURACE: boolean;
  57544. MICROSURFACEMAP: boolean;
  57545. MICROSURFACEMAPDIRECTUV: number;
  57546. METALLICWORKFLOW: boolean;
  57547. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  57548. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  57549. METALLNESSSTOREINMETALMAPBLUE: boolean;
  57550. AOSTOREINMETALMAPRED: boolean;
  57551. METALLIC_REFLECTANCE: boolean;
  57552. METALLIC_REFLECTANCEDIRECTUV: number;
  57553. ENVIRONMENTBRDF: boolean;
  57554. ENVIRONMENTBRDF_RGBD: boolean;
  57555. NORMAL: boolean;
  57556. TANGENT: boolean;
  57557. BUMP: boolean;
  57558. BUMPDIRECTUV: number;
  57559. OBJECTSPACE_NORMALMAP: boolean;
  57560. PARALLAX: boolean;
  57561. PARALLAXOCCLUSION: boolean;
  57562. NORMALXYSCALE: boolean;
  57563. LIGHTMAP: boolean;
  57564. LIGHTMAPDIRECTUV: number;
  57565. USELIGHTMAPASSHADOWMAP: boolean;
  57566. GAMMALIGHTMAP: boolean;
  57567. RGBDLIGHTMAP: boolean;
  57568. REFLECTION: boolean;
  57569. REFLECTIONMAP_3D: boolean;
  57570. REFLECTIONMAP_SPHERICAL: boolean;
  57571. REFLECTIONMAP_PLANAR: boolean;
  57572. REFLECTIONMAP_CUBIC: boolean;
  57573. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  57574. REFLECTIONMAP_PROJECTION: boolean;
  57575. REFLECTIONMAP_SKYBOX: boolean;
  57576. REFLECTIONMAP_EXPLICIT: boolean;
  57577. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  57578. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  57579. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  57580. INVERTCUBICMAP: boolean;
  57581. USESPHERICALFROMREFLECTIONMAP: boolean;
  57582. USEIRRADIANCEMAP: boolean;
  57583. SPHERICAL_HARMONICS: boolean;
  57584. USESPHERICALINVERTEX: boolean;
  57585. REFLECTIONMAP_OPPOSITEZ: boolean;
  57586. LODINREFLECTIONALPHA: boolean;
  57587. GAMMAREFLECTION: boolean;
  57588. RGBDREFLECTION: boolean;
  57589. LINEARSPECULARREFLECTION: boolean;
  57590. RADIANCEOCCLUSION: boolean;
  57591. HORIZONOCCLUSION: boolean;
  57592. INSTANCES: boolean;
  57593. THIN_INSTANCES: boolean;
  57594. NUM_BONE_INFLUENCERS: number;
  57595. BonesPerMesh: number;
  57596. BONETEXTURE: boolean;
  57597. NONUNIFORMSCALING: boolean;
  57598. MORPHTARGETS: boolean;
  57599. MORPHTARGETS_NORMAL: boolean;
  57600. MORPHTARGETS_TANGENT: boolean;
  57601. MORPHTARGETS_UV: boolean;
  57602. NUM_MORPH_INFLUENCERS: number;
  57603. IMAGEPROCESSING: boolean;
  57604. VIGNETTE: boolean;
  57605. VIGNETTEBLENDMODEMULTIPLY: boolean;
  57606. VIGNETTEBLENDMODEOPAQUE: boolean;
  57607. TONEMAPPING: boolean;
  57608. TONEMAPPING_ACES: boolean;
  57609. CONTRAST: boolean;
  57610. COLORCURVES: boolean;
  57611. COLORGRADING: boolean;
  57612. COLORGRADING3D: boolean;
  57613. SAMPLER3DGREENDEPTH: boolean;
  57614. SAMPLER3DBGRMAP: boolean;
  57615. IMAGEPROCESSINGPOSTPROCESS: boolean;
  57616. EXPOSURE: boolean;
  57617. MULTIVIEW: boolean;
  57618. USEPHYSICALLIGHTFALLOFF: boolean;
  57619. USEGLTFLIGHTFALLOFF: boolean;
  57620. TWOSIDEDLIGHTING: boolean;
  57621. SHADOWFLOAT: boolean;
  57622. CLIPPLANE: boolean;
  57623. CLIPPLANE2: boolean;
  57624. CLIPPLANE3: boolean;
  57625. CLIPPLANE4: boolean;
  57626. CLIPPLANE5: boolean;
  57627. CLIPPLANE6: boolean;
  57628. POINTSIZE: boolean;
  57629. FOG: boolean;
  57630. LOGARITHMICDEPTH: boolean;
  57631. FORCENORMALFORWARD: boolean;
  57632. SPECULARAA: boolean;
  57633. CLEARCOAT: boolean;
  57634. CLEARCOAT_DEFAULTIOR: boolean;
  57635. CLEARCOAT_TEXTURE: boolean;
  57636. CLEARCOAT_TEXTUREDIRECTUV: number;
  57637. CLEARCOAT_BUMP: boolean;
  57638. CLEARCOAT_BUMPDIRECTUV: number;
  57639. CLEARCOAT_TINT: boolean;
  57640. CLEARCOAT_TINT_TEXTURE: boolean;
  57641. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57642. ANISOTROPIC: boolean;
  57643. ANISOTROPIC_TEXTURE: boolean;
  57644. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57645. BRDF_V_HEIGHT_CORRELATED: boolean;
  57646. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57647. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57648. SHEEN: boolean;
  57649. SHEEN_TEXTURE: boolean;
  57650. SHEEN_TEXTUREDIRECTUV: number;
  57651. SHEEN_LINKWITHALBEDO: boolean;
  57652. SHEEN_ROUGHNESS: boolean;
  57653. SHEEN_ALBEDOSCALING: boolean;
  57654. SUBSURFACE: boolean;
  57655. SS_REFRACTION: boolean;
  57656. SS_TRANSLUCENCY: boolean;
  57657. SS_SCATTERING: boolean;
  57658. SS_THICKNESSANDMASK_TEXTURE: boolean;
  57659. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  57660. SS_REFRACTIONMAP_3D: boolean;
  57661. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  57662. SS_LODINREFRACTIONALPHA: boolean;
  57663. SS_GAMMAREFRACTION: boolean;
  57664. SS_RGBDREFRACTION: boolean;
  57665. SS_LINEARSPECULARREFRACTION: boolean;
  57666. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  57667. SS_ALBEDOFORREFRACTIONTINT: boolean;
  57668. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  57669. UNLIT: boolean;
  57670. DEBUGMODE: number;
  57671. /**
  57672. * Initializes the PBR Material defines.
  57673. */
  57674. constructor();
  57675. /**
  57676. * Resets the PBR Material defines.
  57677. */
  57678. reset(): void;
  57679. }
  57680. /**
  57681. * The Physically based material base class of BJS.
  57682. *
  57683. * This offers the main features of a standard PBR material.
  57684. * For more information, please refer to the documentation :
  57685. * https://doc.babylonjs.com/how_to/physically_based_rendering
  57686. */
  57687. export abstract class PBRBaseMaterial extends PushMaterial {
  57688. /**
  57689. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  57690. */
  57691. static readonly PBRMATERIAL_OPAQUE: number;
  57692. /**
  57693. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  57694. */
  57695. static readonly PBRMATERIAL_ALPHATEST: number;
  57696. /**
  57697. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  57698. */
  57699. static readonly PBRMATERIAL_ALPHABLEND: number;
  57700. /**
  57701. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  57702. * They are also discarded below the alpha cutoff threshold to improve performances.
  57703. */
  57704. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  57705. /**
  57706. * Defines the default value of how much AO map is occluding the analytical lights
  57707. * (point spot...).
  57708. */
  57709. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  57710. /**
  57711. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  57712. */
  57713. static readonly LIGHTFALLOFF_PHYSICAL: number;
  57714. /**
  57715. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  57716. * to enhance interoperability with other engines.
  57717. */
  57718. static readonly LIGHTFALLOFF_GLTF: number;
  57719. /**
  57720. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  57721. * to enhance interoperability with other materials.
  57722. */
  57723. static readonly LIGHTFALLOFF_STANDARD: number;
  57724. /**
  57725. * Intensity of the direct lights e.g. the four lights available in your scene.
  57726. * This impacts both the direct diffuse and specular highlights.
  57727. */
  57728. protected _directIntensity: number;
  57729. /**
  57730. * Intensity of the emissive part of the material.
  57731. * This helps controlling the emissive effect without modifying the emissive color.
  57732. */
  57733. protected _emissiveIntensity: number;
  57734. /**
  57735. * Intensity of the environment e.g. how much the environment will light the object
  57736. * either through harmonics for rough material or through the refelction for shiny ones.
  57737. */
  57738. protected _environmentIntensity: number;
  57739. /**
  57740. * This is a special control allowing the reduction of the specular highlights coming from the
  57741. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  57742. */
  57743. protected _specularIntensity: number;
  57744. /**
  57745. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  57746. */
  57747. private _lightingInfos;
  57748. /**
  57749. * Debug Control allowing disabling the bump map on this material.
  57750. */
  57751. protected _disableBumpMap: boolean;
  57752. /**
  57753. * AKA Diffuse Texture in standard nomenclature.
  57754. */
  57755. protected _albedoTexture: Nullable<BaseTexture>;
  57756. /**
  57757. * AKA Occlusion Texture in other nomenclature.
  57758. */
  57759. protected _ambientTexture: Nullable<BaseTexture>;
  57760. /**
  57761. * AKA Occlusion Texture Intensity in other nomenclature.
  57762. */
  57763. protected _ambientTextureStrength: number;
  57764. /**
  57765. * Defines how much the AO map is occluding the analytical lights (point spot...).
  57766. * 1 means it completely occludes it
  57767. * 0 mean it has no impact
  57768. */
  57769. protected _ambientTextureImpactOnAnalyticalLights: number;
  57770. /**
  57771. * Stores the alpha values in a texture.
  57772. */
  57773. protected _opacityTexture: Nullable<BaseTexture>;
  57774. /**
  57775. * Stores the reflection values in a texture.
  57776. */
  57777. protected _reflectionTexture: Nullable<BaseTexture>;
  57778. /**
  57779. * Stores the emissive values in a texture.
  57780. */
  57781. protected _emissiveTexture: Nullable<BaseTexture>;
  57782. /**
  57783. * AKA Specular texture in other nomenclature.
  57784. */
  57785. protected _reflectivityTexture: Nullable<BaseTexture>;
  57786. /**
  57787. * Used to switch from specular/glossiness to metallic/roughness workflow.
  57788. */
  57789. protected _metallicTexture: Nullable<BaseTexture>;
  57790. /**
  57791. * Specifies the metallic scalar of the metallic/roughness workflow.
  57792. * Can also be used to scale the metalness values of the metallic texture.
  57793. */
  57794. protected _metallic: Nullable<number>;
  57795. /**
  57796. * Specifies the roughness scalar of the metallic/roughness workflow.
  57797. * Can also be used to scale the roughness values of the metallic texture.
  57798. */
  57799. protected _roughness: Nullable<number>;
  57800. /**
  57801. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  57802. * By default the indexOfrefraction is used to compute F0;
  57803. *
  57804. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  57805. *
  57806. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  57807. * F90 = metallicReflectanceColor;
  57808. */
  57809. protected _metallicF0Factor: number;
  57810. /**
  57811. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  57812. * By default the F90 is always 1;
  57813. *
  57814. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  57815. *
  57816. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  57817. * F90 = metallicReflectanceColor;
  57818. */
  57819. protected _metallicReflectanceColor: Color3;
  57820. /**
  57821. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  57822. * This is multiply against the scalar values defined in the material.
  57823. */
  57824. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  57825. /**
  57826. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  57827. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  57828. */
  57829. protected _microSurfaceTexture: Nullable<BaseTexture>;
  57830. /**
  57831. * Stores surface normal data used to displace a mesh in a texture.
  57832. */
  57833. protected _bumpTexture: Nullable<BaseTexture>;
  57834. /**
  57835. * Stores the pre-calculated light information of a mesh in a texture.
  57836. */
  57837. protected _lightmapTexture: Nullable<BaseTexture>;
  57838. /**
  57839. * The color of a material in ambient lighting.
  57840. */
  57841. protected _ambientColor: Color3;
  57842. /**
  57843. * AKA Diffuse Color in other nomenclature.
  57844. */
  57845. protected _albedoColor: Color3;
  57846. /**
  57847. * AKA Specular Color in other nomenclature.
  57848. */
  57849. protected _reflectivityColor: Color3;
  57850. /**
  57851. * The color applied when light is reflected from a material.
  57852. */
  57853. protected _reflectionColor: Color3;
  57854. /**
  57855. * The color applied when light is emitted from a material.
  57856. */
  57857. protected _emissiveColor: Color3;
  57858. /**
  57859. * AKA Glossiness in other nomenclature.
  57860. */
  57861. protected _microSurface: number;
  57862. /**
  57863. * Specifies that the material will use the light map as a show map.
  57864. */
  57865. protected _useLightmapAsShadowmap: boolean;
  57866. /**
  57867. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  57868. * makes the reflect vector face the model (under horizon).
  57869. */
  57870. protected _useHorizonOcclusion: boolean;
  57871. /**
  57872. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  57873. * too much the area relying on ambient texture to define their ambient occlusion.
  57874. */
  57875. protected _useRadianceOcclusion: boolean;
  57876. /**
  57877. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  57878. */
  57879. protected _useAlphaFromAlbedoTexture: boolean;
  57880. /**
  57881. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  57882. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  57883. */
  57884. protected _useSpecularOverAlpha: boolean;
  57885. /**
  57886. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  57887. */
  57888. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  57889. /**
  57890. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  57891. */
  57892. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  57893. /**
  57894. * Specifies if the metallic texture contains the roughness information in its green channel.
  57895. */
  57896. protected _useRoughnessFromMetallicTextureGreen: boolean;
  57897. /**
  57898. * Specifies if the metallic texture contains the metallness information in its blue channel.
  57899. */
  57900. protected _useMetallnessFromMetallicTextureBlue: boolean;
  57901. /**
  57902. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  57903. */
  57904. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  57905. /**
  57906. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  57907. */
  57908. protected _useAmbientInGrayScale: boolean;
  57909. /**
  57910. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  57911. * The material will try to infer what glossiness each pixel should be.
  57912. */
  57913. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  57914. /**
  57915. * Defines the falloff type used in this material.
  57916. * It by default is Physical.
  57917. */
  57918. protected _lightFalloff: number;
  57919. /**
  57920. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  57921. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  57922. */
  57923. protected _useRadianceOverAlpha: boolean;
  57924. /**
  57925. * Allows using an object space normal map (instead of tangent space).
  57926. */
  57927. protected _useObjectSpaceNormalMap: boolean;
  57928. /**
  57929. * Allows using the bump map in parallax mode.
  57930. */
  57931. protected _useParallax: boolean;
  57932. /**
  57933. * Allows using the bump map in parallax occlusion mode.
  57934. */
  57935. protected _useParallaxOcclusion: boolean;
  57936. /**
  57937. * Controls the scale bias of the parallax mode.
  57938. */
  57939. protected _parallaxScaleBias: number;
  57940. /**
  57941. * If sets to true, disables all the lights affecting the material.
  57942. */
  57943. protected _disableLighting: boolean;
  57944. /**
  57945. * Number of Simultaneous lights allowed on the material.
  57946. */
  57947. protected _maxSimultaneousLights: number;
  57948. /**
  57949. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57950. */
  57951. protected _invertNormalMapX: boolean;
  57952. /**
  57953. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57954. */
  57955. protected _invertNormalMapY: boolean;
  57956. /**
  57957. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  57958. */
  57959. protected _twoSidedLighting: boolean;
  57960. /**
  57961. * Defines the alpha limits in alpha test mode.
  57962. */
  57963. protected _alphaCutOff: number;
  57964. /**
  57965. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  57966. */
  57967. protected _forceAlphaTest: boolean;
  57968. /**
  57969. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  57970. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  57971. */
  57972. protected _useAlphaFresnel: boolean;
  57973. /**
  57974. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  57975. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  57976. */
  57977. protected _useLinearAlphaFresnel: boolean;
  57978. /**
  57979. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  57980. * from cos thetav and roughness:
  57981. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  57982. */
  57983. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  57984. /**
  57985. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  57986. */
  57987. protected _forceIrradianceInFragment: boolean;
  57988. private _realTimeFiltering;
  57989. /**
  57990. * Enables realtime filtering on the texture.
  57991. */
  57992. get realTimeFiltering(): boolean;
  57993. set realTimeFiltering(b: boolean);
  57994. private _realTimeFilteringQuality;
  57995. /**
  57996. * Quality switch for realtime filtering
  57997. */
  57998. get realTimeFilteringQuality(): number;
  57999. set realTimeFilteringQuality(n: number);
  58000. /**
  58001. * Force normal to face away from face.
  58002. */
  58003. protected _forceNormalForward: boolean;
  58004. /**
  58005. * Enables specular anti aliasing in the PBR shader.
  58006. * It will both interacts on the Geometry for analytical and IBL lighting.
  58007. * It also prefilter the roughness map based on the bump values.
  58008. */
  58009. protected _enableSpecularAntiAliasing: boolean;
  58010. /**
  58011. * Default configuration related to image processing available in the PBR Material.
  58012. */
  58013. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  58014. /**
  58015. * Keep track of the image processing observer to allow dispose and replace.
  58016. */
  58017. private _imageProcessingObserver;
  58018. /**
  58019. * Attaches a new image processing configuration to the PBR Material.
  58020. * @param configuration
  58021. */
  58022. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  58023. /**
  58024. * Stores the available render targets.
  58025. */
  58026. private _renderTargets;
  58027. /**
  58028. * Sets the global ambient color for the material used in lighting calculations.
  58029. */
  58030. private _globalAmbientColor;
  58031. /**
  58032. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  58033. */
  58034. private _useLogarithmicDepth;
  58035. /**
  58036. * If set to true, no lighting calculations will be applied.
  58037. */
  58038. private _unlit;
  58039. private _debugMode;
  58040. /**
  58041. * @hidden
  58042. * This is reserved for the inspector.
  58043. * Defines the material debug mode.
  58044. * It helps seeing only some components of the material while troubleshooting.
  58045. */
  58046. debugMode: number;
  58047. /**
  58048. * @hidden
  58049. * This is reserved for the inspector.
  58050. * Specify from where on screen the debug mode should start.
  58051. * The value goes from -1 (full screen) to 1 (not visible)
  58052. * It helps with side by side comparison against the final render
  58053. * This defaults to -1
  58054. */
  58055. private debugLimit;
  58056. /**
  58057. * @hidden
  58058. * This is reserved for the inspector.
  58059. * As the default viewing range might not be enough (if the ambient is really small for instance)
  58060. * You can use the factor to better multiply the final value.
  58061. */
  58062. private debugFactor;
  58063. /**
  58064. * Defines the clear coat layer parameters for the material.
  58065. */
  58066. readonly clearCoat: PBRClearCoatConfiguration;
  58067. /**
  58068. * Defines the anisotropic parameters for the material.
  58069. */
  58070. readonly anisotropy: PBRAnisotropicConfiguration;
  58071. /**
  58072. * Defines the BRDF parameters for the material.
  58073. */
  58074. readonly brdf: PBRBRDFConfiguration;
  58075. /**
  58076. * Defines the Sheen parameters for the material.
  58077. */
  58078. readonly sheen: PBRSheenConfiguration;
  58079. /**
  58080. * Defines the SubSurface parameters for the material.
  58081. */
  58082. readonly subSurface: PBRSubSurfaceConfiguration;
  58083. /**
  58084. * Defines the detail map parameters for the material.
  58085. */
  58086. readonly detailMap: DetailMapConfiguration;
  58087. protected _rebuildInParallel: boolean;
  58088. /**
  58089. * Instantiates a new PBRMaterial instance.
  58090. *
  58091. * @param name The material name
  58092. * @param scene The scene the material will be use in.
  58093. */
  58094. constructor(name: string, scene: Scene);
  58095. /**
  58096. * Gets a boolean indicating that current material needs to register RTT
  58097. */
  58098. get hasRenderTargetTextures(): boolean;
  58099. /**
  58100. * Gets the name of the material class.
  58101. */
  58102. getClassName(): string;
  58103. /**
  58104. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  58105. */
  58106. get useLogarithmicDepth(): boolean;
  58107. /**
  58108. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  58109. */
  58110. set useLogarithmicDepth(value: boolean);
  58111. /**
  58112. * Returns true if alpha blending should be disabled.
  58113. */
  58114. protected get _disableAlphaBlending(): boolean;
  58115. /**
  58116. * Specifies whether or not this material should be rendered in alpha blend mode.
  58117. */
  58118. needAlphaBlending(): boolean;
  58119. /**
  58120. * Specifies whether or not this material should be rendered in alpha test mode.
  58121. */
  58122. needAlphaTesting(): boolean;
  58123. /**
  58124. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  58125. */
  58126. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  58127. /**
  58128. * Gets the texture used for the alpha test.
  58129. */
  58130. getAlphaTestTexture(): Nullable<BaseTexture>;
  58131. /**
  58132. * Specifies that the submesh is ready to be used.
  58133. * @param mesh - BJS mesh.
  58134. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  58135. * @param useInstances - Specifies that instances should be used.
  58136. * @returns - boolean indicating that the submesh is ready or not.
  58137. */
  58138. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  58139. /**
  58140. * Specifies if the material uses metallic roughness workflow.
  58141. * @returns boolean specifiying if the material uses metallic roughness workflow.
  58142. */
  58143. isMetallicWorkflow(): boolean;
  58144. private _prepareEffect;
  58145. private _prepareDefines;
  58146. /**
  58147. * Force shader compilation
  58148. */
  58149. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  58150. /**
  58151. * Initializes the uniform buffer layout for the shader.
  58152. */
  58153. buildUniformLayout(): void;
  58154. /**
  58155. * Unbinds the material from the mesh
  58156. */
  58157. unbind(): void;
  58158. /**
  58159. * Binds the submesh data.
  58160. * @param world - The world matrix.
  58161. * @param mesh - The BJS mesh.
  58162. * @param subMesh - A submesh of the BJS mesh.
  58163. */
  58164. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  58165. /**
  58166. * Returns the animatable textures.
  58167. * @returns - Array of animatable textures.
  58168. */
  58169. getAnimatables(): IAnimatable[];
  58170. /**
  58171. * Returns the texture used for reflections.
  58172. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  58173. */
  58174. private _getReflectionTexture;
  58175. /**
  58176. * Returns an array of the actively used textures.
  58177. * @returns - Array of BaseTextures
  58178. */
  58179. getActiveTextures(): BaseTexture[];
  58180. /**
  58181. * Checks to see if a texture is used in the material.
  58182. * @param texture - Base texture to use.
  58183. * @returns - Boolean specifying if a texture is used in the material.
  58184. */
  58185. hasTexture(texture: BaseTexture): boolean;
  58186. /**
  58187. * Disposes the resources of the material.
  58188. * @param forceDisposeEffect - Forces the disposal of effects.
  58189. * @param forceDisposeTextures - Forces the disposal of all textures.
  58190. */
  58191. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  58192. }
  58193. }
  58194. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  58195. import { Nullable } from "babylonjs/types";
  58196. import { Scene } from "babylonjs/scene";
  58197. import { Color3 } from "babylonjs/Maths/math.color";
  58198. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  58199. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  58200. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58201. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  58202. /**
  58203. * The Physically based material of BJS.
  58204. *
  58205. * This offers the main features of a standard PBR material.
  58206. * For more information, please refer to the documentation :
  58207. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58208. */
  58209. export class PBRMaterial extends PBRBaseMaterial {
  58210. /**
  58211. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58212. */
  58213. static readonly PBRMATERIAL_OPAQUE: number;
  58214. /**
  58215. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58216. */
  58217. static readonly PBRMATERIAL_ALPHATEST: number;
  58218. /**
  58219. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58220. */
  58221. static readonly PBRMATERIAL_ALPHABLEND: number;
  58222. /**
  58223. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58224. * They are also discarded below the alpha cutoff threshold to improve performances.
  58225. */
  58226. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58227. /**
  58228. * Defines the default value of how much AO map is occluding the analytical lights
  58229. * (point spot...).
  58230. */
  58231. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58232. /**
  58233. * Intensity of the direct lights e.g. the four lights available in your scene.
  58234. * This impacts both the direct diffuse and specular highlights.
  58235. */
  58236. directIntensity: number;
  58237. /**
  58238. * Intensity of the emissive part of the material.
  58239. * This helps controlling the emissive effect without modifying the emissive color.
  58240. */
  58241. emissiveIntensity: number;
  58242. /**
  58243. * Intensity of the environment e.g. how much the environment will light the object
  58244. * either through harmonics for rough material or through the refelction for shiny ones.
  58245. */
  58246. environmentIntensity: number;
  58247. /**
  58248. * This is a special control allowing the reduction of the specular highlights coming from the
  58249. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  58250. */
  58251. specularIntensity: number;
  58252. /**
  58253. * Debug Control allowing disabling the bump map on this material.
  58254. */
  58255. disableBumpMap: boolean;
  58256. /**
  58257. * AKA Diffuse Texture in standard nomenclature.
  58258. */
  58259. albedoTexture: BaseTexture;
  58260. /**
  58261. * AKA Occlusion Texture in other nomenclature.
  58262. */
  58263. ambientTexture: BaseTexture;
  58264. /**
  58265. * AKA Occlusion Texture Intensity in other nomenclature.
  58266. */
  58267. ambientTextureStrength: number;
  58268. /**
  58269. * Defines how much the AO map is occluding the analytical lights (point spot...).
  58270. * 1 means it completely occludes it
  58271. * 0 mean it has no impact
  58272. */
  58273. ambientTextureImpactOnAnalyticalLights: number;
  58274. /**
  58275. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  58276. */
  58277. opacityTexture: BaseTexture;
  58278. /**
  58279. * Stores the reflection values in a texture.
  58280. */
  58281. reflectionTexture: Nullable<BaseTexture>;
  58282. /**
  58283. * Stores the emissive values in a texture.
  58284. */
  58285. emissiveTexture: BaseTexture;
  58286. /**
  58287. * AKA Specular texture in other nomenclature.
  58288. */
  58289. reflectivityTexture: BaseTexture;
  58290. /**
  58291. * Used to switch from specular/glossiness to metallic/roughness workflow.
  58292. */
  58293. metallicTexture: BaseTexture;
  58294. /**
  58295. * Specifies the metallic scalar of the metallic/roughness workflow.
  58296. * Can also be used to scale the metalness values of the metallic texture.
  58297. */
  58298. metallic: Nullable<number>;
  58299. /**
  58300. * Specifies the roughness scalar of the metallic/roughness workflow.
  58301. * Can also be used to scale the roughness values of the metallic texture.
  58302. */
  58303. roughness: Nullable<number>;
  58304. /**
  58305. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  58306. * By default the indexOfrefraction is used to compute F0;
  58307. *
  58308. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  58309. *
  58310. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  58311. * F90 = metallicReflectanceColor;
  58312. */
  58313. metallicF0Factor: number;
  58314. /**
  58315. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  58316. * By default the F90 is always 1;
  58317. *
  58318. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  58319. *
  58320. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  58321. * F90 = metallicReflectanceColor;
  58322. */
  58323. metallicReflectanceColor: Color3;
  58324. /**
  58325. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  58326. * This is multiply against the scalar values defined in the material.
  58327. */
  58328. metallicReflectanceTexture: Nullable<BaseTexture>;
  58329. /**
  58330. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  58331. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  58332. */
  58333. microSurfaceTexture: BaseTexture;
  58334. /**
  58335. * Stores surface normal data used to displace a mesh in a texture.
  58336. */
  58337. bumpTexture: BaseTexture;
  58338. /**
  58339. * Stores the pre-calculated light information of a mesh in a texture.
  58340. */
  58341. lightmapTexture: BaseTexture;
  58342. /**
  58343. * Stores the refracted light information in a texture.
  58344. */
  58345. get refractionTexture(): Nullable<BaseTexture>;
  58346. set refractionTexture(value: Nullable<BaseTexture>);
  58347. /**
  58348. * The color of a material in ambient lighting.
  58349. */
  58350. ambientColor: Color3;
  58351. /**
  58352. * AKA Diffuse Color in other nomenclature.
  58353. */
  58354. albedoColor: Color3;
  58355. /**
  58356. * AKA Specular Color in other nomenclature.
  58357. */
  58358. reflectivityColor: Color3;
  58359. /**
  58360. * The color reflected from the material.
  58361. */
  58362. reflectionColor: Color3;
  58363. /**
  58364. * The color emitted from the material.
  58365. */
  58366. emissiveColor: Color3;
  58367. /**
  58368. * AKA Glossiness in other nomenclature.
  58369. */
  58370. microSurface: number;
  58371. /**
  58372. * Index of refraction of the material base layer.
  58373. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58374. *
  58375. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58376. *
  58377. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58378. */
  58379. get indexOfRefraction(): number;
  58380. set indexOfRefraction(value: number);
  58381. /**
  58382. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58383. */
  58384. get invertRefractionY(): boolean;
  58385. set invertRefractionY(value: boolean);
  58386. /**
  58387. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58388. * Materials half opaque for instance using refraction could benefit from this control.
  58389. */
  58390. get linkRefractionWithTransparency(): boolean;
  58391. set linkRefractionWithTransparency(value: boolean);
  58392. /**
  58393. * If true, the light map contains occlusion information instead of lighting info.
  58394. */
  58395. useLightmapAsShadowmap: boolean;
  58396. /**
  58397. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  58398. */
  58399. useAlphaFromAlbedoTexture: boolean;
  58400. /**
  58401. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  58402. */
  58403. forceAlphaTest: boolean;
  58404. /**
  58405. * Defines the alpha limits in alpha test mode.
  58406. */
  58407. alphaCutOff: number;
  58408. /**
  58409. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  58410. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  58411. */
  58412. useSpecularOverAlpha: boolean;
  58413. /**
  58414. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  58415. */
  58416. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  58417. /**
  58418. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  58419. */
  58420. useRoughnessFromMetallicTextureAlpha: boolean;
  58421. /**
  58422. * Specifies if the metallic texture contains the roughness information in its green channel.
  58423. */
  58424. useRoughnessFromMetallicTextureGreen: boolean;
  58425. /**
  58426. * Specifies if the metallic texture contains the metallness information in its blue channel.
  58427. */
  58428. useMetallnessFromMetallicTextureBlue: boolean;
  58429. /**
  58430. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  58431. */
  58432. useAmbientOcclusionFromMetallicTextureRed: boolean;
  58433. /**
  58434. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  58435. */
  58436. useAmbientInGrayScale: boolean;
  58437. /**
  58438. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  58439. * The material will try to infer what glossiness each pixel should be.
  58440. */
  58441. useAutoMicroSurfaceFromReflectivityMap: boolean;
  58442. /**
  58443. * BJS is using an harcoded light falloff based on a manually sets up range.
  58444. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  58445. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  58446. */
  58447. get usePhysicalLightFalloff(): boolean;
  58448. /**
  58449. * BJS is using an harcoded light falloff based on a manually sets up range.
  58450. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  58451. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  58452. */
  58453. set usePhysicalLightFalloff(value: boolean);
  58454. /**
  58455. * In order to support the falloff compatibility with gltf, a special mode has been added
  58456. * to reproduce the gltf light falloff.
  58457. */
  58458. get useGLTFLightFalloff(): boolean;
  58459. /**
  58460. * In order to support the falloff compatibility with gltf, a special mode has been added
  58461. * to reproduce the gltf light falloff.
  58462. */
  58463. set useGLTFLightFalloff(value: boolean);
  58464. /**
  58465. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  58466. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  58467. */
  58468. useRadianceOverAlpha: boolean;
  58469. /**
  58470. * Allows using an object space normal map (instead of tangent space).
  58471. */
  58472. useObjectSpaceNormalMap: boolean;
  58473. /**
  58474. * Allows using the bump map in parallax mode.
  58475. */
  58476. useParallax: boolean;
  58477. /**
  58478. * Allows using the bump map in parallax occlusion mode.
  58479. */
  58480. useParallaxOcclusion: boolean;
  58481. /**
  58482. * Controls the scale bias of the parallax mode.
  58483. */
  58484. parallaxScaleBias: number;
  58485. /**
  58486. * If sets to true, disables all the lights affecting the material.
  58487. */
  58488. disableLighting: boolean;
  58489. /**
  58490. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  58491. */
  58492. forceIrradianceInFragment: boolean;
  58493. /**
  58494. * Number of Simultaneous lights allowed on the material.
  58495. */
  58496. maxSimultaneousLights: number;
  58497. /**
  58498. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  58499. */
  58500. invertNormalMapX: boolean;
  58501. /**
  58502. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  58503. */
  58504. invertNormalMapY: boolean;
  58505. /**
  58506. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  58507. */
  58508. twoSidedLighting: boolean;
  58509. /**
  58510. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  58511. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  58512. */
  58513. useAlphaFresnel: boolean;
  58514. /**
  58515. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  58516. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  58517. */
  58518. useLinearAlphaFresnel: boolean;
  58519. /**
  58520. * Let user defines the brdf lookup texture used for IBL.
  58521. * A default 8bit version is embedded but you could point at :
  58522. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  58523. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  58524. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  58525. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  58526. */
  58527. environmentBRDFTexture: Nullable<BaseTexture>;
  58528. /**
  58529. * Force normal to face away from face.
  58530. */
  58531. forceNormalForward: boolean;
  58532. /**
  58533. * Enables specular anti aliasing in the PBR shader.
  58534. * It will both interacts on the Geometry for analytical and IBL lighting.
  58535. * It also prefilter the roughness map based on the bump values.
  58536. */
  58537. enableSpecularAntiAliasing: boolean;
  58538. /**
  58539. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  58540. * makes the reflect vector face the model (under horizon).
  58541. */
  58542. useHorizonOcclusion: boolean;
  58543. /**
  58544. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  58545. * too much the area relying on ambient texture to define their ambient occlusion.
  58546. */
  58547. useRadianceOcclusion: boolean;
  58548. /**
  58549. * If set to true, no lighting calculations will be applied.
  58550. */
  58551. unlit: boolean;
  58552. /**
  58553. * Gets the image processing configuration used either in this material.
  58554. */
  58555. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  58556. /**
  58557. * Sets the Default image processing configuration used either in the this material.
  58558. *
  58559. * If sets to null, the scene one is in use.
  58560. */
  58561. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  58562. /**
  58563. * Gets wether the color curves effect is enabled.
  58564. */
  58565. get cameraColorCurvesEnabled(): boolean;
  58566. /**
  58567. * Sets wether the color curves effect is enabled.
  58568. */
  58569. set cameraColorCurvesEnabled(value: boolean);
  58570. /**
  58571. * Gets wether the color grading effect is enabled.
  58572. */
  58573. get cameraColorGradingEnabled(): boolean;
  58574. /**
  58575. * Gets wether the color grading effect is enabled.
  58576. */
  58577. set cameraColorGradingEnabled(value: boolean);
  58578. /**
  58579. * Gets wether tonemapping is enabled or not.
  58580. */
  58581. get cameraToneMappingEnabled(): boolean;
  58582. /**
  58583. * Sets wether tonemapping is enabled or not
  58584. */
  58585. set cameraToneMappingEnabled(value: boolean);
  58586. /**
  58587. * The camera exposure used on this material.
  58588. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  58589. * This corresponds to a photographic exposure.
  58590. */
  58591. get cameraExposure(): number;
  58592. /**
  58593. * The camera exposure used on this material.
  58594. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  58595. * This corresponds to a photographic exposure.
  58596. */
  58597. set cameraExposure(value: number);
  58598. /**
  58599. * Gets The camera contrast used on this material.
  58600. */
  58601. get cameraContrast(): number;
  58602. /**
  58603. * Sets The camera contrast used on this material.
  58604. */
  58605. set cameraContrast(value: number);
  58606. /**
  58607. * Gets the Color Grading 2D Lookup Texture.
  58608. */
  58609. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  58610. /**
  58611. * Sets the Color Grading 2D Lookup Texture.
  58612. */
  58613. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  58614. /**
  58615. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  58616. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  58617. * 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;
  58618. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  58619. */
  58620. get cameraColorCurves(): Nullable<ColorCurves>;
  58621. /**
  58622. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  58623. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  58624. * 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;
  58625. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  58626. */
  58627. set cameraColorCurves(value: Nullable<ColorCurves>);
  58628. /**
  58629. * Instantiates a new PBRMaterial instance.
  58630. *
  58631. * @param name The material name
  58632. * @param scene The scene the material will be use in.
  58633. */
  58634. constructor(name: string, scene: Scene);
  58635. /**
  58636. * Returns the name of this material class.
  58637. */
  58638. getClassName(): string;
  58639. /**
  58640. * Makes a duplicate of the current material.
  58641. * @param name - name to use for the new material.
  58642. */
  58643. clone(name: string): PBRMaterial;
  58644. /**
  58645. * Serializes this PBR Material.
  58646. * @returns - An object with the serialized material.
  58647. */
  58648. serialize(): any;
  58649. /**
  58650. * Parses a PBR Material from a serialized object.
  58651. * @param source - Serialized object.
  58652. * @param scene - BJS scene instance.
  58653. * @param rootUrl - url for the scene object
  58654. * @returns - PBRMaterial
  58655. */
  58656. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  58657. }
  58658. }
  58659. declare module "babylonjs/Misc/dds" {
  58660. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  58661. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  58662. import { Nullable } from "babylonjs/types";
  58663. import { Scene } from "babylonjs/scene";
  58664. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  58665. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  58666. /**
  58667. * Direct draw surface info
  58668. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  58669. */
  58670. export interface DDSInfo {
  58671. /**
  58672. * Width of the texture
  58673. */
  58674. width: number;
  58675. /**
  58676. * Width of the texture
  58677. */
  58678. height: number;
  58679. /**
  58680. * Number of Mipmaps for the texture
  58681. * @see https://en.wikipedia.org/wiki/Mipmap
  58682. */
  58683. mipmapCount: number;
  58684. /**
  58685. * If the textures format is a known fourCC format
  58686. * @see https://www.fourcc.org/
  58687. */
  58688. isFourCC: boolean;
  58689. /**
  58690. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  58691. */
  58692. isRGB: boolean;
  58693. /**
  58694. * If the texture is a lumincance format
  58695. */
  58696. isLuminance: boolean;
  58697. /**
  58698. * If this is a cube texture
  58699. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  58700. */
  58701. isCube: boolean;
  58702. /**
  58703. * If the texture is a compressed format eg. FOURCC_DXT1
  58704. */
  58705. isCompressed: boolean;
  58706. /**
  58707. * The dxgiFormat of the texture
  58708. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  58709. */
  58710. dxgiFormat: number;
  58711. /**
  58712. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  58713. */
  58714. textureType: number;
  58715. /**
  58716. * Sphericle polynomial created for the dds texture
  58717. */
  58718. sphericalPolynomial?: SphericalPolynomial;
  58719. }
  58720. /**
  58721. * Class used to provide DDS decompression tools
  58722. */
  58723. export class DDSTools {
  58724. /**
  58725. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  58726. */
  58727. static StoreLODInAlphaChannel: boolean;
  58728. /**
  58729. * Gets DDS information from an array buffer
  58730. * @param data defines the array buffer view to read data from
  58731. * @returns the DDS information
  58732. */
  58733. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  58734. private static _FloatView;
  58735. private static _Int32View;
  58736. private static _ToHalfFloat;
  58737. private static _FromHalfFloat;
  58738. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  58739. private static _GetHalfFloatRGBAArrayBuffer;
  58740. private static _GetFloatRGBAArrayBuffer;
  58741. private static _GetFloatAsUIntRGBAArrayBuffer;
  58742. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  58743. private static _GetRGBAArrayBuffer;
  58744. private static _ExtractLongWordOrder;
  58745. private static _GetRGBArrayBuffer;
  58746. private static _GetLuminanceArrayBuffer;
  58747. /**
  58748. * Uploads DDS Levels to a Babylon Texture
  58749. * @hidden
  58750. */
  58751. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  58752. }
  58753. module "babylonjs/Engines/thinEngine" {
  58754. interface ThinEngine {
  58755. /**
  58756. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  58757. * @param rootUrl defines the url where the file to load is located
  58758. * @param scene defines the current scene
  58759. * @param lodScale defines scale to apply to the mip map selection
  58760. * @param lodOffset defines offset to apply to the mip map selection
  58761. * @param onLoad defines an optional callback raised when the texture is loaded
  58762. * @param onError defines an optional callback raised if there is an issue to load the texture
  58763. * @param format defines the format of the data
  58764. * @param forcedExtension defines the extension to use to pick the right loader
  58765. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  58766. * @returns the cube texture as an InternalTexture
  58767. */
  58768. 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;
  58769. }
  58770. }
  58771. }
  58772. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  58773. import { Nullable } from "babylonjs/types";
  58774. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  58775. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  58776. /**
  58777. * Implementation of the DDS Texture Loader.
  58778. * @hidden
  58779. */
  58780. export class _DDSTextureLoader implements IInternalTextureLoader {
  58781. /**
  58782. * Defines wether the loader supports cascade loading the different faces.
  58783. */
  58784. readonly supportCascades: boolean;
  58785. /**
  58786. * This returns if the loader support the current file information.
  58787. * @param extension defines the file extension of the file being loaded
  58788. * @returns true if the loader can load the specified file
  58789. */
  58790. canLoad(extension: string): boolean;
  58791. /**
  58792. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  58793. * @param data contains the texture data
  58794. * @param texture defines the BabylonJS internal texture
  58795. * @param createPolynomials will be true if polynomials have been requested
  58796. * @param onLoad defines the callback to trigger once the texture is ready
  58797. * @param onError defines the callback to trigger in case of error
  58798. */
  58799. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  58800. /**
  58801. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  58802. * @param data contains the texture data
  58803. * @param texture defines the BabylonJS internal texture
  58804. * @param callback defines the method to call once ready to upload
  58805. */
  58806. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  58807. }
  58808. }
  58809. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  58810. import { Nullable } from "babylonjs/types";
  58811. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  58812. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  58813. /**
  58814. * Implementation of the ENV Texture Loader.
  58815. * @hidden
  58816. */
  58817. export class _ENVTextureLoader implements IInternalTextureLoader {
  58818. /**
  58819. * Defines wether the loader supports cascade loading the different faces.
  58820. */
  58821. readonly supportCascades: boolean;
  58822. /**
  58823. * This returns if the loader support the current file information.
  58824. * @param extension defines the file extension of the file being loaded
  58825. * @returns true if the loader can load the specified file
  58826. */
  58827. canLoad(extension: string): boolean;
  58828. /**
  58829. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  58830. * @param data contains the texture data
  58831. * @param texture defines the BabylonJS internal texture
  58832. * @param createPolynomials will be true if polynomials have been requested
  58833. * @param onLoad defines the callback to trigger once the texture is ready
  58834. * @param onError defines the callback to trigger in case of error
  58835. */
  58836. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  58837. /**
  58838. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  58839. * @param data contains the texture data
  58840. * @param texture defines the BabylonJS internal texture
  58841. * @param callback defines the method to call once ready to upload
  58842. */
  58843. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  58844. }
  58845. }
  58846. declare module "babylonjs/Misc/khronosTextureContainer" {
  58847. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  58848. /**
  58849. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  58850. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  58851. */
  58852. export class KhronosTextureContainer {
  58853. /** contents of the KTX container file */
  58854. data: ArrayBufferView;
  58855. private static HEADER_LEN;
  58856. private static COMPRESSED_2D;
  58857. private static COMPRESSED_3D;
  58858. private static TEX_2D;
  58859. private static TEX_3D;
  58860. /**
  58861. * Gets the openGL type
  58862. */
  58863. glType: number;
  58864. /**
  58865. * Gets the openGL type size
  58866. */
  58867. glTypeSize: number;
  58868. /**
  58869. * Gets the openGL format
  58870. */
  58871. glFormat: number;
  58872. /**
  58873. * Gets the openGL internal format
  58874. */
  58875. glInternalFormat: number;
  58876. /**
  58877. * Gets the base internal format
  58878. */
  58879. glBaseInternalFormat: number;
  58880. /**
  58881. * Gets image width in pixel
  58882. */
  58883. pixelWidth: number;
  58884. /**
  58885. * Gets image height in pixel
  58886. */
  58887. pixelHeight: number;
  58888. /**
  58889. * Gets image depth in pixels
  58890. */
  58891. pixelDepth: number;
  58892. /**
  58893. * Gets the number of array elements
  58894. */
  58895. numberOfArrayElements: number;
  58896. /**
  58897. * Gets the number of faces
  58898. */
  58899. numberOfFaces: number;
  58900. /**
  58901. * Gets the number of mipmap levels
  58902. */
  58903. numberOfMipmapLevels: number;
  58904. /**
  58905. * Gets the bytes of key value data
  58906. */
  58907. bytesOfKeyValueData: number;
  58908. /**
  58909. * Gets the load type
  58910. */
  58911. loadType: number;
  58912. /**
  58913. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  58914. */
  58915. isInvalid: boolean;
  58916. /**
  58917. * Creates a new KhronosTextureContainer
  58918. * @param data contents of the KTX container file
  58919. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  58920. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  58921. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  58922. */
  58923. constructor(
  58924. /** contents of the KTX container file */
  58925. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  58926. /**
  58927. * Uploads KTX content to a Babylon Texture.
  58928. * It is assumed that the texture has already been created & is currently bound
  58929. * @hidden
  58930. */
  58931. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  58932. private _upload2DCompressedLevels;
  58933. /**
  58934. * Checks if the given data starts with a KTX file identifier.
  58935. * @param data the data to check
  58936. * @returns true if the data is a KTX file or false otherwise
  58937. */
  58938. static IsValid(data: ArrayBufferView): boolean;
  58939. }
  58940. }
  58941. declare module "babylonjs/Misc/khronosTextureContainer2" {
  58942. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  58943. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  58944. /**
  58945. * Class for loading KTX2 files
  58946. * !!! Experimental Extension Subject to Changes !!!
  58947. * @hidden
  58948. */
  58949. export class KhronosTextureContainer2 {
  58950. private static _ModulePromise;
  58951. private static _TranscodeFormat;
  58952. constructor(engine: ThinEngine);
  58953. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  58954. private _determineTranscodeFormat;
  58955. /**
  58956. * Checks if the given data starts with a KTX2 file identifier.
  58957. * @param data the data to check
  58958. * @returns true if the data is a KTX2 file or false otherwise
  58959. */
  58960. static IsValid(data: ArrayBufferView): boolean;
  58961. }
  58962. }
  58963. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  58964. import { Nullable } from "babylonjs/types";
  58965. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  58966. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  58967. /**
  58968. * Implementation of the KTX Texture Loader.
  58969. * @hidden
  58970. */
  58971. export class _KTXTextureLoader implements IInternalTextureLoader {
  58972. /**
  58973. * Defines wether the loader supports cascade loading the different faces.
  58974. */
  58975. readonly supportCascades: boolean;
  58976. /**
  58977. * This returns if the loader support the current file information.
  58978. * @param extension defines the file extension of the file being loaded
  58979. * @returns true if the loader can load the specified file
  58980. */
  58981. canLoad(extension: string): boolean;
  58982. /**
  58983. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  58984. * @param data contains the texture data
  58985. * @param texture defines the BabylonJS internal texture
  58986. * @param createPolynomials will be true if polynomials have been requested
  58987. * @param onLoad defines the callback to trigger once the texture is ready
  58988. * @param onError defines the callback to trigger in case of error
  58989. */
  58990. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  58991. /**
  58992. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  58993. * @param data contains the texture data
  58994. * @param texture defines the BabylonJS internal texture
  58995. * @param callback defines the method to call once ready to upload
  58996. */
  58997. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  58998. }
  58999. }
  59000. declare module "babylonjs/Helpers/sceneHelpers" {
  59001. import { Nullable } from "babylonjs/types";
  59002. import { Mesh } from "babylonjs/Meshes/mesh";
  59003. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59004. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  59005. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  59006. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  59007. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  59008. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  59009. import "babylonjs/Meshes/Builders/boxBuilder";
  59010. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  59011. /** @hidden */
  59012. export var _forceSceneHelpersToBundle: boolean;
  59013. module "babylonjs/scene" {
  59014. interface Scene {
  59015. /**
  59016. * Creates a default light for the scene.
  59017. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  59018. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  59019. */
  59020. createDefaultLight(replace?: boolean): void;
  59021. /**
  59022. * Creates a default camera for the scene.
  59023. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  59024. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  59025. * @param replace has default false, when true replaces the active camera in the scene
  59026. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  59027. */
  59028. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  59029. /**
  59030. * Creates a default camera and a default light.
  59031. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  59032. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  59033. * @param replace has the default false, when true replaces the active camera/light in the scene
  59034. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  59035. */
  59036. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  59037. /**
  59038. * Creates a new sky box
  59039. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  59040. * @param environmentTexture defines the texture to use as environment texture
  59041. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  59042. * @param scale defines the overall scale of the skybox
  59043. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  59044. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  59045. * @returns a new mesh holding the sky box
  59046. */
  59047. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  59048. /**
  59049. * Creates a new environment
  59050. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  59051. * @param options defines the options you can use to configure the environment
  59052. * @returns the new EnvironmentHelper
  59053. */
  59054. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  59055. /**
  59056. * Creates a new VREXperienceHelper
  59057. * @see http://doc.babylonjs.com/how_to/webvr_helper
  59058. * @param webVROptions defines the options used to create the new VREXperienceHelper
  59059. * @returns a new VREXperienceHelper
  59060. */
  59061. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  59062. /**
  59063. * Creates a new WebXRDefaultExperience
  59064. * @see http://doc.babylonjs.com/how_to/webxr
  59065. * @param options experience options
  59066. * @returns a promise for a new WebXRDefaultExperience
  59067. */
  59068. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  59069. }
  59070. }
  59071. }
  59072. declare module "babylonjs/Helpers/videoDome" {
  59073. import { Scene } from "babylonjs/scene";
  59074. import { TransformNode } from "babylonjs/Meshes/transformNode";
  59075. import { Mesh } from "babylonjs/Meshes/mesh";
  59076. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  59077. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  59078. import "babylonjs/Meshes/Builders/sphereBuilder";
  59079. /**
  59080. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  59081. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  59082. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  59083. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  59084. */
  59085. export class VideoDome extends TransformNode {
  59086. /**
  59087. * Define the video source as a Monoscopic panoramic 360 video.
  59088. */
  59089. static readonly MODE_MONOSCOPIC: number;
  59090. /**
  59091. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  59092. */
  59093. static readonly MODE_TOPBOTTOM: number;
  59094. /**
  59095. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  59096. */
  59097. static readonly MODE_SIDEBYSIDE: number;
  59098. private _halfDome;
  59099. private _useDirectMapping;
  59100. /**
  59101. * The video texture being displayed on the sphere
  59102. */
  59103. protected _videoTexture: VideoTexture;
  59104. /**
  59105. * Gets the video texture being displayed on the sphere
  59106. */
  59107. get videoTexture(): VideoTexture;
  59108. /**
  59109. * The skybox material
  59110. */
  59111. protected _material: BackgroundMaterial;
  59112. /**
  59113. * The surface used for the skybox
  59114. */
  59115. protected _mesh: Mesh;
  59116. /**
  59117. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  59118. */
  59119. private _halfDomeMask;
  59120. /**
  59121. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  59122. * Also see the options.resolution property.
  59123. */
  59124. get fovMultiplier(): number;
  59125. set fovMultiplier(value: number);
  59126. private _videoMode;
  59127. /**
  59128. * Gets or set the current video mode for the video. It can be:
  59129. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  59130. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  59131. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  59132. */
  59133. get videoMode(): number;
  59134. set videoMode(value: number);
  59135. /**
  59136. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  59137. *
  59138. */
  59139. get halfDome(): boolean;
  59140. /**
  59141. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  59142. */
  59143. set halfDome(enabled: boolean);
  59144. /**
  59145. * Oberserver used in Stereoscopic VR Mode.
  59146. */
  59147. private _onBeforeCameraRenderObserver;
  59148. /**
  59149. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  59150. * @param name Element's name, child elements will append suffixes for their own names.
  59151. * @param urlsOrVideo defines the url(s) or the video element to use
  59152. * @param options An object containing optional or exposed sub element properties
  59153. */
  59154. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  59155. resolution?: number;
  59156. clickToPlay?: boolean;
  59157. autoPlay?: boolean;
  59158. loop?: boolean;
  59159. size?: number;
  59160. poster?: string;
  59161. faceForward?: boolean;
  59162. useDirectMapping?: boolean;
  59163. halfDomeMode?: boolean;
  59164. }, scene: Scene);
  59165. private _changeVideoMode;
  59166. /**
  59167. * Releases resources associated with this node.
  59168. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  59169. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  59170. */
  59171. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  59172. }
  59173. }
  59174. declare module "babylonjs/Helpers/index" {
  59175. export * from "babylonjs/Helpers/environmentHelper";
  59176. export * from "babylonjs/Helpers/photoDome";
  59177. export * from "babylonjs/Helpers/sceneHelpers";
  59178. export * from "babylonjs/Helpers/videoDome";
  59179. }
  59180. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  59181. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  59182. import { IDisposable } from "babylonjs/scene";
  59183. import { Engine } from "babylonjs/Engines/engine";
  59184. /**
  59185. * This class can be used to get instrumentation data from a Babylon engine
  59186. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  59187. */
  59188. export class EngineInstrumentation implements IDisposable {
  59189. /**
  59190. * Define the instrumented engine.
  59191. */
  59192. engine: Engine;
  59193. private _captureGPUFrameTime;
  59194. private _gpuFrameTimeToken;
  59195. private _gpuFrameTime;
  59196. private _captureShaderCompilationTime;
  59197. private _shaderCompilationTime;
  59198. private _onBeginFrameObserver;
  59199. private _onEndFrameObserver;
  59200. private _onBeforeShaderCompilationObserver;
  59201. private _onAfterShaderCompilationObserver;
  59202. /**
  59203. * Gets the perf counter used for GPU frame time
  59204. */
  59205. get gpuFrameTimeCounter(): PerfCounter;
  59206. /**
  59207. * Gets the GPU frame time capture status
  59208. */
  59209. get captureGPUFrameTime(): boolean;
  59210. /**
  59211. * Enable or disable the GPU frame time capture
  59212. */
  59213. set captureGPUFrameTime(value: boolean);
  59214. /**
  59215. * Gets the perf counter used for shader compilation time
  59216. */
  59217. get shaderCompilationTimeCounter(): PerfCounter;
  59218. /**
  59219. * Gets the shader compilation time capture status
  59220. */
  59221. get captureShaderCompilationTime(): boolean;
  59222. /**
  59223. * Enable or disable the shader compilation time capture
  59224. */
  59225. set captureShaderCompilationTime(value: boolean);
  59226. /**
  59227. * Instantiates a new engine instrumentation.
  59228. * This class can be used to get instrumentation data from a Babylon engine
  59229. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  59230. * @param engine Defines the engine to instrument
  59231. */
  59232. constructor(
  59233. /**
  59234. * Define the instrumented engine.
  59235. */
  59236. engine: Engine);
  59237. /**
  59238. * Dispose and release associated resources.
  59239. */
  59240. dispose(): void;
  59241. }
  59242. }
  59243. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  59244. import { Scene, IDisposable } from "babylonjs/scene";
  59245. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  59246. /**
  59247. * This class can be used to get instrumentation data from a Babylon engine
  59248. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  59249. */
  59250. export class SceneInstrumentation implements IDisposable {
  59251. /**
  59252. * Defines the scene to instrument
  59253. */
  59254. scene: Scene;
  59255. private _captureActiveMeshesEvaluationTime;
  59256. private _activeMeshesEvaluationTime;
  59257. private _captureRenderTargetsRenderTime;
  59258. private _renderTargetsRenderTime;
  59259. private _captureFrameTime;
  59260. private _frameTime;
  59261. private _captureRenderTime;
  59262. private _renderTime;
  59263. private _captureInterFrameTime;
  59264. private _interFrameTime;
  59265. private _captureParticlesRenderTime;
  59266. private _particlesRenderTime;
  59267. private _captureSpritesRenderTime;
  59268. private _spritesRenderTime;
  59269. private _capturePhysicsTime;
  59270. private _physicsTime;
  59271. private _captureAnimationsTime;
  59272. private _animationsTime;
  59273. private _captureCameraRenderTime;
  59274. private _cameraRenderTime;
  59275. private _onBeforeActiveMeshesEvaluationObserver;
  59276. private _onAfterActiveMeshesEvaluationObserver;
  59277. private _onBeforeRenderTargetsRenderObserver;
  59278. private _onAfterRenderTargetsRenderObserver;
  59279. private _onAfterRenderObserver;
  59280. private _onBeforeDrawPhaseObserver;
  59281. private _onAfterDrawPhaseObserver;
  59282. private _onBeforeAnimationsObserver;
  59283. private _onBeforeParticlesRenderingObserver;
  59284. private _onAfterParticlesRenderingObserver;
  59285. private _onBeforeSpritesRenderingObserver;
  59286. private _onAfterSpritesRenderingObserver;
  59287. private _onBeforePhysicsObserver;
  59288. private _onAfterPhysicsObserver;
  59289. private _onAfterAnimationsObserver;
  59290. private _onBeforeCameraRenderObserver;
  59291. private _onAfterCameraRenderObserver;
  59292. /**
  59293. * Gets the perf counter used for active meshes evaluation time
  59294. */
  59295. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  59296. /**
  59297. * Gets the active meshes evaluation time capture status
  59298. */
  59299. get captureActiveMeshesEvaluationTime(): boolean;
  59300. /**
  59301. * Enable or disable the active meshes evaluation time capture
  59302. */
  59303. set captureActiveMeshesEvaluationTime(value: boolean);
  59304. /**
  59305. * Gets the perf counter used for render targets render time
  59306. */
  59307. get renderTargetsRenderTimeCounter(): PerfCounter;
  59308. /**
  59309. * Gets the render targets render time capture status
  59310. */
  59311. get captureRenderTargetsRenderTime(): boolean;
  59312. /**
  59313. * Enable or disable the render targets render time capture
  59314. */
  59315. set captureRenderTargetsRenderTime(value: boolean);
  59316. /**
  59317. * Gets the perf counter used for particles render time
  59318. */
  59319. get particlesRenderTimeCounter(): PerfCounter;
  59320. /**
  59321. * Gets the particles render time capture status
  59322. */
  59323. get captureParticlesRenderTime(): boolean;
  59324. /**
  59325. * Enable or disable the particles render time capture
  59326. */
  59327. set captureParticlesRenderTime(value: boolean);
  59328. /**
  59329. * Gets the perf counter used for sprites render time
  59330. */
  59331. get spritesRenderTimeCounter(): PerfCounter;
  59332. /**
  59333. * Gets the sprites render time capture status
  59334. */
  59335. get captureSpritesRenderTime(): boolean;
  59336. /**
  59337. * Enable or disable the sprites render time capture
  59338. */
  59339. set captureSpritesRenderTime(value: boolean);
  59340. /**
  59341. * Gets the perf counter used for physics time
  59342. */
  59343. get physicsTimeCounter(): PerfCounter;
  59344. /**
  59345. * Gets the physics time capture status
  59346. */
  59347. get capturePhysicsTime(): boolean;
  59348. /**
  59349. * Enable or disable the physics time capture
  59350. */
  59351. set capturePhysicsTime(value: boolean);
  59352. /**
  59353. * Gets the perf counter used for animations time
  59354. */
  59355. get animationsTimeCounter(): PerfCounter;
  59356. /**
  59357. * Gets the animations time capture status
  59358. */
  59359. get captureAnimationsTime(): boolean;
  59360. /**
  59361. * Enable or disable the animations time capture
  59362. */
  59363. set captureAnimationsTime(value: boolean);
  59364. /**
  59365. * Gets the perf counter used for frame time capture
  59366. */
  59367. get frameTimeCounter(): PerfCounter;
  59368. /**
  59369. * Gets the frame time capture status
  59370. */
  59371. get captureFrameTime(): boolean;
  59372. /**
  59373. * Enable or disable the frame time capture
  59374. */
  59375. set captureFrameTime(value: boolean);
  59376. /**
  59377. * Gets the perf counter used for inter-frames time capture
  59378. */
  59379. get interFrameTimeCounter(): PerfCounter;
  59380. /**
  59381. * Gets the inter-frames time capture status
  59382. */
  59383. get captureInterFrameTime(): boolean;
  59384. /**
  59385. * Enable or disable the inter-frames time capture
  59386. */
  59387. set captureInterFrameTime(value: boolean);
  59388. /**
  59389. * Gets the perf counter used for render time capture
  59390. */
  59391. get renderTimeCounter(): PerfCounter;
  59392. /**
  59393. * Gets the render time capture status
  59394. */
  59395. get captureRenderTime(): boolean;
  59396. /**
  59397. * Enable or disable the render time capture
  59398. */
  59399. set captureRenderTime(value: boolean);
  59400. /**
  59401. * Gets the perf counter used for camera render time capture
  59402. */
  59403. get cameraRenderTimeCounter(): PerfCounter;
  59404. /**
  59405. * Gets the camera render time capture status
  59406. */
  59407. get captureCameraRenderTime(): boolean;
  59408. /**
  59409. * Enable or disable the camera render time capture
  59410. */
  59411. set captureCameraRenderTime(value: boolean);
  59412. /**
  59413. * Gets the perf counter used for draw calls
  59414. */
  59415. get drawCallsCounter(): PerfCounter;
  59416. /**
  59417. * Instantiates a new scene instrumentation.
  59418. * This class can be used to get instrumentation data from a Babylon engine
  59419. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  59420. * @param scene Defines the scene to instrument
  59421. */
  59422. constructor(
  59423. /**
  59424. * Defines the scene to instrument
  59425. */
  59426. scene: Scene);
  59427. /**
  59428. * Dispose and release associated resources.
  59429. */
  59430. dispose(): void;
  59431. }
  59432. }
  59433. declare module "babylonjs/Instrumentation/index" {
  59434. export * from "babylonjs/Instrumentation/engineInstrumentation";
  59435. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  59436. export * from "babylonjs/Instrumentation/timeToken";
  59437. }
  59438. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  59439. /** @hidden */
  59440. export var glowMapGenerationPixelShader: {
  59441. name: string;
  59442. shader: string;
  59443. };
  59444. }
  59445. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  59446. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  59447. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  59448. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  59449. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  59450. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  59451. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  59452. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  59453. /** @hidden */
  59454. export var glowMapGenerationVertexShader: {
  59455. name: string;
  59456. shader: string;
  59457. };
  59458. }
  59459. declare module "babylonjs/Layers/effectLayer" {
  59460. import { Observable } from "babylonjs/Misc/observable";
  59461. import { Nullable } from "babylonjs/types";
  59462. import { Camera } from "babylonjs/Cameras/camera";
  59463. import { Scene } from "babylonjs/scene";
  59464. import { ISize } from "babylonjs/Maths/math.size";
  59465. import { Color4 } from "babylonjs/Maths/math.color";
  59466. import { Engine } from "babylonjs/Engines/engine";
  59467. import { SubMesh } from "babylonjs/Meshes/subMesh";
  59468. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59469. import { Mesh } from "babylonjs/Meshes/mesh";
  59470. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  59471. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59472. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  59473. import { Effect } from "babylonjs/Materials/effect";
  59474. import { Material } from "babylonjs/Materials/material";
  59475. import "babylonjs/Shaders/glowMapGeneration.fragment";
  59476. import "babylonjs/Shaders/glowMapGeneration.vertex";
  59477. /**
  59478. * Effect layer options. This helps customizing the behaviour
  59479. * of the effect layer.
  59480. */
  59481. export interface IEffectLayerOptions {
  59482. /**
  59483. * Multiplication factor apply to the canvas size to compute the render target size
  59484. * used to generated the objects (the smaller the faster).
  59485. */
  59486. mainTextureRatio: number;
  59487. /**
  59488. * Enforces a fixed size texture to ensure effect stability across devices.
  59489. */
  59490. mainTextureFixedSize?: number;
  59491. /**
  59492. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  59493. */
  59494. alphaBlendingMode: number;
  59495. /**
  59496. * The camera attached to the layer.
  59497. */
  59498. camera: Nullable<Camera>;
  59499. /**
  59500. * The rendering group to draw the layer in.
  59501. */
  59502. renderingGroupId: number;
  59503. }
  59504. /**
  59505. * The effect layer Helps adding post process effect blended with the main pass.
  59506. *
  59507. * This can be for instance use to generate glow or higlight effects on the scene.
  59508. *
  59509. * The effect layer class can not be used directly and is intented to inherited from to be
  59510. * customized per effects.
  59511. */
  59512. export abstract class EffectLayer {
  59513. private _vertexBuffers;
  59514. private _indexBuffer;
  59515. private _cachedDefines;
  59516. private _effectLayerMapGenerationEffect;
  59517. private _effectLayerOptions;
  59518. private _mergeEffect;
  59519. protected _scene: Scene;
  59520. protected _engine: Engine;
  59521. protected _maxSize: number;
  59522. protected _mainTextureDesiredSize: ISize;
  59523. protected _mainTexture: RenderTargetTexture;
  59524. protected _shouldRender: boolean;
  59525. protected _postProcesses: PostProcess[];
  59526. protected _textures: BaseTexture[];
  59527. protected _emissiveTextureAndColor: {
  59528. texture: Nullable<BaseTexture>;
  59529. color: Color4;
  59530. };
  59531. /**
  59532. * The name of the layer
  59533. */
  59534. name: string;
  59535. /**
  59536. * The clear color of the texture used to generate the glow map.
  59537. */
  59538. neutralColor: Color4;
  59539. /**
  59540. * Specifies whether the highlight layer is enabled or not.
  59541. */
  59542. isEnabled: boolean;
  59543. /**
  59544. * Gets the camera attached to the layer.
  59545. */
  59546. get camera(): Nullable<Camera>;
  59547. /**
  59548. * Gets the rendering group id the layer should render in.
  59549. */
  59550. get renderingGroupId(): number;
  59551. set renderingGroupId(renderingGroupId: number);
  59552. /**
  59553. * An event triggered when the effect layer has been disposed.
  59554. */
  59555. onDisposeObservable: Observable<EffectLayer>;
  59556. /**
  59557. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  59558. */
  59559. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  59560. /**
  59561. * An event triggered when the generated texture is being merged in the scene.
  59562. */
  59563. onBeforeComposeObservable: Observable<EffectLayer>;
  59564. /**
  59565. * An event triggered when the mesh is rendered into the effect render target.
  59566. */
  59567. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  59568. /**
  59569. * An event triggered after the mesh has been rendered into the effect render target.
  59570. */
  59571. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  59572. /**
  59573. * An event triggered when the generated texture has been merged in the scene.
  59574. */
  59575. onAfterComposeObservable: Observable<EffectLayer>;
  59576. /**
  59577. * An event triggered when the efffect layer changes its size.
  59578. */
  59579. onSizeChangedObservable: Observable<EffectLayer>;
  59580. /** @hidden */
  59581. static _SceneComponentInitialization: (scene: Scene) => void;
  59582. /**
  59583. * Instantiates a new effect Layer and references it in the scene.
  59584. * @param name The name of the layer
  59585. * @param scene The scene to use the layer in
  59586. */
  59587. constructor(
  59588. /** The Friendly of the effect in the scene */
  59589. name: string, scene: Scene);
  59590. /**
  59591. * Get the effect name of the layer.
  59592. * @return The effect name
  59593. */
  59594. abstract getEffectName(): string;
  59595. /**
  59596. * Checks for the readiness of the element composing the layer.
  59597. * @param subMesh the mesh to check for
  59598. * @param useInstances specify whether or not to use instances to render the mesh
  59599. * @return true if ready otherwise, false
  59600. */
  59601. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  59602. /**
  59603. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  59604. * @returns true if the effect requires stencil during the main canvas render pass.
  59605. */
  59606. abstract needStencil(): boolean;
  59607. /**
  59608. * Create the merge effect. This is the shader use to blit the information back
  59609. * to the main canvas at the end of the scene rendering.
  59610. * @returns The effect containing the shader used to merge the effect on the main canvas
  59611. */
  59612. protected abstract _createMergeEffect(): Effect;
  59613. /**
  59614. * Creates the render target textures and post processes used in the effect layer.
  59615. */
  59616. protected abstract _createTextureAndPostProcesses(): void;
  59617. /**
  59618. * Implementation specific of rendering the generating effect on the main canvas.
  59619. * @param effect The effect used to render through
  59620. */
  59621. protected abstract _internalRender(effect: Effect): void;
  59622. /**
  59623. * Sets the required values for both the emissive texture and and the main color.
  59624. */
  59625. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  59626. /**
  59627. * Free any resources and references associated to a mesh.
  59628. * Internal use
  59629. * @param mesh The mesh to free.
  59630. */
  59631. abstract _disposeMesh(mesh: Mesh): void;
  59632. /**
  59633. * Serializes this layer (Glow or Highlight for example)
  59634. * @returns a serialized layer object
  59635. */
  59636. abstract serialize?(): any;
  59637. /**
  59638. * Initializes the effect layer with the required options.
  59639. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  59640. */
  59641. protected _init(options: Partial<IEffectLayerOptions>): void;
  59642. /**
  59643. * Generates the index buffer of the full screen quad blending to the main canvas.
  59644. */
  59645. private _generateIndexBuffer;
  59646. /**
  59647. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  59648. */
  59649. private _generateVertexBuffer;
  59650. /**
  59651. * Sets the main texture desired size which is the closest power of two
  59652. * of the engine canvas size.
  59653. */
  59654. private _setMainTextureSize;
  59655. /**
  59656. * Creates the main texture for the effect layer.
  59657. */
  59658. protected _createMainTexture(): void;
  59659. /**
  59660. * Adds specific effects defines.
  59661. * @param defines The defines to add specifics to.
  59662. */
  59663. protected _addCustomEffectDefines(defines: string[]): void;
  59664. /**
  59665. * Checks for the readiness of the element composing the layer.
  59666. * @param subMesh the mesh to check for
  59667. * @param useInstances specify whether or not to use instances to render the mesh
  59668. * @param emissiveTexture the associated emissive texture used to generate the glow
  59669. * @return true if ready otherwise, false
  59670. */
  59671. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  59672. /**
  59673. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  59674. */
  59675. render(): void;
  59676. /**
  59677. * Determine if a given mesh will be used in the current effect.
  59678. * @param mesh mesh to test
  59679. * @returns true if the mesh will be used
  59680. */
  59681. hasMesh(mesh: AbstractMesh): boolean;
  59682. /**
  59683. * Returns true if the layer contains information to display, otherwise false.
  59684. * @returns true if the glow layer should be rendered
  59685. */
  59686. shouldRender(): boolean;
  59687. /**
  59688. * Returns true if the mesh should render, otherwise false.
  59689. * @param mesh The mesh to render
  59690. * @returns true if it should render otherwise false
  59691. */
  59692. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  59693. /**
  59694. * Returns true if the mesh can be rendered, otherwise false.
  59695. * @param mesh The mesh to render
  59696. * @param material The material used on the mesh
  59697. * @returns true if it can be rendered otherwise false
  59698. */
  59699. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  59700. /**
  59701. * Returns true if the mesh should render, otherwise false.
  59702. * @param mesh The mesh to render
  59703. * @returns true if it should render otherwise false
  59704. */
  59705. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  59706. /**
  59707. * Renders the submesh passed in parameter to the generation map.
  59708. */
  59709. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  59710. /**
  59711. * Defines whether the current material of the mesh should be use to render the effect.
  59712. * @param mesh defines the current mesh to render
  59713. */
  59714. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  59715. /**
  59716. * Rebuild the required buffers.
  59717. * @hidden Internal use only.
  59718. */
  59719. _rebuild(): void;
  59720. /**
  59721. * Dispose only the render target textures and post process.
  59722. */
  59723. private _disposeTextureAndPostProcesses;
  59724. /**
  59725. * Dispose the highlight layer and free resources.
  59726. */
  59727. dispose(): void;
  59728. /**
  59729. * Gets the class name of the effect layer
  59730. * @returns the string with the class name of the effect layer
  59731. */
  59732. getClassName(): string;
  59733. /**
  59734. * Creates an effect layer from parsed effect layer data
  59735. * @param parsedEffectLayer defines effect layer data
  59736. * @param scene defines the current scene
  59737. * @param rootUrl defines the root URL containing the effect layer information
  59738. * @returns a parsed effect Layer
  59739. */
  59740. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  59741. }
  59742. }
  59743. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  59744. import { Scene } from "babylonjs/scene";
  59745. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  59746. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  59747. import { AbstractScene } from "babylonjs/abstractScene";
  59748. module "babylonjs/abstractScene" {
  59749. interface AbstractScene {
  59750. /**
  59751. * The list of effect layers (highlights/glow) added to the scene
  59752. * @see http://doc.babylonjs.com/how_to/highlight_layer
  59753. * @see http://doc.babylonjs.com/how_to/glow_layer
  59754. */
  59755. effectLayers: Array<EffectLayer>;
  59756. /**
  59757. * Removes the given effect layer from this scene.
  59758. * @param toRemove defines the effect layer to remove
  59759. * @returns the index of the removed effect layer
  59760. */
  59761. removeEffectLayer(toRemove: EffectLayer): number;
  59762. /**
  59763. * Adds the given effect layer to this scene
  59764. * @param newEffectLayer defines the effect layer to add
  59765. */
  59766. addEffectLayer(newEffectLayer: EffectLayer): void;
  59767. }
  59768. }
  59769. /**
  59770. * Defines the layer scene component responsible to manage any effect layers
  59771. * in a given scene.
  59772. */
  59773. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  59774. /**
  59775. * The component name helpfull to identify the component in the list of scene components.
  59776. */
  59777. readonly name: string;
  59778. /**
  59779. * The scene the component belongs to.
  59780. */
  59781. scene: Scene;
  59782. private _engine;
  59783. private _renderEffects;
  59784. private _needStencil;
  59785. private _previousStencilState;
  59786. /**
  59787. * Creates a new instance of the component for the given scene
  59788. * @param scene Defines the scene to register the component in
  59789. */
  59790. constructor(scene: Scene);
  59791. /**
  59792. * Registers the component in a given scene
  59793. */
  59794. register(): void;
  59795. /**
  59796. * Rebuilds the elements related to this component in case of
  59797. * context lost for instance.
  59798. */
  59799. rebuild(): void;
  59800. /**
  59801. * Serializes the component data to the specified json object
  59802. * @param serializationObject The object to serialize to
  59803. */
  59804. serialize(serializationObject: any): void;
  59805. /**
  59806. * Adds all the elements from the container to the scene
  59807. * @param container the container holding the elements
  59808. */
  59809. addFromContainer(container: AbstractScene): void;
  59810. /**
  59811. * Removes all the elements in the container from the scene
  59812. * @param container contains the elements to remove
  59813. * @param dispose if the removed element should be disposed (default: false)
  59814. */
  59815. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  59816. /**
  59817. * Disposes the component and the associated ressources.
  59818. */
  59819. dispose(): void;
  59820. private _isReadyForMesh;
  59821. private _renderMainTexture;
  59822. private _setStencil;
  59823. private _setStencilBack;
  59824. private _draw;
  59825. private _drawCamera;
  59826. private _drawRenderingGroup;
  59827. }
  59828. }
  59829. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  59830. /** @hidden */
  59831. export var glowMapMergePixelShader: {
  59832. name: string;
  59833. shader: string;
  59834. };
  59835. }
  59836. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  59837. /** @hidden */
  59838. export var glowMapMergeVertexShader: {
  59839. name: string;
  59840. shader: string;
  59841. };
  59842. }
  59843. declare module "babylonjs/Layers/glowLayer" {
  59844. import { Nullable } from "babylonjs/types";
  59845. import { Camera } from "babylonjs/Cameras/camera";
  59846. import { Scene } from "babylonjs/scene";
  59847. import { SubMesh } from "babylonjs/Meshes/subMesh";
  59848. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59849. import { Mesh } from "babylonjs/Meshes/mesh";
  59850. import { Texture } from "babylonjs/Materials/Textures/texture";
  59851. import { Effect } from "babylonjs/Materials/effect";
  59852. import { Material } from "babylonjs/Materials/material";
  59853. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  59854. import { Color4 } from "babylonjs/Maths/math.color";
  59855. import "babylonjs/Shaders/glowMapMerge.fragment";
  59856. import "babylonjs/Shaders/glowMapMerge.vertex";
  59857. import "babylonjs/Layers/effectLayerSceneComponent";
  59858. module "babylonjs/abstractScene" {
  59859. interface AbstractScene {
  59860. /**
  59861. * Return a the first highlight layer of the scene with a given name.
  59862. * @param name The name of the highlight layer to look for.
  59863. * @return The highlight layer if found otherwise null.
  59864. */
  59865. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  59866. }
  59867. }
  59868. /**
  59869. * Glow layer options. This helps customizing the behaviour
  59870. * of the glow layer.
  59871. */
  59872. export interface IGlowLayerOptions {
  59873. /**
  59874. * Multiplication factor apply to the canvas size to compute the render target size
  59875. * used to generated the glowing objects (the smaller the faster).
  59876. */
  59877. mainTextureRatio: number;
  59878. /**
  59879. * Enforces a fixed size texture to ensure resize independant blur.
  59880. */
  59881. mainTextureFixedSize?: number;
  59882. /**
  59883. * How big is the kernel of the blur texture.
  59884. */
  59885. blurKernelSize: number;
  59886. /**
  59887. * The camera attached to the layer.
  59888. */
  59889. camera: Nullable<Camera>;
  59890. /**
  59891. * Enable MSAA by chosing the number of samples.
  59892. */
  59893. mainTextureSamples?: number;
  59894. /**
  59895. * The rendering group to draw the layer in.
  59896. */
  59897. renderingGroupId: number;
  59898. }
  59899. /**
  59900. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  59901. *
  59902. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  59903. *
  59904. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  59905. */
  59906. export class GlowLayer extends EffectLayer {
  59907. /**
  59908. * Effect Name of the layer.
  59909. */
  59910. static readonly EffectName: string;
  59911. /**
  59912. * The default blur kernel size used for the glow.
  59913. */
  59914. static DefaultBlurKernelSize: number;
  59915. /**
  59916. * The default texture size ratio used for the glow.
  59917. */
  59918. static DefaultTextureRatio: number;
  59919. /**
  59920. * Sets the kernel size of the blur.
  59921. */
  59922. set blurKernelSize(value: number);
  59923. /**
  59924. * Gets the kernel size of the blur.
  59925. */
  59926. get blurKernelSize(): number;
  59927. /**
  59928. * Sets the glow intensity.
  59929. */
  59930. set intensity(value: number);
  59931. /**
  59932. * Gets the glow intensity.
  59933. */
  59934. get intensity(): number;
  59935. private _options;
  59936. private _intensity;
  59937. private _horizontalBlurPostprocess1;
  59938. private _verticalBlurPostprocess1;
  59939. private _horizontalBlurPostprocess2;
  59940. private _verticalBlurPostprocess2;
  59941. private _blurTexture1;
  59942. private _blurTexture2;
  59943. private _postProcesses1;
  59944. private _postProcesses2;
  59945. private _includedOnlyMeshes;
  59946. private _excludedMeshes;
  59947. private _meshesUsingTheirOwnMaterials;
  59948. /**
  59949. * Callback used to let the user override the color selection on a per mesh basis
  59950. */
  59951. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  59952. /**
  59953. * Callback used to let the user override the texture selection on a per mesh basis
  59954. */
  59955. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  59956. /**
  59957. * Instantiates a new glow Layer and references it to the scene.
  59958. * @param name The name of the layer
  59959. * @param scene The scene to use the layer in
  59960. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  59961. */
  59962. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  59963. /**
  59964. * Get the effect name of the layer.
  59965. * @return The effect name
  59966. */
  59967. getEffectName(): string;
  59968. /**
  59969. * Create the merge effect. This is the shader use to blit the information back
  59970. * to the main canvas at the end of the scene rendering.
  59971. */
  59972. protected _createMergeEffect(): Effect;
  59973. /**
  59974. * Creates the render target textures and post processes used in the glow layer.
  59975. */
  59976. protected _createTextureAndPostProcesses(): void;
  59977. /**
  59978. * Checks for the readiness of the element composing the layer.
  59979. * @param subMesh the mesh to check for
  59980. * @param useInstances specify wether or not to use instances to render the mesh
  59981. * @param emissiveTexture the associated emissive texture used to generate the glow
  59982. * @return true if ready otherwise, false
  59983. */
  59984. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  59985. /**
  59986. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  59987. */
  59988. needStencil(): boolean;
  59989. /**
  59990. * Returns true if the mesh can be rendered, otherwise false.
  59991. * @param mesh The mesh to render
  59992. * @param material The material used on the mesh
  59993. * @returns true if it can be rendered otherwise false
  59994. */
  59995. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  59996. /**
  59997. * Implementation specific of rendering the generating effect on the main canvas.
  59998. * @param effect The effect used to render through
  59999. */
  60000. protected _internalRender(effect: Effect): void;
  60001. /**
  60002. * Sets the required values for both the emissive texture and and the main color.
  60003. */
  60004. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60005. /**
  60006. * Returns true if the mesh should render, otherwise false.
  60007. * @param mesh The mesh to render
  60008. * @returns true if it should render otherwise false
  60009. */
  60010. protected _shouldRenderMesh(mesh: Mesh): boolean;
  60011. /**
  60012. * Adds specific effects defines.
  60013. * @param defines The defines to add specifics to.
  60014. */
  60015. protected _addCustomEffectDefines(defines: string[]): void;
  60016. /**
  60017. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  60018. * @param mesh The mesh to exclude from the glow layer
  60019. */
  60020. addExcludedMesh(mesh: Mesh): void;
  60021. /**
  60022. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  60023. * @param mesh The mesh to remove
  60024. */
  60025. removeExcludedMesh(mesh: Mesh): void;
  60026. /**
  60027. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  60028. * @param mesh The mesh to include in the glow layer
  60029. */
  60030. addIncludedOnlyMesh(mesh: Mesh): void;
  60031. /**
  60032. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  60033. * @param mesh The mesh to remove
  60034. */
  60035. removeIncludedOnlyMesh(mesh: Mesh): void;
  60036. /**
  60037. * Determine if a given mesh will be used in the glow layer
  60038. * @param mesh The mesh to test
  60039. * @returns true if the mesh will be highlighted by the current glow layer
  60040. */
  60041. hasMesh(mesh: AbstractMesh): boolean;
  60042. /**
  60043. * Defines whether the current material of the mesh should be use to render the effect.
  60044. * @param mesh defines the current mesh to render
  60045. */
  60046. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60047. /**
  60048. * Add a mesh to be rendered through its own material and not with emissive only.
  60049. * @param mesh The mesh for which we need to use its material
  60050. */
  60051. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  60052. /**
  60053. * Remove a mesh from being rendered through its own material and not with emissive only.
  60054. * @param mesh The mesh for which we need to not use its material
  60055. */
  60056. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  60057. /**
  60058. * Free any resources and references associated to a mesh.
  60059. * Internal use
  60060. * @param mesh The mesh to free.
  60061. * @hidden
  60062. */
  60063. _disposeMesh(mesh: Mesh): void;
  60064. /**
  60065. * Gets the class name of the effect layer
  60066. * @returns the string with the class name of the effect layer
  60067. */
  60068. getClassName(): string;
  60069. /**
  60070. * Serializes this glow layer
  60071. * @returns a serialized glow layer object
  60072. */
  60073. serialize(): any;
  60074. /**
  60075. * Creates a Glow Layer from parsed glow layer data
  60076. * @param parsedGlowLayer defines glow layer data
  60077. * @param scene defines the current scene
  60078. * @param rootUrl defines the root URL containing the glow layer information
  60079. * @returns a parsed Glow Layer
  60080. */
  60081. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  60082. }
  60083. }
  60084. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  60085. /** @hidden */
  60086. export var glowBlurPostProcessPixelShader: {
  60087. name: string;
  60088. shader: string;
  60089. };
  60090. }
  60091. declare module "babylonjs/Layers/highlightLayer" {
  60092. import { Observable } from "babylonjs/Misc/observable";
  60093. import { Nullable } from "babylonjs/types";
  60094. import { Camera } from "babylonjs/Cameras/camera";
  60095. import { Scene } from "babylonjs/scene";
  60096. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60097. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60098. import { Mesh } from "babylonjs/Meshes/mesh";
  60099. import { Effect } from "babylonjs/Materials/effect";
  60100. import { Material } from "babylonjs/Materials/material";
  60101. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60102. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  60103. import "babylonjs/Shaders/glowMapMerge.fragment";
  60104. import "babylonjs/Shaders/glowMapMerge.vertex";
  60105. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  60106. module "babylonjs/abstractScene" {
  60107. interface AbstractScene {
  60108. /**
  60109. * Return a the first highlight layer of the scene with a given name.
  60110. * @param name The name of the highlight layer to look for.
  60111. * @return The highlight layer if found otherwise null.
  60112. */
  60113. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  60114. }
  60115. }
  60116. /**
  60117. * Highlight layer options. This helps customizing the behaviour
  60118. * of the highlight layer.
  60119. */
  60120. export interface IHighlightLayerOptions {
  60121. /**
  60122. * Multiplication factor apply to the canvas size to compute the render target size
  60123. * used to generated the glowing objects (the smaller the faster).
  60124. */
  60125. mainTextureRatio: number;
  60126. /**
  60127. * Enforces a fixed size texture to ensure resize independant blur.
  60128. */
  60129. mainTextureFixedSize?: number;
  60130. /**
  60131. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  60132. * of the picture to blur (the smaller the faster).
  60133. */
  60134. blurTextureSizeRatio: number;
  60135. /**
  60136. * How big in texel of the blur texture is the vertical blur.
  60137. */
  60138. blurVerticalSize: number;
  60139. /**
  60140. * How big in texel of the blur texture is the horizontal blur.
  60141. */
  60142. blurHorizontalSize: number;
  60143. /**
  60144. * Alpha blending mode used to apply the blur. Default is combine.
  60145. */
  60146. alphaBlendingMode: number;
  60147. /**
  60148. * The camera attached to the layer.
  60149. */
  60150. camera: Nullable<Camera>;
  60151. /**
  60152. * Should we display highlight as a solid stroke?
  60153. */
  60154. isStroke?: boolean;
  60155. /**
  60156. * The rendering group to draw the layer in.
  60157. */
  60158. renderingGroupId: number;
  60159. }
  60160. /**
  60161. * The highlight layer Helps adding a glow effect around a mesh.
  60162. *
  60163. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  60164. * glowy meshes to your scene.
  60165. *
  60166. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  60167. */
  60168. export class HighlightLayer extends EffectLayer {
  60169. name: string;
  60170. /**
  60171. * Effect Name of the highlight layer.
  60172. */
  60173. static readonly EffectName: string;
  60174. /**
  60175. * The neutral color used during the preparation of the glow effect.
  60176. * This is black by default as the blend operation is a blend operation.
  60177. */
  60178. static NeutralColor: Color4;
  60179. /**
  60180. * Stencil value used for glowing meshes.
  60181. */
  60182. static GlowingMeshStencilReference: number;
  60183. /**
  60184. * Stencil value used for the other meshes in the scene.
  60185. */
  60186. static NormalMeshStencilReference: number;
  60187. /**
  60188. * Specifies whether or not the inner glow is ACTIVE in the layer.
  60189. */
  60190. innerGlow: boolean;
  60191. /**
  60192. * Specifies whether or not the outer glow is ACTIVE in the layer.
  60193. */
  60194. outerGlow: boolean;
  60195. /**
  60196. * Specifies the horizontal size of the blur.
  60197. */
  60198. set blurHorizontalSize(value: number);
  60199. /**
  60200. * Specifies the vertical size of the blur.
  60201. */
  60202. set blurVerticalSize(value: number);
  60203. /**
  60204. * Gets the horizontal size of the blur.
  60205. */
  60206. get blurHorizontalSize(): number;
  60207. /**
  60208. * Gets the vertical size of the blur.
  60209. */
  60210. get blurVerticalSize(): number;
  60211. /**
  60212. * An event triggered when the highlight layer is being blurred.
  60213. */
  60214. onBeforeBlurObservable: Observable<HighlightLayer>;
  60215. /**
  60216. * An event triggered when the highlight layer has been blurred.
  60217. */
  60218. onAfterBlurObservable: Observable<HighlightLayer>;
  60219. private _instanceGlowingMeshStencilReference;
  60220. private _options;
  60221. private _downSamplePostprocess;
  60222. private _horizontalBlurPostprocess;
  60223. private _verticalBlurPostprocess;
  60224. private _blurTexture;
  60225. private _meshes;
  60226. private _excludedMeshes;
  60227. /**
  60228. * Instantiates a new highlight Layer and references it to the scene..
  60229. * @param name The name of the layer
  60230. * @param scene The scene to use the layer in
  60231. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  60232. */
  60233. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  60234. /**
  60235. * Get the effect name of the layer.
  60236. * @return The effect name
  60237. */
  60238. getEffectName(): string;
  60239. /**
  60240. * Create the merge effect. This is the shader use to blit the information back
  60241. * to the main canvas at the end of the scene rendering.
  60242. */
  60243. protected _createMergeEffect(): Effect;
  60244. /**
  60245. * Creates the render target textures and post processes used in the highlight layer.
  60246. */
  60247. protected _createTextureAndPostProcesses(): void;
  60248. /**
  60249. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  60250. */
  60251. needStencil(): boolean;
  60252. /**
  60253. * Checks for the readiness of the element composing the layer.
  60254. * @param subMesh the mesh to check for
  60255. * @param useInstances specify wether or not to use instances to render the mesh
  60256. * @param emissiveTexture the associated emissive texture used to generate the glow
  60257. * @return true if ready otherwise, false
  60258. */
  60259. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60260. /**
  60261. * Implementation specific of rendering the generating effect on the main canvas.
  60262. * @param effect The effect used to render through
  60263. */
  60264. protected _internalRender(effect: Effect): void;
  60265. /**
  60266. * Returns true if the layer contains information to display, otherwise false.
  60267. */
  60268. shouldRender(): boolean;
  60269. /**
  60270. * Returns true if the mesh should render, otherwise false.
  60271. * @param mesh The mesh to render
  60272. * @returns true if it should render otherwise false
  60273. */
  60274. protected _shouldRenderMesh(mesh: Mesh): boolean;
  60275. /**
  60276. * Adds specific effects defines.
  60277. * @param defines The defines to add specifics to.
  60278. */
  60279. protected _addCustomEffectDefines(defines: string[]): void;
  60280. /**
  60281. * Sets the required values for both the emissive texture and and the main color.
  60282. */
  60283. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60284. /**
  60285. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  60286. * @param mesh The mesh to exclude from the highlight layer
  60287. */
  60288. addExcludedMesh(mesh: Mesh): void;
  60289. /**
  60290. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  60291. * @param mesh The mesh to highlight
  60292. */
  60293. removeExcludedMesh(mesh: Mesh): void;
  60294. /**
  60295. * Determine if a given mesh will be highlighted by the current HighlightLayer
  60296. * @param mesh mesh to test
  60297. * @returns true if the mesh will be highlighted by the current HighlightLayer
  60298. */
  60299. hasMesh(mesh: AbstractMesh): boolean;
  60300. /**
  60301. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  60302. * @param mesh The mesh to highlight
  60303. * @param color The color of the highlight
  60304. * @param glowEmissiveOnly Extract the glow from the emissive texture
  60305. */
  60306. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  60307. /**
  60308. * Remove a mesh from the highlight layer in order to make it stop glowing.
  60309. * @param mesh The mesh to highlight
  60310. */
  60311. removeMesh(mesh: Mesh): void;
  60312. /**
  60313. * Remove all the meshes currently referenced in the highlight layer
  60314. */
  60315. removeAllMeshes(): void;
  60316. /**
  60317. * Force the stencil to the normal expected value for none glowing parts
  60318. */
  60319. private _defaultStencilReference;
  60320. /**
  60321. * Free any resources and references associated to a mesh.
  60322. * Internal use
  60323. * @param mesh The mesh to free.
  60324. * @hidden
  60325. */
  60326. _disposeMesh(mesh: Mesh): void;
  60327. /**
  60328. * Dispose the highlight layer and free resources.
  60329. */
  60330. dispose(): void;
  60331. /**
  60332. * Gets the class name of the effect layer
  60333. * @returns the string with the class name of the effect layer
  60334. */
  60335. getClassName(): string;
  60336. /**
  60337. * Serializes this Highlight layer
  60338. * @returns a serialized Highlight layer object
  60339. */
  60340. serialize(): any;
  60341. /**
  60342. * Creates a Highlight layer from parsed Highlight layer data
  60343. * @param parsedHightlightLayer defines the Highlight layer data
  60344. * @param scene defines the current scene
  60345. * @param rootUrl defines the root URL containing the Highlight layer information
  60346. * @returns a parsed Highlight layer
  60347. */
  60348. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  60349. }
  60350. }
  60351. declare module "babylonjs/Layers/layerSceneComponent" {
  60352. import { Scene } from "babylonjs/scene";
  60353. import { ISceneComponent } from "babylonjs/sceneComponent";
  60354. import { Layer } from "babylonjs/Layers/layer";
  60355. import { AbstractScene } from "babylonjs/abstractScene";
  60356. module "babylonjs/abstractScene" {
  60357. interface AbstractScene {
  60358. /**
  60359. * The list of layers (background and foreground) of the scene
  60360. */
  60361. layers: Array<Layer>;
  60362. }
  60363. }
  60364. /**
  60365. * Defines the layer scene component responsible to manage any layers
  60366. * in a given scene.
  60367. */
  60368. export class LayerSceneComponent implements ISceneComponent {
  60369. /**
  60370. * The component name helpfull to identify the component in the list of scene components.
  60371. */
  60372. readonly name: string;
  60373. /**
  60374. * The scene the component belongs to.
  60375. */
  60376. scene: Scene;
  60377. private _engine;
  60378. /**
  60379. * Creates a new instance of the component for the given scene
  60380. * @param scene Defines the scene to register the component in
  60381. */
  60382. constructor(scene: Scene);
  60383. /**
  60384. * Registers the component in a given scene
  60385. */
  60386. register(): void;
  60387. /**
  60388. * Rebuilds the elements related to this component in case of
  60389. * context lost for instance.
  60390. */
  60391. rebuild(): void;
  60392. /**
  60393. * Disposes the component and the associated ressources.
  60394. */
  60395. dispose(): void;
  60396. private _draw;
  60397. private _drawCameraPredicate;
  60398. private _drawCameraBackground;
  60399. private _drawCameraForeground;
  60400. private _drawRenderTargetPredicate;
  60401. private _drawRenderTargetBackground;
  60402. private _drawRenderTargetForeground;
  60403. /**
  60404. * Adds all the elements from the container to the scene
  60405. * @param container the container holding the elements
  60406. */
  60407. addFromContainer(container: AbstractScene): void;
  60408. /**
  60409. * Removes all the elements in the container from the scene
  60410. * @param container contains the elements to remove
  60411. * @param dispose if the removed element should be disposed (default: false)
  60412. */
  60413. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  60414. }
  60415. }
  60416. declare module "babylonjs/Shaders/layer.fragment" {
  60417. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  60418. /** @hidden */
  60419. export var layerPixelShader: {
  60420. name: string;
  60421. shader: string;
  60422. };
  60423. }
  60424. declare module "babylonjs/Shaders/layer.vertex" {
  60425. /** @hidden */
  60426. export var layerVertexShader: {
  60427. name: string;
  60428. shader: string;
  60429. };
  60430. }
  60431. declare module "babylonjs/Layers/layer" {
  60432. import { Observable } from "babylonjs/Misc/observable";
  60433. import { Nullable } from "babylonjs/types";
  60434. import { Scene } from "babylonjs/scene";
  60435. import { Vector2 } from "babylonjs/Maths/math.vector";
  60436. import { Color4 } from "babylonjs/Maths/math.color";
  60437. import { Texture } from "babylonjs/Materials/Textures/texture";
  60438. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60439. import "babylonjs/Shaders/layer.fragment";
  60440. import "babylonjs/Shaders/layer.vertex";
  60441. /**
  60442. * This represents a full screen 2d layer.
  60443. * This can be useful to display a picture in the background of your scene for instance.
  60444. * @see https://www.babylonjs-playground.com/#08A2BS#1
  60445. */
  60446. export class Layer {
  60447. /**
  60448. * Define the name of the layer.
  60449. */
  60450. name: string;
  60451. /**
  60452. * Define the texture the layer should display.
  60453. */
  60454. texture: Nullable<Texture>;
  60455. /**
  60456. * Is the layer in background or foreground.
  60457. */
  60458. isBackground: boolean;
  60459. /**
  60460. * Define the color of the layer (instead of texture).
  60461. */
  60462. color: Color4;
  60463. /**
  60464. * Define the scale of the layer in order to zoom in out of the texture.
  60465. */
  60466. scale: Vector2;
  60467. /**
  60468. * Define an offset for the layer in order to shift the texture.
  60469. */
  60470. offset: Vector2;
  60471. /**
  60472. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  60473. */
  60474. alphaBlendingMode: number;
  60475. /**
  60476. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  60477. * Alpha test will not mix with the background color in case of transparency.
  60478. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  60479. */
  60480. alphaTest: boolean;
  60481. /**
  60482. * Define a mask to restrict the layer to only some of the scene cameras.
  60483. */
  60484. layerMask: number;
  60485. /**
  60486. * Define the list of render target the layer is visible into.
  60487. */
  60488. renderTargetTextures: RenderTargetTexture[];
  60489. /**
  60490. * Define if the layer is only used in renderTarget or if it also
  60491. * renders in the main frame buffer of the canvas.
  60492. */
  60493. renderOnlyInRenderTargetTextures: boolean;
  60494. private _scene;
  60495. private _vertexBuffers;
  60496. private _indexBuffer;
  60497. private _effect;
  60498. private _previousDefines;
  60499. /**
  60500. * An event triggered when the layer is disposed.
  60501. */
  60502. onDisposeObservable: Observable<Layer>;
  60503. private _onDisposeObserver;
  60504. /**
  60505. * Back compatibility with callback before the onDisposeObservable existed.
  60506. * The set callback will be triggered when the layer has been disposed.
  60507. */
  60508. set onDispose(callback: () => void);
  60509. /**
  60510. * An event triggered before rendering the scene
  60511. */
  60512. onBeforeRenderObservable: Observable<Layer>;
  60513. private _onBeforeRenderObserver;
  60514. /**
  60515. * Back compatibility with callback before the onBeforeRenderObservable existed.
  60516. * The set callback will be triggered just before rendering the layer.
  60517. */
  60518. set onBeforeRender(callback: () => void);
  60519. /**
  60520. * An event triggered after rendering the scene
  60521. */
  60522. onAfterRenderObservable: Observable<Layer>;
  60523. private _onAfterRenderObserver;
  60524. /**
  60525. * Back compatibility with callback before the onAfterRenderObservable existed.
  60526. * The set callback will be triggered just after rendering the layer.
  60527. */
  60528. set onAfterRender(callback: () => void);
  60529. /**
  60530. * Instantiates a new layer.
  60531. * This represents a full screen 2d layer.
  60532. * This can be useful to display a picture in the background of your scene for instance.
  60533. * @see https://www.babylonjs-playground.com/#08A2BS#1
  60534. * @param name Define the name of the layer in the scene
  60535. * @param imgUrl Define the url of the texture to display in the layer
  60536. * @param scene Define the scene the layer belongs to
  60537. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  60538. * @param color Defines a color for the layer
  60539. */
  60540. constructor(
  60541. /**
  60542. * Define the name of the layer.
  60543. */
  60544. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  60545. private _createIndexBuffer;
  60546. /** @hidden */
  60547. _rebuild(): void;
  60548. /**
  60549. * Renders the layer in the scene.
  60550. */
  60551. render(): void;
  60552. /**
  60553. * Disposes and releases the associated ressources.
  60554. */
  60555. dispose(): void;
  60556. }
  60557. }
  60558. declare module "babylonjs/Layers/index" {
  60559. export * from "babylonjs/Layers/effectLayer";
  60560. export * from "babylonjs/Layers/effectLayerSceneComponent";
  60561. export * from "babylonjs/Layers/glowLayer";
  60562. export * from "babylonjs/Layers/highlightLayer";
  60563. export * from "babylonjs/Layers/layer";
  60564. export * from "babylonjs/Layers/layerSceneComponent";
  60565. }
  60566. declare module "babylonjs/Shaders/lensFlare.fragment" {
  60567. /** @hidden */
  60568. export var lensFlarePixelShader: {
  60569. name: string;
  60570. shader: string;
  60571. };
  60572. }
  60573. declare module "babylonjs/Shaders/lensFlare.vertex" {
  60574. /** @hidden */
  60575. export var lensFlareVertexShader: {
  60576. name: string;
  60577. shader: string;
  60578. };
  60579. }
  60580. declare module "babylonjs/LensFlares/lensFlareSystem" {
  60581. import { Scene } from "babylonjs/scene";
  60582. import { Vector3 } from "babylonjs/Maths/math.vector";
  60583. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60584. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  60585. import "babylonjs/Shaders/lensFlare.fragment";
  60586. import "babylonjs/Shaders/lensFlare.vertex";
  60587. import { Viewport } from "babylonjs/Maths/math.viewport";
  60588. /**
  60589. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  60590. * It is usually composed of several `lensFlare`.
  60591. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60592. */
  60593. export class LensFlareSystem {
  60594. /**
  60595. * Define the name of the lens flare system
  60596. */
  60597. name: string;
  60598. /**
  60599. * List of lens flares used in this system.
  60600. */
  60601. lensFlares: LensFlare[];
  60602. /**
  60603. * Define a limit from the border the lens flare can be visible.
  60604. */
  60605. borderLimit: number;
  60606. /**
  60607. * Define a viewport border we do not want to see the lens flare in.
  60608. */
  60609. viewportBorder: number;
  60610. /**
  60611. * Define a predicate which could limit the list of meshes able to occlude the effect.
  60612. */
  60613. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  60614. /**
  60615. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  60616. */
  60617. layerMask: number;
  60618. /**
  60619. * Define the id of the lens flare system in the scene.
  60620. * (equal to name by default)
  60621. */
  60622. id: string;
  60623. private _scene;
  60624. private _emitter;
  60625. private _vertexBuffers;
  60626. private _indexBuffer;
  60627. private _effect;
  60628. private _positionX;
  60629. private _positionY;
  60630. private _isEnabled;
  60631. /** @hidden */
  60632. static _SceneComponentInitialization: (scene: Scene) => void;
  60633. /**
  60634. * Instantiates a lens flare system.
  60635. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  60636. * It is usually composed of several `lensFlare`.
  60637. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60638. * @param name Define the name of the lens flare system in the scene
  60639. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  60640. * @param scene Define the scene the lens flare system belongs to
  60641. */
  60642. constructor(
  60643. /**
  60644. * Define the name of the lens flare system
  60645. */
  60646. name: string, emitter: any, scene: Scene);
  60647. /**
  60648. * Define if the lens flare system is enabled.
  60649. */
  60650. get isEnabled(): boolean;
  60651. set isEnabled(value: boolean);
  60652. /**
  60653. * Get the scene the effects belongs to.
  60654. * @returns the scene holding the lens flare system
  60655. */
  60656. getScene(): Scene;
  60657. /**
  60658. * Get the emitter of the lens flare system.
  60659. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  60660. * @returns the emitter of the lens flare system
  60661. */
  60662. getEmitter(): any;
  60663. /**
  60664. * Set the emitter of the lens flare system.
  60665. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  60666. * @param newEmitter Define the new emitter of the system
  60667. */
  60668. setEmitter(newEmitter: any): void;
  60669. /**
  60670. * Get the lens flare system emitter position.
  60671. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  60672. * @returns the position
  60673. */
  60674. getEmitterPosition(): Vector3;
  60675. /**
  60676. * @hidden
  60677. */
  60678. computeEffectivePosition(globalViewport: Viewport): boolean;
  60679. /** @hidden */
  60680. _isVisible(): boolean;
  60681. /**
  60682. * @hidden
  60683. */
  60684. render(): boolean;
  60685. /**
  60686. * Dispose and release the lens flare with its associated resources.
  60687. */
  60688. dispose(): void;
  60689. /**
  60690. * Parse a lens flare system from a JSON repressentation
  60691. * @param parsedLensFlareSystem Define the JSON to parse
  60692. * @param scene Define the scene the parsed system should be instantiated in
  60693. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  60694. * @returns the parsed system
  60695. */
  60696. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  60697. /**
  60698. * Serialize the current Lens Flare System into a JSON representation.
  60699. * @returns the serialized JSON
  60700. */
  60701. serialize(): any;
  60702. }
  60703. }
  60704. declare module "babylonjs/LensFlares/lensFlare" {
  60705. import { Nullable } from "babylonjs/types";
  60706. import { Color3 } from "babylonjs/Maths/math.color";
  60707. import { Texture } from "babylonjs/Materials/Textures/texture";
  60708. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  60709. /**
  60710. * This represents one of the lens effect in a `lensFlareSystem`.
  60711. * It controls one of the indiviual texture used in the effect.
  60712. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60713. */
  60714. export class LensFlare {
  60715. /**
  60716. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  60717. */
  60718. size: number;
  60719. /**
  60720. * 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.
  60721. */
  60722. position: number;
  60723. /**
  60724. * Define the lens color.
  60725. */
  60726. color: Color3;
  60727. /**
  60728. * Define the lens texture.
  60729. */
  60730. texture: Nullable<Texture>;
  60731. /**
  60732. * Define the alpha mode to render this particular lens.
  60733. */
  60734. alphaMode: number;
  60735. private _system;
  60736. /**
  60737. * Creates a new Lens Flare.
  60738. * This represents one of the lens effect in a `lensFlareSystem`.
  60739. * It controls one of the indiviual texture used in the effect.
  60740. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60741. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  60742. * @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.
  60743. * @param color Define the lens color
  60744. * @param imgUrl Define the lens texture url
  60745. * @param system Define the `lensFlareSystem` this flare is part of
  60746. * @returns The newly created Lens Flare
  60747. */
  60748. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  60749. /**
  60750. * Instantiates a new Lens Flare.
  60751. * This represents one of the lens effect in a `lensFlareSystem`.
  60752. * It controls one of the indiviual texture used in the effect.
  60753. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60754. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  60755. * @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.
  60756. * @param color Define the lens color
  60757. * @param imgUrl Define the lens texture url
  60758. * @param system Define the `lensFlareSystem` this flare is part of
  60759. */
  60760. constructor(
  60761. /**
  60762. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  60763. */
  60764. size: number,
  60765. /**
  60766. * 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.
  60767. */
  60768. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  60769. /**
  60770. * Dispose and release the lens flare with its associated resources.
  60771. */
  60772. dispose(): void;
  60773. }
  60774. }
  60775. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  60776. import { Nullable } from "babylonjs/types";
  60777. import { Scene } from "babylonjs/scene";
  60778. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  60779. import { AbstractScene } from "babylonjs/abstractScene";
  60780. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  60781. module "babylonjs/abstractScene" {
  60782. interface AbstractScene {
  60783. /**
  60784. * The list of lens flare system added to the scene
  60785. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60786. */
  60787. lensFlareSystems: Array<LensFlareSystem>;
  60788. /**
  60789. * Removes the given lens flare system from this scene.
  60790. * @param toRemove The lens flare system to remove
  60791. * @returns The index of the removed lens flare system
  60792. */
  60793. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  60794. /**
  60795. * Adds the given lens flare system to this scene
  60796. * @param newLensFlareSystem The lens flare system to add
  60797. */
  60798. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  60799. /**
  60800. * Gets a lens flare system using its name
  60801. * @param name defines the name to look for
  60802. * @returns the lens flare system or null if not found
  60803. */
  60804. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  60805. /**
  60806. * Gets a lens flare system using its id
  60807. * @param id defines the id to look for
  60808. * @returns the lens flare system or null if not found
  60809. */
  60810. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  60811. }
  60812. }
  60813. /**
  60814. * Defines the lens flare scene component responsible to manage any lens flares
  60815. * in a given scene.
  60816. */
  60817. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  60818. /**
  60819. * The component name helpfull to identify the component in the list of scene components.
  60820. */
  60821. readonly name: string;
  60822. /**
  60823. * The scene the component belongs to.
  60824. */
  60825. scene: Scene;
  60826. /**
  60827. * Creates a new instance of the component for the given scene
  60828. * @param scene Defines the scene to register the component in
  60829. */
  60830. constructor(scene: Scene);
  60831. /**
  60832. * Registers the component in a given scene
  60833. */
  60834. register(): void;
  60835. /**
  60836. * Rebuilds the elements related to this component in case of
  60837. * context lost for instance.
  60838. */
  60839. rebuild(): void;
  60840. /**
  60841. * Adds all the elements from the container to the scene
  60842. * @param container the container holding the elements
  60843. */
  60844. addFromContainer(container: AbstractScene): void;
  60845. /**
  60846. * Removes all the elements in the container from the scene
  60847. * @param container contains the elements to remove
  60848. * @param dispose if the removed element should be disposed (default: false)
  60849. */
  60850. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  60851. /**
  60852. * Serializes the component data to the specified json object
  60853. * @param serializationObject The object to serialize to
  60854. */
  60855. serialize(serializationObject: any): void;
  60856. /**
  60857. * Disposes the component and the associated ressources.
  60858. */
  60859. dispose(): void;
  60860. private _draw;
  60861. }
  60862. }
  60863. declare module "babylonjs/LensFlares/index" {
  60864. export * from "babylonjs/LensFlares/lensFlare";
  60865. export * from "babylonjs/LensFlares/lensFlareSystem";
  60866. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  60867. }
  60868. declare module "babylonjs/Shaders/depth.fragment" {
  60869. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  60870. /** @hidden */
  60871. export var depthPixelShader: {
  60872. name: string;
  60873. shader: string;
  60874. };
  60875. }
  60876. declare module "babylonjs/Shaders/depth.vertex" {
  60877. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60878. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60879. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60880. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60881. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60882. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60883. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60884. /** @hidden */
  60885. export var depthVertexShader: {
  60886. name: string;
  60887. shader: string;
  60888. };
  60889. }
  60890. declare module "babylonjs/Rendering/depthRenderer" {
  60891. import { Nullable } from "babylonjs/types";
  60892. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60893. import { Scene } from "babylonjs/scene";
  60894. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60895. import { Camera } from "babylonjs/Cameras/camera";
  60896. import "babylonjs/Shaders/depth.fragment";
  60897. import "babylonjs/Shaders/depth.vertex";
  60898. /**
  60899. * This represents a depth renderer in Babylon.
  60900. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  60901. */
  60902. export class DepthRenderer {
  60903. private _scene;
  60904. private _depthMap;
  60905. private _effect;
  60906. private readonly _storeNonLinearDepth;
  60907. private readonly _clearColor;
  60908. /** Get if the depth renderer is using packed depth or not */
  60909. readonly isPacked: boolean;
  60910. private _cachedDefines;
  60911. private _camera;
  60912. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  60913. enabled: boolean;
  60914. /**
  60915. * Specifiess that the depth renderer will only be used within
  60916. * the camera it is created for.
  60917. * This can help forcing its rendering during the camera processing.
  60918. */
  60919. useOnlyInActiveCamera: boolean;
  60920. /** @hidden */
  60921. static _SceneComponentInitialization: (scene: Scene) => void;
  60922. /**
  60923. * Instantiates a depth renderer
  60924. * @param scene The scene the renderer belongs to
  60925. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  60926. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  60927. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  60928. */
  60929. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  60930. /**
  60931. * Creates the depth rendering effect and checks if the effect is ready.
  60932. * @param subMesh The submesh to be used to render the depth map of
  60933. * @param useInstances If multiple world instances should be used
  60934. * @returns if the depth renderer is ready to render the depth map
  60935. */
  60936. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60937. /**
  60938. * Gets the texture which the depth map will be written to.
  60939. * @returns The depth map texture
  60940. */
  60941. getDepthMap(): RenderTargetTexture;
  60942. /**
  60943. * Disposes of the depth renderer.
  60944. */
  60945. dispose(): void;
  60946. }
  60947. }
  60948. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  60949. /** @hidden */
  60950. export var minmaxReduxPixelShader: {
  60951. name: string;
  60952. shader: string;
  60953. };
  60954. }
  60955. declare module "babylonjs/Misc/minMaxReducer" {
  60956. import { Nullable } from "babylonjs/types";
  60957. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60958. import { Camera } from "babylonjs/Cameras/camera";
  60959. import { Observer } from "babylonjs/Misc/observable";
  60960. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60961. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  60962. import { Observable } from "babylonjs/Misc/observable";
  60963. import "babylonjs/Shaders/minmaxRedux.fragment";
  60964. /**
  60965. * This class computes a min/max reduction from a texture: it means it computes the minimum
  60966. * and maximum values from all values of the texture.
  60967. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  60968. * The source values are read from the red channel of the texture.
  60969. */
  60970. export class MinMaxReducer {
  60971. /**
  60972. * Observable triggered when the computation has been performed
  60973. */
  60974. onAfterReductionPerformed: Observable<{
  60975. min: number;
  60976. max: number;
  60977. }>;
  60978. protected _camera: Camera;
  60979. protected _sourceTexture: Nullable<RenderTargetTexture>;
  60980. protected _reductionSteps: Nullable<Array<PostProcess>>;
  60981. protected _postProcessManager: PostProcessManager;
  60982. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  60983. protected _forceFullscreenViewport: boolean;
  60984. /**
  60985. * Creates a min/max reducer
  60986. * @param camera The camera to use for the post processes
  60987. */
  60988. constructor(camera: Camera);
  60989. /**
  60990. * Gets the texture used to read the values from.
  60991. */
  60992. get sourceTexture(): Nullable<RenderTargetTexture>;
  60993. /**
  60994. * Sets the source texture to read the values from.
  60995. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  60996. * because in such textures '1' value must not be taken into account to compute the maximum
  60997. * as this value is used to clear the texture.
  60998. * Note that the computation is not activated by calling this function, you must call activate() for that!
  60999. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  61000. * @param depthRedux Indicates if the texture is a depth texture or not
  61001. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  61002. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  61003. */
  61004. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  61005. /**
  61006. * Defines the refresh rate of the computation.
  61007. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  61008. */
  61009. get refreshRate(): number;
  61010. set refreshRate(value: number);
  61011. protected _activated: boolean;
  61012. /**
  61013. * Gets the activation status of the reducer
  61014. */
  61015. get activated(): boolean;
  61016. /**
  61017. * Activates the reduction computation.
  61018. * When activated, the observers registered in onAfterReductionPerformed are
  61019. * called after the compuation is performed
  61020. */
  61021. activate(): void;
  61022. /**
  61023. * Deactivates the reduction computation.
  61024. */
  61025. deactivate(): void;
  61026. /**
  61027. * Disposes the min/max reducer
  61028. * @param disposeAll true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
  61029. */
  61030. dispose(disposeAll?: boolean): void;
  61031. }
  61032. }
  61033. declare module "babylonjs/Misc/depthReducer" {
  61034. import { Nullable } from "babylonjs/types";
  61035. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61036. import { Camera } from "babylonjs/Cameras/camera";
  61037. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  61038. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  61039. /**
  61040. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  61041. */
  61042. export class DepthReducer extends MinMaxReducer {
  61043. private _depthRenderer;
  61044. private _depthRendererId;
  61045. /**
  61046. * Gets the depth renderer used for the computation.
  61047. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  61048. */
  61049. get depthRenderer(): Nullable<DepthRenderer>;
  61050. /**
  61051. * Creates a depth reducer
  61052. * @param camera The camera used to render the depth texture
  61053. */
  61054. constructor(camera: Camera);
  61055. /**
  61056. * Sets the depth renderer to use to generate the depth map
  61057. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  61058. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  61059. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  61060. */
  61061. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  61062. /** @hidden */
  61063. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  61064. /**
  61065. * Activates the reduction computation.
  61066. * When activated, the observers registered in onAfterReductionPerformed are
  61067. * called after the compuation is performed
  61068. */
  61069. activate(): void;
  61070. /**
  61071. * Deactivates the reduction computation.
  61072. */
  61073. deactivate(): void;
  61074. /**
  61075. * Disposes the depth reducer
  61076. * @param disposeAll true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
  61077. */
  61078. dispose(disposeAll?: boolean): void;
  61079. }
  61080. }
  61081. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  61082. import { Nullable } from "babylonjs/types";
  61083. import { Scene } from "babylonjs/scene";
  61084. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  61085. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61086. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61087. import { Effect } from "babylonjs/Materials/effect";
  61088. import "babylonjs/Shaders/shadowMap.fragment";
  61089. import "babylonjs/Shaders/shadowMap.vertex";
  61090. import "babylonjs/Shaders/depthBoxBlur.fragment";
  61091. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  61092. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  61093. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  61094. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  61095. /**
  61096. * A CSM implementation allowing casting shadows on large scenes.
  61097. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  61098. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  61099. */
  61100. export class CascadedShadowGenerator extends ShadowGenerator {
  61101. private static readonly frustumCornersNDCSpace;
  61102. /**
  61103. * Name of the CSM class
  61104. */
  61105. static CLASSNAME: string;
  61106. /**
  61107. * Defines the default number of cascades used by the CSM.
  61108. */
  61109. static readonly DEFAULT_CASCADES_COUNT: number;
  61110. /**
  61111. * Defines the minimum number of cascades used by the CSM.
  61112. */
  61113. static readonly MIN_CASCADES_COUNT: number;
  61114. /**
  61115. * Defines the maximum number of cascades used by the CSM.
  61116. */
  61117. static readonly MAX_CASCADES_COUNT: number;
  61118. protected _validateFilter(filter: number): number;
  61119. /**
  61120. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  61121. */
  61122. penumbraDarkness: number;
  61123. private _numCascades;
  61124. /**
  61125. * Gets or set the number of cascades used by the CSM.
  61126. */
  61127. get numCascades(): number;
  61128. set numCascades(value: number);
  61129. /**
  61130. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  61131. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  61132. */
  61133. stabilizeCascades: boolean;
  61134. private _freezeShadowCastersBoundingInfo;
  61135. private _freezeShadowCastersBoundingInfoObservable;
  61136. /**
  61137. * Enables or disables the shadow casters bounding info computation.
  61138. * If your shadow casters don't move, you can disable this feature.
  61139. * If it is enabled, the bounding box computation is done every frame.
  61140. */
  61141. get freezeShadowCastersBoundingInfo(): boolean;
  61142. set freezeShadowCastersBoundingInfo(freeze: boolean);
  61143. private _scbiMin;
  61144. private _scbiMax;
  61145. protected _computeShadowCastersBoundingInfo(): void;
  61146. protected _shadowCastersBoundingInfo: BoundingInfo;
  61147. /**
  61148. * Gets or sets the shadow casters bounding info.
  61149. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  61150. * so that the system won't overwrite the bounds you provide
  61151. */
  61152. get shadowCastersBoundingInfo(): BoundingInfo;
  61153. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  61154. protected _breaksAreDirty: boolean;
  61155. protected _minDistance: number;
  61156. protected _maxDistance: number;
  61157. /**
  61158. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  61159. *
  61160. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  61161. * If you don't know these values, simply leave them to their defaults and don't call this function.
  61162. * @param min minimal distance for the breaks (default to 0.)
  61163. * @param max maximal distance for the breaks (default to 1.)
  61164. */
  61165. setMinMaxDistance(min: number, max: number): void;
  61166. /** Gets the minimal distance used in the cascade break computation */
  61167. get minDistance(): number;
  61168. /** Gets the maximal distance used in the cascade break computation */
  61169. get maxDistance(): number;
  61170. /**
  61171. * Gets the class name of that object
  61172. * @returns "CascadedShadowGenerator"
  61173. */
  61174. getClassName(): string;
  61175. private _cascadeMinExtents;
  61176. private _cascadeMaxExtents;
  61177. /**
  61178. * Gets a cascade minimum extents
  61179. * @param cascadeIndex index of the cascade
  61180. * @returns the minimum cascade extents
  61181. */
  61182. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  61183. /**
  61184. * Gets a cascade maximum extents
  61185. * @param cascadeIndex index of the cascade
  61186. * @returns the maximum cascade extents
  61187. */
  61188. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  61189. private _cascades;
  61190. private _currentLayer;
  61191. private _viewSpaceFrustumsZ;
  61192. private _viewMatrices;
  61193. private _projectionMatrices;
  61194. private _transformMatrices;
  61195. private _transformMatricesAsArray;
  61196. private _frustumLengths;
  61197. private _lightSizeUVCorrection;
  61198. private _depthCorrection;
  61199. private _frustumCornersWorldSpace;
  61200. private _frustumCenter;
  61201. private _shadowCameraPos;
  61202. private _shadowMaxZ;
  61203. /**
  61204. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  61205. * It defaults to camera.maxZ
  61206. */
  61207. get shadowMaxZ(): number;
  61208. /**
  61209. * Sets the shadow max z distance.
  61210. */
  61211. set shadowMaxZ(value: number);
  61212. protected _debug: boolean;
  61213. /**
  61214. * Gets or sets the debug flag.
  61215. * When enabled, the cascades are materialized by different colors on the screen.
  61216. */
  61217. get debug(): boolean;
  61218. set debug(dbg: boolean);
  61219. private _depthClamp;
  61220. /**
  61221. * Gets or sets the depth clamping value.
  61222. *
  61223. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  61224. * to account for the shadow casters far away.
  61225. *
  61226. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  61227. */
  61228. get depthClamp(): boolean;
  61229. set depthClamp(value: boolean);
  61230. private _cascadeBlendPercentage;
  61231. /**
  61232. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  61233. * It defaults to 0.1 (10% blending).
  61234. */
  61235. get cascadeBlendPercentage(): number;
  61236. set cascadeBlendPercentage(value: number);
  61237. private _lambda;
  61238. /**
  61239. * Gets or set the lambda parameter.
  61240. * This parameter is used to split the camera frustum and create the cascades.
  61241. * It's a value between 0. and 1.: If 0, the split is a uniform split of the frustum, if 1 it is a logarithmic split.
  61242. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  61243. */
  61244. get lambda(): number;
  61245. set lambda(value: number);
  61246. /**
  61247. * Gets the view matrix corresponding to a given cascade
  61248. * @param cascadeNum cascade to retrieve the view matrix from
  61249. * @returns the cascade view matrix
  61250. */
  61251. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  61252. /**
  61253. * Gets the projection matrix corresponding to a given cascade
  61254. * @param cascadeNum cascade to retrieve the projection matrix from
  61255. * @returns the cascade projection matrix
  61256. */
  61257. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  61258. /**
  61259. * Gets the transformation matrix corresponding to a given cascade
  61260. * @param cascadeNum cascade to retrieve the transformation matrix from
  61261. * @returns the cascade transformation matrix
  61262. */
  61263. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  61264. private _depthRenderer;
  61265. /**
  61266. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  61267. *
  61268. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  61269. *
  61270. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  61271. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  61272. * @param depthRenderer The depth renderer to use when autoCalcDepthBounds is enabled. If you pass null or don't call this function at all, a depth renderer will be automatically created
  61273. */
  61274. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  61275. private _depthReducer;
  61276. private _autoCalcDepthBounds;
  61277. /**
  61278. * Gets or sets the autoCalcDepthBounds property.
  61279. *
  61280. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  61281. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  61282. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  61283. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  61284. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  61285. */
  61286. get autoCalcDepthBounds(): boolean;
  61287. set autoCalcDepthBounds(value: boolean);
  61288. /**
  61289. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  61290. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  61291. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  61292. * for setting the refresh rate on the renderer yourself!
  61293. */
  61294. get autoCalcDepthBoundsRefreshRate(): number;
  61295. set autoCalcDepthBoundsRefreshRate(value: number);
  61296. /**
  61297. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  61298. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  61299. * you change the camera near/far planes!
  61300. */
  61301. splitFrustum(): void;
  61302. private _splitFrustum;
  61303. private _computeMatrices;
  61304. private _computeFrustumInWorldSpace;
  61305. private _computeCascadeFrustum;
  61306. /**
  61307. * Support test.
  61308. */
  61309. static get IsSupported(): boolean;
  61310. /** @hidden */
  61311. static _SceneComponentInitialization: (scene: Scene) => void;
  61312. /**
  61313. * Creates a Cascaded Shadow Generator object.
  61314. * A ShadowGenerator is the required tool to use the shadows.
  61315. * Each directional light casting shadows needs to use its own ShadowGenerator.
  61316. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  61317. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  61318. * @param light The directional light object generating the shadows.
  61319. * @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.
  61320. */
  61321. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  61322. protected _initializeGenerator(): void;
  61323. protected _createTargetRenderTexture(): void;
  61324. protected _initializeShadowMap(): void;
  61325. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  61326. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  61327. /**
  61328. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  61329. * @param defines Defines of the material we want to update
  61330. * @param lightIndex Index of the light in the enabled light list of the material
  61331. */
  61332. prepareDefines(defines: any, lightIndex: number): void;
  61333. /**
  61334. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  61335. * defined in the generator but impacting the effect).
  61336. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  61337. * @param effect The effect we are binfing the information for
  61338. */
  61339. bindShadowLight(lightIndex: string, effect: Effect): void;
  61340. /**
  61341. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  61342. * (eq to view projection * shadow projection matrices)
  61343. * @returns The transform matrix used to create the shadow map
  61344. */
  61345. getTransformMatrix(): Matrix;
  61346. /**
  61347. * Disposes the ShadowGenerator.
  61348. * Returns nothing.
  61349. */
  61350. dispose(): void;
  61351. /**
  61352. * Serializes the shadow generator setup to a json object.
  61353. * @returns The serialized JSON object
  61354. */
  61355. serialize(): any;
  61356. /**
  61357. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  61358. * @param parsedShadowGenerator The JSON object to parse
  61359. * @param scene The scene to create the shadow map for
  61360. * @returns The parsed shadow generator
  61361. */
  61362. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  61363. }
  61364. }
  61365. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  61366. import { Scene } from "babylonjs/scene";
  61367. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61368. import { AbstractScene } from "babylonjs/abstractScene";
  61369. /**
  61370. * Defines the shadow generator component responsible to manage any shadow generators
  61371. * in a given scene.
  61372. */
  61373. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  61374. /**
  61375. * The component name helpfull to identify the component in the list of scene components.
  61376. */
  61377. readonly name: string;
  61378. /**
  61379. * The scene the component belongs to.
  61380. */
  61381. scene: Scene;
  61382. /**
  61383. * Creates a new instance of the component for the given scene
  61384. * @param scene Defines the scene to register the component in
  61385. */
  61386. constructor(scene: Scene);
  61387. /**
  61388. * Registers the component in a given scene
  61389. */
  61390. register(): void;
  61391. /**
  61392. * Rebuilds the elements related to this component in case of
  61393. * context lost for instance.
  61394. */
  61395. rebuild(): void;
  61396. /**
  61397. * Serializes the component data to the specified json object
  61398. * @param serializationObject The object to serialize to
  61399. */
  61400. serialize(serializationObject: any): void;
  61401. /**
  61402. * Adds all the elements from the container to the scene
  61403. * @param container the container holding the elements
  61404. */
  61405. addFromContainer(container: AbstractScene): void;
  61406. /**
  61407. * Removes all the elements in the container from the scene
  61408. * @param container contains the elements to remove
  61409. * @param dispose if the removed element should be disposed (default: false)
  61410. */
  61411. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61412. /**
  61413. * Rebuilds the elements related to this component in case of
  61414. * context lost for instance.
  61415. */
  61416. dispose(): void;
  61417. private _gatherRenderTargets;
  61418. }
  61419. }
  61420. declare module "babylonjs/Lights/Shadows/index" {
  61421. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  61422. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  61423. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  61424. }
  61425. declare module "babylonjs/Lights/pointLight" {
  61426. import { Scene } from "babylonjs/scene";
  61427. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  61428. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61429. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  61430. import { Effect } from "babylonjs/Materials/effect";
  61431. /**
  61432. * A point light is a light defined by an unique point in world space.
  61433. * The light is emitted in every direction from this point.
  61434. * A good example of a point light is a standard light bulb.
  61435. * Documentation: https://doc.babylonjs.com/babylon101/lights
  61436. */
  61437. export class PointLight extends ShadowLight {
  61438. private _shadowAngle;
  61439. /**
  61440. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61441. * This specifies what angle the shadow will use to be created.
  61442. *
  61443. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  61444. */
  61445. get shadowAngle(): number;
  61446. /**
  61447. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61448. * This specifies what angle the shadow will use to be created.
  61449. *
  61450. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  61451. */
  61452. set shadowAngle(value: number);
  61453. /**
  61454. * Gets the direction if it has been set.
  61455. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61456. */
  61457. get direction(): Vector3;
  61458. /**
  61459. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61460. */
  61461. set direction(value: Vector3);
  61462. /**
  61463. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  61464. * A PointLight emits the light in every direction.
  61465. * It can cast shadows.
  61466. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  61467. * ```javascript
  61468. * var pointLight = new PointLight("pl", camera.position, scene);
  61469. * ```
  61470. * Documentation : https://doc.babylonjs.com/babylon101/lights
  61471. * @param name The light friendly name
  61472. * @param position The position of the point light in the scene
  61473. * @param scene The scene the lights belongs to
  61474. */
  61475. constructor(name: string, position: Vector3, scene: Scene);
  61476. /**
  61477. * Returns the string "PointLight"
  61478. * @returns the class name
  61479. */
  61480. getClassName(): string;
  61481. /**
  61482. * Returns the integer 0.
  61483. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  61484. */
  61485. getTypeID(): number;
  61486. /**
  61487. * Specifies wether or not the shadowmap should be a cube texture.
  61488. * @returns true if the shadowmap needs to be a cube texture.
  61489. */
  61490. needCube(): boolean;
  61491. /**
  61492. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  61493. * @param faceIndex The index of the face we are computed the direction to generate shadow
  61494. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  61495. */
  61496. getShadowDirection(faceIndex?: number): Vector3;
  61497. /**
  61498. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  61499. * - fov = PI / 2
  61500. * - aspect ratio : 1.0
  61501. * - z-near and far equal to the active camera minZ and maxZ.
  61502. * Returns the PointLight.
  61503. */
  61504. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  61505. protected _buildUniformLayout(): void;
  61506. /**
  61507. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  61508. * @param effect The effect to update
  61509. * @param lightIndex The index of the light in the effect to update
  61510. * @returns The point light
  61511. */
  61512. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  61513. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  61514. /**
  61515. * Prepares the list of defines specific to the light type.
  61516. * @param defines the list of defines
  61517. * @param lightIndex defines the index of the light for the effect
  61518. */
  61519. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  61520. }
  61521. }
  61522. declare module "babylonjs/Lights/index" {
  61523. export * from "babylonjs/Lights/light";
  61524. export * from "babylonjs/Lights/shadowLight";
  61525. export * from "babylonjs/Lights/Shadows/index";
  61526. export * from "babylonjs/Lights/directionalLight";
  61527. export * from "babylonjs/Lights/hemisphericLight";
  61528. export * from "babylonjs/Lights/pointLight";
  61529. export * from "babylonjs/Lights/spotLight";
  61530. }
  61531. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  61532. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  61533. /**
  61534. * Header information of HDR texture files.
  61535. */
  61536. export interface HDRInfo {
  61537. /**
  61538. * The height of the texture in pixels.
  61539. */
  61540. height: number;
  61541. /**
  61542. * The width of the texture in pixels.
  61543. */
  61544. width: number;
  61545. /**
  61546. * The index of the beginning of the data in the binary file.
  61547. */
  61548. dataPosition: number;
  61549. }
  61550. /**
  61551. * This groups tools to convert HDR texture to native colors array.
  61552. */
  61553. export class HDRTools {
  61554. private static Ldexp;
  61555. private static Rgbe2float;
  61556. private static readStringLine;
  61557. /**
  61558. * Reads header information from an RGBE texture stored in a native array.
  61559. * More information on this format are available here:
  61560. * https://en.wikipedia.org/wiki/RGBE_image_format
  61561. *
  61562. * @param uint8array The binary file stored in native array.
  61563. * @return The header information.
  61564. */
  61565. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  61566. /**
  61567. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  61568. * This RGBE texture needs to store the information as a panorama.
  61569. *
  61570. * More information on this format are available here:
  61571. * https://en.wikipedia.org/wiki/RGBE_image_format
  61572. *
  61573. * @param buffer The binary file stored in an array buffer.
  61574. * @param size The expected size of the extracted cubemap.
  61575. * @return The Cube Map information.
  61576. */
  61577. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  61578. /**
  61579. * Returns the pixels data extracted from an RGBE texture.
  61580. * This pixels will be stored left to right up to down in the R G B order in one array.
  61581. *
  61582. * More information on this format are available here:
  61583. * https://en.wikipedia.org/wiki/RGBE_image_format
  61584. *
  61585. * @param uint8array The binary file stored in an array buffer.
  61586. * @param hdrInfo The header information of the file.
  61587. * @return The pixels data in RGB right to left up to down order.
  61588. */
  61589. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  61590. private static RGBE_ReadPixels_RLE;
  61591. }
  61592. }
  61593. declare module "babylonjs/Materials/effectRenderer" {
  61594. import { Nullable } from "babylonjs/types";
  61595. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  61596. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61597. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  61598. import { Viewport } from "babylonjs/Maths/math.viewport";
  61599. import { Observable } from "babylonjs/Misc/observable";
  61600. import { Effect } from "babylonjs/Materials/effect";
  61601. import "babylonjs/Shaders/postprocess.vertex";
  61602. /**
  61603. * Effect Render Options
  61604. */
  61605. export interface IEffectRendererOptions {
  61606. /**
  61607. * Defines the vertices positions.
  61608. */
  61609. positions?: number[];
  61610. /**
  61611. * Defines the indices.
  61612. */
  61613. indices?: number[];
  61614. }
  61615. /**
  61616. * Helper class to render one or more effects.
  61617. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  61618. */
  61619. export class EffectRenderer {
  61620. private engine;
  61621. private static _DefaultOptions;
  61622. private _vertexBuffers;
  61623. private _indexBuffer;
  61624. private _fullscreenViewport;
  61625. /**
  61626. * Creates an effect renderer
  61627. * @param engine the engine to use for rendering
  61628. * @param options defines the options of the effect renderer
  61629. */
  61630. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  61631. /**
  61632. * Sets the current viewport in normalized coordinates 0-1
  61633. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  61634. */
  61635. setViewport(viewport?: Viewport): void;
  61636. /**
  61637. * Binds the embedded attributes buffer to the effect.
  61638. * @param effect Defines the effect to bind the attributes for
  61639. */
  61640. bindBuffers(effect: Effect): void;
  61641. /**
  61642. * Sets the current effect wrapper to use during draw.
  61643. * The effect needs to be ready before calling this api.
  61644. * This also sets the default full screen position attribute.
  61645. * @param effectWrapper Defines the effect to draw with
  61646. */
  61647. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  61648. /**
  61649. * Restores engine states
  61650. */
  61651. restoreStates(): void;
  61652. /**
  61653. * Draws a full screen quad.
  61654. */
  61655. draw(): void;
  61656. private isRenderTargetTexture;
  61657. /**
  61658. * renders one or more effects to a specified texture
  61659. * @param effectWrapper the effect to renderer
  61660. * @param outputTexture texture to draw to, if null it will render to the screen.
  61661. */
  61662. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  61663. /**
  61664. * Disposes of the effect renderer
  61665. */
  61666. dispose(): void;
  61667. }
  61668. /**
  61669. * Options to create an EffectWrapper
  61670. */
  61671. interface EffectWrapperCreationOptions {
  61672. /**
  61673. * Engine to use to create the effect
  61674. */
  61675. engine: ThinEngine;
  61676. /**
  61677. * Fragment shader for the effect
  61678. */
  61679. fragmentShader: string;
  61680. /**
  61681. * Use the shader store instead of direct source code
  61682. */
  61683. useShaderStore?: boolean;
  61684. /**
  61685. * Vertex shader for the effect
  61686. */
  61687. vertexShader?: string;
  61688. /**
  61689. * Attributes to use in the shader
  61690. */
  61691. attributeNames?: Array<string>;
  61692. /**
  61693. * Uniforms to use in the shader
  61694. */
  61695. uniformNames?: Array<string>;
  61696. /**
  61697. * Texture sampler names to use in the shader
  61698. */
  61699. samplerNames?: Array<string>;
  61700. /**
  61701. * Defines to use in the shader
  61702. */
  61703. defines?: Array<string>;
  61704. /**
  61705. * Callback when effect is compiled
  61706. */
  61707. onCompiled?: Nullable<(effect: Effect) => void>;
  61708. /**
  61709. * The friendly name of the effect displayed in Spector.
  61710. */
  61711. name?: string;
  61712. }
  61713. /**
  61714. * Wraps an effect to be used for rendering
  61715. */
  61716. export class EffectWrapper {
  61717. /**
  61718. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  61719. */
  61720. onApplyObservable: Observable<{}>;
  61721. /**
  61722. * The underlying effect
  61723. */
  61724. effect: Effect;
  61725. /**
  61726. * Creates an effect to be renderer
  61727. * @param creationOptions options to create the effect
  61728. */
  61729. constructor(creationOptions: EffectWrapperCreationOptions);
  61730. /**
  61731. * Disposes of the effect wrapper
  61732. */
  61733. dispose(): void;
  61734. }
  61735. }
  61736. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  61737. /** @hidden */
  61738. export var hdrFilteringVertexShader: {
  61739. name: string;
  61740. shader: string;
  61741. };
  61742. }
  61743. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  61744. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61745. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  61746. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  61747. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  61748. /** @hidden */
  61749. export var hdrFilteringPixelShader: {
  61750. name: string;
  61751. shader: string;
  61752. };
  61753. }
  61754. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  61755. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  61756. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  61757. import { Nullable } from "babylonjs/types";
  61758. import "babylonjs/Shaders/hdrFiltering.vertex";
  61759. import "babylonjs/Shaders/hdrFiltering.fragment";
  61760. /**
  61761. * Options for texture filtering
  61762. */
  61763. interface IHDRFilteringOptions {
  61764. /**
  61765. * Scales pixel intensity for the input HDR map.
  61766. */
  61767. hdrScale?: number;
  61768. /**
  61769. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  61770. */
  61771. quality?: number;
  61772. }
  61773. /**
  61774. * Filters HDR maps to get correct renderings of PBR reflections
  61775. */
  61776. export class HDRFiltering {
  61777. private _engine;
  61778. private _effectRenderer;
  61779. private _effectWrapper;
  61780. private _lodGenerationOffset;
  61781. private _lodGenerationScale;
  61782. /**
  61783. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  61784. * you care about baking speed.
  61785. */
  61786. quality: number;
  61787. /**
  61788. * Scales pixel intensity for the input HDR map.
  61789. */
  61790. hdrScale: number;
  61791. /**
  61792. * Instantiates HDR filter for reflection maps
  61793. *
  61794. * @param engine Thin engine
  61795. * @param options Options
  61796. */
  61797. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  61798. private _createRenderTarget;
  61799. private _prefilterInternal;
  61800. private _createEffect;
  61801. /**
  61802. * Get a value indicating if the filter is ready to be used
  61803. * @param texture Texture to filter
  61804. * @returns true if the filter is ready
  61805. */
  61806. isReady(texture: BaseTexture): boolean;
  61807. /**
  61808. * Prefilters a cube texture to have mipmap levels representing roughness values.
  61809. * Prefiltering will be invoked at the end of next rendering pass.
  61810. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  61811. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  61812. * @param texture Texture to filter
  61813. * @param onFinished Callback when filtering is done
  61814. * @return Promise called when prefiltering is done
  61815. */
  61816. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  61817. }
  61818. }
  61819. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  61820. import { Nullable } from "babylonjs/types";
  61821. import { Scene } from "babylonjs/scene";
  61822. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  61823. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  61824. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  61825. import "babylonjs/Engines/Extensions/engine.rawTexture";
  61826. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  61827. /**
  61828. * This represents a texture coming from an HDR input.
  61829. *
  61830. * The only supported format is currently panorama picture stored in RGBE format.
  61831. * Example of such files can be found on HDRLib: http://hdrlib.com/
  61832. */
  61833. export class HDRCubeTexture extends BaseTexture {
  61834. private static _facesMapping;
  61835. private _generateHarmonics;
  61836. private _noMipmap;
  61837. private _prefilterOnLoad;
  61838. private _textureMatrix;
  61839. private _size;
  61840. private _onLoad;
  61841. private _onError;
  61842. /**
  61843. * The texture URL.
  61844. */
  61845. url: string;
  61846. /**
  61847. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  61848. */
  61849. coordinatesMode: number;
  61850. protected _isBlocking: boolean;
  61851. /**
  61852. * Sets wether or not the texture is blocking during loading.
  61853. */
  61854. set isBlocking(value: boolean);
  61855. /**
  61856. * Gets wether or not the texture is blocking during loading.
  61857. */
  61858. get isBlocking(): boolean;
  61859. protected _rotationY: number;
  61860. /**
  61861. * Sets texture matrix rotation angle around Y axis in radians.
  61862. */
  61863. set rotationY(value: number);
  61864. /**
  61865. * Gets texture matrix rotation angle around Y axis radians.
  61866. */
  61867. get rotationY(): number;
  61868. /**
  61869. * Gets or sets the center of the bounding box associated with the cube texture
  61870. * It must define where the camera used to render the texture was set
  61871. */
  61872. boundingBoxPosition: Vector3;
  61873. private _boundingBoxSize;
  61874. /**
  61875. * Gets or sets the size of the bounding box associated with the cube texture
  61876. * When defined, the cubemap will switch to local mode
  61877. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  61878. * @example https://www.babylonjs-playground.com/#RNASML
  61879. */
  61880. set boundingBoxSize(value: Vector3);
  61881. get boundingBoxSize(): Vector3;
  61882. /**
  61883. * Instantiates an HDRTexture from the following parameters.
  61884. *
  61885. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  61886. * @param sceneOrEngine The scene or engine the texture will be used in
  61887. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  61888. * @param noMipmap Forces to not generate the mipmap if true
  61889. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  61890. * @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)
  61891. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  61892. */
  61893. constructor(url: string, sceneOrEngine: Scene | ThinEngine, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, prefilterOnLoad?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  61894. /**
  61895. * Get the current class name of the texture useful for serialization or dynamic coding.
  61896. * @returns "HDRCubeTexture"
  61897. */
  61898. getClassName(): string;
  61899. /**
  61900. * Occurs when the file is raw .hdr file.
  61901. */
  61902. private loadTexture;
  61903. clone(): HDRCubeTexture;
  61904. delayLoad(): void;
  61905. /**
  61906. * Get the texture reflection matrix used to rotate/transform the reflection.
  61907. * @returns the reflection matrix
  61908. */
  61909. getReflectionTextureMatrix(): Matrix;
  61910. /**
  61911. * Set the texture reflection matrix used to rotate/transform the reflection.
  61912. * @param value Define the reflection matrix to set
  61913. */
  61914. setReflectionTextureMatrix(value: Matrix): void;
  61915. /**
  61916. * Parses a JSON representation of an HDR Texture in order to create the texture
  61917. * @param parsedTexture Define the JSON representation
  61918. * @param scene Define the scene the texture should be created in
  61919. * @param rootUrl Define the root url in case we need to load relative dependencies
  61920. * @returns the newly created texture after parsing
  61921. */
  61922. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  61923. serialize(): any;
  61924. }
  61925. }
  61926. declare module "babylonjs/Physics/physicsEngine" {
  61927. import { Nullable } from "babylonjs/types";
  61928. import { Vector3 } from "babylonjs/Maths/math.vector";
  61929. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  61930. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  61931. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  61932. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  61933. /**
  61934. * Class used to control physics engine
  61935. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  61936. */
  61937. export class PhysicsEngine implements IPhysicsEngine {
  61938. private _physicsPlugin;
  61939. /**
  61940. * Global value used to control the smallest number supported by the simulation
  61941. */
  61942. static Epsilon: number;
  61943. private _impostors;
  61944. private _joints;
  61945. private _subTimeStep;
  61946. /**
  61947. * Gets the gravity vector used by the simulation
  61948. */
  61949. gravity: Vector3;
  61950. /**
  61951. * Factory used to create the default physics plugin.
  61952. * @returns The default physics plugin
  61953. */
  61954. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  61955. /**
  61956. * Creates a new Physics Engine
  61957. * @param gravity defines the gravity vector used by the simulation
  61958. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  61959. */
  61960. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  61961. /**
  61962. * Sets the gravity vector used by the simulation
  61963. * @param gravity defines the gravity vector to use
  61964. */
  61965. setGravity(gravity: Vector3): void;
  61966. /**
  61967. * Set the time step of the physics engine.
  61968. * Default is 1/60.
  61969. * To slow it down, enter 1/600 for example.
  61970. * To speed it up, 1/30
  61971. * @param newTimeStep defines the new timestep to apply to this world.
  61972. */
  61973. setTimeStep(newTimeStep?: number): void;
  61974. /**
  61975. * Get the time step of the physics engine.
  61976. * @returns the current time step
  61977. */
  61978. getTimeStep(): number;
  61979. /**
  61980. * Set the sub time step of the physics engine.
  61981. * Default is 0 meaning there is no sub steps
  61982. * To increase physics resolution precision, set a small value (like 1 ms)
  61983. * @param subTimeStep defines the new sub timestep used for physics resolution.
  61984. */
  61985. setSubTimeStep(subTimeStep?: number): void;
  61986. /**
  61987. * Get the sub time step of the physics engine.
  61988. * @returns the current sub time step
  61989. */
  61990. getSubTimeStep(): number;
  61991. /**
  61992. * Release all resources
  61993. */
  61994. dispose(): void;
  61995. /**
  61996. * Gets the name of the current physics plugin
  61997. * @returns the name of the plugin
  61998. */
  61999. getPhysicsPluginName(): string;
  62000. /**
  62001. * Adding a new impostor for the impostor tracking.
  62002. * This will be done by the impostor itself.
  62003. * @param impostor the impostor to add
  62004. */
  62005. addImpostor(impostor: PhysicsImpostor): void;
  62006. /**
  62007. * Remove an impostor from the engine.
  62008. * This impostor and its mesh will not longer be updated by the physics engine.
  62009. * @param impostor the impostor to remove
  62010. */
  62011. removeImpostor(impostor: PhysicsImpostor): void;
  62012. /**
  62013. * Add a joint to the physics engine
  62014. * @param mainImpostor defines the main impostor to which the joint is added.
  62015. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  62016. * @param joint defines the joint that will connect both impostors.
  62017. */
  62018. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  62019. /**
  62020. * Removes a joint from the simulation
  62021. * @param mainImpostor defines the impostor used with the joint
  62022. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  62023. * @param joint defines the joint to remove
  62024. */
  62025. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  62026. /**
  62027. * Called by the scene. No need to call it.
  62028. * @param delta defines the timespam between frames
  62029. */
  62030. _step(delta: number): void;
  62031. /**
  62032. * Gets the current plugin used to run the simulation
  62033. * @returns current plugin
  62034. */
  62035. getPhysicsPlugin(): IPhysicsEnginePlugin;
  62036. /**
  62037. * Gets the list of physic impostors
  62038. * @returns an array of PhysicsImpostor
  62039. */
  62040. getImpostors(): Array<PhysicsImpostor>;
  62041. /**
  62042. * Gets the impostor for a physics enabled object
  62043. * @param object defines the object impersonated by the impostor
  62044. * @returns the PhysicsImpostor or null if not found
  62045. */
  62046. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  62047. /**
  62048. * Gets the impostor for a physics body object
  62049. * @param body defines physics body used by the impostor
  62050. * @returns the PhysicsImpostor or null if not found
  62051. */
  62052. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  62053. /**
  62054. * Does a raycast in the physics world
  62055. * @param from when should the ray start?
  62056. * @param to when should the ray end?
  62057. * @returns PhysicsRaycastResult
  62058. */
  62059. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62060. }
  62061. }
  62062. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  62063. import { Nullable } from "babylonjs/types";
  62064. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  62065. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62066. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  62067. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62068. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  62069. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  62070. /** @hidden */
  62071. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  62072. private _useDeltaForWorldStep;
  62073. world: any;
  62074. name: string;
  62075. private _physicsMaterials;
  62076. private _fixedTimeStep;
  62077. private _cannonRaycastResult;
  62078. private _raycastResult;
  62079. private _physicsBodysToRemoveAfterStep;
  62080. private _firstFrame;
  62081. BJSCANNON: any;
  62082. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  62083. setGravity(gravity: Vector3): void;
  62084. setTimeStep(timeStep: number): void;
  62085. getTimeStep(): number;
  62086. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62087. private _removeMarkedPhysicsBodiesFromWorld;
  62088. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62089. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62090. generatePhysicsBody(impostor: PhysicsImpostor): void;
  62091. private _processChildMeshes;
  62092. removePhysicsBody(impostor: PhysicsImpostor): void;
  62093. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  62094. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  62095. private _addMaterial;
  62096. private _checkWithEpsilon;
  62097. private _createShape;
  62098. private _createHeightmap;
  62099. private _minus90X;
  62100. private _plus90X;
  62101. private _tmpPosition;
  62102. private _tmpDeltaPosition;
  62103. private _tmpUnityRotation;
  62104. private _updatePhysicsBodyTransformation;
  62105. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  62106. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  62107. isSupported(): boolean;
  62108. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62109. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62110. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62111. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62112. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  62113. getBodyMass(impostor: PhysicsImpostor): number;
  62114. getBodyFriction(impostor: PhysicsImpostor): number;
  62115. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  62116. getBodyRestitution(impostor: PhysicsImpostor): number;
  62117. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  62118. sleepBody(impostor: PhysicsImpostor): void;
  62119. wakeUpBody(impostor: PhysicsImpostor): void;
  62120. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  62121. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  62122. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  62123. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  62124. getRadius(impostor: PhysicsImpostor): number;
  62125. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  62126. dispose(): void;
  62127. private _extendNamespace;
  62128. /**
  62129. * Does a raycast in the physics world
  62130. * @param from when should the ray start?
  62131. * @param to when should the ray end?
  62132. * @returns PhysicsRaycastResult
  62133. */
  62134. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62135. }
  62136. }
  62137. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  62138. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  62139. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62140. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  62141. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62142. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  62143. import { Nullable } from "babylonjs/types";
  62144. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  62145. /** @hidden */
  62146. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  62147. private _useDeltaForWorldStep;
  62148. world: any;
  62149. name: string;
  62150. BJSOIMO: any;
  62151. private _raycastResult;
  62152. private _fixedTimeStep;
  62153. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  62154. setGravity(gravity: Vector3): void;
  62155. setTimeStep(timeStep: number): void;
  62156. getTimeStep(): number;
  62157. private _tmpImpostorsArray;
  62158. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62159. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62160. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62161. generatePhysicsBody(impostor: PhysicsImpostor): void;
  62162. private _tmpPositionVector;
  62163. removePhysicsBody(impostor: PhysicsImpostor): void;
  62164. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  62165. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  62166. isSupported(): boolean;
  62167. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  62168. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  62169. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62170. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62171. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62172. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62173. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  62174. getBodyMass(impostor: PhysicsImpostor): number;
  62175. getBodyFriction(impostor: PhysicsImpostor): number;
  62176. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  62177. getBodyRestitution(impostor: PhysicsImpostor): number;
  62178. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  62179. sleepBody(impostor: PhysicsImpostor): void;
  62180. wakeUpBody(impostor: PhysicsImpostor): void;
  62181. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  62182. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  62183. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  62184. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  62185. getRadius(impostor: PhysicsImpostor): number;
  62186. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  62187. dispose(): void;
  62188. /**
  62189. * Does a raycast in the physics world
  62190. * @param from when should the ray start?
  62191. * @param to when should the ray end?
  62192. * @returns PhysicsRaycastResult
  62193. */
  62194. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62195. }
  62196. }
  62197. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  62198. import { Nullable } from "babylonjs/types";
  62199. import { Scene } from "babylonjs/scene";
  62200. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  62201. import { Color4 } from "babylonjs/Maths/math.color";
  62202. import { Mesh } from "babylonjs/Meshes/mesh";
  62203. /**
  62204. * Class containing static functions to help procedurally build meshes
  62205. */
  62206. export class RibbonBuilder {
  62207. /**
  62208. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  62209. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  62210. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  62211. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  62212. * * 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
  62213. * * 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
  62214. * * 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
  62215. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  62216. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  62217. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  62218. * * 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
  62219. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  62220. * * 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
  62221. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  62222. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  62223. * @param name defines the name of the mesh
  62224. * @param options defines the options used to create the mesh
  62225. * @param scene defines the hosting scene
  62226. * @returns the ribbon mesh
  62227. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  62228. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  62229. */
  62230. static CreateRibbon(name: string, options: {
  62231. pathArray: Vector3[][];
  62232. closeArray?: boolean;
  62233. closePath?: boolean;
  62234. offset?: number;
  62235. updatable?: boolean;
  62236. sideOrientation?: number;
  62237. frontUVs?: Vector4;
  62238. backUVs?: Vector4;
  62239. instance?: Mesh;
  62240. invertUV?: boolean;
  62241. uvs?: Vector2[];
  62242. colors?: Color4[];
  62243. }, scene?: Nullable<Scene>): Mesh;
  62244. }
  62245. }
  62246. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  62247. import { Nullable } from "babylonjs/types";
  62248. import { Scene } from "babylonjs/scene";
  62249. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  62250. import { Mesh } from "babylonjs/Meshes/mesh";
  62251. /**
  62252. * Class containing static functions to help procedurally build meshes
  62253. */
  62254. export class ShapeBuilder {
  62255. /**
  62256. * 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.
  62257. * * 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.
  62258. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  62259. * * 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.
  62260. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  62261. * * 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
  62262. * * 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
  62263. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  62264. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  62265. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  62266. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  62267. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  62268. * @param name defines the name of the mesh
  62269. * @param options defines the options used to create the mesh
  62270. * @param scene defines the hosting scene
  62271. * @returns the extruded shape mesh
  62272. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  62273. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  62274. */
  62275. static ExtrudeShape(name: string, options: {
  62276. shape: Vector3[];
  62277. path: Vector3[];
  62278. scale?: number;
  62279. rotation?: number;
  62280. cap?: number;
  62281. updatable?: boolean;
  62282. sideOrientation?: number;
  62283. frontUVs?: Vector4;
  62284. backUVs?: Vector4;
  62285. instance?: Mesh;
  62286. invertUV?: boolean;
  62287. }, scene?: Nullable<Scene>): Mesh;
  62288. /**
  62289. * Creates an custom extruded shape mesh.
  62290. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  62291. * * 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.
  62292. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  62293. * * 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
  62294. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  62295. * * 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
  62296. * * It must returns a float value that will be the scale value applied to the shape on each path point
  62297. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  62298. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  62299. * * 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
  62300. * * 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
  62301. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  62302. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  62303. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  62304. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  62305. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  62306. * @param name defines the name of the mesh
  62307. * @param options defines the options used to create the mesh
  62308. * @param scene defines the hosting scene
  62309. * @returns the custom extruded shape mesh
  62310. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  62311. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  62312. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  62313. */
  62314. static ExtrudeShapeCustom(name: string, options: {
  62315. shape: Vector3[];
  62316. path: Vector3[];
  62317. scaleFunction?: any;
  62318. rotationFunction?: any;
  62319. ribbonCloseArray?: boolean;
  62320. ribbonClosePath?: boolean;
  62321. cap?: number;
  62322. updatable?: boolean;
  62323. sideOrientation?: number;
  62324. frontUVs?: Vector4;
  62325. backUVs?: Vector4;
  62326. instance?: Mesh;
  62327. invertUV?: boolean;
  62328. }, scene?: Nullable<Scene>): Mesh;
  62329. private static _ExtrudeShapeGeneric;
  62330. }
  62331. }
  62332. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  62333. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  62334. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  62335. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62336. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  62337. import { Nullable } from "babylonjs/types";
  62338. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62339. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  62340. /**
  62341. * AmmoJS Physics plugin
  62342. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  62343. * @see https://github.com/kripken/ammo.js/
  62344. */
  62345. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  62346. private _useDeltaForWorldStep;
  62347. /**
  62348. * Reference to the Ammo library
  62349. */
  62350. bjsAMMO: any;
  62351. /**
  62352. * Created ammoJS world which physics bodies are added to
  62353. */
  62354. world: any;
  62355. /**
  62356. * Name of the plugin
  62357. */
  62358. name: string;
  62359. private _timeStep;
  62360. private _fixedTimeStep;
  62361. private _maxSteps;
  62362. private _tmpQuaternion;
  62363. private _tmpAmmoTransform;
  62364. private _tmpAmmoQuaternion;
  62365. private _tmpAmmoConcreteContactResultCallback;
  62366. private _collisionConfiguration;
  62367. private _dispatcher;
  62368. private _overlappingPairCache;
  62369. private _solver;
  62370. private _softBodySolver;
  62371. private _tmpAmmoVectorA;
  62372. private _tmpAmmoVectorB;
  62373. private _tmpAmmoVectorC;
  62374. private _tmpAmmoVectorD;
  62375. private _tmpContactCallbackResult;
  62376. private _tmpAmmoVectorRCA;
  62377. private _tmpAmmoVectorRCB;
  62378. private _raycastResult;
  62379. private static readonly DISABLE_COLLISION_FLAG;
  62380. private static readonly KINEMATIC_FLAG;
  62381. private static readonly DISABLE_DEACTIVATION_FLAG;
  62382. /**
  62383. * Initializes the ammoJS plugin
  62384. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  62385. * @param ammoInjection can be used to inject your own ammo reference
  62386. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  62387. */
  62388. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  62389. /**
  62390. * Sets the gravity of the physics world (m/(s^2))
  62391. * @param gravity Gravity to set
  62392. */
  62393. setGravity(gravity: Vector3): void;
  62394. /**
  62395. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  62396. * @param timeStep timestep to use in seconds
  62397. */
  62398. setTimeStep(timeStep: number): void;
  62399. /**
  62400. * 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)
  62401. * @param fixedTimeStep fixedTimeStep to use in seconds
  62402. */
  62403. setFixedTimeStep(fixedTimeStep: number): void;
  62404. /**
  62405. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  62406. * @param maxSteps the maximum number of steps by the physics engine per frame
  62407. */
  62408. setMaxSteps(maxSteps: number): void;
  62409. /**
  62410. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  62411. * @returns the current timestep in seconds
  62412. */
  62413. getTimeStep(): number;
  62414. /**
  62415. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  62416. */
  62417. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  62418. private _isImpostorInContact;
  62419. private _isImpostorPairInContact;
  62420. private _stepSimulation;
  62421. /**
  62422. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  62423. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  62424. * After the step the babylon meshes are set to the position of the physics imposters
  62425. * @param delta amount of time to step forward
  62426. * @param impostors array of imposters to update before/after the step
  62427. */
  62428. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62429. /**
  62430. * Update babylon mesh to match physics world object
  62431. * @param impostor imposter to match
  62432. */
  62433. private _afterSoftStep;
  62434. /**
  62435. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  62436. * @param impostor imposter to match
  62437. */
  62438. private _ropeStep;
  62439. /**
  62440. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  62441. * @param impostor imposter to match
  62442. */
  62443. private _softbodyOrClothStep;
  62444. private _tmpMatrix;
  62445. /**
  62446. * Applies an impulse on the imposter
  62447. * @param impostor imposter to apply impulse to
  62448. * @param force amount of force to be applied to the imposter
  62449. * @param contactPoint the location to apply the impulse on the imposter
  62450. */
  62451. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62452. /**
  62453. * Applies a force on the imposter
  62454. * @param impostor imposter to apply force
  62455. * @param force amount of force to be applied to the imposter
  62456. * @param contactPoint the location to apply the force on the imposter
  62457. */
  62458. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62459. /**
  62460. * Creates a physics body using the plugin
  62461. * @param impostor the imposter to create the physics body on
  62462. */
  62463. generatePhysicsBody(impostor: PhysicsImpostor): void;
  62464. /**
  62465. * Removes the physics body from the imposter and disposes of the body's memory
  62466. * @param impostor imposter to remove the physics body from
  62467. */
  62468. removePhysicsBody(impostor: PhysicsImpostor): void;
  62469. /**
  62470. * Generates a joint
  62471. * @param impostorJoint the imposter joint to create the joint with
  62472. */
  62473. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  62474. /**
  62475. * Removes a joint
  62476. * @param impostorJoint the imposter joint to remove the joint from
  62477. */
  62478. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  62479. private _addMeshVerts;
  62480. /**
  62481. * Initialise the soft body vertices to match its object's (mesh) vertices
  62482. * Softbody vertices (nodes) are in world space and to match this
  62483. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  62484. * @param impostor to create the softbody for
  62485. */
  62486. private _softVertexData;
  62487. /**
  62488. * Create an impostor's soft body
  62489. * @param impostor to create the softbody for
  62490. */
  62491. private _createSoftbody;
  62492. /**
  62493. * Create cloth for an impostor
  62494. * @param impostor to create the softbody for
  62495. */
  62496. private _createCloth;
  62497. /**
  62498. * Create rope for an impostor
  62499. * @param impostor to create the softbody for
  62500. */
  62501. private _createRope;
  62502. /**
  62503. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  62504. * @param impostor to create the custom physics shape for
  62505. */
  62506. private _createCustom;
  62507. private _addHullVerts;
  62508. private _createShape;
  62509. /**
  62510. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  62511. * @param impostor imposter containing the physics body and babylon object
  62512. */
  62513. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  62514. /**
  62515. * Sets the babylon object's position/rotation from the physics body's position/rotation
  62516. * @param impostor imposter containing the physics body and babylon object
  62517. * @param newPosition new position
  62518. * @param newRotation new rotation
  62519. */
  62520. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  62521. /**
  62522. * If this plugin is supported
  62523. * @returns true if its supported
  62524. */
  62525. isSupported(): boolean;
  62526. /**
  62527. * Sets the linear velocity of the physics body
  62528. * @param impostor imposter to set the velocity on
  62529. * @param velocity velocity to set
  62530. */
  62531. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62532. /**
  62533. * Sets the angular velocity of the physics body
  62534. * @param impostor imposter to set the velocity on
  62535. * @param velocity velocity to set
  62536. */
  62537. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62538. /**
  62539. * gets the linear velocity
  62540. * @param impostor imposter to get linear velocity from
  62541. * @returns linear velocity
  62542. */
  62543. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62544. /**
  62545. * gets the angular velocity
  62546. * @param impostor imposter to get angular velocity from
  62547. * @returns angular velocity
  62548. */
  62549. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62550. /**
  62551. * Sets the mass of physics body
  62552. * @param impostor imposter to set the mass on
  62553. * @param mass mass to set
  62554. */
  62555. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  62556. /**
  62557. * Gets the mass of the physics body
  62558. * @param impostor imposter to get the mass from
  62559. * @returns mass
  62560. */
  62561. getBodyMass(impostor: PhysicsImpostor): number;
  62562. /**
  62563. * Gets friction of the impostor
  62564. * @param impostor impostor to get friction from
  62565. * @returns friction value
  62566. */
  62567. getBodyFriction(impostor: PhysicsImpostor): number;
  62568. /**
  62569. * Sets friction of the impostor
  62570. * @param impostor impostor to set friction on
  62571. * @param friction friction value
  62572. */
  62573. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  62574. /**
  62575. * Gets restitution of the impostor
  62576. * @param impostor impostor to get restitution from
  62577. * @returns restitution value
  62578. */
  62579. getBodyRestitution(impostor: PhysicsImpostor): number;
  62580. /**
  62581. * Sets resitution of the impostor
  62582. * @param impostor impostor to set resitution on
  62583. * @param restitution resitution value
  62584. */
  62585. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  62586. /**
  62587. * Gets pressure inside the impostor
  62588. * @param impostor impostor to get pressure from
  62589. * @returns pressure value
  62590. */
  62591. getBodyPressure(impostor: PhysicsImpostor): number;
  62592. /**
  62593. * Sets pressure inside a soft body impostor
  62594. * Cloth and rope must remain 0 pressure
  62595. * @param impostor impostor to set pressure on
  62596. * @param pressure pressure value
  62597. */
  62598. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  62599. /**
  62600. * Gets stiffness of the impostor
  62601. * @param impostor impostor to get stiffness from
  62602. * @returns pressure value
  62603. */
  62604. getBodyStiffness(impostor: PhysicsImpostor): number;
  62605. /**
  62606. * Sets stiffness of the impostor
  62607. * @param impostor impostor to set stiffness on
  62608. * @param stiffness stiffness value from 0 to 1
  62609. */
  62610. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  62611. /**
  62612. * Gets velocityIterations of the impostor
  62613. * @param impostor impostor to get velocity iterations from
  62614. * @returns velocityIterations value
  62615. */
  62616. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  62617. /**
  62618. * Sets velocityIterations of the impostor
  62619. * @param impostor impostor to set velocity iterations on
  62620. * @param velocityIterations velocityIterations value
  62621. */
  62622. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  62623. /**
  62624. * Gets positionIterations of the impostor
  62625. * @param impostor impostor to get position iterations from
  62626. * @returns positionIterations value
  62627. */
  62628. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  62629. /**
  62630. * Sets positionIterations of the impostor
  62631. * @param impostor impostor to set position on
  62632. * @param positionIterations positionIterations value
  62633. */
  62634. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  62635. /**
  62636. * Append an anchor to a cloth object
  62637. * @param impostor is the cloth impostor to add anchor to
  62638. * @param otherImpostor is the rigid impostor to anchor to
  62639. * @param width ratio across width from 0 to 1
  62640. * @param height ratio up height from 0 to 1
  62641. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  62642. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  62643. */
  62644. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  62645. /**
  62646. * Append an hook to a rope object
  62647. * @param impostor is the rope impostor to add hook to
  62648. * @param otherImpostor is the rigid impostor to hook to
  62649. * @param length ratio along the rope from 0 to 1
  62650. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  62651. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  62652. */
  62653. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  62654. /**
  62655. * Sleeps the physics body and stops it from being active
  62656. * @param impostor impostor to sleep
  62657. */
  62658. sleepBody(impostor: PhysicsImpostor): void;
  62659. /**
  62660. * Activates the physics body
  62661. * @param impostor impostor to activate
  62662. */
  62663. wakeUpBody(impostor: PhysicsImpostor): void;
  62664. /**
  62665. * Updates the distance parameters of the joint
  62666. * @param joint joint to update
  62667. * @param maxDistance maximum distance of the joint
  62668. * @param minDistance minimum distance of the joint
  62669. */
  62670. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  62671. /**
  62672. * Sets a motor on the joint
  62673. * @param joint joint to set motor on
  62674. * @param speed speed of the motor
  62675. * @param maxForce maximum force of the motor
  62676. * @param motorIndex index of the motor
  62677. */
  62678. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  62679. /**
  62680. * Sets the motors limit
  62681. * @param joint joint to set limit on
  62682. * @param upperLimit upper limit
  62683. * @param lowerLimit lower limit
  62684. */
  62685. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  62686. /**
  62687. * Syncs the position and rotation of a mesh with the impostor
  62688. * @param mesh mesh to sync
  62689. * @param impostor impostor to update the mesh with
  62690. */
  62691. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  62692. /**
  62693. * Gets the radius of the impostor
  62694. * @param impostor impostor to get radius from
  62695. * @returns the radius
  62696. */
  62697. getRadius(impostor: PhysicsImpostor): number;
  62698. /**
  62699. * Gets the box size of the impostor
  62700. * @param impostor impostor to get box size from
  62701. * @param result the resulting box size
  62702. */
  62703. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  62704. /**
  62705. * Disposes of the impostor
  62706. */
  62707. dispose(): void;
  62708. /**
  62709. * Does a raycast in the physics world
  62710. * @param from when should the ray start?
  62711. * @param to when should the ray end?
  62712. * @returns PhysicsRaycastResult
  62713. */
  62714. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62715. }
  62716. }
  62717. declare module "babylonjs/Probes/reflectionProbe" {
  62718. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62719. import { Vector3 } from "babylonjs/Maths/math.vector";
  62720. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62721. import { Nullable } from "babylonjs/types";
  62722. import { Scene } from "babylonjs/scene";
  62723. module "babylonjs/abstractScene" {
  62724. interface AbstractScene {
  62725. /**
  62726. * The list of reflection probes added to the scene
  62727. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  62728. */
  62729. reflectionProbes: Array<ReflectionProbe>;
  62730. /**
  62731. * Removes the given reflection probe from this scene.
  62732. * @param toRemove The reflection probe to remove
  62733. * @returns The index of the removed reflection probe
  62734. */
  62735. removeReflectionProbe(toRemove: ReflectionProbe): number;
  62736. /**
  62737. * Adds the given reflection probe to this scene.
  62738. * @param newReflectionProbe The reflection probe to add
  62739. */
  62740. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  62741. }
  62742. }
  62743. /**
  62744. * Class used to generate realtime reflection / refraction cube textures
  62745. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  62746. */
  62747. export class ReflectionProbe {
  62748. /** defines the name of the probe */
  62749. name: string;
  62750. private _scene;
  62751. private _renderTargetTexture;
  62752. private _projectionMatrix;
  62753. private _viewMatrix;
  62754. private _target;
  62755. private _add;
  62756. private _attachedMesh;
  62757. private _invertYAxis;
  62758. /** Gets or sets probe position (center of the cube map) */
  62759. position: Vector3;
  62760. /**
  62761. * Creates a new reflection probe
  62762. * @param name defines the name of the probe
  62763. * @param size defines the texture resolution (for each face)
  62764. * @param scene defines the hosting scene
  62765. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  62766. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  62767. */
  62768. constructor(
  62769. /** defines the name of the probe */
  62770. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  62771. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  62772. get samples(): number;
  62773. set samples(value: number);
  62774. /** Gets or sets the refresh rate to use (on every frame by default) */
  62775. get refreshRate(): number;
  62776. set refreshRate(value: number);
  62777. /**
  62778. * Gets the hosting scene
  62779. * @returns a Scene
  62780. */
  62781. getScene(): Scene;
  62782. /** Gets the internal CubeTexture used to render to */
  62783. get cubeTexture(): RenderTargetTexture;
  62784. /** Gets the list of meshes to render */
  62785. get renderList(): Nullable<AbstractMesh[]>;
  62786. /**
  62787. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  62788. * @param mesh defines the mesh to attach to
  62789. */
  62790. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  62791. /**
  62792. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  62793. * @param renderingGroupId The rendering group id corresponding to its index
  62794. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  62795. */
  62796. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  62797. /**
  62798. * Clean all associated resources
  62799. */
  62800. dispose(): void;
  62801. /**
  62802. * Converts the reflection probe information to a readable string for debug purpose.
  62803. * @param fullDetails Supports for multiple levels of logging within scene loading
  62804. * @returns the human readable reflection probe info
  62805. */
  62806. toString(fullDetails?: boolean): string;
  62807. /**
  62808. * Get the class name of the relfection probe.
  62809. * @returns "ReflectionProbe"
  62810. */
  62811. getClassName(): string;
  62812. /**
  62813. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  62814. * @returns The JSON representation of the texture
  62815. */
  62816. serialize(): any;
  62817. /**
  62818. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  62819. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  62820. * @param scene Define the scene the parsed reflection probe should be instantiated in
  62821. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  62822. * @returns The parsed reflection probe if successful
  62823. */
  62824. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  62825. }
  62826. }
  62827. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  62828. /** @hidden */
  62829. export var _BabylonLoaderRegistered: boolean;
  62830. /**
  62831. * Helps setting up some configuration for the babylon file loader.
  62832. */
  62833. export class BabylonFileLoaderConfiguration {
  62834. /**
  62835. * The loader does not allow injecting custom physix engine into the plugins.
  62836. * Unfortunately in ES6, we need to manually inject them into the plugin.
  62837. * So you could set this variable to your engine import to make it work.
  62838. */
  62839. static LoaderInjectedPhysicsEngine: any;
  62840. }
  62841. }
  62842. declare module "babylonjs/Loading/Plugins/index" {
  62843. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  62844. }
  62845. declare module "babylonjs/Loading/index" {
  62846. export * from "babylonjs/Loading/loadingScreen";
  62847. export * from "babylonjs/Loading/Plugins/index";
  62848. export * from "babylonjs/Loading/sceneLoader";
  62849. export * from "babylonjs/Loading/sceneLoaderFlags";
  62850. }
  62851. declare module "babylonjs/Materials/Background/index" {
  62852. export * from "babylonjs/Materials/Background/backgroundMaterial";
  62853. }
  62854. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  62855. import { Scene } from "babylonjs/scene";
  62856. import { Color3 } from "babylonjs/Maths/math.color";
  62857. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  62858. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62859. /**
  62860. * The Physically based simple base material of BJS.
  62861. *
  62862. * This enables better naming and convention enforcements on top of the pbrMaterial.
  62863. * It is used as the base class for both the specGloss and metalRough conventions.
  62864. */
  62865. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  62866. /**
  62867. * Number of Simultaneous lights allowed on the material.
  62868. */
  62869. maxSimultaneousLights: number;
  62870. /**
  62871. * If sets to true, disables all the lights affecting the material.
  62872. */
  62873. disableLighting: boolean;
  62874. /**
  62875. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  62876. */
  62877. environmentTexture: BaseTexture;
  62878. /**
  62879. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  62880. */
  62881. invertNormalMapX: boolean;
  62882. /**
  62883. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  62884. */
  62885. invertNormalMapY: boolean;
  62886. /**
  62887. * Normal map used in the model.
  62888. */
  62889. normalTexture: BaseTexture;
  62890. /**
  62891. * Emissivie color used to self-illuminate the model.
  62892. */
  62893. emissiveColor: Color3;
  62894. /**
  62895. * Emissivie texture used to self-illuminate the model.
  62896. */
  62897. emissiveTexture: BaseTexture;
  62898. /**
  62899. * Occlusion Channel Strenght.
  62900. */
  62901. occlusionStrength: number;
  62902. /**
  62903. * Occlusion Texture of the material (adding extra occlusion effects).
  62904. */
  62905. occlusionTexture: BaseTexture;
  62906. /**
  62907. * Defines the alpha limits in alpha test mode.
  62908. */
  62909. alphaCutOff: number;
  62910. /**
  62911. * Gets the current double sided mode.
  62912. */
  62913. get doubleSided(): boolean;
  62914. /**
  62915. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  62916. */
  62917. set doubleSided(value: boolean);
  62918. /**
  62919. * Stores the pre-calculated light information of a mesh in a texture.
  62920. */
  62921. lightmapTexture: BaseTexture;
  62922. /**
  62923. * If true, the light map contains occlusion information instead of lighting info.
  62924. */
  62925. useLightmapAsShadowmap: boolean;
  62926. /**
  62927. * Instantiates a new PBRMaterial instance.
  62928. *
  62929. * @param name The material name
  62930. * @param scene The scene the material will be use in.
  62931. */
  62932. constructor(name: string, scene: Scene);
  62933. getClassName(): string;
  62934. }
  62935. }
  62936. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  62937. import { Scene } from "babylonjs/scene";
  62938. import { Color3 } from "babylonjs/Maths/math.color";
  62939. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62940. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  62941. /**
  62942. * The PBR material of BJS following the metal roughness convention.
  62943. *
  62944. * This fits to the PBR convention in the GLTF definition:
  62945. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  62946. */
  62947. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  62948. /**
  62949. * The base color has two different interpretations depending on the value of metalness.
  62950. * When the material is a metal, the base color is the specific measured reflectance value
  62951. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  62952. * of the material.
  62953. */
  62954. baseColor: Color3;
  62955. /**
  62956. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  62957. * well as opacity information in the alpha channel.
  62958. */
  62959. baseTexture: BaseTexture;
  62960. /**
  62961. * Specifies the metallic scalar value of the material.
  62962. * Can also be used to scale the metalness values of the metallic texture.
  62963. */
  62964. metallic: number;
  62965. /**
  62966. * Specifies the roughness scalar value of the material.
  62967. * Can also be used to scale the roughness values of the metallic texture.
  62968. */
  62969. roughness: number;
  62970. /**
  62971. * Texture containing both the metallic value in the B channel and the
  62972. * roughness value in the G channel to keep better precision.
  62973. */
  62974. metallicRoughnessTexture: BaseTexture;
  62975. /**
  62976. * Instantiates a new PBRMetalRoughnessMaterial instance.
  62977. *
  62978. * @param name The material name
  62979. * @param scene The scene the material will be use in.
  62980. */
  62981. constructor(name: string, scene: Scene);
  62982. /**
  62983. * Return the currrent class name of the material.
  62984. */
  62985. getClassName(): string;
  62986. /**
  62987. * Makes a duplicate of the current material.
  62988. * @param name - name to use for the new material.
  62989. */
  62990. clone(name: string): PBRMetallicRoughnessMaterial;
  62991. /**
  62992. * Serialize the material to a parsable JSON object.
  62993. */
  62994. serialize(): any;
  62995. /**
  62996. * Parses a JSON object correponding to the serialize function.
  62997. */
  62998. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  62999. }
  63000. }
  63001. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  63002. import { Scene } from "babylonjs/scene";
  63003. import { Color3 } from "babylonjs/Maths/math.color";
  63004. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63005. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  63006. /**
  63007. * The PBR material of BJS following the specular glossiness convention.
  63008. *
  63009. * This fits to the PBR convention in the GLTF definition:
  63010. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  63011. */
  63012. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  63013. /**
  63014. * Specifies the diffuse color of the material.
  63015. */
  63016. diffuseColor: Color3;
  63017. /**
  63018. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  63019. * channel.
  63020. */
  63021. diffuseTexture: BaseTexture;
  63022. /**
  63023. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  63024. */
  63025. specularColor: Color3;
  63026. /**
  63027. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  63028. */
  63029. glossiness: number;
  63030. /**
  63031. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  63032. */
  63033. specularGlossinessTexture: BaseTexture;
  63034. /**
  63035. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  63036. *
  63037. * @param name The material name
  63038. * @param scene The scene the material will be use in.
  63039. */
  63040. constructor(name: string, scene: Scene);
  63041. /**
  63042. * Return the currrent class name of the material.
  63043. */
  63044. getClassName(): string;
  63045. /**
  63046. * Makes a duplicate of the current material.
  63047. * @param name - name to use for the new material.
  63048. */
  63049. clone(name: string): PBRSpecularGlossinessMaterial;
  63050. /**
  63051. * Serialize the material to a parsable JSON object.
  63052. */
  63053. serialize(): any;
  63054. /**
  63055. * Parses a JSON object correponding to the serialize function.
  63056. */
  63057. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  63058. }
  63059. }
  63060. declare module "babylonjs/Materials/PBR/index" {
  63061. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63062. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  63063. export * from "babylonjs/Materials/PBR/pbrMaterial";
  63064. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  63065. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  63066. }
  63067. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  63068. import { Nullable } from "babylonjs/types";
  63069. import { Scene } from "babylonjs/scene";
  63070. import { Matrix } from "babylonjs/Maths/math.vector";
  63071. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63072. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63073. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63074. /**
  63075. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  63076. * It can help converting any input color in a desired output one. This can then be used to create effects
  63077. * from sepia, black and white to sixties or futuristic rendering...
  63078. *
  63079. * The only supported format is currently 3dl.
  63080. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  63081. */
  63082. export class ColorGradingTexture extends BaseTexture {
  63083. /**
  63084. * The texture URL.
  63085. */
  63086. url: string;
  63087. /**
  63088. * Empty line regex stored for GC.
  63089. */
  63090. private static _noneEmptyLineRegex;
  63091. private _textureMatrix;
  63092. private _onLoad;
  63093. /**
  63094. * Instantiates a ColorGradingTexture from the following parameters.
  63095. *
  63096. * @param url The location of the color gradind data (currently only supporting 3dl)
  63097. * @param sceneOrEngine The scene or engine the texture will be used in
  63098. * @param onLoad defines a callback triggered when the texture has been loaded
  63099. */
  63100. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  63101. /**
  63102. * Fires the onload event from the constructor if requested.
  63103. */
  63104. private _triggerOnLoad;
  63105. /**
  63106. * Returns the texture matrix used in most of the material.
  63107. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  63108. */
  63109. getTextureMatrix(): Matrix;
  63110. /**
  63111. * Occurs when the file being loaded is a .3dl LUT file.
  63112. */
  63113. private load3dlTexture;
  63114. /**
  63115. * Starts the loading process of the texture.
  63116. */
  63117. private loadTexture;
  63118. /**
  63119. * Clones the color gradind texture.
  63120. */
  63121. clone(): ColorGradingTexture;
  63122. /**
  63123. * Called during delayed load for textures.
  63124. */
  63125. delayLoad(): void;
  63126. /**
  63127. * Parses a color grading texture serialized by Babylon.
  63128. * @param parsedTexture The texture information being parsedTexture
  63129. * @param scene The scene to load the texture in
  63130. * @param rootUrl The root url of the data assets to load
  63131. * @return A color gradind texture
  63132. */
  63133. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  63134. /**
  63135. * Serializes the LUT texture to json format.
  63136. */
  63137. serialize(): any;
  63138. }
  63139. }
  63140. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  63141. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63142. import { Scene } from "babylonjs/scene";
  63143. import { Nullable } from "babylonjs/types";
  63144. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63145. /**
  63146. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  63147. */
  63148. export class EquiRectangularCubeTexture extends BaseTexture {
  63149. /** The six faces of the cube. */
  63150. private static _FacesMapping;
  63151. private _noMipmap;
  63152. private _onLoad;
  63153. private _onError;
  63154. /** The size of the cubemap. */
  63155. private _size;
  63156. /** The buffer of the image. */
  63157. private _buffer;
  63158. /** The width of the input image. */
  63159. private _width;
  63160. /** The height of the input image. */
  63161. private _height;
  63162. /** The URL to the image. */
  63163. url: string;
  63164. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  63165. coordinatesMode: number;
  63166. /**
  63167. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  63168. * @param url The location of the image
  63169. * @param scene The scene the texture will be used in
  63170. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63171. * @param noMipmap Forces to not generate the mipmap if true
  63172. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  63173. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  63174. * @param onLoad — defines a callback called when texture is loaded
  63175. * @param onError — defines a callback called if there is an error
  63176. */
  63177. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  63178. /**
  63179. * Load the image data, by putting the image on a canvas and extracting its buffer.
  63180. */
  63181. private loadImage;
  63182. /**
  63183. * Convert the image buffer into a cubemap and create a CubeTexture.
  63184. */
  63185. private loadTexture;
  63186. /**
  63187. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  63188. * @param buffer The ArrayBuffer that should be converted.
  63189. * @returns The buffer as Float32Array.
  63190. */
  63191. private getFloat32ArrayFromArrayBuffer;
  63192. /**
  63193. * Get the current class name of the texture useful for serialization or dynamic coding.
  63194. * @returns "EquiRectangularCubeTexture"
  63195. */
  63196. getClassName(): string;
  63197. /**
  63198. * Create a clone of the current EquiRectangularCubeTexture and return it.
  63199. * @returns A clone of the current EquiRectangularCubeTexture.
  63200. */
  63201. clone(): EquiRectangularCubeTexture;
  63202. }
  63203. }
  63204. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  63205. import { Nullable } from "babylonjs/types";
  63206. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63207. import { Matrix } from "babylonjs/Maths/math.vector";
  63208. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  63209. import "babylonjs/Engines/Extensions/engine.videoTexture";
  63210. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63211. import { Scene } from "babylonjs/scene";
  63212. /**
  63213. * Defines the options related to the creation of an HtmlElementTexture
  63214. */
  63215. export interface IHtmlElementTextureOptions {
  63216. /**
  63217. * Defines wether mip maps should be created or not.
  63218. */
  63219. generateMipMaps?: boolean;
  63220. /**
  63221. * Defines the sampling mode of the texture.
  63222. */
  63223. samplingMode?: number;
  63224. /**
  63225. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  63226. */
  63227. engine: Nullable<ThinEngine>;
  63228. /**
  63229. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  63230. */
  63231. scene: Nullable<Scene>;
  63232. }
  63233. /**
  63234. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  63235. * To be as efficient as possible depending on your constraints nothing aside the first upload
  63236. * is automatically managed.
  63237. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  63238. * in your application.
  63239. *
  63240. * As the update is not automatic, you need to call them manually.
  63241. */
  63242. export class HtmlElementTexture extends BaseTexture {
  63243. /**
  63244. * The texture URL.
  63245. */
  63246. element: HTMLVideoElement | HTMLCanvasElement;
  63247. private static readonly DefaultOptions;
  63248. private _textureMatrix;
  63249. private _isVideo;
  63250. private _generateMipMaps;
  63251. private _samplingMode;
  63252. /**
  63253. * Instantiates a HtmlElementTexture from the following parameters.
  63254. *
  63255. * @param name Defines the name of the texture
  63256. * @param element Defines the video or canvas the texture is filled with
  63257. * @param options Defines the other none mandatory texture creation options
  63258. */
  63259. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  63260. private _createInternalTexture;
  63261. /**
  63262. * Returns the texture matrix used in most of the material.
  63263. */
  63264. getTextureMatrix(): Matrix;
  63265. /**
  63266. * Updates the content of the texture.
  63267. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  63268. */
  63269. update(invertY?: Nullable<boolean>): void;
  63270. }
  63271. }
  63272. declare module "babylonjs/Misc/tga" {
  63273. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63274. /**
  63275. * Based on jsTGALoader - Javascript loader for TGA file
  63276. * By Vincent Thibault
  63277. * @see http://blog.robrowser.com/javascript-tga-loader.html
  63278. */
  63279. export class TGATools {
  63280. private static _TYPE_INDEXED;
  63281. private static _TYPE_RGB;
  63282. private static _TYPE_GREY;
  63283. private static _TYPE_RLE_INDEXED;
  63284. private static _TYPE_RLE_RGB;
  63285. private static _TYPE_RLE_GREY;
  63286. private static _ORIGIN_MASK;
  63287. private static _ORIGIN_SHIFT;
  63288. private static _ORIGIN_BL;
  63289. private static _ORIGIN_BR;
  63290. private static _ORIGIN_UL;
  63291. private static _ORIGIN_UR;
  63292. /**
  63293. * Gets the header of a TGA file
  63294. * @param data defines the TGA data
  63295. * @returns the header
  63296. */
  63297. static GetTGAHeader(data: Uint8Array): any;
  63298. /**
  63299. * Uploads TGA content to a Babylon Texture
  63300. * @hidden
  63301. */
  63302. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  63303. /** @hidden */
  63304. 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;
  63305. /** @hidden */
  63306. 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;
  63307. /** @hidden */
  63308. 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;
  63309. /** @hidden */
  63310. 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;
  63311. /** @hidden */
  63312. 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;
  63313. /** @hidden */
  63314. 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;
  63315. }
  63316. }
  63317. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  63318. import { Nullable } from "babylonjs/types";
  63319. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63320. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  63321. /**
  63322. * Implementation of the TGA Texture Loader.
  63323. * @hidden
  63324. */
  63325. export class _TGATextureLoader implements IInternalTextureLoader {
  63326. /**
  63327. * Defines wether the loader supports cascade loading the different faces.
  63328. */
  63329. readonly supportCascades: boolean;
  63330. /**
  63331. * This returns if the loader support the current file information.
  63332. * @param extension defines the file extension of the file being loaded
  63333. * @returns true if the loader can load the specified file
  63334. */
  63335. canLoad(extension: string): boolean;
  63336. /**
  63337. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  63338. * @param data contains the texture data
  63339. * @param texture defines the BabylonJS internal texture
  63340. * @param createPolynomials will be true if polynomials have been requested
  63341. * @param onLoad defines the callback to trigger once the texture is ready
  63342. * @param onError defines the callback to trigger in case of error
  63343. */
  63344. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  63345. /**
  63346. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  63347. * @param data contains the texture data
  63348. * @param texture defines the BabylonJS internal texture
  63349. * @param callback defines the method to call once ready to upload
  63350. */
  63351. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  63352. }
  63353. }
  63354. declare module "babylonjs/Misc/basis" {
  63355. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63356. /**
  63357. * Info about the .basis files
  63358. */
  63359. class BasisFileInfo {
  63360. /**
  63361. * If the file has alpha
  63362. */
  63363. hasAlpha: boolean;
  63364. /**
  63365. * Info about each image of the basis file
  63366. */
  63367. images: Array<{
  63368. levels: Array<{
  63369. width: number;
  63370. height: number;
  63371. transcodedPixels: ArrayBufferView;
  63372. }>;
  63373. }>;
  63374. }
  63375. /**
  63376. * Result of transcoding a basis file
  63377. */
  63378. class TranscodeResult {
  63379. /**
  63380. * Info about the .basis file
  63381. */
  63382. fileInfo: BasisFileInfo;
  63383. /**
  63384. * Format to use when loading the file
  63385. */
  63386. format: number;
  63387. }
  63388. /**
  63389. * Configuration options for the Basis transcoder
  63390. */
  63391. export class BasisTranscodeConfiguration {
  63392. /**
  63393. * Supported compression formats used to determine the supported output format of the transcoder
  63394. */
  63395. supportedCompressionFormats?: {
  63396. /**
  63397. * etc1 compression format
  63398. */
  63399. etc1?: boolean;
  63400. /**
  63401. * s3tc compression format
  63402. */
  63403. s3tc?: boolean;
  63404. /**
  63405. * pvrtc compression format
  63406. */
  63407. pvrtc?: boolean;
  63408. /**
  63409. * etc2 compression format
  63410. */
  63411. etc2?: boolean;
  63412. };
  63413. /**
  63414. * If mipmap levels should be loaded for transcoded images (Default: true)
  63415. */
  63416. loadMipmapLevels?: boolean;
  63417. /**
  63418. * Index of a single image to load (Default: all images)
  63419. */
  63420. loadSingleImage?: number;
  63421. }
  63422. /**
  63423. * Used to load .Basis files
  63424. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  63425. */
  63426. export class BasisTools {
  63427. private static _IgnoreSupportedFormats;
  63428. /**
  63429. * URL to use when loading the basis transcoder
  63430. */
  63431. static JSModuleURL: string;
  63432. /**
  63433. * URL to use when loading the wasm module for the transcoder
  63434. */
  63435. static WasmModuleURL: string;
  63436. /**
  63437. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  63438. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  63439. * @returns internal format corresponding to the Basis format
  63440. */
  63441. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  63442. private static _WorkerPromise;
  63443. private static _Worker;
  63444. private static _actionId;
  63445. private static _CreateWorkerAsync;
  63446. /**
  63447. * Transcodes a loaded image file to compressed pixel data
  63448. * @param data image data to transcode
  63449. * @param config configuration options for the transcoding
  63450. * @returns a promise resulting in the transcoded image
  63451. */
  63452. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  63453. /**
  63454. * Loads a texture from the transcode result
  63455. * @param texture texture load to
  63456. * @param transcodeResult the result of transcoding the basis file to load from
  63457. */
  63458. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  63459. }
  63460. }
  63461. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  63462. import { Nullable } from "babylonjs/types";
  63463. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63464. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  63465. /**
  63466. * Loader for .basis file format
  63467. */
  63468. export class _BasisTextureLoader implements IInternalTextureLoader {
  63469. /**
  63470. * Defines whether the loader supports cascade loading the different faces.
  63471. */
  63472. readonly supportCascades: boolean;
  63473. /**
  63474. * This returns if the loader support the current file information.
  63475. * @param extension defines the file extension of the file being loaded
  63476. * @returns true if the loader can load the specified file
  63477. */
  63478. canLoad(extension: string): boolean;
  63479. /**
  63480. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  63481. * @param data contains the texture data
  63482. * @param texture defines the BabylonJS internal texture
  63483. * @param createPolynomials will be true if polynomials have been requested
  63484. * @param onLoad defines the callback to trigger once the texture is ready
  63485. * @param onError defines the callback to trigger in case of error
  63486. */
  63487. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  63488. /**
  63489. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  63490. * @param data contains the texture data
  63491. * @param texture defines the BabylonJS internal texture
  63492. * @param callback defines the method to call once ready to upload
  63493. */
  63494. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  63495. }
  63496. }
  63497. declare module "babylonjs/Materials/Textures/Loaders/index" {
  63498. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  63499. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  63500. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  63501. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  63502. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  63503. }
  63504. declare module "babylonjs/Materials/Textures/Packer/frame" {
  63505. import { Vector2 } from "babylonjs/Maths/math.vector";
  63506. /**
  63507. * Defines the basic options interface of a TexturePacker Frame
  63508. */
  63509. export interface ITexturePackerFrame {
  63510. /**
  63511. * The frame ID
  63512. */
  63513. id: number;
  63514. /**
  63515. * The frames Scale
  63516. */
  63517. scale: Vector2;
  63518. /**
  63519. * The Frames offset
  63520. */
  63521. offset: Vector2;
  63522. }
  63523. /**
  63524. * This is a support class for frame Data on texture packer sets.
  63525. */
  63526. export class TexturePackerFrame implements ITexturePackerFrame {
  63527. /**
  63528. * The frame ID
  63529. */
  63530. id: number;
  63531. /**
  63532. * The frames Scale
  63533. */
  63534. scale: Vector2;
  63535. /**
  63536. * The Frames offset
  63537. */
  63538. offset: Vector2;
  63539. /**
  63540. * Initializes a texture package frame.
  63541. * @param id The numerical frame identifier
  63542. * @param scale Scalar Vector2 for UV frame
  63543. * @param offset Vector2 for the frame position in UV units.
  63544. * @returns TexturePackerFrame
  63545. */
  63546. constructor(id: number, scale: Vector2, offset: Vector2);
  63547. }
  63548. }
  63549. declare module "babylonjs/Materials/Textures/Packer/packer" {
  63550. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63551. import { Scene } from "babylonjs/scene";
  63552. import { Nullable } from "babylonjs/types";
  63553. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  63554. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  63555. /**
  63556. * Defines the basic options interface of a TexturePacker
  63557. */
  63558. export interface ITexturePackerOptions {
  63559. /**
  63560. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  63561. */
  63562. map?: string[];
  63563. /**
  63564. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  63565. */
  63566. uvsIn?: string;
  63567. /**
  63568. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  63569. */
  63570. uvsOut?: string;
  63571. /**
  63572. * number representing the layout style. Defaults to LAYOUT_STRIP
  63573. */
  63574. layout?: number;
  63575. /**
  63576. * number of columns if using custom column count layout(2). This defaults to 4.
  63577. */
  63578. colnum?: number;
  63579. /**
  63580. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  63581. */
  63582. updateInputMeshes?: boolean;
  63583. /**
  63584. * boolean flag to dispose all the source textures. Defaults to true.
  63585. */
  63586. disposeSources?: boolean;
  63587. /**
  63588. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  63589. */
  63590. fillBlanks?: boolean;
  63591. /**
  63592. * string value representing the context fill style color. Defaults to 'black'.
  63593. */
  63594. customFillColor?: string;
  63595. /**
  63596. * Width and Height Value of each Frame in the TexturePacker Sets
  63597. */
  63598. frameSize?: number;
  63599. /**
  63600. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  63601. */
  63602. paddingRatio?: number;
  63603. /**
  63604. * Number that declares the fill method for the padding gutter.
  63605. */
  63606. paddingMode?: number;
  63607. /**
  63608. * If in SUBUV_COLOR padding mode what color to use.
  63609. */
  63610. paddingColor?: Color3 | Color4;
  63611. }
  63612. /**
  63613. * Defines the basic interface of a TexturePacker JSON File
  63614. */
  63615. export interface ITexturePackerJSON {
  63616. /**
  63617. * The frame ID
  63618. */
  63619. name: string;
  63620. /**
  63621. * The base64 channel data
  63622. */
  63623. sets: any;
  63624. /**
  63625. * The options of the Packer
  63626. */
  63627. options: ITexturePackerOptions;
  63628. /**
  63629. * The frame data of the Packer
  63630. */
  63631. frames: Array<number>;
  63632. }
  63633. /**
  63634. * This is a support class that generates a series of packed texture sets.
  63635. * @see https://doc.babylonjs.com/babylon101/materials
  63636. */
  63637. export class TexturePacker {
  63638. /** Packer Layout Constant 0 */
  63639. static readonly LAYOUT_STRIP: number;
  63640. /** Packer Layout Constant 1 */
  63641. static readonly LAYOUT_POWER2: number;
  63642. /** Packer Layout Constant 2 */
  63643. static readonly LAYOUT_COLNUM: number;
  63644. /** Packer Layout Constant 0 */
  63645. static readonly SUBUV_WRAP: number;
  63646. /** Packer Layout Constant 1 */
  63647. static readonly SUBUV_EXTEND: number;
  63648. /** Packer Layout Constant 2 */
  63649. static readonly SUBUV_COLOR: number;
  63650. /** The Name of the Texture Package */
  63651. name: string;
  63652. /** The scene scope of the TexturePacker */
  63653. scene: Scene;
  63654. /** The Meshes to target */
  63655. meshes: AbstractMesh[];
  63656. /** Arguments passed with the Constructor */
  63657. options: ITexturePackerOptions;
  63658. /** The promise that is started upon initialization */
  63659. promise: Nullable<Promise<TexturePacker | string>>;
  63660. /** The Container object for the channel sets that are generated */
  63661. sets: object;
  63662. /** The Container array for the frames that are generated */
  63663. frames: TexturePackerFrame[];
  63664. /** The expected number of textures the system is parsing. */
  63665. private _expecting;
  63666. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  63667. private _paddingValue;
  63668. /**
  63669. * Initializes a texture package series from an array of meshes or a single mesh.
  63670. * @param name The name of the package
  63671. * @param meshes The target meshes to compose the package from
  63672. * @param options The arguments that texture packer should follow while building.
  63673. * @param scene The scene which the textures are scoped to.
  63674. * @returns TexturePacker
  63675. */
  63676. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  63677. /**
  63678. * Starts the package process
  63679. * @param resolve The promises resolution function
  63680. * @returns TexturePacker
  63681. */
  63682. private _createFrames;
  63683. /**
  63684. * Calculates the Size of the Channel Sets
  63685. * @returns Vector2
  63686. */
  63687. private _calculateSize;
  63688. /**
  63689. * Calculates the UV data for the frames.
  63690. * @param baseSize the base frameSize
  63691. * @param padding the base frame padding
  63692. * @param dtSize size of the Dynamic Texture for that channel
  63693. * @param dtUnits is 1/dtSize
  63694. * @param update flag to update the input meshes
  63695. */
  63696. private _calculateMeshUVFrames;
  63697. /**
  63698. * Calculates the frames Offset.
  63699. * @param index of the frame
  63700. * @returns Vector2
  63701. */
  63702. private _getFrameOffset;
  63703. /**
  63704. * Updates a Mesh to the frame data
  63705. * @param mesh that is the target
  63706. * @param frameID or the frame index
  63707. */
  63708. private _updateMeshUV;
  63709. /**
  63710. * Updates a Meshes materials to use the texture packer channels
  63711. * @param m is the mesh to target
  63712. * @param force all channels on the packer to be set.
  63713. */
  63714. private _updateTextureReferences;
  63715. /**
  63716. * Public method to set a Mesh to a frame
  63717. * @param m that is the target
  63718. * @param frameID or the frame index
  63719. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  63720. */
  63721. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  63722. /**
  63723. * Starts the async promise to compile the texture packer.
  63724. * @returns Promise<void>
  63725. */
  63726. processAsync(): Promise<void>;
  63727. /**
  63728. * Disposes all textures associated with this packer
  63729. */
  63730. dispose(): void;
  63731. /**
  63732. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  63733. * @param imageType is the image type to use.
  63734. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  63735. */
  63736. download(imageType?: string, quality?: number): void;
  63737. /**
  63738. * Public method to load a texturePacker JSON file.
  63739. * @param data of the JSON file in string format.
  63740. */
  63741. updateFromJSON(data: string): void;
  63742. }
  63743. }
  63744. declare module "babylonjs/Materials/Textures/Packer/index" {
  63745. export * from "babylonjs/Materials/Textures/Packer/packer";
  63746. export * from "babylonjs/Materials/Textures/Packer/frame";
  63747. }
  63748. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  63749. import { Scene } from "babylonjs/scene";
  63750. import { Texture } from "babylonjs/Materials/Textures/texture";
  63751. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  63752. /**
  63753. * 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.
  63754. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  63755. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  63756. */
  63757. export class CustomProceduralTexture extends ProceduralTexture {
  63758. private _animate;
  63759. private _time;
  63760. private _config;
  63761. private _texturePath;
  63762. /**
  63763. * Instantiates a new Custom Procedural Texture.
  63764. * 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.
  63765. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  63766. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  63767. * @param name Define the name of the texture
  63768. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  63769. * @param size Define the size of the texture to create
  63770. * @param scene Define the scene the texture belongs to
  63771. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  63772. * @param generateMipMaps Define if the texture should creates mip maps or not
  63773. */
  63774. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  63775. private _loadJson;
  63776. /**
  63777. * Is the texture ready to be used ? (rendered at least once)
  63778. * @returns true if ready, otherwise, false.
  63779. */
  63780. isReady(): boolean;
  63781. /**
  63782. * Render the texture to its associated render target.
  63783. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  63784. */
  63785. render(useCameraPostProcess?: boolean): void;
  63786. /**
  63787. * Update the list of dependant textures samplers in the shader.
  63788. */
  63789. updateTextures(): void;
  63790. /**
  63791. * Update the uniform values of the procedural texture in the shader.
  63792. */
  63793. updateShaderUniforms(): void;
  63794. /**
  63795. * Define if the texture animates or not.
  63796. */
  63797. get animate(): boolean;
  63798. set animate(value: boolean);
  63799. }
  63800. }
  63801. declare module "babylonjs/Shaders/noise.fragment" {
  63802. /** @hidden */
  63803. export var noisePixelShader: {
  63804. name: string;
  63805. shader: string;
  63806. };
  63807. }
  63808. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  63809. import { Nullable } from "babylonjs/types";
  63810. import { Scene } from "babylonjs/scene";
  63811. import { Texture } from "babylonjs/Materials/Textures/texture";
  63812. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  63813. import "babylonjs/Shaders/noise.fragment";
  63814. /**
  63815. * Class used to generate noise procedural textures
  63816. */
  63817. export class NoiseProceduralTexture extends ProceduralTexture {
  63818. private _time;
  63819. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  63820. brightness: number;
  63821. /** Defines the number of octaves to process */
  63822. octaves: number;
  63823. /** Defines the level of persistence (0.8 by default) */
  63824. persistence: number;
  63825. /** Gets or sets animation speed factor (default is 1) */
  63826. animationSpeedFactor: number;
  63827. /**
  63828. * Creates a new NoiseProceduralTexture
  63829. * @param name defines the name fo the texture
  63830. * @param size defines the size of the texture (default is 256)
  63831. * @param scene defines the hosting scene
  63832. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  63833. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  63834. */
  63835. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  63836. private _updateShaderUniforms;
  63837. protected _getDefines(): string;
  63838. /** Generate the current state of the procedural texture */
  63839. render(useCameraPostProcess?: boolean): void;
  63840. /**
  63841. * Serializes this noise procedural texture
  63842. * @returns a serialized noise procedural texture object
  63843. */
  63844. serialize(): any;
  63845. /**
  63846. * Clone the texture.
  63847. * @returns the cloned texture
  63848. */
  63849. clone(): NoiseProceduralTexture;
  63850. /**
  63851. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  63852. * @param parsedTexture defines parsed texture data
  63853. * @param scene defines the current scene
  63854. * @param rootUrl defines the root URL containing noise procedural texture information
  63855. * @returns a parsed NoiseProceduralTexture
  63856. */
  63857. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  63858. }
  63859. }
  63860. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  63861. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  63862. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  63863. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  63864. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  63865. }
  63866. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  63867. import { Nullable } from "babylonjs/types";
  63868. import { Scene } from "babylonjs/scene";
  63869. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  63870. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63871. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  63872. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63873. /**
  63874. * Raw cube texture where the raw buffers are passed in
  63875. */
  63876. export class RawCubeTexture extends CubeTexture {
  63877. /**
  63878. * Creates a cube texture where the raw buffers are passed in.
  63879. * @param scene defines the scene the texture is attached to
  63880. * @param data defines the array of data to use to create each face
  63881. * @param size defines the size of the textures
  63882. * @param format defines the format of the data
  63883. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  63884. * @param generateMipMaps defines if the engine should generate the mip levels
  63885. * @param invertY defines if data must be stored with Y axis inverted
  63886. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  63887. * @param compression defines the compression used (null by default)
  63888. */
  63889. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  63890. /**
  63891. * Updates the raw cube texture.
  63892. * @param data defines the data to store
  63893. * @param format defines the data format
  63894. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  63895. * @param invertY defines if data must be stored with Y axis inverted
  63896. * @param compression defines the compression used (null by default)
  63897. * @param level defines which level of the texture to update
  63898. */
  63899. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  63900. /**
  63901. * Updates a raw cube texture with RGBD encoded data.
  63902. * @param data defines the array of data [mipmap][face] to use to create each face
  63903. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  63904. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  63905. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  63906. * @returns a promsie that resolves when the operation is complete
  63907. */
  63908. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  63909. /**
  63910. * Clones the raw cube texture.
  63911. * @return a new cube texture
  63912. */
  63913. clone(): CubeTexture;
  63914. /** @hidden */
  63915. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  63916. }
  63917. }
  63918. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  63919. import { Scene } from "babylonjs/scene";
  63920. import { Texture } from "babylonjs/Materials/Textures/texture";
  63921. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63922. /**
  63923. * Class used to store 2D array textures containing user data
  63924. */
  63925. export class RawTexture2DArray extends Texture {
  63926. /** Gets or sets the texture format to use */
  63927. format: number;
  63928. /**
  63929. * Create a new RawTexture2DArray
  63930. * @param data defines the data of the texture
  63931. * @param width defines the width of the texture
  63932. * @param height defines the height of the texture
  63933. * @param depth defines the number of layers of the texture
  63934. * @param format defines the texture format to use
  63935. * @param scene defines the hosting scene
  63936. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  63937. * @param invertY defines if texture must be stored with Y axis inverted
  63938. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  63939. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  63940. */
  63941. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  63942. /** Gets or sets the texture format to use */
  63943. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  63944. /**
  63945. * Update the texture with new data
  63946. * @param data defines the data to store in the texture
  63947. */
  63948. update(data: ArrayBufferView): void;
  63949. }
  63950. }
  63951. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  63952. import { Scene } from "babylonjs/scene";
  63953. import { Texture } from "babylonjs/Materials/Textures/texture";
  63954. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63955. /**
  63956. * Class used to store 3D textures containing user data
  63957. */
  63958. export class RawTexture3D extends Texture {
  63959. /** Gets or sets the texture format to use */
  63960. format: number;
  63961. /**
  63962. * Create a new RawTexture3D
  63963. * @param data defines the data of the texture
  63964. * @param width defines the width of the texture
  63965. * @param height defines the height of the texture
  63966. * @param depth defines the depth of the texture
  63967. * @param format defines the texture format to use
  63968. * @param scene defines the hosting scene
  63969. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  63970. * @param invertY defines if texture must be stored with Y axis inverted
  63971. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  63972. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  63973. */
  63974. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  63975. /** Gets or sets the texture format to use */
  63976. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  63977. /**
  63978. * Update the texture with new data
  63979. * @param data defines the data to store in the texture
  63980. */
  63981. update(data: ArrayBufferView): void;
  63982. }
  63983. }
  63984. declare module "babylonjs/Materials/Textures/refractionTexture" {
  63985. import { Scene } from "babylonjs/scene";
  63986. import { Plane } from "babylonjs/Maths/math.plane";
  63987. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63988. /**
  63989. * Creates a refraction texture used by refraction channel of the standard material.
  63990. * It is like a mirror but to see through a material.
  63991. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  63992. */
  63993. export class RefractionTexture extends RenderTargetTexture {
  63994. /**
  63995. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  63996. * 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.
  63997. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  63998. */
  63999. refractionPlane: Plane;
  64000. /**
  64001. * Define how deep under the surface we should see.
  64002. */
  64003. depth: number;
  64004. /**
  64005. * Creates a refraction texture used by refraction channel of the standard material.
  64006. * It is like a mirror but to see through a material.
  64007. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  64008. * @param name Define the texture name
  64009. * @param size Define the size of the underlying texture
  64010. * @param scene Define the scene the refraction belongs to
  64011. * @param generateMipMaps Define if we need to generate mips level for the refraction
  64012. */
  64013. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  64014. /**
  64015. * Clone the refraction texture.
  64016. * @returns the cloned texture
  64017. */
  64018. clone(): RefractionTexture;
  64019. /**
  64020. * Serialize the texture to a JSON representation you could use in Parse later on
  64021. * @returns the serialized JSON representation
  64022. */
  64023. serialize(): any;
  64024. }
  64025. }
  64026. declare module "babylonjs/Materials/Textures/index" {
  64027. export * from "babylonjs/Materials/Textures/baseTexture";
  64028. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  64029. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  64030. export * from "babylonjs/Materials/Textures/cubeTexture";
  64031. export * from "babylonjs/Materials/Textures/dynamicTexture";
  64032. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  64033. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  64034. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  64035. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  64036. export * from "babylonjs/Materials/Textures/internalTexture";
  64037. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  64038. export * from "babylonjs/Materials/Textures/Loaders/index";
  64039. export * from "babylonjs/Materials/Textures/mirrorTexture";
  64040. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  64041. export * from "babylonjs/Materials/Textures/Packer/index";
  64042. export * from "babylonjs/Materials/Textures/Procedurals/index";
  64043. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  64044. export * from "babylonjs/Materials/Textures/rawTexture";
  64045. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  64046. export * from "babylonjs/Materials/Textures/rawTexture3D";
  64047. export * from "babylonjs/Materials/Textures/refractionTexture";
  64048. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  64049. export * from "babylonjs/Materials/Textures/texture";
  64050. export * from "babylonjs/Materials/Textures/videoTexture";
  64051. }
  64052. declare module "babylonjs/Materials/Node/Enums/index" {
  64053. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  64054. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  64055. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  64056. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  64057. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  64058. }
  64059. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  64060. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64061. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64062. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64063. import { Mesh } from "babylonjs/Meshes/mesh";
  64064. import { Effect } from "babylonjs/Materials/effect";
  64065. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64066. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64067. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  64068. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  64069. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  64070. /**
  64071. * Block used to add support for vertex skinning (bones)
  64072. */
  64073. export class BonesBlock extends NodeMaterialBlock {
  64074. /**
  64075. * Creates a new BonesBlock
  64076. * @param name defines the block name
  64077. */
  64078. constructor(name: string);
  64079. /**
  64080. * Initialize the block and prepare the context for build
  64081. * @param state defines the state that will be used for the build
  64082. */
  64083. initialize(state: NodeMaterialBuildState): void;
  64084. /**
  64085. * Gets the current class name
  64086. * @returns the class name
  64087. */
  64088. getClassName(): string;
  64089. /**
  64090. * Gets the matrix indices input component
  64091. */
  64092. get matricesIndices(): NodeMaterialConnectionPoint;
  64093. /**
  64094. * Gets the matrix weights input component
  64095. */
  64096. get matricesWeights(): NodeMaterialConnectionPoint;
  64097. /**
  64098. * Gets the extra matrix indices input component
  64099. */
  64100. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  64101. /**
  64102. * Gets the extra matrix weights input component
  64103. */
  64104. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  64105. /**
  64106. * Gets the world input component
  64107. */
  64108. get world(): NodeMaterialConnectionPoint;
  64109. /**
  64110. * Gets the output component
  64111. */
  64112. get output(): NodeMaterialConnectionPoint;
  64113. autoConfigure(material: NodeMaterial): void;
  64114. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  64115. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64116. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64117. protected _buildBlock(state: NodeMaterialBuildState): this;
  64118. }
  64119. }
  64120. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  64121. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64122. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64123. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64124. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64125. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64126. import { SubMesh } from "babylonjs/Meshes/subMesh";
  64127. /**
  64128. * Block used to add support for instances
  64129. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  64130. */
  64131. export class InstancesBlock extends NodeMaterialBlock {
  64132. /**
  64133. * Creates a new InstancesBlock
  64134. * @param name defines the block name
  64135. */
  64136. constructor(name: string);
  64137. /**
  64138. * Gets the current class name
  64139. * @returns the class name
  64140. */
  64141. getClassName(): string;
  64142. /**
  64143. * Gets the first world row input component
  64144. */
  64145. get world0(): NodeMaterialConnectionPoint;
  64146. /**
  64147. * Gets the second world row input component
  64148. */
  64149. get world1(): NodeMaterialConnectionPoint;
  64150. /**
  64151. * Gets the third world row input component
  64152. */
  64153. get world2(): NodeMaterialConnectionPoint;
  64154. /**
  64155. * Gets the forth world row input component
  64156. */
  64157. get world3(): NodeMaterialConnectionPoint;
  64158. /**
  64159. * Gets the world input component
  64160. */
  64161. get world(): NodeMaterialConnectionPoint;
  64162. /**
  64163. * Gets the output component
  64164. */
  64165. get output(): NodeMaterialConnectionPoint;
  64166. /**
  64167. * Gets the isntanceID component
  64168. */
  64169. get instanceID(): NodeMaterialConnectionPoint;
  64170. autoConfigure(material: NodeMaterial): void;
  64171. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  64172. protected _buildBlock(state: NodeMaterialBuildState): this;
  64173. }
  64174. }
  64175. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  64176. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64177. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64178. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64179. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64180. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64181. import { Effect } from "babylonjs/Materials/effect";
  64182. import { Mesh } from "babylonjs/Meshes/mesh";
  64183. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  64184. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  64185. /**
  64186. * Block used to add morph targets support to vertex shader
  64187. */
  64188. export class MorphTargetsBlock extends NodeMaterialBlock {
  64189. private _repeatableContentAnchor;
  64190. /**
  64191. * Create a new MorphTargetsBlock
  64192. * @param name defines the block name
  64193. */
  64194. constructor(name: string);
  64195. /**
  64196. * Gets the current class name
  64197. * @returns the class name
  64198. */
  64199. getClassName(): string;
  64200. /**
  64201. * Gets the position input component
  64202. */
  64203. get position(): NodeMaterialConnectionPoint;
  64204. /**
  64205. * Gets the normal input component
  64206. */
  64207. get normal(): NodeMaterialConnectionPoint;
  64208. /**
  64209. * Gets the tangent input component
  64210. */
  64211. get tangent(): NodeMaterialConnectionPoint;
  64212. /**
  64213. * Gets the tangent input component
  64214. */
  64215. get uv(): NodeMaterialConnectionPoint;
  64216. /**
  64217. * Gets the position output component
  64218. */
  64219. get positionOutput(): NodeMaterialConnectionPoint;
  64220. /**
  64221. * Gets the normal output component
  64222. */
  64223. get normalOutput(): NodeMaterialConnectionPoint;
  64224. /**
  64225. * Gets the tangent output component
  64226. */
  64227. get tangentOutput(): NodeMaterialConnectionPoint;
  64228. /**
  64229. * Gets the tangent output component
  64230. */
  64231. get uvOutput(): NodeMaterialConnectionPoint;
  64232. initialize(state: NodeMaterialBuildState): void;
  64233. autoConfigure(material: NodeMaterial): void;
  64234. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64235. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64236. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  64237. protected _buildBlock(state: NodeMaterialBuildState): this;
  64238. }
  64239. }
  64240. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  64241. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64242. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64243. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64244. import { Nullable } from "babylonjs/types";
  64245. import { Scene } from "babylonjs/scene";
  64246. import { Effect } from "babylonjs/Materials/effect";
  64247. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64248. import { Mesh } from "babylonjs/Meshes/mesh";
  64249. import { Light } from "babylonjs/Lights/light";
  64250. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64251. /**
  64252. * Block used to get data information from a light
  64253. */
  64254. export class LightInformationBlock extends NodeMaterialBlock {
  64255. private _lightDataUniformName;
  64256. private _lightColorUniformName;
  64257. private _lightTypeDefineName;
  64258. /**
  64259. * Gets or sets the light associated with this block
  64260. */
  64261. light: Nullable<Light>;
  64262. /**
  64263. * Creates a new LightInformationBlock
  64264. * @param name defines the block name
  64265. */
  64266. constructor(name: string);
  64267. /**
  64268. * Gets the current class name
  64269. * @returns the class name
  64270. */
  64271. getClassName(): string;
  64272. /**
  64273. * Gets the world position input component
  64274. */
  64275. get worldPosition(): NodeMaterialConnectionPoint;
  64276. /**
  64277. * Gets the direction output component
  64278. */
  64279. get direction(): NodeMaterialConnectionPoint;
  64280. /**
  64281. * Gets the direction output component
  64282. */
  64283. get color(): NodeMaterialConnectionPoint;
  64284. /**
  64285. * Gets the direction output component
  64286. */
  64287. get intensity(): NodeMaterialConnectionPoint;
  64288. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64289. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64290. protected _buildBlock(state: NodeMaterialBuildState): this;
  64291. serialize(): any;
  64292. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64293. }
  64294. }
  64295. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  64296. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  64297. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  64298. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  64299. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  64300. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  64301. }
  64302. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  64303. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64304. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64305. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64306. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64307. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64308. import { Effect } from "babylonjs/Materials/effect";
  64309. import { Mesh } from "babylonjs/Meshes/mesh";
  64310. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  64311. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  64312. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  64313. /**
  64314. * Block used to add image processing support to fragment shader
  64315. */
  64316. export class ImageProcessingBlock extends NodeMaterialBlock {
  64317. /**
  64318. * Create a new ImageProcessingBlock
  64319. * @param name defines the block name
  64320. */
  64321. constructor(name: string);
  64322. /**
  64323. * Gets the current class name
  64324. * @returns the class name
  64325. */
  64326. getClassName(): string;
  64327. /**
  64328. * Gets the color input component
  64329. */
  64330. get color(): NodeMaterialConnectionPoint;
  64331. /**
  64332. * Gets the output component
  64333. */
  64334. get output(): NodeMaterialConnectionPoint;
  64335. /**
  64336. * Initialize the block and prepare the context for build
  64337. * @param state defines the state that will be used for the build
  64338. */
  64339. initialize(state: NodeMaterialBuildState): void;
  64340. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  64341. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64342. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64343. protected _buildBlock(state: NodeMaterialBuildState): this;
  64344. }
  64345. }
  64346. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  64347. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64348. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64349. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64350. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64351. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64352. import { Effect } from "babylonjs/Materials/effect";
  64353. import { Mesh } from "babylonjs/Meshes/mesh";
  64354. import { Scene } from "babylonjs/scene";
  64355. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  64356. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  64357. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  64358. /**
  64359. * Block used to pertub normals based on a normal map
  64360. */
  64361. export class PerturbNormalBlock extends NodeMaterialBlock {
  64362. private _tangentSpaceParameterName;
  64363. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  64364. invertX: boolean;
  64365. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  64366. invertY: boolean;
  64367. /**
  64368. * Create a new PerturbNormalBlock
  64369. * @param name defines the block name
  64370. */
  64371. constructor(name: string);
  64372. /**
  64373. * Gets the current class name
  64374. * @returns the class name
  64375. */
  64376. getClassName(): string;
  64377. /**
  64378. * Gets the world position input component
  64379. */
  64380. get worldPosition(): NodeMaterialConnectionPoint;
  64381. /**
  64382. * Gets the world normal input component
  64383. */
  64384. get worldNormal(): NodeMaterialConnectionPoint;
  64385. /**
  64386. * Gets the world tangent input component
  64387. */
  64388. get worldTangent(): NodeMaterialConnectionPoint;
  64389. /**
  64390. * Gets the uv input component
  64391. */
  64392. get uv(): NodeMaterialConnectionPoint;
  64393. /**
  64394. * Gets the normal map color input component
  64395. */
  64396. get normalMapColor(): NodeMaterialConnectionPoint;
  64397. /**
  64398. * Gets the strength input component
  64399. */
  64400. get strength(): NodeMaterialConnectionPoint;
  64401. /**
  64402. * Gets the output component
  64403. */
  64404. get output(): NodeMaterialConnectionPoint;
  64405. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64406. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64407. autoConfigure(material: NodeMaterial): void;
  64408. protected _buildBlock(state: NodeMaterialBuildState): this;
  64409. protected _dumpPropertiesCode(): string;
  64410. serialize(): any;
  64411. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64412. }
  64413. }
  64414. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  64415. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64416. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64417. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64418. /**
  64419. * Block used to discard a pixel if a value is smaller than a cutoff
  64420. */
  64421. export class DiscardBlock extends NodeMaterialBlock {
  64422. /**
  64423. * Create a new DiscardBlock
  64424. * @param name defines the block name
  64425. */
  64426. constructor(name: string);
  64427. /**
  64428. * Gets the current class name
  64429. * @returns the class name
  64430. */
  64431. getClassName(): string;
  64432. /**
  64433. * Gets the color input component
  64434. */
  64435. get value(): NodeMaterialConnectionPoint;
  64436. /**
  64437. * Gets the cutoff input component
  64438. */
  64439. get cutoff(): NodeMaterialConnectionPoint;
  64440. protected _buildBlock(state: NodeMaterialBuildState): this;
  64441. }
  64442. }
  64443. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  64444. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64445. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64446. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64447. /**
  64448. * Block used to test if the fragment shader is front facing
  64449. */
  64450. export class FrontFacingBlock extends NodeMaterialBlock {
  64451. /**
  64452. * Creates a new FrontFacingBlock
  64453. * @param name defines the block name
  64454. */
  64455. constructor(name: string);
  64456. /**
  64457. * Gets the current class name
  64458. * @returns the class name
  64459. */
  64460. getClassName(): string;
  64461. /**
  64462. * Gets the output component
  64463. */
  64464. get output(): NodeMaterialConnectionPoint;
  64465. protected _buildBlock(state: NodeMaterialBuildState): this;
  64466. }
  64467. }
  64468. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  64469. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64470. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64471. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64472. /**
  64473. * Block used to get the derivative value on x and y of a given input
  64474. */
  64475. export class DerivativeBlock extends NodeMaterialBlock {
  64476. /**
  64477. * Create a new DerivativeBlock
  64478. * @param name defines the block name
  64479. */
  64480. constructor(name: string);
  64481. /**
  64482. * Gets the current class name
  64483. * @returns the class name
  64484. */
  64485. getClassName(): string;
  64486. /**
  64487. * Gets the input component
  64488. */
  64489. get input(): NodeMaterialConnectionPoint;
  64490. /**
  64491. * Gets the derivative output on x
  64492. */
  64493. get dx(): NodeMaterialConnectionPoint;
  64494. /**
  64495. * Gets the derivative output on y
  64496. */
  64497. get dy(): NodeMaterialConnectionPoint;
  64498. protected _buildBlock(state: NodeMaterialBuildState): this;
  64499. }
  64500. }
  64501. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  64502. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64503. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64504. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64505. /**
  64506. * Block used to make gl_FragCoord available
  64507. */
  64508. export class FragCoordBlock extends NodeMaterialBlock {
  64509. /**
  64510. * Creates a new FragCoordBlock
  64511. * @param name defines the block name
  64512. */
  64513. constructor(name: string);
  64514. /**
  64515. * Gets the current class name
  64516. * @returns the class name
  64517. */
  64518. getClassName(): string;
  64519. /**
  64520. * Gets the xy component
  64521. */
  64522. get xy(): NodeMaterialConnectionPoint;
  64523. /**
  64524. * Gets the xyz component
  64525. */
  64526. get xyz(): NodeMaterialConnectionPoint;
  64527. /**
  64528. * Gets the xyzw component
  64529. */
  64530. get xyzw(): NodeMaterialConnectionPoint;
  64531. /**
  64532. * Gets the x component
  64533. */
  64534. get x(): NodeMaterialConnectionPoint;
  64535. /**
  64536. * Gets the y component
  64537. */
  64538. get y(): NodeMaterialConnectionPoint;
  64539. /**
  64540. * Gets the z component
  64541. */
  64542. get z(): NodeMaterialConnectionPoint;
  64543. /**
  64544. * Gets the w component
  64545. */
  64546. get output(): NodeMaterialConnectionPoint;
  64547. protected writeOutputs(state: NodeMaterialBuildState): string;
  64548. protected _buildBlock(state: NodeMaterialBuildState): this;
  64549. }
  64550. }
  64551. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  64552. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64553. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64554. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64555. import { Effect } from "babylonjs/Materials/effect";
  64556. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  64557. import { Mesh } from "babylonjs/Meshes/mesh";
  64558. /**
  64559. * Block used to get the screen sizes
  64560. */
  64561. export class ScreenSizeBlock extends NodeMaterialBlock {
  64562. private _varName;
  64563. private _scene;
  64564. /**
  64565. * Creates a new ScreenSizeBlock
  64566. * @param name defines the block name
  64567. */
  64568. constructor(name: string);
  64569. /**
  64570. * Gets the current class name
  64571. * @returns the class name
  64572. */
  64573. getClassName(): string;
  64574. /**
  64575. * Gets the xy component
  64576. */
  64577. get xy(): NodeMaterialConnectionPoint;
  64578. /**
  64579. * Gets the x component
  64580. */
  64581. get x(): NodeMaterialConnectionPoint;
  64582. /**
  64583. * Gets the y component
  64584. */
  64585. get y(): NodeMaterialConnectionPoint;
  64586. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64587. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  64588. protected _buildBlock(state: NodeMaterialBuildState): this;
  64589. }
  64590. }
  64591. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  64592. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  64593. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  64594. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  64595. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  64596. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  64597. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  64598. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  64599. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  64600. }
  64601. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  64602. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64603. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64604. import { Mesh } from "babylonjs/Meshes/mesh";
  64605. import { Effect } from "babylonjs/Materials/effect";
  64606. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64607. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64608. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64609. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  64610. /**
  64611. * Block used to add support for scene fog
  64612. */
  64613. export class FogBlock extends NodeMaterialBlock {
  64614. private _fogDistanceName;
  64615. private _fogParameters;
  64616. /**
  64617. * Create a new FogBlock
  64618. * @param name defines the block name
  64619. */
  64620. constructor(name: string);
  64621. /**
  64622. * Gets the current class name
  64623. * @returns the class name
  64624. */
  64625. getClassName(): string;
  64626. /**
  64627. * Gets the world position input component
  64628. */
  64629. get worldPosition(): NodeMaterialConnectionPoint;
  64630. /**
  64631. * Gets the view input component
  64632. */
  64633. get view(): NodeMaterialConnectionPoint;
  64634. /**
  64635. * Gets the color input component
  64636. */
  64637. get input(): NodeMaterialConnectionPoint;
  64638. /**
  64639. * Gets the fog color input component
  64640. */
  64641. get fogColor(): NodeMaterialConnectionPoint;
  64642. /**
  64643. * Gets the output component
  64644. */
  64645. get output(): NodeMaterialConnectionPoint;
  64646. autoConfigure(material: NodeMaterial): void;
  64647. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64648. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64649. protected _buildBlock(state: NodeMaterialBuildState): this;
  64650. }
  64651. }
  64652. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  64653. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64654. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64655. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64656. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64657. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64658. import { Effect } from "babylonjs/Materials/effect";
  64659. import { Mesh } from "babylonjs/Meshes/mesh";
  64660. import { Light } from "babylonjs/Lights/light";
  64661. import { Nullable } from "babylonjs/types";
  64662. import { Scene } from "babylonjs/scene";
  64663. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  64664. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  64665. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  64666. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  64667. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  64668. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  64669. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  64670. /**
  64671. * Block used to add light in the fragment shader
  64672. */
  64673. export class LightBlock extends NodeMaterialBlock {
  64674. private _lightId;
  64675. /**
  64676. * Gets or sets the light associated with this block
  64677. */
  64678. light: Nullable<Light>;
  64679. /**
  64680. * Create a new LightBlock
  64681. * @param name defines the block name
  64682. */
  64683. constructor(name: string);
  64684. /**
  64685. * Gets the current class name
  64686. * @returns the class name
  64687. */
  64688. getClassName(): string;
  64689. /**
  64690. * Gets the world position input component
  64691. */
  64692. get worldPosition(): NodeMaterialConnectionPoint;
  64693. /**
  64694. * Gets the world normal input component
  64695. */
  64696. get worldNormal(): NodeMaterialConnectionPoint;
  64697. /**
  64698. * Gets the camera (or eye) position component
  64699. */
  64700. get cameraPosition(): NodeMaterialConnectionPoint;
  64701. /**
  64702. * Gets the glossiness component
  64703. */
  64704. get glossiness(): NodeMaterialConnectionPoint;
  64705. /**
  64706. * Gets the glossinness power component
  64707. */
  64708. get glossPower(): NodeMaterialConnectionPoint;
  64709. /**
  64710. * Gets the diffuse color component
  64711. */
  64712. get diffuseColor(): NodeMaterialConnectionPoint;
  64713. /**
  64714. * Gets the specular color component
  64715. */
  64716. get specularColor(): NodeMaterialConnectionPoint;
  64717. /**
  64718. * Gets the diffuse output component
  64719. */
  64720. get diffuseOutput(): NodeMaterialConnectionPoint;
  64721. /**
  64722. * Gets the specular output component
  64723. */
  64724. get specularOutput(): NodeMaterialConnectionPoint;
  64725. /**
  64726. * Gets the shadow output component
  64727. */
  64728. get shadow(): NodeMaterialConnectionPoint;
  64729. autoConfigure(material: NodeMaterial): void;
  64730. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64731. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  64732. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64733. private _injectVertexCode;
  64734. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  64735. serialize(): any;
  64736. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64737. }
  64738. }
  64739. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  64740. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64741. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64742. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  64743. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  64744. /**
  64745. * Block used to read a reflection texture from a sampler
  64746. */
  64747. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  64748. /**
  64749. * Create a new ReflectionTextureBlock
  64750. * @param name defines the block name
  64751. */
  64752. constructor(name: string);
  64753. /**
  64754. * Gets the current class name
  64755. * @returns the class name
  64756. */
  64757. getClassName(): string;
  64758. /**
  64759. * Gets the world position input component
  64760. */
  64761. get position(): NodeMaterialConnectionPoint;
  64762. /**
  64763. * Gets the world position input component
  64764. */
  64765. get worldPosition(): NodeMaterialConnectionPoint;
  64766. /**
  64767. * Gets the world normal input component
  64768. */
  64769. get worldNormal(): NodeMaterialConnectionPoint;
  64770. /**
  64771. * Gets the world input component
  64772. */
  64773. get world(): NodeMaterialConnectionPoint;
  64774. /**
  64775. * Gets the camera (or eye) position component
  64776. */
  64777. get cameraPosition(): NodeMaterialConnectionPoint;
  64778. /**
  64779. * Gets the view input component
  64780. */
  64781. get view(): NodeMaterialConnectionPoint;
  64782. /**
  64783. * Gets the rgb output component
  64784. */
  64785. get rgb(): NodeMaterialConnectionPoint;
  64786. /**
  64787. * Gets the rgba output component
  64788. */
  64789. get rgba(): NodeMaterialConnectionPoint;
  64790. /**
  64791. * Gets the r output component
  64792. */
  64793. get r(): NodeMaterialConnectionPoint;
  64794. /**
  64795. * Gets the g output component
  64796. */
  64797. get g(): NodeMaterialConnectionPoint;
  64798. /**
  64799. * Gets the b output component
  64800. */
  64801. get b(): NodeMaterialConnectionPoint;
  64802. /**
  64803. * Gets the a output component
  64804. */
  64805. get a(): NodeMaterialConnectionPoint;
  64806. autoConfigure(material: NodeMaterial): void;
  64807. protected _buildBlock(state: NodeMaterialBuildState): this;
  64808. }
  64809. }
  64810. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  64811. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  64812. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  64813. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  64814. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  64815. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  64816. }
  64817. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  64818. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  64819. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  64820. }
  64821. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  64822. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64823. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64824. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64825. /**
  64826. * Block used to add 2 vectors
  64827. */
  64828. export class AddBlock extends NodeMaterialBlock {
  64829. /**
  64830. * Creates a new AddBlock
  64831. * @param name defines the block name
  64832. */
  64833. constructor(name: string);
  64834. /**
  64835. * Gets the current class name
  64836. * @returns the class name
  64837. */
  64838. getClassName(): string;
  64839. /**
  64840. * Gets the left operand input component
  64841. */
  64842. get left(): NodeMaterialConnectionPoint;
  64843. /**
  64844. * Gets the right operand input component
  64845. */
  64846. get right(): NodeMaterialConnectionPoint;
  64847. /**
  64848. * Gets the output component
  64849. */
  64850. get output(): NodeMaterialConnectionPoint;
  64851. protected _buildBlock(state: NodeMaterialBuildState): this;
  64852. }
  64853. }
  64854. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  64855. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64856. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64857. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64858. /**
  64859. * Block used to scale a vector by a float
  64860. */
  64861. export class ScaleBlock extends NodeMaterialBlock {
  64862. /**
  64863. * Creates a new ScaleBlock
  64864. * @param name defines the block name
  64865. */
  64866. constructor(name: string);
  64867. /**
  64868. * Gets the current class name
  64869. * @returns the class name
  64870. */
  64871. getClassName(): string;
  64872. /**
  64873. * Gets the input component
  64874. */
  64875. get input(): NodeMaterialConnectionPoint;
  64876. /**
  64877. * Gets the factor input component
  64878. */
  64879. get factor(): NodeMaterialConnectionPoint;
  64880. /**
  64881. * Gets the output component
  64882. */
  64883. get output(): NodeMaterialConnectionPoint;
  64884. protected _buildBlock(state: NodeMaterialBuildState): this;
  64885. }
  64886. }
  64887. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  64888. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64889. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64890. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64891. import { Scene } from "babylonjs/scene";
  64892. /**
  64893. * Block used to clamp a float
  64894. */
  64895. export class ClampBlock extends NodeMaterialBlock {
  64896. /** Gets or sets the minimum range */
  64897. minimum: number;
  64898. /** Gets or sets the maximum range */
  64899. maximum: number;
  64900. /**
  64901. * Creates a new ClampBlock
  64902. * @param name defines the block name
  64903. */
  64904. constructor(name: string);
  64905. /**
  64906. * Gets the current class name
  64907. * @returns the class name
  64908. */
  64909. getClassName(): string;
  64910. /**
  64911. * Gets the value input component
  64912. */
  64913. get value(): NodeMaterialConnectionPoint;
  64914. /**
  64915. * Gets the output component
  64916. */
  64917. get output(): NodeMaterialConnectionPoint;
  64918. protected _buildBlock(state: NodeMaterialBuildState): this;
  64919. protected _dumpPropertiesCode(): string;
  64920. serialize(): any;
  64921. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64922. }
  64923. }
  64924. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  64925. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64926. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64927. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64928. /**
  64929. * Block used to apply a cross product between 2 vectors
  64930. */
  64931. export class CrossBlock extends NodeMaterialBlock {
  64932. /**
  64933. * Creates a new CrossBlock
  64934. * @param name defines the block name
  64935. */
  64936. constructor(name: string);
  64937. /**
  64938. * Gets the current class name
  64939. * @returns the class name
  64940. */
  64941. getClassName(): string;
  64942. /**
  64943. * Gets the left operand input component
  64944. */
  64945. get left(): NodeMaterialConnectionPoint;
  64946. /**
  64947. * Gets the right operand input component
  64948. */
  64949. get right(): NodeMaterialConnectionPoint;
  64950. /**
  64951. * Gets the output component
  64952. */
  64953. get output(): NodeMaterialConnectionPoint;
  64954. protected _buildBlock(state: NodeMaterialBuildState): this;
  64955. }
  64956. }
  64957. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  64958. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64959. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64960. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64961. /**
  64962. * Block used to apply a dot product between 2 vectors
  64963. */
  64964. export class DotBlock extends NodeMaterialBlock {
  64965. /**
  64966. * Creates a new DotBlock
  64967. * @param name defines the block name
  64968. */
  64969. constructor(name: string);
  64970. /**
  64971. * Gets the current class name
  64972. * @returns the class name
  64973. */
  64974. getClassName(): string;
  64975. /**
  64976. * Gets the left operand input component
  64977. */
  64978. get left(): NodeMaterialConnectionPoint;
  64979. /**
  64980. * Gets the right operand input component
  64981. */
  64982. get right(): NodeMaterialConnectionPoint;
  64983. /**
  64984. * Gets the output component
  64985. */
  64986. get output(): NodeMaterialConnectionPoint;
  64987. protected _buildBlock(state: NodeMaterialBuildState): this;
  64988. }
  64989. }
  64990. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  64991. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64992. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64993. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64994. /**
  64995. * Block used to normalize a vector
  64996. */
  64997. export class NormalizeBlock extends NodeMaterialBlock {
  64998. /**
  64999. * Creates a new NormalizeBlock
  65000. * @param name defines the block name
  65001. */
  65002. constructor(name: string);
  65003. /**
  65004. * Gets the current class name
  65005. * @returns the class name
  65006. */
  65007. getClassName(): string;
  65008. /**
  65009. * Gets the input component
  65010. */
  65011. get input(): NodeMaterialConnectionPoint;
  65012. /**
  65013. * Gets the output component
  65014. */
  65015. get output(): NodeMaterialConnectionPoint;
  65016. protected _buildBlock(state: NodeMaterialBuildState): this;
  65017. }
  65018. }
  65019. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  65020. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65021. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65022. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65023. import { Scene } from "babylonjs/scene";
  65024. /**
  65025. * Operations supported by the Trigonometry block
  65026. */
  65027. export enum TrigonometryBlockOperations {
  65028. /** Cos */
  65029. Cos = 0,
  65030. /** Sin */
  65031. Sin = 1,
  65032. /** Abs */
  65033. Abs = 2,
  65034. /** Exp */
  65035. Exp = 3,
  65036. /** Exp2 */
  65037. Exp2 = 4,
  65038. /** Round */
  65039. Round = 5,
  65040. /** Floor */
  65041. Floor = 6,
  65042. /** Ceiling */
  65043. Ceiling = 7,
  65044. /** Square root */
  65045. Sqrt = 8,
  65046. /** Log */
  65047. Log = 9,
  65048. /** Tangent */
  65049. Tan = 10,
  65050. /** Arc tangent */
  65051. ArcTan = 11,
  65052. /** Arc cosinus */
  65053. ArcCos = 12,
  65054. /** Arc sinus */
  65055. ArcSin = 13,
  65056. /** Fraction */
  65057. Fract = 14,
  65058. /** Sign */
  65059. Sign = 15,
  65060. /** To radians (from degrees) */
  65061. Radians = 16,
  65062. /** To degrees (from radians) */
  65063. Degrees = 17
  65064. }
  65065. /**
  65066. * Block used to apply trigonometry operation to floats
  65067. */
  65068. export class TrigonometryBlock extends NodeMaterialBlock {
  65069. /**
  65070. * Gets or sets the operation applied by the block
  65071. */
  65072. operation: TrigonometryBlockOperations;
  65073. /**
  65074. * Creates a new TrigonometryBlock
  65075. * @param name defines the block name
  65076. */
  65077. constructor(name: string);
  65078. /**
  65079. * Gets the current class name
  65080. * @returns the class name
  65081. */
  65082. getClassName(): string;
  65083. /**
  65084. * Gets the input component
  65085. */
  65086. get input(): NodeMaterialConnectionPoint;
  65087. /**
  65088. * Gets the output component
  65089. */
  65090. get output(): NodeMaterialConnectionPoint;
  65091. protected _buildBlock(state: NodeMaterialBuildState): this;
  65092. serialize(): any;
  65093. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65094. protected _dumpPropertiesCode(): string;
  65095. }
  65096. }
  65097. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  65098. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65099. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65100. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65101. /**
  65102. * Block used to create a Color3/4 out of individual inputs (one for each component)
  65103. */
  65104. export class ColorMergerBlock extends NodeMaterialBlock {
  65105. /**
  65106. * Create a new ColorMergerBlock
  65107. * @param name defines the block name
  65108. */
  65109. constructor(name: string);
  65110. /**
  65111. * Gets the current class name
  65112. * @returns the class name
  65113. */
  65114. getClassName(): string;
  65115. /**
  65116. * Gets the rgb component (input)
  65117. */
  65118. get rgbIn(): NodeMaterialConnectionPoint;
  65119. /**
  65120. * Gets the r component (input)
  65121. */
  65122. get r(): NodeMaterialConnectionPoint;
  65123. /**
  65124. * Gets the g component (input)
  65125. */
  65126. get g(): NodeMaterialConnectionPoint;
  65127. /**
  65128. * Gets the b component (input)
  65129. */
  65130. get b(): NodeMaterialConnectionPoint;
  65131. /**
  65132. * Gets the a component (input)
  65133. */
  65134. get a(): NodeMaterialConnectionPoint;
  65135. /**
  65136. * Gets the rgba component (output)
  65137. */
  65138. get rgba(): NodeMaterialConnectionPoint;
  65139. /**
  65140. * Gets the rgb component (output)
  65141. */
  65142. get rgbOut(): NodeMaterialConnectionPoint;
  65143. /**
  65144. * Gets the rgb component (output)
  65145. * @deprecated Please use rgbOut instead.
  65146. */
  65147. get rgb(): NodeMaterialConnectionPoint;
  65148. protected _buildBlock(state: NodeMaterialBuildState): this;
  65149. }
  65150. }
  65151. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  65152. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65153. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65154. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65155. /**
  65156. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  65157. */
  65158. export class VectorSplitterBlock extends NodeMaterialBlock {
  65159. /**
  65160. * Create a new VectorSplitterBlock
  65161. * @param name defines the block name
  65162. */
  65163. constructor(name: string);
  65164. /**
  65165. * Gets the current class name
  65166. * @returns the class name
  65167. */
  65168. getClassName(): string;
  65169. /**
  65170. * Gets the xyzw component (input)
  65171. */
  65172. get xyzw(): NodeMaterialConnectionPoint;
  65173. /**
  65174. * Gets the xyz component (input)
  65175. */
  65176. get xyzIn(): NodeMaterialConnectionPoint;
  65177. /**
  65178. * Gets the xy component (input)
  65179. */
  65180. get xyIn(): NodeMaterialConnectionPoint;
  65181. /**
  65182. * Gets the xyz component (output)
  65183. */
  65184. get xyzOut(): NodeMaterialConnectionPoint;
  65185. /**
  65186. * Gets the xy component (output)
  65187. */
  65188. get xyOut(): NodeMaterialConnectionPoint;
  65189. /**
  65190. * Gets the x component (output)
  65191. */
  65192. get x(): NodeMaterialConnectionPoint;
  65193. /**
  65194. * Gets the y component (output)
  65195. */
  65196. get y(): NodeMaterialConnectionPoint;
  65197. /**
  65198. * Gets the z component (output)
  65199. */
  65200. get z(): NodeMaterialConnectionPoint;
  65201. /**
  65202. * Gets the w component (output)
  65203. */
  65204. get w(): NodeMaterialConnectionPoint;
  65205. protected _inputRename(name: string): string;
  65206. protected _outputRename(name: string): string;
  65207. protected _buildBlock(state: NodeMaterialBuildState): this;
  65208. }
  65209. }
  65210. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  65211. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65212. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65213. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65214. /**
  65215. * Block used to lerp between 2 values
  65216. */
  65217. export class LerpBlock extends NodeMaterialBlock {
  65218. /**
  65219. * Creates a new LerpBlock
  65220. * @param name defines the block name
  65221. */
  65222. constructor(name: string);
  65223. /**
  65224. * Gets the current class name
  65225. * @returns the class name
  65226. */
  65227. getClassName(): string;
  65228. /**
  65229. * Gets the left operand input component
  65230. */
  65231. get left(): NodeMaterialConnectionPoint;
  65232. /**
  65233. * Gets the right operand input component
  65234. */
  65235. get right(): NodeMaterialConnectionPoint;
  65236. /**
  65237. * Gets the gradient operand input component
  65238. */
  65239. get gradient(): NodeMaterialConnectionPoint;
  65240. /**
  65241. * Gets the output component
  65242. */
  65243. get output(): NodeMaterialConnectionPoint;
  65244. protected _buildBlock(state: NodeMaterialBuildState): this;
  65245. }
  65246. }
  65247. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  65248. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65249. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65250. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65251. /**
  65252. * Block used to divide 2 vectors
  65253. */
  65254. export class DivideBlock extends NodeMaterialBlock {
  65255. /**
  65256. * Creates a new DivideBlock
  65257. * @param name defines the block name
  65258. */
  65259. constructor(name: string);
  65260. /**
  65261. * Gets the current class name
  65262. * @returns the class name
  65263. */
  65264. getClassName(): string;
  65265. /**
  65266. * Gets the left operand input component
  65267. */
  65268. get left(): NodeMaterialConnectionPoint;
  65269. /**
  65270. * Gets the right operand input component
  65271. */
  65272. get right(): NodeMaterialConnectionPoint;
  65273. /**
  65274. * Gets the output component
  65275. */
  65276. get output(): NodeMaterialConnectionPoint;
  65277. protected _buildBlock(state: NodeMaterialBuildState): this;
  65278. }
  65279. }
  65280. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  65281. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65282. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65283. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65284. /**
  65285. * Block used to subtract 2 vectors
  65286. */
  65287. export class SubtractBlock extends NodeMaterialBlock {
  65288. /**
  65289. * Creates a new SubtractBlock
  65290. * @param name defines the block name
  65291. */
  65292. constructor(name: string);
  65293. /**
  65294. * Gets the current class name
  65295. * @returns the class name
  65296. */
  65297. getClassName(): string;
  65298. /**
  65299. * Gets the left operand input component
  65300. */
  65301. get left(): NodeMaterialConnectionPoint;
  65302. /**
  65303. * Gets the right operand input component
  65304. */
  65305. get right(): NodeMaterialConnectionPoint;
  65306. /**
  65307. * Gets the output component
  65308. */
  65309. get output(): NodeMaterialConnectionPoint;
  65310. protected _buildBlock(state: NodeMaterialBuildState): this;
  65311. }
  65312. }
  65313. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  65314. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65315. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65316. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65317. /**
  65318. * Block used to step a value
  65319. */
  65320. export class StepBlock extends NodeMaterialBlock {
  65321. /**
  65322. * Creates a new StepBlock
  65323. * @param name defines the block name
  65324. */
  65325. constructor(name: string);
  65326. /**
  65327. * Gets the current class name
  65328. * @returns the class name
  65329. */
  65330. getClassName(): string;
  65331. /**
  65332. * Gets the value operand input component
  65333. */
  65334. get value(): NodeMaterialConnectionPoint;
  65335. /**
  65336. * Gets the edge operand input component
  65337. */
  65338. get edge(): NodeMaterialConnectionPoint;
  65339. /**
  65340. * Gets the output component
  65341. */
  65342. get output(): NodeMaterialConnectionPoint;
  65343. protected _buildBlock(state: NodeMaterialBuildState): this;
  65344. }
  65345. }
  65346. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  65347. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65348. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65349. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65350. /**
  65351. * Block used to get the opposite (1 - x) of a value
  65352. */
  65353. export class OneMinusBlock extends NodeMaterialBlock {
  65354. /**
  65355. * Creates a new OneMinusBlock
  65356. * @param name defines the block name
  65357. */
  65358. constructor(name: string);
  65359. /**
  65360. * Gets the current class name
  65361. * @returns the class name
  65362. */
  65363. getClassName(): string;
  65364. /**
  65365. * Gets the input component
  65366. */
  65367. get input(): NodeMaterialConnectionPoint;
  65368. /**
  65369. * Gets the output component
  65370. */
  65371. get output(): NodeMaterialConnectionPoint;
  65372. protected _buildBlock(state: NodeMaterialBuildState): this;
  65373. }
  65374. }
  65375. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  65376. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65377. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65378. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65379. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65380. /**
  65381. * Block used to get the view direction
  65382. */
  65383. export class ViewDirectionBlock extends NodeMaterialBlock {
  65384. /**
  65385. * Creates a new ViewDirectionBlock
  65386. * @param name defines the block name
  65387. */
  65388. constructor(name: string);
  65389. /**
  65390. * Gets the current class name
  65391. * @returns the class name
  65392. */
  65393. getClassName(): string;
  65394. /**
  65395. * Gets the world position component
  65396. */
  65397. get worldPosition(): NodeMaterialConnectionPoint;
  65398. /**
  65399. * Gets the camera position component
  65400. */
  65401. get cameraPosition(): NodeMaterialConnectionPoint;
  65402. /**
  65403. * Gets the output component
  65404. */
  65405. get output(): NodeMaterialConnectionPoint;
  65406. autoConfigure(material: NodeMaterial): void;
  65407. protected _buildBlock(state: NodeMaterialBuildState): this;
  65408. }
  65409. }
  65410. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  65411. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65412. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65413. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65414. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65415. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  65416. /**
  65417. * Block used to compute fresnel value
  65418. */
  65419. export class FresnelBlock extends NodeMaterialBlock {
  65420. /**
  65421. * Create a new FresnelBlock
  65422. * @param name defines the block name
  65423. */
  65424. constructor(name: string);
  65425. /**
  65426. * Gets the current class name
  65427. * @returns the class name
  65428. */
  65429. getClassName(): string;
  65430. /**
  65431. * Gets the world normal input component
  65432. */
  65433. get worldNormal(): NodeMaterialConnectionPoint;
  65434. /**
  65435. * Gets the view direction input component
  65436. */
  65437. get viewDirection(): NodeMaterialConnectionPoint;
  65438. /**
  65439. * Gets the bias input component
  65440. */
  65441. get bias(): NodeMaterialConnectionPoint;
  65442. /**
  65443. * Gets the camera (or eye) position component
  65444. */
  65445. get power(): NodeMaterialConnectionPoint;
  65446. /**
  65447. * Gets the fresnel output component
  65448. */
  65449. get fresnel(): NodeMaterialConnectionPoint;
  65450. autoConfigure(material: NodeMaterial): void;
  65451. protected _buildBlock(state: NodeMaterialBuildState): this;
  65452. }
  65453. }
  65454. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  65455. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65456. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65457. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65458. /**
  65459. * Block used to get the max of 2 values
  65460. */
  65461. export class MaxBlock extends NodeMaterialBlock {
  65462. /**
  65463. * Creates a new MaxBlock
  65464. * @param name defines the block name
  65465. */
  65466. constructor(name: string);
  65467. /**
  65468. * Gets the current class name
  65469. * @returns the class name
  65470. */
  65471. getClassName(): string;
  65472. /**
  65473. * Gets the left operand input component
  65474. */
  65475. get left(): NodeMaterialConnectionPoint;
  65476. /**
  65477. * Gets the right operand input component
  65478. */
  65479. get right(): NodeMaterialConnectionPoint;
  65480. /**
  65481. * Gets the output component
  65482. */
  65483. get output(): NodeMaterialConnectionPoint;
  65484. protected _buildBlock(state: NodeMaterialBuildState): this;
  65485. }
  65486. }
  65487. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  65488. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65489. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65490. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65491. /**
  65492. * Block used to get the min of 2 values
  65493. */
  65494. export class MinBlock extends NodeMaterialBlock {
  65495. /**
  65496. * Creates a new MinBlock
  65497. * @param name defines the block name
  65498. */
  65499. constructor(name: string);
  65500. /**
  65501. * Gets the current class name
  65502. * @returns the class name
  65503. */
  65504. getClassName(): string;
  65505. /**
  65506. * Gets the left operand input component
  65507. */
  65508. get left(): NodeMaterialConnectionPoint;
  65509. /**
  65510. * Gets the right operand input component
  65511. */
  65512. get right(): NodeMaterialConnectionPoint;
  65513. /**
  65514. * Gets the output component
  65515. */
  65516. get output(): NodeMaterialConnectionPoint;
  65517. protected _buildBlock(state: NodeMaterialBuildState): this;
  65518. }
  65519. }
  65520. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  65521. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65522. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65523. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65524. /**
  65525. * Block used to get the distance between 2 values
  65526. */
  65527. export class DistanceBlock extends NodeMaterialBlock {
  65528. /**
  65529. * Creates a new DistanceBlock
  65530. * @param name defines the block name
  65531. */
  65532. constructor(name: string);
  65533. /**
  65534. * Gets the current class name
  65535. * @returns the class name
  65536. */
  65537. getClassName(): string;
  65538. /**
  65539. * Gets the left operand input component
  65540. */
  65541. get left(): NodeMaterialConnectionPoint;
  65542. /**
  65543. * Gets the right operand input component
  65544. */
  65545. get right(): NodeMaterialConnectionPoint;
  65546. /**
  65547. * Gets the output component
  65548. */
  65549. get output(): NodeMaterialConnectionPoint;
  65550. protected _buildBlock(state: NodeMaterialBuildState): this;
  65551. }
  65552. }
  65553. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  65554. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65555. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65556. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65557. /**
  65558. * Block used to get the length of a vector
  65559. */
  65560. export class LengthBlock extends NodeMaterialBlock {
  65561. /**
  65562. * Creates a new LengthBlock
  65563. * @param name defines the block name
  65564. */
  65565. constructor(name: string);
  65566. /**
  65567. * Gets the current class name
  65568. * @returns the class name
  65569. */
  65570. getClassName(): string;
  65571. /**
  65572. * Gets the value input component
  65573. */
  65574. get value(): NodeMaterialConnectionPoint;
  65575. /**
  65576. * Gets the output component
  65577. */
  65578. get output(): NodeMaterialConnectionPoint;
  65579. protected _buildBlock(state: NodeMaterialBuildState): this;
  65580. }
  65581. }
  65582. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  65583. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65584. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65585. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65586. /**
  65587. * Block used to get negative version of a value (i.e. x * -1)
  65588. */
  65589. export class NegateBlock extends NodeMaterialBlock {
  65590. /**
  65591. * Creates a new NegateBlock
  65592. * @param name defines the block name
  65593. */
  65594. constructor(name: string);
  65595. /**
  65596. * Gets the current class name
  65597. * @returns the class name
  65598. */
  65599. getClassName(): string;
  65600. /**
  65601. * Gets the value input component
  65602. */
  65603. get value(): NodeMaterialConnectionPoint;
  65604. /**
  65605. * Gets the output component
  65606. */
  65607. get output(): NodeMaterialConnectionPoint;
  65608. protected _buildBlock(state: NodeMaterialBuildState): this;
  65609. }
  65610. }
  65611. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  65612. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65613. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65614. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65615. /**
  65616. * Block used to get the value of the first parameter raised to the power of the second
  65617. */
  65618. export class PowBlock extends NodeMaterialBlock {
  65619. /**
  65620. * Creates a new PowBlock
  65621. * @param name defines the block name
  65622. */
  65623. constructor(name: string);
  65624. /**
  65625. * Gets the current class name
  65626. * @returns the class name
  65627. */
  65628. getClassName(): string;
  65629. /**
  65630. * Gets the value operand input component
  65631. */
  65632. get value(): NodeMaterialConnectionPoint;
  65633. /**
  65634. * Gets the power operand input component
  65635. */
  65636. get power(): NodeMaterialConnectionPoint;
  65637. /**
  65638. * Gets the output component
  65639. */
  65640. get output(): NodeMaterialConnectionPoint;
  65641. protected _buildBlock(state: NodeMaterialBuildState): this;
  65642. }
  65643. }
  65644. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  65645. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65646. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65647. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65648. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65649. /**
  65650. * Block used to get a random number
  65651. */
  65652. export class RandomNumberBlock extends NodeMaterialBlock {
  65653. /**
  65654. * Creates a new RandomNumberBlock
  65655. * @param name defines the block name
  65656. */
  65657. constructor(name: string);
  65658. /**
  65659. * Gets the current class name
  65660. * @returns the class name
  65661. */
  65662. getClassName(): string;
  65663. /**
  65664. * Gets the seed input component
  65665. */
  65666. get seed(): NodeMaterialConnectionPoint;
  65667. /**
  65668. * Gets the output component
  65669. */
  65670. get output(): NodeMaterialConnectionPoint;
  65671. protected _buildBlock(state: NodeMaterialBuildState): this;
  65672. }
  65673. }
  65674. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  65675. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65676. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65677. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65678. /**
  65679. * Block used to compute arc tangent of 2 values
  65680. */
  65681. export class ArcTan2Block extends NodeMaterialBlock {
  65682. /**
  65683. * Creates a new ArcTan2Block
  65684. * @param name defines the block name
  65685. */
  65686. constructor(name: string);
  65687. /**
  65688. * Gets the current class name
  65689. * @returns the class name
  65690. */
  65691. getClassName(): string;
  65692. /**
  65693. * Gets the x operand input component
  65694. */
  65695. get x(): NodeMaterialConnectionPoint;
  65696. /**
  65697. * Gets the y operand input component
  65698. */
  65699. get y(): NodeMaterialConnectionPoint;
  65700. /**
  65701. * Gets the output component
  65702. */
  65703. get output(): NodeMaterialConnectionPoint;
  65704. protected _buildBlock(state: NodeMaterialBuildState): this;
  65705. }
  65706. }
  65707. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  65708. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65709. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65710. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65711. /**
  65712. * Block used to smooth step a value
  65713. */
  65714. export class SmoothStepBlock extends NodeMaterialBlock {
  65715. /**
  65716. * Creates a new SmoothStepBlock
  65717. * @param name defines the block name
  65718. */
  65719. constructor(name: string);
  65720. /**
  65721. * Gets the current class name
  65722. * @returns the class name
  65723. */
  65724. getClassName(): string;
  65725. /**
  65726. * Gets the value operand input component
  65727. */
  65728. get value(): NodeMaterialConnectionPoint;
  65729. /**
  65730. * Gets the first edge operand input component
  65731. */
  65732. get edge0(): NodeMaterialConnectionPoint;
  65733. /**
  65734. * Gets the second edge operand input component
  65735. */
  65736. get edge1(): NodeMaterialConnectionPoint;
  65737. /**
  65738. * Gets the output component
  65739. */
  65740. get output(): NodeMaterialConnectionPoint;
  65741. protected _buildBlock(state: NodeMaterialBuildState): this;
  65742. }
  65743. }
  65744. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  65745. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65746. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65747. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65748. /**
  65749. * Block used to get the reciprocal (1 / x) of a value
  65750. */
  65751. export class ReciprocalBlock extends NodeMaterialBlock {
  65752. /**
  65753. * Creates a new ReciprocalBlock
  65754. * @param name defines the block name
  65755. */
  65756. constructor(name: string);
  65757. /**
  65758. * Gets the current class name
  65759. * @returns the class name
  65760. */
  65761. getClassName(): string;
  65762. /**
  65763. * Gets the input component
  65764. */
  65765. get input(): NodeMaterialConnectionPoint;
  65766. /**
  65767. * Gets the output component
  65768. */
  65769. get output(): NodeMaterialConnectionPoint;
  65770. protected _buildBlock(state: NodeMaterialBuildState): this;
  65771. }
  65772. }
  65773. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  65774. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65775. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65776. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65777. /**
  65778. * Block used to replace a color by another one
  65779. */
  65780. export class ReplaceColorBlock extends NodeMaterialBlock {
  65781. /**
  65782. * Creates a new ReplaceColorBlock
  65783. * @param name defines the block name
  65784. */
  65785. constructor(name: string);
  65786. /**
  65787. * Gets the current class name
  65788. * @returns the class name
  65789. */
  65790. getClassName(): string;
  65791. /**
  65792. * Gets the value input component
  65793. */
  65794. get value(): NodeMaterialConnectionPoint;
  65795. /**
  65796. * Gets the reference input component
  65797. */
  65798. get reference(): NodeMaterialConnectionPoint;
  65799. /**
  65800. * Gets the distance input component
  65801. */
  65802. get distance(): NodeMaterialConnectionPoint;
  65803. /**
  65804. * Gets the replacement input component
  65805. */
  65806. get replacement(): NodeMaterialConnectionPoint;
  65807. /**
  65808. * Gets the output component
  65809. */
  65810. get output(): NodeMaterialConnectionPoint;
  65811. protected _buildBlock(state: NodeMaterialBuildState): this;
  65812. }
  65813. }
  65814. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  65815. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65816. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65817. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65818. /**
  65819. * Block used to posterize a value
  65820. * @see https://en.wikipedia.org/wiki/Posterization
  65821. */
  65822. export class PosterizeBlock extends NodeMaterialBlock {
  65823. /**
  65824. * Creates a new PosterizeBlock
  65825. * @param name defines the block name
  65826. */
  65827. constructor(name: string);
  65828. /**
  65829. * Gets the current class name
  65830. * @returns the class name
  65831. */
  65832. getClassName(): string;
  65833. /**
  65834. * Gets the value input component
  65835. */
  65836. get value(): NodeMaterialConnectionPoint;
  65837. /**
  65838. * Gets the steps input component
  65839. */
  65840. get steps(): NodeMaterialConnectionPoint;
  65841. /**
  65842. * Gets the output component
  65843. */
  65844. get output(): NodeMaterialConnectionPoint;
  65845. protected _buildBlock(state: NodeMaterialBuildState): this;
  65846. }
  65847. }
  65848. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  65849. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65850. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65851. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65852. import { Scene } from "babylonjs/scene";
  65853. /**
  65854. * Operations supported by the Wave block
  65855. */
  65856. export enum WaveBlockKind {
  65857. /** SawTooth */
  65858. SawTooth = 0,
  65859. /** Square */
  65860. Square = 1,
  65861. /** Triangle */
  65862. Triangle = 2
  65863. }
  65864. /**
  65865. * Block used to apply wave operation to floats
  65866. */
  65867. export class WaveBlock extends NodeMaterialBlock {
  65868. /**
  65869. * Gets or sets the kibnd of wave to be applied by the block
  65870. */
  65871. kind: WaveBlockKind;
  65872. /**
  65873. * Creates a new WaveBlock
  65874. * @param name defines the block name
  65875. */
  65876. constructor(name: string);
  65877. /**
  65878. * Gets the current class name
  65879. * @returns the class name
  65880. */
  65881. getClassName(): string;
  65882. /**
  65883. * Gets the input component
  65884. */
  65885. get input(): NodeMaterialConnectionPoint;
  65886. /**
  65887. * Gets the output component
  65888. */
  65889. get output(): NodeMaterialConnectionPoint;
  65890. protected _buildBlock(state: NodeMaterialBuildState): this;
  65891. serialize(): any;
  65892. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65893. }
  65894. }
  65895. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  65896. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65897. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65898. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65899. import { Color3 } from "babylonjs/Maths/math.color";
  65900. import { Scene } from "babylonjs/scene";
  65901. /**
  65902. * Class used to store a color step for the GradientBlock
  65903. */
  65904. export class GradientBlockColorStep {
  65905. /**
  65906. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  65907. */
  65908. step: number;
  65909. /**
  65910. * Gets or sets the color associated with this step
  65911. */
  65912. color: Color3;
  65913. /**
  65914. * Creates a new GradientBlockColorStep
  65915. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  65916. * @param color defines the color associated with this step
  65917. */
  65918. constructor(
  65919. /**
  65920. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  65921. */
  65922. step: number,
  65923. /**
  65924. * Gets or sets the color associated with this step
  65925. */
  65926. color: Color3);
  65927. }
  65928. /**
  65929. * Block used to return a color from a gradient based on an input value between 0 and 1
  65930. */
  65931. export class GradientBlock extends NodeMaterialBlock {
  65932. /**
  65933. * Gets or sets the list of color steps
  65934. */
  65935. colorSteps: GradientBlockColorStep[];
  65936. /**
  65937. * Creates a new GradientBlock
  65938. * @param name defines the block name
  65939. */
  65940. constructor(name: string);
  65941. /**
  65942. * Gets the current class name
  65943. * @returns the class name
  65944. */
  65945. getClassName(): string;
  65946. /**
  65947. * Gets the gradient input component
  65948. */
  65949. get gradient(): NodeMaterialConnectionPoint;
  65950. /**
  65951. * Gets the output component
  65952. */
  65953. get output(): NodeMaterialConnectionPoint;
  65954. private _writeColorConstant;
  65955. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65956. serialize(): any;
  65957. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65958. protected _dumpPropertiesCode(): string;
  65959. }
  65960. }
  65961. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  65962. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65963. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65964. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65965. /**
  65966. * Block used to normalize lerp between 2 values
  65967. */
  65968. export class NLerpBlock extends NodeMaterialBlock {
  65969. /**
  65970. * Creates a new NLerpBlock
  65971. * @param name defines the block name
  65972. */
  65973. constructor(name: string);
  65974. /**
  65975. * Gets the current class name
  65976. * @returns the class name
  65977. */
  65978. getClassName(): string;
  65979. /**
  65980. * Gets the left operand input component
  65981. */
  65982. get left(): NodeMaterialConnectionPoint;
  65983. /**
  65984. * Gets the right operand input component
  65985. */
  65986. get right(): NodeMaterialConnectionPoint;
  65987. /**
  65988. * Gets the gradient operand input component
  65989. */
  65990. get gradient(): NodeMaterialConnectionPoint;
  65991. /**
  65992. * Gets the output component
  65993. */
  65994. get output(): NodeMaterialConnectionPoint;
  65995. protected _buildBlock(state: NodeMaterialBuildState): this;
  65996. }
  65997. }
  65998. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  65999. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66000. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66001. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66002. import { Scene } from "babylonjs/scene";
  66003. /**
  66004. * block used to Generate a Worley Noise 3D Noise Pattern
  66005. */
  66006. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  66007. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  66008. manhattanDistance: boolean;
  66009. /**
  66010. * Creates a new WorleyNoise3DBlock
  66011. * @param name defines the block name
  66012. */
  66013. constructor(name: string);
  66014. /**
  66015. * Gets the current class name
  66016. * @returns the class name
  66017. */
  66018. getClassName(): string;
  66019. /**
  66020. * Gets the seed input component
  66021. */
  66022. get seed(): NodeMaterialConnectionPoint;
  66023. /**
  66024. * Gets the jitter input component
  66025. */
  66026. get jitter(): NodeMaterialConnectionPoint;
  66027. /**
  66028. * Gets the output component
  66029. */
  66030. get output(): NodeMaterialConnectionPoint;
  66031. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66032. /**
  66033. * Exposes the properties to the UI?
  66034. */
  66035. protected _dumpPropertiesCode(): string;
  66036. /**
  66037. * Exposes the properties to the Seralize?
  66038. */
  66039. serialize(): any;
  66040. /**
  66041. * Exposes the properties to the deseralize?
  66042. */
  66043. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66044. }
  66045. }
  66046. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  66047. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66048. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66049. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66050. /**
  66051. * block used to Generate a Simplex Perlin 3d Noise Pattern
  66052. */
  66053. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  66054. /**
  66055. * Creates a new SimplexPerlin3DBlock
  66056. * @param name defines the block name
  66057. */
  66058. constructor(name: string);
  66059. /**
  66060. * Gets the current class name
  66061. * @returns the class name
  66062. */
  66063. getClassName(): string;
  66064. /**
  66065. * Gets the seed operand input component
  66066. */
  66067. get seed(): NodeMaterialConnectionPoint;
  66068. /**
  66069. * Gets the output component
  66070. */
  66071. get output(): NodeMaterialConnectionPoint;
  66072. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66073. }
  66074. }
  66075. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  66076. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66077. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66078. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66079. /**
  66080. * Block used to blend normals
  66081. */
  66082. export class NormalBlendBlock extends NodeMaterialBlock {
  66083. /**
  66084. * Creates a new NormalBlendBlock
  66085. * @param name defines the block name
  66086. */
  66087. constructor(name: string);
  66088. /**
  66089. * Gets the current class name
  66090. * @returns the class name
  66091. */
  66092. getClassName(): string;
  66093. /**
  66094. * Gets the first input component
  66095. */
  66096. get normalMap0(): NodeMaterialConnectionPoint;
  66097. /**
  66098. * Gets the second input component
  66099. */
  66100. get normalMap1(): NodeMaterialConnectionPoint;
  66101. /**
  66102. * Gets the output component
  66103. */
  66104. get output(): NodeMaterialConnectionPoint;
  66105. protected _buildBlock(state: NodeMaterialBuildState): this;
  66106. }
  66107. }
  66108. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  66109. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66110. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66111. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66112. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66113. /**
  66114. * Block used to rotate a 2d vector by a given angle
  66115. */
  66116. export class Rotate2dBlock extends NodeMaterialBlock {
  66117. /**
  66118. * Creates a new Rotate2dBlock
  66119. * @param name defines the block name
  66120. */
  66121. constructor(name: string);
  66122. /**
  66123. * Gets the current class name
  66124. * @returns the class name
  66125. */
  66126. getClassName(): string;
  66127. /**
  66128. * Gets the input vector
  66129. */
  66130. get input(): NodeMaterialConnectionPoint;
  66131. /**
  66132. * Gets the input angle
  66133. */
  66134. get angle(): NodeMaterialConnectionPoint;
  66135. /**
  66136. * Gets the output component
  66137. */
  66138. get output(): NodeMaterialConnectionPoint;
  66139. autoConfigure(material: NodeMaterial): void;
  66140. protected _buildBlock(state: NodeMaterialBuildState): this;
  66141. }
  66142. }
  66143. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  66144. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66145. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66146. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66147. /**
  66148. * Block used to get the reflected vector from a direction and a normal
  66149. */
  66150. export class ReflectBlock extends NodeMaterialBlock {
  66151. /**
  66152. * Creates a new ReflectBlock
  66153. * @param name defines the block name
  66154. */
  66155. constructor(name: string);
  66156. /**
  66157. * Gets the current class name
  66158. * @returns the class name
  66159. */
  66160. getClassName(): string;
  66161. /**
  66162. * Gets the incident component
  66163. */
  66164. get incident(): NodeMaterialConnectionPoint;
  66165. /**
  66166. * Gets the normal component
  66167. */
  66168. get normal(): NodeMaterialConnectionPoint;
  66169. /**
  66170. * Gets the output component
  66171. */
  66172. get output(): NodeMaterialConnectionPoint;
  66173. protected _buildBlock(state: NodeMaterialBuildState): this;
  66174. }
  66175. }
  66176. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  66177. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66178. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66179. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66180. /**
  66181. * Block used to get the refracted vector from a direction and a normal
  66182. */
  66183. export class RefractBlock extends NodeMaterialBlock {
  66184. /**
  66185. * Creates a new RefractBlock
  66186. * @param name defines the block name
  66187. */
  66188. constructor(name: string);
  66189. /**
  66190. * Gets the current class name
  66191. * @returns the class name
  66192. */
  66193. getClassName(): string;
  66194. /**
  66195. * Gets the incident component
  66196. */
  66197. get incident(): NodeMaterialConnectionPoint;
  66198. /**
  66199. * Gets the normal component
  66200. */
  66201. get normal(): NodeMaterialConnectionPoint;
  66202. /**
  66203. * Gets the index of refraction component
  66204. */
  66205. get ior(): NodeMaterialConnectionPoint;
  66206. /**
  66207. * Gets the output component
  66208. */
  66209. get output(): NodeMaterialConnectionPoint;
  66210. protected _buildBlock(state: NodeMaterialBuildState): this;
  66211. }
  66212. }
  66213. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  66214. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66215. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66216. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66217. /**
  66218. * Block used to desaturate a color
  66219. */
  66220. export class DesaturateBlock extends NodeMaterialBlock {
  66221. /**
  66222. * Creates a new DesaturateBlock
  66223. * @param name defines the block name
  66224. */
  66225. constructor(name: string);
  66226. /**
  66227. * Gets the current class name
  66228. * @returns the class name
  66229. */
  66230. getClassName(): string;
  66231. /**
  66232. * Gets the color operand input component
  66233. */
  66234. get color(): NodeMaterialConnectionPoint;
  66235. /**
  66236. * Gets the level operand input component
  66237. */
  66238. get level(): NodeMaterialConnectionPoint;
  66239. /**
  66240. * Gets the output component
  66241. */
  66242. get output(): NodeMaterialConnectionPoint;
  66243. protected _buildBlock(state: NodeMaterialBuildState): this;
  66244. }
  66245. }
  66246. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  66247. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66248. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66249. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66250. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66251. import { Nullable } from "babylonjs/types";
  66252. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66253. import { Scene } from "babylonjs/scene";
  66254. /**
  66255. * Block used to implement the ambient occlusion module of the PBR material
  66256. */
  66257. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  66258. /**
  66259. * Create a new AmbientOcclusionBlock
  66260. * @param name defines the block name
  66261. */
  66262. constructor(name: string);
  66263. /**
  66264. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  66265. */
  66266. useAmbientInGrayScale: boolean;
  66267. /**
  66268. * Initialize the block and prepare the context for build
  66269. * @param state defines the state that will be used for the build
  66270. */
  66271. initialize(state: NodeMaterialBuildState): void;
  66272. /**
  66273. * Gets the current class name
  66274. * @returns the class name
  66275. */
  66276. getClassName(): string;
  66277. /**
  66278. * Gets the texture input component
  66279. */
  66280. get texture(): NodeMaterialConnectionPoint;
  66281. /**
  66282. * Gets the texture intensity component
  66283. */
  66284. get intensity(): NodeMaterialConnectionPoint;
  66285. /**
  66286. * Gets the direct light intensity input component
  66287. */
  66288. get directLightIntensity(): NodeMaterialConnectionPoint;
  66289. /**
  66290. * Gets the ambient occlusion object output component
  66291. */
  66292. get ambientOcclusion(): NodeMaterialConnectionPoint;
  66293. /**
  66294. * Gets the main code of the block (fragment side)
  66295. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  66296. * @returns the shader code
  66297. */
  66298. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  66299. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66300. protected _buildBlock(state: NodeMaterialBuildState): this;
  66301. protected _dumpPropertiesCode(): string;
  66302. serialize(): any;
  66303. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66304. }
  66305. }
  66306. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  66307. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66308. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66309. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66310. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  66311. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66312. import { Nullable } from "babylonjs/types";
  66313. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  66314. import { Mesh } from "babylonjs/Meshes/mesh";
  66315. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66316. import { Effect } from "babylonjs/Materials/effect";
  66317. import { Scene } from "babylonjs/scene";
  66318. /**
  66319. * Block used to implement the reflection module of the PBR material
  66320. */
  66321. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  66322. /** @hidden */
  66323. _defineLODReflectionAlpha: string;
  66324. /** @hidden */
  66325. _defineLinearSpecularReflection: string;
  66326. private _vEnvironmentIrradianceName;
  66327. /** @hidden */
  66328. _vReflectionMicrosurfaceInfosName: string;
  66329. /** @hidden */
  66330. _vReflectionInfosName: string;
  66331. /** @hidden */
  66332. _vReflectionFilteringInfoName: string;
  66333. private _scene;
  66334. /**
  66335. * The three properties below are set by the main PBR block prior to calling methods of this class.
  66336. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  66337. * It's less burden on the user side in the editor part.
  66338. */
  66339. /** @hidden */
  66340. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  66341. /** @hidden */
  66342. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  66343. /** @hidden */
  66344. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  66345. /**
  66346. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  66347. * diffuse part of the IBL.
  66348. */
  66349. useSphericalHarmonics: boolean;
  66350. /**
  66351. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  66352. */
  66353. forceIrradianceInFragment: boolean;
  66354. /**
  66355. * Create a new ReflectionBlock
  66356. * @param name defines the block name
  66357. */
  66358. constructor(name: string);
  66359. /**
  66360. * Gets the current class name
  66361. * @returns the class name
  66362. */
  66363. getClassName(): string;
  66364. /**
  66365. * Gets the position input component
  66366. */
  66367. get position(): NodeMaterialConnectionPoint;
  66368. /**
  66369. * Gets the world position input component
  66370. */
  66371. get worldPosition(): NodeMaterialConnectionPoint;
  66372. /**
  66373. * Gets the world normal input component
  66374. */
  66375. get worldNormal(): NodeMaterialConnectionPoint;
  66376. /**
  66377. * Gets the world input component
  66378. */
  66379. get world(): NodeMaterialConnectionPoint;
  66380. /**
  66381. * Gets the camera (or eye) position component
  66382. */
  66383. get cameraPosition(): NodeMaterialConnectionPoint;
  66384. /**
  66385. * Gets the view input component
  66386. */
  66387. get view(): NodeMaterialConnectionPoint;
  66388. /**
  66389. * Gets the color input component
  66390. */
  66391. get color(): NodeMaterialConnectionPoint;
  66392. /**
  66393. * Gets the reflection object output component
  66394. */
  66395. get reflection(): NodeMaterialConnectionPoint;
  66396. /**
  66397. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  66398. */
  66399. get hasTexture(): boolean;
  66400. /**
  66401. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  66402. */
  66403. get reflectionColor(): string;
  66404. protected _getTexture(): Nullable<BaseTexture>;
  66405. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66406. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  66407. /**
  66408. * Gets the code to inject in the vertex shader
  66409. * @param state current state of the node material building
  66410. * @returns the shader code
  66411. */
  66412. handleVertexSide(state: NodeMaterialBuildState): string;
  66413. /**
  66414. * Gets the main code of the block (fragment side)
  66415. * @param state current state of the node material building
  66416. * @param normalVarName name of the existing variable corresponding to the normal
  66417. * @returns the shader code
  66418. */
  66419. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  66420. protected _buildBlock(state: NodeMaterialBuildState): this;
  66421. protected _dumpPropertiesCode(): string;
  66422. serialize(): any;
  66423. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66424. }
  66425. }
  66426. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  66427. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66428. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66429. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66430. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66431. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66432. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  66433. import { Scene } from "babylonjs/scene";
  66434. import { Nullable } from "babylonjs/types";
  66435. /**
  66436. * Block used to implement the sheen module of the PBR material
  66437. */
  66438. export class SheenBlock extends NodeMaterialBlock {
  66439. /**
  66440. * Create a new SheenBlock
  66441. * @param name defines the block name
  66442. */
  66443. constructor(name: string);
  66444. /**
  66445. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  66446. * It allows the strength of the sheen effect to not depend on the base color of the material,
  66447. * making it easier to setup and tweak the effect
  66448. */
  66449. albedoScaling: boolean;
  66450. /**
  66451. * Defines if the sheen is linked to the sheen color.
  66452. */
  66453. linkSheenWithAlbedo: boolean;
  66454. /**
  66455. * Initialize the block and prepare the context for build
  66456. * @param state defines the state that will be used for the build
  66457. */
  66458. initialize(state: NodeMaterialBuildState): void;
  66459. /**
  66460. * Gets the current class name
  66461. * @returns the class name
  66462. */
  66463. getClassName(): string;
  66464. /**
  66465. * Gets the intensity input component
  66466. */
  66467. get intensity(): NodeMaterialConnectionPoint;
  66468. /**
  66469. * Gets the color input component
  66470. */
  66471. get color(): NodeMaterialConnectionPoint;
  66472. /**
  66473. * Gets the roughness input component
  66474. */
  66475. get roughness(): NodeMaterialConnectionPoint;
  66476. /**
  66477. * Gets the sheen object output component
  66478. */
  66479. get sheen(): NodeMaterialConnectionPoint;
  66480. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66481. /**
  66482. * Gets the main code of the block (fragment side)
  66483. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  66484. * @returns the shader code
  66485. */
  66486. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  66487. protected _buildBlock(state: NodeMaterialBuildState): this;
  66488. protected _dumpPropertiesCode(): string;
  66489. serialize(): any;
  66490. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66491. }
  66492. }
  66493. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  66494. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66495. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66496. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66497. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66498. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66499. import { Scene } from "babylonjs/scene";
  66500. import { Nullable } from "babylonjs/types";
  66501. import { Mesh } from "babylonjs/Meshes/mesh";
  66502. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66503. import { Effect } from "babylonjs/Materials/effect";
  66504. /**
  66505. * Block used to implement the reflectivity module of the PBR material
  66506. */
  66507. export class ReflectivityBlock extends NodeMaterialBlock {
  66508. private _metallicReflectanceColor;
  66509. private _metallicF0Factor;
  66510. /** @hidden */
  66511. _vMetallicReflectanceFactorsName: string;
  66512. /**
  66513. * The property below is set by the main PBR block prior to calling methods of this class.
  66514. */
  66515. /** @hidden */
  66516. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  66517. /**
  66518. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  66519. */
  66520. useAmbientOcclusionFromMetallicTextureRed: boolean;
  66521. /**
  66522. * Specifies if the metallic texture contains the metallness information in its blue channel.
  66523. */
  66524. useMetallnessFromMetallicTextureBlue: boolean;
  66525. /**
  66526. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  66527. */
  66528. useRoughnessFromMetallicTextureAlpha: boolean;
  66529. /**
  66530. * Specifies if the metallic texture contains the roughness information in its green channel.
  66531. */
  66532. useRoughnessFromMetallicTextureGreen: boolean;
  66533. /**
  66534. * Create a new ReflectivityBlock
  66535. * @param name defines the block name
  66536. */
  66537. constructor(name: string);
  66538. /**
  66539. * Initialize the block and prepare the context for build
  66540. * @param state defines the state that will be used for the build
  66541. */
  66542. initialize(state: NodeMaterialBuildState): void;
  66543. /**
  66544. * Gets the current class name
  66545. * @returns the class name
  66546. */
  66547. getClassName(): string;
  66548. /**
  66549. * Gets the metallic input component
  66550. */
  66551. get metallic(): NodeMaterialConnectionPoint;
  66552. /**
  66553. * Gets the roughness input component
  66554. */
  66555. get roughness(): NodeMaterialConnectionPoint;
  66556. /**
  66557. * Gets the texture input component
  66558. */
  66559. get texture(): NodeMaterialConnectionPoint;
  66560. /**
  66561. * Gets the reflectivity object output component
  66562. */
  66563. get reflectivity(): NodeMaterialConnectionPoint;
  66564. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  66565. /**
  66566. * Gets the main code of the block (fragment side)
  66567. * @param state current state of the node material building
  66568. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  66569. * @returns the shader code
  66570. */
  66571. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  66572. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66573. protected _buildBlock(state: NodeMaterialBuildState): this;
  66574. protected _dumpPropertiesCode(): string;
  66575. serialize(): any;
  66576. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66577. }
  66578. }
  66579. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  66580. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66581. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66582. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66583. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66584. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66585. /**
  66586. * Block used to implement the anisotropy module of the PBR material
  66587. */
  66588. export class AnisotropyBlock extends NodeMaterialBlock {
  66589. /**
  66590. * The two properties below are set by the main PBR block prior to calling methods of this class.
  66591. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  66592. * It's less burden on the user side in the editor part.
  66593. */
  66594. /** @hidden */
  66595. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  66596. /** @hidden */
  66597. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  66598. /**
  66599. * Create a new AnisotropyBlock
  66600. * @param name defines the block name
  66601. */
  66602. constructor(name: string);
  66603. /**
  66604. * Initialize the block and prepare the context for build
  66605. * @param state defines the state that will be used for the build
  66606. */
  66607. initialize(state: NodeMaterialBuildState): void;
  66608. /**
  66609. * Gets the current class name
  66610. * @returns the class name
  66611. */
  66612. getClassName(): string;
  66613. /**
  66614. * Gets the intensity input component
  66615. */
  66616. get intensity(): NodeMaterialConnectionPoint;
  66617. /**
  66618. * Gets the direction input component
  66619. */
  66620. get direction(): NodeMaterialConnectionPoint;
  66621. /**
  66622. * Gets the texture input component
  66623. */
  66624. get texture(): NodeMaterialConnectionPoint;
  66625. /**
  66626. * Gets the uv input component
  66627. */
  66628. get uv(): NodeMaterialConnectionPoint;
  66629. /**
  66630. * Gets the worldTangent input component
  66631. */
  66632. get worldTangent(): NodeMaterialConnectionPoint;
  66633. /**
  66634. * Gets the anisotropy object output component
  66635. */
  66636. get anisotropy(): NodeMaterialConnectionPoint;
  66637. private _generateTBNSpace;
  66638. /**
  66639. * Gets the main code of the block (fragment side)
  66640. * @param state current state of the node material building
  66641. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  66642. * @returns the shader code
  66643. */
  66644. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  66645. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66646. protected _buildBlock(state: NodeMaterialBuildState): this;
  66647. }
  66648. }
  66649. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  66650. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66651. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66652. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66653. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66655. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  66656. import { Nullable } from "babylonjs/types";
  66657. import { Mesh } from "babylonjs/Meshes/mesh";
  66658. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66659. import { Effect } from "babylonjs/Materials/effect";
  66660. /**
  66661. * Block used to implement the clear coat module of the PBR material
  66662. */
  66663. export class ClearCoatBlock extends NodeMaterialBlock {
  66664. private _scene;
  66665. /**
  66666. * Create a new ClearCoatBlock
  66667. * @param name defines the block name
  66668. */
  66669. constructor(name: string);
  66670. /**
  66671. * Initialize the block and prepare the context for build
  66672. * @param state defines the state that will be used for the build
  66673. */
  66674. initialize(state: NodeMaterialBuildState): void;
  66675. /**
  66676. * Gets the current class name
  66677. * @returns the class name
  66678. */
  66679. getClassName(): string;
  66680. /**
  66681. * Gets the intensity input component
  66682. */
  66683. get intensity(): NodeMaterialConnectionPoint;
  66684. /**
  66685. * Gets the roughness input component
  66686. */
  66687. get roughness(): NodeMaterialConnectionPoint;
  66688. /**
  66689. * Gets the ior input component
  66690. */
  66691. get ior(): NodeMaterialConnectionPoint;
  66692. /**
  66693. * Gets the texture input component
  66694. */
  66695. get texture(): NodeMaterialConnectionPoint;
  66696. /**
  66697. * Gets the bump texture input component
  66698. */
  66699. get bumpTexture(): NodeMaterialConnectionPoint;
  66700. /**
  66701. * Gets the uv input component
  66702. */
  66703. get uv(): NodeMaterialConnectionPoint;
  66704. /**
  66705. * Gets the tint color input component
  66706. */
  66707. get tintColor(): NodeMaterialConnectionPoint;
  66708. /**
  66709. * Gets the tint "at distance" input component
  66710. */
  66711. get tintAtDistance(): NodeMaterialConnectionPoint;
  66712. /**
  66713. * Gets the tint thickness input component
  66714. */
  66715. get tintThickness(): NodeMaterialConnectionPoint;
  66716. /**
  66717. * Gets the world tangent input component
  66718. */
  66719. get worldTangent(): NodeMaterialConnectionPoint;
  66720. /**
  66721. * Gets the clear coat object output component
  66722. */
  66723. get clearcoat(): NodeMaterialConnectionPoint;
  66724. autoConfigure(material: NodeMaterial): void;
  66725. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66726. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  66727. private _generateTBNSpace;
  66728. /**
  66729. * Gets the main code of the block (fragment side)
  66730. * @param state current state of the node material building
  66731. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  66732. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  66733. * @param worldPosVarName name of the variable holding the world position
  66734. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  66735. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  66736. * @param worldNormalVarName name of the variable holding the world normal
  66737. * @returns the shader code
  66738. */
  66739. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  66740. protected _buildBlock(state: NodeMaterialBuildState): this;
  66741. }
  66742. }
  66743. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  66744. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66745. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66746. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66747. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66748. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66749. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  66750. import { Nullable } from "babylonjs/types";
  66751. /**
  66752. * Block used to implement the sub surface module of the PBR material
  66753. */
  66754. export class SubSurfaceBlock extends NodeMaterialBlock {
  66755. /**
  66756. * Create a new SubSurfaceBlock
  66757. * @param name defines the block name
  66758. */
  66759. constructor(name: string);
  66760. /**
  66761. * Stores the intensity of the different subsurface effects in the thickness texture.
  66762. * * the green channel is the translucency intensity.
  66763. * * the blue channel is the scattering intensity.
  66764. * * the alpha channel is the refraction intensity.
  66765. */
  66766. useMaskFromThicknessTexture: boolean;
  66767. /**
  66768. * Initialize the block and prepare the context for build
  66769. * @param state defines the state that will be used for the build
  66770. */
  66771. initialize(state: NodeMaterialBuildState): void;
  66772. /**
  66773. * Gets the current class name
  66774. * @returns the class name
  66775. */
  66776. getClassName(): string;
  66777. /**
  66778. * Gets the min thickness input component
  66779. */
  66780. get minThickness(): NodeMaterialConnectionPoint;
  66781. /**
  66782. * Gets the max thickness input component
  66783. */
  66784. get maxThickness(): NodeMaterialConnectionPoint;
  66785. /**
  66786. * Gets the thickness texture component
  66787. */
  66788. get thicknessTexture(): NodeMaterialConnectionPoint;
  66789. /**
  66790. * Gets the tint color input component
  66791. */
  66792. get tintColor(): NodeMaterialConnectionPoint;
  66793. /**
  66794. * Gets the translucency intensity input component
  66795. */
  66796. get translucencyIntensity(): NodeMaterialConnectionPoint;
  66797. /**
  66798. * Gets the translucency diffusion distance input component
  66799. */
  66800. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  66801. /**
  66802. * Gets the refraction object parameters
  66803. */
  66804. get refraction(): NodeMaterialConnectionPoint;
  66805. /**
  66806. * Gets the sub surface object output component
  66807. */
  66808. get subsurface(): NodeMaterialConnectionPoint;
  66809. autoConfigure(material: NodeMaterial): void;
  66810. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66811. /**
  66812. * Gets the main code of the block (fragment side)
  66813. * @param state current state of the node material building
  66814. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  66815. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  66816. * @param worldPosVarName name of the variable holding the world position
  66817. * @returns the shader code
  66818. */
  66819. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  66820. protected _buildBlock(state: NodeMaterialBuildState): this;
  66821. }
  66822. }
  66823. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  66824. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66825. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66826. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66827. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66828. import { Light } from "babylonjs/Lights/light";
  66829. import { Nullable } from "babylonjs/types";
  66830. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66831. import { Effect } from "babylonjs/Materials/effect";
  66832. import { Mesh } from "babylonjs/Meshes/mesh";
  66833. import { Scene } from "babylonjs/scene";
  66834. /**
  66835. * Block used to implement the PBR metallic/roughness model
  66836. */
  66837. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  66838. /**
  66839. * Gets or sets the light associated with this block
  66840. */
  66841. light: Nullable<Light>;
  66842. private _lightId;
  66843. private _scene;
  66844. private _environmentBRDFTexture;
  66845. private _environmentBrdfSamplerName;
  66846. private _vNormalWName;
  66847. private _invertNormalName;
  66848. /**
  66849. * Create a new ReflectionBlock
  66850. * @param name defines the block name
  66851. */
  66852. constructor(name: string);
  66853. /**
  66854. * Intensity of the direct lights e.g. the four lights available in your scene.
  66855. * This impacts both the direct diffuse and specular highlights.
  66856. */
  66857. directIntensity: number;
  66858. /**
  66859. * Intensity of the environment e.g. how much the environment will light the object
  66860. * either through harmonics for rough material or through the refelction for shiny ones.
  66861. */
  66862. environmentIntensity: number;
  66863. /**
  66864. * This is a special control allowing the reduction of the specular highlights coming from the
  66865. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  66866. */
  66867. specularIntensity: number;
  66868. /**
  66869. * Defines the falloff type used in this material.
  66870. * It by default is Physical.
  66871. */
  66872. lightFalloff: number;
  66873. /**
  66874. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  66875. */
  66876. useAlphaFromAlbedoTexture: boolean;
  66877. /**
  66878. * Specifies that alpha test should be used
  66879. */
  66880. useAlphaTest: boolean;
  66881. /**
  66882. * Defines the alpha limits in alpha test mode.
  66883. */
  66884. alphaTestCutoff: number;
  66885. /**
  66886. * Specifies that alpha blending should be used
  66887. */
  66888. useAlphaBlending: boolean;
  66889. /**
  66890. * Defines if the alpha value should be determined via the rgb values.
  66891. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  66892. */
  66893. opacityRGB: boolean;
  66894. /**
  66895. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  66896. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  66897. */
  66898. useRadianceOverAlpha: boolean;
  66899. /**
  66900. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  66901. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  66902. */
  66903. useSpecularOverAlpha: boolean;
  66904. /**
  66905. * Enables specular anti aliasing in the PBR shader.
  66906. * It will both interacts on the Geometry for analytical and IBL lighting.
  66907. * It also prefilter the roughness map based on the bump values.
  66908. */
  66909. enableSpecularAntiAliasing: boolean;
  66910. /**
  66911. * Enables realtime filtering on the texture.
  66912. */
  66913. realTimeFiltering: boolean;
  66914. /**
  66915. * Quality switch for realtime filtering
  66916. */
  66917. realTimeFilteringQuality: number;
  66918. /**
  66919. * Defines if the material uses energy conservation.
  66920. */
  66921. useEnergyConservation: boolean;
  66922. /**
  66923. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  66924. * too much the area relying on ambient texture to define their ambient occlusion.
  66925. */
  66926. useRadianceOcclusion: boolean;
  66927. /**
  66928. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  66929. * makes the reflect vector face the model (under horizon).
  66930. */
  66931. useHorizonOcclusion: boolean;
  66932. /**
  66933. * If set to true, no lighting calculations will be applied.
  66934. */
  66935. unlit: boolean;
  66936. /**
  66937. * Force normal to face away from face.
  66938. */
  66939. forceNormalForward: boolean;
  66940. /**
  66941. * Defines the material debug mode.
  66942. * It helps seeing only some components of the material while troubleshooting.
  66943. */
  66944. debugMode: number;
  66945. /**
  66946. * Specify from where on screen the debug mode should start.
  66947. * The value goes from -1 (full screen) to 1 (not visible)
  66948. * It helps with side by side comparison against the final render
  66949. * This defaults to 0
  66950. */
  66951. debugLimit: number;
  66952. /**
  66953. * As the default viewing range might not be enough (if the ambient is really small for instance)
  66954. * You can use the factor to better multiply the final value.
  66955. */
  66956. debugFactor: number;
  66957. /**
  66958. * Initialize the block and prepare the context for build
  66959. * @param state defines the state that will be used for the build
  66960. */
  66961. initialize(state: NodeMaterialBuildState): void;
  66962. /**
  66963. * Gets the current class name
  66964. * @returns the class name
  66965. */
  66966. getClassName(): string;
  66967. /**
  66968. * Gets the world position input component
  66969. */
  66970. get worldPosition(): NodeMaterialConnectionPoint;
  66971. /**
  66972. * Gets the world normal input component
  66973. */
  66974. get worldNormal(): NodeMaterialConnectionPoint;
  66975. /**
  66976. * Gets the perturbed normal input component
  66977. */
  66978. get perturbedNormal(): NodeMaterialConnectionPoint;
  66979. /**
  66980. * Gets the camera position input component
  66981. */
  66982. get cameraPosition(): NodeMaterialConnectionPoint;
  66983. /**
  66984. * Gets the base color input component
  66985. */
  66986. get baseColor(): NodeMaterialConnectionPoint;
  66987. /**
  66988. * Gets the opacity texture input component
  66989. */
  66990. get opacityTexture(): NodeMaterialConnectionPoint;
  66991. /**
  66992. * Gets the ambient color input component
  66993. */
  66994. get ambientColor(): NodeMaterialConnectionPoint;
  66995. /**
  66996. * Gets the reflectivity object parameters
  66997. */
  66998. get reflectivity(): NodeMaterialConnectionPoint;
  66999. /**
  67000. * Gets the ambient occlusion object parameters
  67001. */
  67002. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67003. /**
  67004. * Gets the reflection object parameters
  67005. */
  67006. get reflection(): NodeMaterialConnectionPoint;
  67007. /**
  67008. * Gets the sheen object parameters
  67009. */
  67010. get sheen(): NodeMaterialConnectionPoint;
  67011. /**
  67012. * Gets the clear coat object parameters
  67013. */
  67014. get clearcoat(): NodeMaterialConnectionPoint;
  67015. /**
  67016. * Gets the sub surface object parameters
  67017. */
  67018. get subsurface(): NodeMaterialConnectionPoint;
  67019. /**
  67020. * Gets the anisotropy object parameters
  67021. */
  67022. get anisotropy(): NodeMaterialConnectionPoint;
  67023. /**
  67024. * Gets the ambient output component
  67025. */
  67026. get ambient(): NodeMaterialConnectionPoint;
  67027. /**
  67028. * Gets the diffuse output component
  67029. */
  67030. get diffuse(): NodeMaterialConnectionPoint;
  67031. /**
  67032. * Gets the specular output component
  67033. */
  67034. get specular(): NodeMaterialConnectionPoint;
  67035. /**
  67036. * Gets the sheen output component
  67037. */
  67038. get sheenDir(): NodeMaterialConnectionPoint;
  67039. /**
  67040. * Gets the clear coat output component
  67041. */
  67042. get clearcoatDir(): NodeMaterialConnectionPoint;
  67043. /**
  67044. * Gets the indirect diffuse output component
  67045. */
  67046. get diffuseIndirect(): NodeMaterialConnectionPoint;
  67047. /**
  67048. * Gets the indirect specular output component
  67049. */
  67050. get specularIndirect(): NodeMaterialConnectionPoint;
  67051. /**
  67052. * Gets the indirect sheen output component
  67053. */
  67054. get sheenIndirect(): NodeMaterialConnectionPoint;
  67055. /**
  67056. * Gets the indirect clear coat output component
  67057. */
  67058. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  67059. /**
  67060. * Gets the refraction output component
  67061. */
  67062. get refraction(): NodeMaterialConnectionPoint;
  67063. /**
  67064. * Gets the global lighting output component
  67065. */
  67066. get lighting(): NodeMaterialConnectionPoint;
  67067. /**
  67068. * Gets the shadow output component
  67069. */
  67070. get shadow(): NodeMaterialConnectionPoint;
  67071. /**
  67072. * Gets the alpha output component
  67073. */
  67074. get alpha(): NodeMaterialConnectionPoint;
  67075. autoConfigure(material: NodeMaterial): void;
  67076. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67077. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  67078. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  67079. private _injectVertexCode;
  67080. /**
  67081. * Gets the code corresponding to the albedo/opacity module
  67082. * @returns the shader code
  67083. */
  67084. getAlbedoOpacityCode(): string;
  67085. protected _buildBlock(state: NodeMaterialBuildState): this;
  67086. protected _dumpPropertiesCode(): string;
  67087. serialize(): any;
  67088. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67089. }
  67090. }
  67091. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  67092. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  67093. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  67094. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  67095. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  67096. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  67097. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67098. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  67099. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  67100. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  67101. }
  67102. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  67103. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  67104. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  67105. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  67106. }
  67107. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  67108. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67109. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67110. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67111. /**
  67112. * Block used to compute value of one parameter modulo another
  67113. */
  67114. export class ModBlock extends NodeMaterialBlock {
  67115. /**
  67116. * Creates a new ModBlock
  67117. * @param name defines the block name
  67118. */
  67119. constructor(name: string);
  67120. /**
  67121. * Gets the current class name
  67122. * @returns the class name
  67123. */
  67124. getClassName(): string;
  67125. /**
  67126. * Gets the left operand input component
  67127. */
  67128. get left(): NodeMaterialConnectionPoint;
  67129. /**
  67130. * Gets the right operand input component
  67131. */
  67132. get right(): NodeMaterialConnectionPoint;
  67133. /**
  67134. * Gets the output component
  67135. */
  67136. get output(): NodeMaterialConnectionPoint;
  67137. protected _buildBlock(state: NodeMaterialBuildState): this;
  67138. }
  67139. }
  67140. declare module "babylonjs/Materials/Node/Blocks/index" {
  67141. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  67142. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  67143. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  67144. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  67145. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  67146. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  67147. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  67148. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  67149. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  67150. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  67151. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  67152. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  67153. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  67154. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  67155. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  67156. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  67157. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  67158. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  67159. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  67160. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  67161. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  67162. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  67163. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  67164. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  67165. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  67166. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  67167. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  67168. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  67169. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  67170. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  67171. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  67172. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  67173. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  67174. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  67175. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  67176. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  67177. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  67178. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  67179. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  67180. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  67181. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  67182. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  67183. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  67184. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  67185. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  67186. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  67187. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  67188. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  67189. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  67190. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  67191. }
  67192. declare module "babylonjs/Materials/Node/Optimizers/index" {
  67193. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  67194. }
  67195. declare module "babylonjs/Materials/Node/index" {
  67196. export * from "babylonjs/Materials/Node/Enums/index";
  67197. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67198. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  67199. export * from "babylonjs/Materials/Node/nodeMaterial";
  67200. export * from "babylonjs/Materials/Node/Blocks/index";
  67201. export * from "babylonjs/Materials/Node/Optimizers/index";
  67202. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  67203. }
  67204. declare module "babylonjs/Materials/index" {
  67205. export * from "babylonjs/Materials/Background/index";
  67206. export * from "babylonjs/Materials/colorCurves";
  67207. export * from "babylonjs/Materials/iEffectFallbacks";
  67208. export * from "babylonjs/Materials/effectFallbacks";
  67209. export * from "babylonjs/Materials/effect";
  67210. export * from "babylonjs/Materials/fresnelParameters";
  67211. export * from "babylonjs/Materials/imageProcessingConfiguration";
  67212. export * from "babylonjs/Materials/material";
  67213. export * from "babylonjs/Materials/materialDefines";
  67214. export * from "babylonjs/Materials/materialHelper";
  67215. export * from "babylonjs/Materials/multiMaterial";
  67216. export * from "babylonjs/Materials/PBR/index";
  67217. export * from "babylonjs/Materials/pushMaterial";
  67218. export * from "babylonjs/Materials/shaderMaterial";
  67219. export * from "babylonjs/Materials/standardMaterial";
  67220. export * from "babylonjs/Materials/Textures/index";
  67221. export * from "babylonjs/Materials/uniformBuffer";
  67222. export * from "babylonjs/Materials/materialFlags";
  67223. export * from "babylonjs/Materials/Node/index";
  67224. export * from "babylonjs/Materials/effectRenderer";
  67225. export * from "babylonjs/Materials/shadowDepthWrapper";
  67226. }
  67227. declare module "babylonjs/Maths/index" {
  67228. export * from "babylonjs/Maths/math.scalar";
  67229. export * from "babylonjs/Maths/math";
  67230. export * from "babylonjs/Maths/sphericalPolynomial";
  67231. }
  67232. declare module "babylonjs/Misc/workerPool" {
  67233. import { IDisposable } from "babylonjs/scene";
  67234. /**
  67235. * Helper class to push actions to a pool of workers.
  67236. */
  67237. export class WorkerPool implements IDisposable {
  67238. private _workerInfos;
  67239. private _pendingActions;
  67240. /**
  67241. * Constructor
  67242. * @param workers Array of workers to use for actions
  67243. */
  67244. constructor(workers: Array<Worker>);
  67245. /**
  67246. * Terminates all workers and clears any pending actions.
  67247. */
  67248. dispose(): void;
  67249. /**
  67250. * Pushes an action to the worker pool. If all the workers are active, the action will be
  67251. * pended until a worker has completed its action.
  67252. * @param action The action to perform. Call onComplete when the action is complete.
  67253. */
  67254. push(action: (worker: Worker, onComplete: () => void) => void): void;
  67255. private _execute;
  67256. }
  67257. }
  67258. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  67259. import { IDisposable } from "babylonjs/scene";
  67260. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  67261. /**
  67262. * Configuration for Draco compression
  67263. */
  67264. export interface IDracoCompressionConfiguration {
  67265. /**
  67266. * Configuration for the decoder.
  67267. */
  67268. decoder: {
  67269. /**
  67270. * The url to the WebAssembly module.
  67271. */
  67272. wasmUrl?: string;
  67273. /**
  67274. * The url to the WebAssembly binary.
  67275. */
  67276. wasmBinaryUrl?: string;
  67277. /**
  67278. * The url to the fallback JavaScript module.
  67279. */
  67280. fallbackUrl?: string;
  67281. };
  67282. }
  67283. /**
  67284. * Draco compression (https://google.github.io/draco/)
  67285. *
  67286. * This class wraps the Draco module.
  67287. *
  67288. * **Encoder**
  67289. *
  67290. * The encoder is not currently implemented.
  67291. *
  67292. * **Decoder**
  67293. *
  67294. * 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.
  67295. *
  67296. * To update the configuration, use the following code:
  67297. * ```javascript
  67298. * DracoCompression.Configuration = {
  67299. * decoder: {
  67300. * wasmUrl: "<url to the WebAssembly library>",
  67301. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  67302. * fallbackUrl: "<url to the fallback JavaScript library>",
  67303. * }
  67304. * };
  67305. * ```
  67306. *
  67307. * 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.
  67308. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  67309. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  67310. *
  67311. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  67312. * ```javascript
  67313. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  67314. * ```
  67315. *
  67316. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  67317. */
  67318. export class DracoCompression implements IDisposable {
  67319. private _workerPoolPromise?;
  67320. private _decoderModulePromise?;
  67321. /**
  67322. * The configuration. Defaults to the following urls:
  67323. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  67324. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  67325. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  67326. */
  67327. static Configuration: IDracoCompressionConfiguration;
  67328. /**
  67329. * Returns true if the decoder configuration is available.
  67330. */
  67331. static get DecoderAvailable(): boolean;
  67332. /**
  67333. * Default number of workers to create when creating the draco compression object.
  67334. */
  67335. static DefaultNumWorkers: number;
  67336. private static GetDefaultNumWorkers;
  67337. private static _Default;
  67338. /**
  67339. * Default instance for the draco compression object.
  67340. */
  67341. static get Default(): DracoCompression;
  67342. /**
  67343. * Constructor
  67344. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  67345. */
  67346. constructor(numWorkers?: number);
  67347. /**
  67348. * Stop all async operations and release resources.
  67349. */
  67350. dispose(): void;
  67351. /**
  67352. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  67353. * @returns a promise that resolves when ready
  67354. */
  67355. whenReadyAsync(): Promise<void>;
  67356. /**
  67357. * Decode Draco compressed mesh data to vertex data.
  67358. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  67359. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  67360. * @returns A promise that resolves with the decoded vertex data
  67361. */
  67362. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  67363. [kind: string]: number;
  67364. }): Promise<VertexData>;
  67365. }
  67366. }
  67367. declare module "babylonjs/Meshes/Compression/index" {
  67368. export * from "babylonjs/Meshes/Compression/dracoCompression";
  67369. }
  67370. declare module "babylonjs/Meshes/csg" {
  67371. import { Nullable } from "babylonjs/types";
  67372. import { Scene } from "babylonjs/scene";
  67373. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  67374. import { Mesh } from "babylonjs/Meshes/mesh";
  67375. import { Material } from "babylonjs/Materials/material";
  67376. /**
  67377. * Class for building Constructive Solid Geometry
  67378. */
  67379. export class CSG {
  67380. private polygons;
  67381. /**
  67382. * The world matrix
  67383. */
  67384. matrix: Matrix;
  67385. /**
  67386. * Stores the position
  67387. */
  67388. position: Vector3;
  67389. /**
  67390. * Stores the rotation
  67391. */
  67392. rotation: Vector3;
  67393. /**
  67394. * Stores the rotation quaternion
  67395. */
  67396. rotationQuaternion: Nullable<Quaternion>;
  67397. /**
  67398. * Stores the scaling vector
  67399. */
  67400. scaling: Vector3;
  67401. /**
  67402. * Convert the Mesh to CSG
  67403. * @param mesh The Mesh to convert to CSG
  67404. * @returns A new CSG from the Mesh
  67405. */
  67406. static FromMesh(mesh: Mesh): CSG;
  67407. /**
  67408. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  67409. * @param polygons Polygons used to construct a CSG solid
  67410. */
  67411. private static FromPolygons;
  67412. /**
  67413. * Clones, or makes a deep copy, of the CSG
  67414. * @returns A new CSG
  67415. */
  67416. clone(): CSG;
  67417. /**
  67418. * Unions this CSG with another CSG
  67419. * @param csg The CSG to union against this CSG
  67420. * @returns The unioned CSG
  67421. */
  67422. union(csg: CSG): CSG;
  67423. /**
  67424. * Unions this CSG with another CSG in place
  67425. * @param csg The CSG to union against this CSG
  67426. */
  67427. unionInPlace(csg: CSG): void;
  67428. /**
  67429. * Subtracts this CSG with another CSG
  67430. * @param csg The CSG to subtract against this CSG
  67431. * @returns A new CSG
  67432. */
  67433. subtract(csg: CSG): CSG;
  67434. /**
  67435. * Subtracts this CSG with another CSG in place
  67436. * @param csg The CSG to subtact against this CSG
  67437. */
  67438. subtractInPlace(csg: CSG): void;
  67439. /**
  67440. * Intersect this CSG with another CSG
  67441. * @param csg The CSG to intersect against this CSG
  67442. * @returns A new CSG
  67443. */
  67444. intersect(csg: CSG): CSG;
  67445. /**
  67446. * Intersects this CSG with another CSG in place
  67447. * @param csg The CSG to intersect against this CSG
  67448. */
  67449. intersectInPlace(csg: CSG): void;
  67450. /**
  67451. * Return a new CSG solid with solid and empty space switched. This solid is
  67452. * not modified.
  67453. * @returns A new CSG solid with solid and empty space switched
  67454. */
  67455. inverse(): CSG;
  67456. /**
  67457. * Inverses the CSG in place
  67458. */
  67459. inverseInPlace(): void;
  67460. /**
  67461. * This is used to keep meshes transformations so they can be restored
  67462. * when we build back a Babylon Mesh
  67463. * NB : All CSG operations are performed in world coordinates
  67464. * @param csg The CSG to copy the transform attributes from
  67465. * @returns This CSG
  67466. */
  67467. copyTransformAttributes(csg: CSG): CSG;
  67468. /**
  67469. * Build Raw mesh from CSG
  67470. * Coordinates here are in world space
  67471. * @param name The name of the mesh geometry
  67472. * @param scene The Scene
  67473. * @param keepSubMeshes Specifies if the submeshes should be kept
  67474. * @returns A new Mesh
  67475. */
  67476. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  67477. /**
  67478. * Build Mesh from CSG taking material and transforms into account
  67479. * @param name The name of the Mesh
  67480. * @param material The material of the Mesh
  67481. * @param scene The Scene
  67482. * @param keepSubMeshes Specifies if submeshes should be kept
  67483. * @returns The new Mesh
  67484. */
  67485. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  67486. }
  67487. }
  67488. declare module "babylonjs/Meshes/trailMesh" {
  67489. import { Mesh } from "babylonjs/Meshes/mesh";
  67490. import { Scene } from "babylonjs/scene";
  67491. import { TransformNode } from "babylonjs/Meshes/transformNode";
  67492. /**
  67493. * Class used to create a trail following a mesh
  67494. */
  67495. export class TrailMesh extends Mesh {
  67496. private _generator;
  67497. private _autoStart;
  67498. private _running;
  67499. private _diameter;
  67500. private _length;
  67501. private _sectionPolygonPointsCount;
  67502. private _sectionVectors;
  67503. private _sectionNormalVectors;
  67504. private _beforeRenderObserver;
  67505. /**
  67506. * @constructor
  67507. * @param name The value used by scene.getMeshByName() to do a lookup.
  67508. * @param generator The mesh or transform node to generate a trail.
  67509. * @param scene The scene to add this mesh to.
  67510. * @param diameter Diameter of trailing mesh. Default is 1.
  67511. * @param length Length of trailing mesh. Default is 60.
  67512. * @param autoStart Automatically start trailing mesh. Default true.
  67513. */
  67514. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  67515. /**
  67516. * "TrailMesh"
  67517. * @returns "TrailMesh"
  67518. */
  67519. getClassName(): string;
  67520. private _createMesh;
  67521. /**
  67522. * Start trailing mesh.
  67523. */
  67524. start(): void;
  67525. /**
  67526. * Stop trailing mesh.
  67527. */
  67528. stop(): void;
  67529. /**
  67530. * Update trailing mesh geometry.
  67531. */
  67532. update(): void;
  67533. /**
  67534. * Returns a new TrailMesh object.
  67535. * @param name is a string, the name given to the new mesh
  67536. * @param newGenerator use new generator object for cloned trail mesh
  67537. * @returns a new mesh
  67538. */
  67539. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  67540. /**
  67541. * Serializes this trail mesh
  67542. * @param serializationObject object to write serialization to
  67543. */
  67544. serialize(serializationObject: any): void;
  67545. /**
  67546. * Parses a serialized trail mesh
  67547. * @param parsedMesh the serialized mesh
  67548. * @param scene the scene to create the trail mesh in
  67549. * @returns the created trail mesh
  67550. */
  67551. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  67552. }
  67553. }
  67554. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  67555. import { Nullable } from "babylonjs/types";
  67556. import { Scene } from "babylonjs/scene";
  67557. import { Vector4 } from "babylonjs/Maths/math.vector";
  67558. import { Color4 } from "babylonjs/Maths/math.color";
  67559. import { Mesh } from "babylonjs/Meshes/mesh";
  67560. /**
  67561. * Class containing static functions to help procedurally build meshes
  67562. */
  67563. export class TiledBoxBuilder {
  67564. /**
  67565. * Creates a box mesh
  67566. * 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)
  67567. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  67568. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67569. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67570. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67571. * @param name defines the name of the mesh
  67572. * @param options defines the options used to create the mesh
  67573. * @param scene defines the hosting scene
  67574. * @returns the box mesh
  67575. */
  67576. static CreateTiledBox(name: string, options: {
  67577. pattern?: number;
  67578. width?: number;
  67579. height?: number;
  67580. depth?: number;
  67581. tileSize?: number;
  67582. tileWidth?: number;
  67583. tileHeight?: number;
  67584. alignHorizontal?: number;
  67585. alignVertical?: number;
  67586. faceUV?: Vector4[];
  67587. faceColors?: Color4[];
  67588. sideOrientation?: number;
  67589. updatable?: boolean;
  67590. }, scene?: Nullable<Scene>): Mesh;
  67591. }
  67592. }
  67593. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  67594. import { Vector4 } from "babylonjs/Maths/math.vector";
  67595. import { Mesh } from "babylonjs/Meshes/mesh";
  67596. /**
  67597. * Class containing static functions to help procedurally build meshes
  67598. */
  67599. export class TorusKnotBuilder {
  67600. /**
  67601. * Creates a torus knot mesh
  67602. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  67603. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  67604. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  67605. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  67606. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67607. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67608. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  67609. * @param name defines the name of the mesh
  67610. * @param options defines the options used to create the mesh
  67611. * @param scene defines the hosting scene
  67612. * @returns the torus knot mesh
  67613. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  67614. */
  67615. static CreateTorusKnot(name: string, options: {
  67616. radius?: number;
  67617. tube?: number;
  67618. radialSegments?: number;
  67619. tubularSegments?: number;
  67620. p?: number;
  67621. q?: number;
  67622. updatable?: boolean;
  67623. sideOrientation?: number;
  67624. frontUVs?: Vector4;
  67625. backUVs?: Vector4;
  67626. }, scene: any): Mesh;
  67627. }
  67628. }
  67629. declare module "babylonjs/Meshes/polygonMesh" {
  67630. import { Scene } from "babylonjs/scene";
  67631. import { Vector2 } from "babylonjs/Maths/math.vector";
  67632. import { Mesh } from "babylonjs/Meshes/mesh";
  67633. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  67634. import { Path2 } from "babylonjs/Maths/math.path";
  67635. /**
  67636. * Polygon
  67637. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  67638. */
  67639. export class Polygon {
  67640. /**
  67641. * Creates a rectangle
  67642. * @param xmin bottom X coord
  67643. * @param ymin bottom Y coord
  67644. * @param xmax top X coord
  67645. * @param ymax top Y coord
  67646. * @returns points that make the resulting rectation
  67647. */
  67648. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  67649. /**
  67650. * Creates a circle
  67651. * @param radius radius of circle
  67652. * @param cx scale in x
  67653. * @param cy scale in y
  67654. * @param numberOfSides number of sides that make up the circle
  67655. * @returns points that make the resulting circle
  67656. */
  67657. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  67658. /**
  67659. * Creates a polygon from input string
  67660. * @param input Input polygon data
  67661. * @returns the parsed points
  67662. */
  67663. static Parse(input: string): Vector2[];
  67664. /**
  67665. * Starts building a polygon from x and y coordinates
  67666. * @param x x coordinate
  67667. * @param y y coordinate
  67668. * @returns the started path2
  67669. */
  67670. static StartingAt(x: number, y: number): Path2;
  67671. }
  67672. /**
  67673. * Builds a polygon
  67674. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  67675. */
  67676. export class PolygonMeshBuilder {
  67677. private _points;
  67678. private _outlinepoints;
  67679. private _holes;
  67680. private _name;
  67681. private _scene;
  67682. private _epoints;
  67683. private _eholes;
  67684. private _addToepoint;
  67685. /**
  67686. * Babylon reference to the earcut plugin.
  67687. */
  67688. bjsEarcut: any;
  67689. /**
  67690. * Creates a PolygonMeshBuilder
  67691. * @param name name of the builder
  67692. * @param contours Path of the polygon
  67693. * @param scene scene to add to when creating the mesh
  67694. * @param earcutInjection can be used to inject your own earcut reference
  67695. */
  67696. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  67697. /**
  67698. * Adds a whole within the polygon
  67699. * @param hole Array of points defining the hole
  67700. * @returns this
  67701. */
  67702. addHole(hole: Vector2[]): PolygonMeshBuilder;
  67703. /**
  67704. * Creates the polygon
  67705. * @param updatable If the mesh should be updatable
  67706. * @param depth The depth of the mesh created
  67707. * @returns the created mesh
  67708. */
  67709. build(updatable?: boolean, depth?: number): Mesh;
  67710. /**
  67711. * Creates the polygon
  67712. * @param depth The depth of the mesh created
  67713. * @returns the created VertexData
  67714. */
  67715. buildVertexData(depth?: number): VertexData;
  67716. /**
  67717. * Adds a side to the polygon
  67718. * @param positions points that make the polygon
  67719. * @param normals normals of the polygon
  67720. * @param uvs uvs of the polygon
  67721. * @param indices indices of the polygon
  67722. * @param bounds bounds of the polygon
  67723. * @param points points of the polygon
  67724. * @param depth depth of the polygon
  67725. * @param flip flip of the polygon
  67726. */
  67727. private addSide;
  67728. }
  67729. }
  67730. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  67731. import { Scene } from "babylonjs/scene";
  67732. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  67733. import { Color4 } from "babylonjs/Maths/math.color";
  67734. import { Mesh } from "babylonjs/Meshes/mesh";
  67735. import { Nullable } from "babylonjs/types";
  67736. /**
  67737. * Class containing static functions to help procedurally build meshes
  67738. */
  67739. export class PolygonBuilder {
  67740. /**
  67741. * Creates a polygon mesh
  67742. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  67743. * * 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
  67744. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  67745. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67746. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  67747. * * Remember you can only change the shape positions, not their number when updating a polygon
  67748. * @param name defines the name of the mesh
  67749. * @param options defines the options used to create the mesh
  67750. * @param scene defines the hosting scene
  67751. * @param earcutInjection can be used to inject your own earcut reference
  67752. * @returns the polygon mesh
  67753. */
  67754. static CreatePolygon(name: string, options: {
  67755. shape: Vector3[];
  67756. holes?: Vector3[][];
  67757. depth?: number;
  67758. faceUV?: Vector4[];
  67759. faceColors?: Color4[];
  67760. updatable?: boolean;
  67761. sideOrientation?: number;
  67762. frontUVs?: Vector4;
  67763. backUVs?: Vector4;
  67764. wrap?: boolean;
  67765. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  67766. /**
  67767. * Creates an extruded polygon mesh, with depth in the Y direction.
  67768. * * 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)
  67769. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  67770. * @param name defines the name of the mesh
  67771. * @param options defines the options used to create the mesh
  67772. * @param scene defines the hosting scene
  67773. * @param earcutInjection can be used to inject your own earcut reference
  67774. * @returns the polygon mesh
  67775. */
  67776. static ExtrudePolygon(name: string, options: {
  67777. shape: Vector3[];
  67778. holes?: Vector3[][];
  67779. depth?: number;
  67780. faceUV?: Vector4[];
  67781. faceColors?: Color4[];
  67782. updatable?: boolean;
  67783. sideOrientation?: number;
  67784. frontUVs?: Vector4;
  67785. backUVs?: Vector4;
  67786. wrap?: boolean;
  67787. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  67788. }
  67789. }
  67790. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  67791. import { Scene } from "babylonjs/scene";
  67792. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  67793. import { Mesh } from "babylonjs/Meshes/mesh";
  67794. import { Nullable } from "babylonjs/types";
  67795. /**
  67796. * Class containing static functions to help procedurally build meshes
  67797. */
  67798. export class LatheBuilder {
  67799. /**
  67800. * Creates lathe mesh.
  67801. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  67802. * * 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
  67803. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  67804. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  67805. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  67806. * * 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
  67807. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  67808. * * 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
  67809. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67810. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67811. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  67812. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67813. * @param name defines the name of the mesh
  67814. * @param options defines the options used to create the mesh
  67815. * @param scene defines the hosting scene
  67816. * @returns the lathe mesh
  67817. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  67818. */
  67819. static CreateLathe(name: string, options: {
  67820. shape: Vector3[];
  67821. radius?: number;
  67822. tessellation?: number;
  67823. clip?: number;
  67824. arc?: number;
  67825. closed?: boolean;
  67826. updatable?: boolean;
  67827. sideOrientation?: number;
  67828. frontUVs?: Vector4;
  67829. backUVs?: Vector4;
  67830. cap?: number;
  67831. invertUV?: boolean;
  67832. }, scene?: Nullable<Scene>): Mesh;
  67833. }
  67834. }
  67835. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  67836. import { Nullable } from "babylonjs/types";
  67837. import { Scene } from "babylonjs/scene";
  67838. import { Vector4 } from "babylonjs/Maths/math.vector";
  67839. import { Mesh } from "babylonjs/Meshes/mesh";
  67840. /**
  67841. * Class containing static functions to help procedurally build meshes
  67842. */
  67843. export class TiledPlaneBuilder {
  67844. /**
  67845. * Creates a tiled plane mesh
  67846. * * The parameter `pattern` will, depending on value, do nothing or
  67847. * * * flip (reflect about central vertical) alternate tiles across and up
  67848. * * * flip every tile on alternate rows
  67849. * * * rotate (180 degs) alternate tiles across and up
  67850. * * * rotate every tile on alternate rows
  67851. * * * flip and rotate alternate tiles across and up
  67852. * * * flip and rotate every tile on alternate rows
  67853. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  67854. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  67855. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67856. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  67857. * * 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)
  67858. * * 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)
  67859. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  67860. * @param name defines the name of the mesh
  67861. * @param options defines the options used to create the mesh
  67862. * @param scene defines the hosting scene
  67863. * @returns the box mesh
  67864. */
  67865. static CreateTiledPlane(name: string, options: {
  67866. pattern?: number;
  67867. tileSize?: number;
  67868. tileWidth?: number;
  67869. tileHeight?: number;
  67870. size?: number;
  67871. width?: number;
  67872. height?: number;
  67873. alignHorizontal?: number;
  67874. alignVertical?: number;
  67875. sideOrientation?: number;
  67876. frontUVs?: Vector4;
  67877. backUVs?: Vector4;
  67878. updatable?: boolean;
  67879. }, scene?: Nullable<Scene>): Mesh;
  67880. }
  67881. }
  67882. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  67883. import { Nullable } from "babylonjs/types";
  67884. import { Scene } from "babylonjs/scene";
  67885. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  67886. import { Mesh } from "babylonjs/Meshes/mesh";
  67887. /**
  67888. * Class containing static functions to help procedurally build meshes
  67889. */
  67890. export class TubeBuilder {
  67891. /**
  67892. * Creates a tube mesh.
  67893. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  67894. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  67895. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  67896. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  67897. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  67898. * * 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)
  67899. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  67900. * * 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
  67901. * * 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
  67902. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67903. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67904. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  67905. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67906. * @param name defines the name of the mesh
  67907. * @param options defines the options used to create the mesh
  67908. * @param scene defines the hosting scene
  67909. * @returns the tube mesh
  67910. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  67911. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  67912. */
  67913. static CreateTube(name: string, options: {
  67914. path: Vector3[];
  67915. radius?: number;
  67916. tessellation?: number;
  67917. radiusFunction?: {
  67918. (i: number, distance: number): number;
  67919. };
  67920. cap?: number;
  67921. arc?: number;
  67922. updatable?: boolean;
  67923. sideOrientation?: number;
  67924. frontUVs?: Vector4;
  67925. backUVs?: Vector4;
  67926. instance?: Mesh;
  67927. invertUV?: boolean;
  67928. }, scene?: Nullable<Scene>): Mesh;
  67929. }
  67930. }
  67931. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  67932. import { Scene } from "babylonjs/scene";
  67933. import { Vector4 } from "babylonjs/Maths/math.vector";
  67934. import { Mesh } from "babylonjs/Meshes/mesh";
  67935. import { Nullable } from "babylonjs/types";
  67936. /**
  67937. * Class containing static functions to help procedurally build meshes
  67938. */
  67939. export class IcoSphereBuilder {
  67940. /**
  67941. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  67942. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  67943. * * 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`)
  67944. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  67945. * * 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
  67946. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67947. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67948. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67949. * @param name defines the name of the mesh
  67950. * @param options defines the options used to create the mesh
  67951. * @param scene defines the hosting scene
  67952. * @returns the icosahedron mesh
  67953. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  67954. */
  67955. static CreateIcoSphere(name: string, options: {
  67956. radius?: number;
  67957. radiusX?: number;
  67958. radiusY?: number;
  67959. radiusZ?: number;
  67960. flat?: boolean;
  67961. subdivisions?: number;
  67962. sideOrientation?: number;
  67963. frontUVs?: Vector4;
  67964. backUVs?: Vector4;
  67965. updatable?: boolean;
  67966. }, scene?: Nullable<Scene>): Mesh;
  67967. }
  67968. }
  67969. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  67970. import { Vector3 } from "babylonjs/Maths/math.vector";
  67971. import { Mesh } from "babylonjs/Meshes/mesh";
  67972. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67973. /**
  67974. * Class containing static functions to help procedurally build meshes
  67975. */
  67976. export class DecalBuilder {
  67977. /**
  67978. * Creates a decal mesh.
  67979. * 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
  67980. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  67981. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  67982. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  67983. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  67984. * @param name defines the name of the mesh
  67985. * @param sourceMesh defines the mesh where the decal must be applied
  67986. * @param options defines the options used to create the mesh
  67987. * @param scene defines the hosting scene
  67988. * @returns the decal mesh
  67989. * @see https://doc.babylonjs.com/how_to/decals
  67990. */
  67991. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  67992. position?: Vector3;
  67993. normal?: Vector3;
  67994. size?: Vector3;
  67995. angle?: number;
  67996. }): Mesh;
  67997. }
  67998. }
  67999. declare module "babylonjs/Meshes/meshBuilder" {
  68000. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  68001. import { Nullable } from "babylonjs/types";
  68002. import { Scene } from "babylonjs/scene";
  68003. import { Mesh } from "babylonjs/Meshes/mesh";
  68004. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  68005. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  68006. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68007. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  68008. import { Plane } from "babylonjs/Maths/math.plane";
  68009. /**
  68010. * Class containing static functions to help procedurally build meshes
  68011. */
  68012. export class MeshBuilder {
  68013. /**
  68014. * Creates a box mesh
  68015. * * The parameter `size` sets the size (float) of each box side (default 1)
  68016. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  68017. * * 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)
  68018. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68019. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68020. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68021. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68022. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68023. * @param name defines the name of the mesh
  68024. * @param options defines the options used to create the mesh
  68025. * @param scene defines the hosting scene
  68026. * @returns the box mesh
  68027. */
  68028. static CreateBox(name: string, options: {
  68029. size?: number;
  68030. width?: number;
  68031. height?: number;
  68032. depth?: number;
  68033. faceUV?: Vector4[];
  68034. faceColors?: Color4[];
  68035. sideOrientation?: number;
  68036. frontUVs?: Vector4;
  68037. backUVs?: Vector4;
  68038. wrap?: boolean;
  68039. topBaseAt?: number;
  68040. bottomBaseAt?: number;
  68041. updatable?: boolean;
  68042. }, scene?: Nullable<Scene>): Mesh;
  68043. /**
  68044. * Creates a tiled box mesh
  68045. * * faceTiles sets the pattern, tile size and number of tiles for a face
  68046. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68047. * @param name defines the name of the mesh
  68048. * @param options defines the options used to create the mesh
  68049. * @param scene defines the hosting scene
  68050. * @returns the tiled box mesh
  68051. */
  68052. static CreateTiledBox(name: string, options: {
  68053. pattern?: number;
  68054. size?: number;
  68055. width?: number;
  68056. height?: number;
  68057. depth: number;
  68058. tileSize?: number;
  68059. tileWidth?: number;
  68060. tileHeight?: number;
  68061. faceUV?: Vector4[];
  68062. faceColors?: Color4[];
  68063. alignHorizontal?: number;
  68064. alignVertical?: number;
  68065. sideOrientation?: number;
  68066. updatable?: boolean;
  68067. }, scene?: Nullable<Scene>): Mesh;
  68068. /**
  68069. * Creates a sphere mesh
  68070. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  68071. * * 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`)
  68072. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  68073. * * 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
  68074. * * 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)
  68075. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68076. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68077. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68078. * @param name defines the name of the mesh
  68079. * @param options defines the options used to create the mesh
  68080. * @param scene defines the hosting scene
  68081. * @returns the sphere mesh
  68082. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  68083. */
  68084. static CreateSphere(name: string, options: {
  68085. segments?: number;
  68086. diameter?: number;
  68087. diameterX?: number;
  68088. diameterY?: number;
  68089. diameterZ?: number;
  68090. arc?: number;
  68091. slice?: number;
  68092. sideOrientation?: number;
  68093. frontUVs?: Vector4;
  68094. backUVs?: Vector4;
  68095. updatable?: boolean;
  68096. }, scene?: Nullable<Scene>): Mesh;
  68097. /**
  68098. * Creates a plane polygonal mesh. By default, this is a disc
  68099. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  68100. * * 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
  68101. * * 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
  68102. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68103. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68104. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68105. * @param name defines the name of the mesh
  68106. * @param options defines the options used to create the mesh
  68107. * @param scene defines the hosting scene
  68108. * @returns the plane polygonal mesh
  68109. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  68110. */
  68111. static CreateDisc(name: string, options: {
  68112. radius?: number;
  68113. tessellation?: number;
  68114. arc?: number;
  68115. updatable?: boolean;
  68116. sideOrientation?: number;
  68117. frontUVs?: Vector4;
  68118. backUVs?: Vector4;
  68119. }, scene?: Nullable<Scene>): Mesh;
  68120. /**
  68121. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  68122. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  68123. * * 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`)
  68124. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  68125. * * 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
  68126. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68127. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68128. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68129. * @param name defines the name of the mesh
  68130. * @param options defines the options used to create the mesh
  68131. * @param scene defines the hosting scene
  68132. * @returns the icosahedron mesh
  68133. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  68134. */
  68135. static CreateIcoSphere(name: string, options: {
  68136. radius?: number;
  68137. radiusX?: number;
  68138. radiusY?: number;
  68139. radiusZ?: number;
  68140. flat?: boolean;
  68141. subdivisions?: number;
  68142. sideOrientation?: number;
  68143. frontUVs?: Vector4;
  68144. backUVs?: Vector4;
  68145. updatable?: boolean;
  68146. }, scene?: Nullable<Scene>): Mesh;
  68147. /**
  68148. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68149. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  68150. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  68151. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  68152. * * 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
  68153. * * 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
  68154. * * 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
  68155. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68156. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68157. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68158. * * 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
  68159. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  68160. * * 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
  68161. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  68162. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68163. * @param name defines the name of the mesh
  68164. * @param options defines the options used to create the mesh
  68165. * @param scene defines the hosting scene
  68166. * @returns the ribbon mesh
  68167. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  68168. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68169. */
  68170. static CreateRibbon(name: string, options: {
  68171. pathArray: Vector3[][];
  68172. closeArray?: boolean;
  68173. closePath?: boolean;
  68174. offset?: number;
  68175. updatable?: boolean;
  68176. sideOrientation?: number;
  68177. frontUVs?: Vector4;
  68178. backUVs?: Vector4;
  68179. instance?: Mesh;
  68180. invertUV?: boolean;
  68181. uvs?: Vector2[];
  68182. colors?: Color4[];
  68183. }, scene?: Nullable<Scene>): Mesh;
  68184. /**
  68185. * Creates a cylinder or a cone mesh
  68186. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  68187. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  68188. * * 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.
  68189. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  68190. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  68191. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  68192. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  68193. * * 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).
  68194. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  68195. * * 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).
  68196. * * 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
  68197. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  68198. * * 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
  68199. * * 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.
  68200. * * If `enclose` is false, a ring surface is one element.
  68201. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  68202. * * 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
  68203. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68204. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68205. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68206. * @param name defines the name of the mesh
  68207. * @param options defines the options used to create the mesh
  68208. * @param scene defines the hosting scene
  68209. * @returns the cylinder mesh
  68210. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  68211. */
  68212. static CreateCylinder(name: string, options: {
  68213. height?: number;
  68214. diameterTop?: number;
  68215. diameterBottom?: number;
  68216. diameter?: number;
  68217. tessellation?: number;
  68218. subdivisions?: number;
  68219. arc?: number;
  68220. faceColors?: Color4[];
  68221. faceUV?: Vector4[];
  68222. updatable?: boolean;
  68223. hasRings?: boolean;
  68224. enclose?: boolean;
  68225. cap?: number;
  68226. sideOrientation?: number;
  68227. frontUVs?: Vector4;
  68228. backUVs?: Vector4;
  68229. }, scene?: Nullable<Scene>): Mesh;
  68230. /**
  68231. * Creates a torus mesh
  68232. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  68233. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  68234. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  68235. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68236. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68237. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68238. * @param name defines the name of the mesh
  68239. * @param options defines the options used to create the mesh
  68240. * @param scene defines the hosting scene
  68241. * @returns the torus mesh
  68242. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  68243. */
  68244. static CreateTorus(name: string, options: {
  68245. diameter?: number;
  68246. thickness?: number;
  68247. tessellation?: number;
  68248. updatable?: boolean;
  68249. sideOrientation?: number;
  68250. frontUVs?: Vector4;
  68251. backUVs?: Vector4;
  68252. }, scene?: Nullable<Scene>): Mesh;
  68253. /**
  68254. * Creates a torus knot mesh
  68255. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68256. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68257. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68258. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68259. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68260. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68261. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68262. * @param name defines the name of the mesh
  68263. * @param options defines the options used to create the mesh
  68264. * @param scene defines the hosting scene
  68265. * @returns the torus knot mesh
  68266. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68267. */
  68268. static CreateTorusKnot(name: string, options: {
  68269. radius?: number;
  68270. tube?: number;
  68271. radialSegments?: number;
  68272. tubularSegments?: number;
  68273. p?: number;
  68274. q?: number;
  68275. updatable?: boolean;
  68276. sideOrientation?: number;
  68277. frontUVs?: Vector4;
  68278. backUVs?: Vector4;
  68279. }, scene?: Nullable<Scene>): Mesh;
  68280. /**
  68281. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  68282. * * 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
  68283. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  68284. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  68285. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  68286. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  68287. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  68288. * * 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
  68289. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  68290. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68291. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  68292. * @param name defines the name of the new line system
  68293. * @param options defines the options used to create the line system
  68294. * @param scene defines the hosting scene
  68295. * @returns a new line system mesh
  68296. */
  68297. static CreateLineSystem(name: string, options: {
  68298. lines: Vector3[][];
  68299. updatable?: boolean;
  68300. instance?: Nullable<LinesMesh>;
  68301. colors?: Nullable<Color4[][]>;
  68302. useVertexAlpha?: boolean;
  68303. }, scene: Nullable<Scene>): LinesMesh;
  68304. /**
  68305. * Creates a line mesh
  68306. * 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
  68307. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  68308. * * The parameter `points` is an array successive Vector3
  68309. * * 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
  68310. * * The optional parameter `colors` is an array of successive Color4, one per line point
  68311. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  68312. * * When updating an instance, remember that only point positions can change, not the number of points
  68313. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68314. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  68315. * @param name defines the name of the new line system
  68316. * @param options defines the options used to create the line system
  68317. * @param scene defines the hosting scene
  68318. * @returns a new line mesh
  68319. */
  68320. static CreateLines(name: string, options: {
  68321. points: Vector3[];
  68322. updatable?: boolean;
  68323. instance?: Nullable<LinesMesh>;
  68324. colors?: Color4[];
  68325. useVertexAlpha?: boolean;
  68326. }, scene?: Nullable<Scene>): LinesMesh;
  68327. /**
  68328. * Creates a dashed line mesh
  68329. * * 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
  68330. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  68331. * * The parameter `points` is an array successive Vector3
  68332. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  68333. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  68334. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  68335. * * 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
  68336. * * When updating an instance, remember that only point positions can change, not the number of points
  68337. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68338. * @param name defines the name of the mesh
  68339. * @param options defines the options used to create the mesh
  68340. * @param scene defines the hosting scene
  68341. * @returns the dashed line mesh
  68342. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  68343. */
  68344. static CreateDashedLines(name: string, options: {
  68345. points: Vector3[];
  68346. dashSize?: number;
  68347. gapSize?: number;
  68348. dashNb?: number;
  68349. updatable?: boolean;
  68350. instance?: LinesMesh;
  68351. }, scene?: Nullable<Scene>): LinesMesh;
  68352. /**
  68353. * 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.
  68354. * * 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.
  68355. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  68356. * * 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.
  68357. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  68358. * * 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
  68359. * * 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
  68360. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  68361. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68362. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68363. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  68364. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68365. * @param name defines the name of the mesh
  68366. * @param options defines the options used to create the mesh
  68367. * @param scene defines the hosting scene
  68368. * @returns the extruded shape mesh
  68369. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68370. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  68371. */
  68372. static ExtrudeShape(name: string, options: {
  68373. shape: Vector3[];
  68374. path: Vector3[];
  68375. scale?: number;
  68376. rotation?: number;
  68377. cap?: number;
  68378. updatable?: boolean;
  68379. sideOrientation?: number;
  68380. frontUVs?: Vector4;
  68381. backUVs?: Vector4;
  68382. instance?: Mesh;
  68383. invertUV?: boolean;
  68384. }, scene?: Nullable<Scene>): Mesh;
  68385. /**
  68386. * Creates an custom extruded shape mesh.
  68387. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  68388. * * 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.
  68389. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  68390. * * 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
  68391. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  68392. * * 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
  68393. * * It must returns a float value that will be the scale value applied to the shape on each path point
  68394. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  68395. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  68396. * * 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
  68397. * * 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
  68398. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  68399. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68400. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68401. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68402. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68403. * @param name defines the name of the mesh
  68404. * @param options defines the options used to create the mesh
  68405. * @param scene defines the hosting scene
  68406. * @returns the custom extruded shape mesh
  68407. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  68408. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68409. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  68410. */
  68411. static ExtrudeShapeCustom(name: string, options: {
  68412. shape: Vector3[];
  68413. path: Vector3[];
  68414. scaleFunction?: any;
  68415. rotationFunction?: any;
  68416. ribbonCloseArray?: boolean;
  68417. ribbonClosePath?: boolean;
  68418. cap?: number;
  68419. updatable?: boolean;
  68420. sideOrientation?: number;
  68421. frontUVs?: Vector4;
  68422. backUVs?: Vector4;
  68423. instance?: Mesh;
  68424. invertUV?: boolean;
  68425. }, scene?: Nullable<Scene>): Mesh;
  68426. /**
  68427. * Creates lathe mesh.
  68428. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68429. * * 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
  68430. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68431. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68432. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68433. * * 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
  68434. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68435. * * 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
  68436. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68437. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68438. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68439. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68440. * @param name defines the name of the mesh
  68441. * @param options defines the options used to create the mesh
  68442. * @param scene defines the hosting scene
  68443. * @returns the lathe mesh
  68444. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68445. */
  68446. static CreateLathe(name: string, options: {
  68447. shape: Vector3[];
  68448. radius?: number;
  68449. tessellation?: number;
  68450. clip?: number;
  68451. arc?: number;
  68452. closed?: boolean;
  68453. updatable?: boolean;
  68454. sideOrientation?: number;
  68455. frontUVs?: Vector4;
  68456. backUVs?: Vector4;
  68457. cap?: number;
  68458. invertUV?: boolean;
  68459. }, scene?: Nullable<Scene>): Mesh;
  68460. /**
  68461. * Creates a tiled plane mesh
  68462. * * You can set a limited pattern arrangement with the tiles
  68463. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68464. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68465. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68466. * @param name defines the name of the mesh
  68467. * @param options defines the options used to create the mesh
  68468. * @param scene defines the hosting scene
  68469. * @returns the plane mesh
  68470. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  68471. */
  68472. static CreateTiledPlane(name: string, options: {
  68473. pattern?: number;
  68474. tileSize?: number;
  68475. tileWidth?: number;
  68476. tileHeight?: number;
  68477. size?: number;
  68478. width?: number;
  68479. height?: number;
  68480. alignHorizontal?: number;
  68481. alignVertical?: number;
  68482. sideOrientation?: number;
  68483. frontUVs?: Vector4;
  68484. backUVs?: Vector4;
  68485. updatable?: boolean;
  68486. }, scene?: Nullable<Scene>): Mesh;
  68487. /**
  68488. * Creates a plane mesh
  68489. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  68490. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  68491. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  68492. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68493. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68494. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68495. * @param name defines the name of the mesh
  68496. * @param options defines the options used to create the mesh
  68497. * @param scene defines the hosting scene
  68498. * @returns the plane mesh
  68499. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  68500. */
  68501. static CreatePlane(name: string, options: {
  68502. size?: number;
  68503. width?: number;
  68504. height?: number;
  68505. sideOrientation?: number;
  68506. frontUVs?: Vector4;
  68507. backUVs?: Vector4;
  68508. updatable?: boolean;
  68509. sourcePlane?: Plane;
  68510. }, scene?: Nullable<Scene>): Mesh;
  68511. /**
  68512. * Creates a ground mesh
  68513. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  68514. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  68515. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68516. * @param name defines the name of the mesh
  68517. * @param options defines the options used to create the mesh
  68518. * @param scene defines the hosting scene
  68519. * @returns the ground mesh
  68520. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  68521. */
  68522. static CreateGround(name: string, options: {
  68523. width?: number;
  68524. height?: number;
  68525. subdivisions?: number;
  68526. subdivisionsX?: number;
  68527. subdivisionsY?: number;
  68528. updatable?: boolean;
  68529. }, scene?: Nullable<Scene>): Mesh;
  68530. /**
  68531. * Creates a tiled ground mesh
  68532. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  68533. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  68534. * * 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
  68535. * * 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
  68536. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68537. * @param name defines the name of the mesh
  68538. * @param options defines the options used to create the mesh
  68539. * @param scene defines the hosting scene
  68540. * @returns the tiled ground mesh
  68541. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  68542. */
  68543. static CreateTiledGround(name: string, options: {
  68544. xmin: number;
  68545. zmin: number;
  68546. xmax: number;
  68547. zmax: number;
  68548. subdivisions?: {
  68549. w: number;
  68550. h: number;
  68551. };
  68552. precision?: {
  68553. w: number;
  68554. h: number;
  68555. };
  68556. updatable?: boolean;
  68557. }, scene?: Nullable<Scene>): Mesh;
  68558. /**
  68559. * Creates a ground mesh from a height map
  68560. * * The parameter `url` sets the URL of the height map image resource.
  68561. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  68562. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  68563. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  68564. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  68565. * * 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.
  68566. * * 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).
  68567. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  68568. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68569. * @param name defines the name of the mesh
  68570. * @param url defines the url to the height map
  68571. * @param options defines the options used to create the mesh
  68572. * @param scene defines the hosting scene
  68573. * @returns the ground mesh
  68574. * @see https://doc.babylonjs.com/babylon101/height_map
  68575. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  68576. */
  68577. static CreateGroundFromHeightMap(name: string, url: string, options: {
  68578. width?: number;
  68579. height?: number;
  68580. subdivisions?: number;
  68581. minHeight?: number;
  68582. maxHeight?: number;
  68583. colorFilter?: Color3;
  68584. alphaFilter?: number;
  68585. updatable?: boolean;
  68586. onReady?: (mesh: GroundMesh) => void;
  68587. }, scene?: Nullable<Scene>): GroundMesh;
  68588. /**
  68589. * Creates a polygon mesh
  68590. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68591. * * 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
  68592. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68593. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68594. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  68595. * * Remember you can only change the shape positions, not their number when updating a polygon
  68596. * @param name defines the name of the mesh
  68597. * @param options defines the options used to create the mesh
  68598. * @param scene defines the hosting scene
  68599. * @param earcutInjection can be used to inject your own earcut reference
  68600. * @returns the polygon mesh
  68601. */
  68602. static CreatePolygon(name: string, options: {
  68603. shape: Vector3[];
  68604. holes?: Vector3[][];
  68605. depth?: number;
  68606. faceUV?: Vector4[];
  68607. faceColors?: Color4[];
  68608. updatable?: boolean;
  68609. sideOrientation?: number;
  68610. frontUVs?: Vector4;
  68611. backUVs?: Vector4;
  68612. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68613. /**
  68614. * Creates an extruded polygon mesh, with depth in the Y direction.
  68615. * * 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)
  68616. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68617. * @param name defines the name of the mesh
  68618. * @param options defines the options used to create the mesh
  68619. * @param scene defines the hosting scene
  68620. * @param earcutInjection can be used to inject your own earcut reference
  68621. * @returns the polygon mesh
  68622. */
  68623. static ExtrudePolygon(name: string, options: {
  68624. shape: Vector3[];
  68625. holes?: Vector3[][];
  68626. depth?: number;
  68627. faceUV?: Vector4[];
  68628. faceColors?: Color4[];
  68629. updatable?: boolean;
  68630. sideOrientation?: number;
  68631. frontUVs?: Vector4;
  68632. backUVs?: Vector4;
  68633. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68634. /**
  68635. * Creates a tube mesh.
  68636. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68637. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68638. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68639. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68640. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68641. * * 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)
  68642. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68643. * * 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
  68644. * * 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
  68645. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68646. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68647. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68648. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68649. * @param name defines the name of the mesh
  68650. * @param options defines the options used to create the mesh
  68651. * @param scene defines the hosting scene
  68652. * @returns the tube mesh
  68653. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68654. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  68655. */
  68656. static CreateTube(name: string, options: {
  68657. path: Vector3[];
  68658. radius?: number;
  68659. tessellation?: number;
  68660. radiusFunction?: {
  68661. (i: number, distance: number): number;
  68662. };
  68663. cap?: number;
  68664. arc?: number;
  68665. updatable?: boolean;
  68666. sideOrientation?: number;
  68667. frontUVs?: Vector4;
  68668. backUVs?: Vector4;
  68669. instance?: Mesh;
  68670. invertUV?: boolean;
  68671. }, scene?: Nullable<Scene>): Mesh;
  68672. /**
  68673. * Creates a polyhedron mesh
  68674. * * 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
  68675. * * The parameter `size` (positive float, default 1) sets the polygon size
  68676. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  68677. * * 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`
  68678. * * 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
  68679. * * 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)`)
  68680. * * 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
  68681. * * 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
  68682. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68683. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68684. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68685. * @param name defines the name of the mesh
  68686. * @param options defines the options used to create the mesh
  68687. * @param scene defines the hosting scene
  68688. * @returns the polyhedron mesh
  68689. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  68690. */
  68691. static CreatePolyhedron(name: string, options: {
  68692. type?: number;
  68693. size?: number;
  68694. sizeX?: number;
  68695. sizeY?: number;
  68696. sizeZ?: number;
  68697. custom?: any;
  68698. faceUV?: Vector4[];
  68699. faceColors?: Color4[];
  68700. flat?: boolean;
  68701. updatable?: boolean;
  68702. sideOrientation?: number;
  68703. frontUVs?: Vector4;
  68704. backUVs?: Vector4;
  68705. }, scene?: Nullable<Scene>): Mesh;
  68706. /**
  68707. * Creates a decal mesh.
  68708. * 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
  68709. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  68710. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  68711. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  68712. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  68713. * @param name defines the name of the mesh
  68714. * @param sourceMesh defines the mesh where the decal must be applied
  68715. * @param options defines the options used to create the mesh
  68716. * @param scene defines the hosting scene
  68717. * @returns the decal mesh
  68718. * @see https://doc.babylonjs.com/how_to/decals
  68719. */
  68720. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  68721. position?: Vector3;
  68722. normal?: Vector3;
  68723. size?: Vector3;
  68724. angle?: number;
  68725. }): Mesh;
  68726. }
  68727. }
  68728. declare module "babylonjs/Meshes/meshSimplification" {
  68729. import { Mesh } from "babylonjs/Meshes/mesh";
  68730. /**
  68731. * A simplifier interface for future simplification implementations
  68732. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  68733. */
  68734. export interface ISimplifier {
  68735. /**
  68736. * Simplification of a given mesh according to the given settings.
  68737. * Since this requires computation, it is assumed that the function runs async.
  68738. * @param settings The settings of the simplification, including quality and distance
  68739. * @param successCallback A callback that will be called after the mesh was simplified.
  68740. * @param errorCallback in case of an error, this callback will be called. optional.
  68741. */
  68742. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  68743. }
  68744. /**
  68745. * Expected simplification settings.
  68746. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  68747. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  68748. */
  68749. export interface ISimplificationSettings {
  68750. /**
  68751. * Gets or sets the expected quality
  68752. */
  68753. quality: number;
  68754. /**
  68755. * Gets or sets the distance when this optimized version should be used
  68756. */
  68757. distance: number;
  68758. /**
  68759. * Gets an already optimized mesh
  68760. */
  68761. optimizeMesh?: boolean;
  68762. }
  68763. /**
  68764. * Class used to specify simplification options
  68765. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  68766. */
  68767. export class SimplificationSettings implements ISimplificationSettings {
  68768. /** expected quality */
  68769. quality: number;
  68770. /** distance when this optimized version should be used */
  68771. distance: number;
  68772. /** already optimized mesh */
  68773. optimizeMesh?: boolean | undefined;
  68774. /**
  68775. * Creates a SimplificationSettings
  68776. * @param quality expected quality
  68777. * @param distance distance when this optimized version should be used
  68778. * @param optimizeMesh already optimized mesh
  68779. */
  68780. constructor(
  68781. /** expected quality */
  68782. quality: number,
  68783. /** distance when this optimized version should be used */
  68784. distance: number,
  68785. /** already optimized mesh */
  68786. optimizeMesh?: boolean | undefined);
  68787. }
  68788. /**
  68789. * Interface used to define a simplification task
  68790. */
  68791. export interface ISimplificationTask {
  68792. /**
  68793. * Array of settings
  68794. */
  68795. settings: Array<ISimplificationSettings>;
  68796. /**
  68797. * Simplification type
  68798. */
  68799. simplificationType: SimplificationType;
  68800. /**
  68801. * Mesh to simplify
  68802. */
  68803. mesh: Mesh;
  68804. /**
  68805. * Callback called on success
  68806. */
  68807. successCallback?: () => void;
  68808. /**
  68809. * Defines if parallel processing can be used
  68810. */
  68811. parallelProcessing: boolean;
  68812. }
  68813. /**
  68814. * Queue used to order the simplification tasks
  68815. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  68816. */
  68817. export class SimplificationQueue {
  68818. private _simplificationArray;
  68819. /**
  68820. * Gets a boolean indicating that the process is still running
  68821. */
  68822. running: boolean;
  68823. /**
  68824. * Creates a new queue
  68825. */
  68826. constructor();
  68827. /**
  68828. * Adds a new simplification task
  68829. * @param task defines a task to add
  68830. */
  68831. addTask(task: ISimplificationTask): void;
  68832. /**
  68833. * Execute next task
  68834. */
  68835. executeNext(): void;
  68836. /**
  68837. * Execute a simplification task
  68838. * @param task defines the task to run
  68839. */
  68840. runSimplification(task: ISimplificationTask): void;
  68841. private getSimplifier;
  68842. }
  68843. /**
  68844. * The implemented types of simplification
  68845. * At the moment only Quadratic Error Decimation is implemented
  68846. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  68847. */
  68848. export enum SimplificationType {
  68849. /** Quadratic error decimation */
  68850. QUADRATIC = 0
  68851. }
  68852. /**
  68853. * An implementation of the Quadratic Error simplification algorithm.
  68854. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  68855. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  68856. * @author RaananW
  68857. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  68858. */
  68859. export class QuadraticErrorSimplification implements ISimplifier {
  68860. private _mesh;
  68861. private triangles;
  68862. private vertices;
  68863. private references;
  68864. private _reconstructedMesh;
  68865. /** Gets or sets the number pf sync interations */
  68866. syncIterations: number;
  68867. /** Gets or sets the aggressiveness of the simplifier */
  68868. aggressiveness: number;
  68869. /** Gets or sets the number of allowed iterations for decimation */
  68870. decimationIterations: number;
  68871. /** Gets or sets the espilon to use for bounding box computation */
  68872. boundingBoxEpsilon: number;
  68873. /**
  68874. * Creates a new QuadraticErrorSimplification
  68875. * @param _mesh defines the target mesh
  68876. */
  68877. constructor(_mesh: Mesh);
  68878. /**
  68879. * Simplification of a given mesh according to the given settings.
  68880. * Since this requires computation, it is assumed that the function runs async.
  68881. * @param settings The settings of the simplification, including quality and distance
  68882. * @param successCallback A callback that will be called after the mesh was simplified.
  68883. */
  68884. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  68885. private runDecimation;
  68886. private initWithMesh;
  68887. private init;
  68888. private reconstructMesh;
  68889. private initDecimatedMesh;
  68890. private isFlipped;
  68891. private updateTriangles;
  68892. private identifyBorder;
  68893. private updateMesh;
  68894. private vertexError;
  68895. private calculateError;
  68896. }
  68897. }
  68898. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  68899. import { Scene } from "babylonjs/scene";
  68900. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  68901. import { ISceneComponent } from "babylonjs/sceneComponent";
  68902. module "babylonjs/scene" {
  68903. interface Scene {
  68904. /** @hidden (Backing field) */
  68905. _simplificationQueue: SimplificationQueue;
  68906. /**
  68907. * Gets or sets the simplification queue attached to the scene
  68908. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  68909. */
  68910. simplificationQueue: SimplificationQueue;
  68911. }
  68912. }
  68913. module "babylonjs/Meshes/mesh" {
  68914. interface Mesh {
  68915. /**
  68916. * Simplify the mesh according to the given array of settings.
  68917. * Function will return immediately and will simplify async
  68918. * @param settings a collection of simplification settings
  68919. * @param parallelProcessing should all levels calculate parallel or one after the other
  68920. * @param simplificationType the type of simplification to run
  68921. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  68922. * @returns the current mesh
  68923. */
  68924. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  68925. }
  68926. }
  68927. /**
  68928. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  68929. * created in a scene
  68930. */
  68931. export class SimplicationQueueSceneComponent implements ISceneComponent {
  68932. /**
  68933. * The component name helpfull to identify the component in the list of scene components.
  68934. */
  68935. readonly name: string;
  68936. /**
  68937. * The scene the component belongs to.
  68938. */
  68939. scene: Scene;
  68940. /**
  68941. * Creates a new instance of the component for the given scene
  68942. * @param scene Defines the scene to register the component in
  68943. */
  68944. constructor(scene: Scene);
  68945. /**
  68946. * Registers the component in a given scene
  68947. */
  68948. register(): void;
  68949. /**
  68950. * Rebuilds the elements related to this component in case of
  68951. * context lost for instance.
  68952. */
  68953. rebuild(): void;
  68954. /**
  68955. * Disposes the component and the associated ressources
  68956. */
  68957. dispose(): void;
  68958. private _beforeCameraUpdate;
  68959. }
  68960. }
  68961. declare module "babylonjs/Meshes/Builders/index" {
  68962. export * from "babylonjs/Meshes/Builders/boxBuilder";
  68963. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  68964. export * from "babylonjs/Meshes/Builders/discBuilder";
  68965. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  68966. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  68967. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  68968. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  68969. export * from "babylonjs/Meshes/Builders/torusBuilder";
  68970. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  68971. export * from "babylonjs/Meshes/Builders/linesBuilder";
  68972. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  68973. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  68974. export * from "babylonjs/Meshes/Builders/latheBuilder";
  68975. export * from "babylonjs/Meshes/Builders/planeBuilder";
  68976. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  68977. export * from "babylonjs/Meshes/Builders/groundBuilder";
  68978. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  68979. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  68980. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  68981. export * from "babylonjs/Meshes/Builders/decalBuilder";
  68982. }
  68983. declare module "babylonjs/Meshes/thinInstanceMesh" {
  68984. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  68985. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  68986. import { Matrix } from "babylonjs/Maths/math.vector";
  68987. module "babylonjs/Meshes/mesh" {
  68988. interface Mesh {
  68989. /**
  68990. * Creates a new thin instance
  68991. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  68992. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  68993. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  68994. */
  68995. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  68996. /**
  68997. * Adds the transformation (matrix) of the current mesh as a thin instance
  68998. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  68999. * @returns the thin instance index number
  69000. */
  69001. thinInstanceAddSelf(refresh: boolean): number;
  69002. /**
  69003. * Registers a custom attribute to be used with thin instances
  69004. * @param kind name of the attribute
  69005. * @param stride size in floats of the attribute
  69006. */
  69007. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  69008. /**
  69009. * Sets the matrix of a thin instance
  69010. * @param index index of the thin instance
  69011. * @param matrix matrix to set
  69012. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  69013. */
  69014. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  69015. /**
  69016. * Sets the value of a custom attribute for a thin instance
  69017. * @param kind name of the attribute
  69018. * @param index index of the thin instance
  69019. * @param value value to set
  69020. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  69021. */
  69022. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  69023. /**
  69024. * Gets / sets the number of thin instances to display. Note that you can't set a number higher than what the underlying buffer can handle.
  69025. */
  69026. thinInstanceCount: number;
  69027. /**
  69028. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  69029. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  69030. * @param buffer buffer to set
  69031. * @param stride size in floats of each value of the buffer
  69032. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  69033. */
  69034. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  69035. /**
  69036. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  69037. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  69038. */
  69039. thinInstanceBufferUpdated(kind: string): void;
  69040. /**
  69041. * Refreshes the bounding info, taking into account all the thin instances defined
  69042. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  69043. */
  69044. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  69045. /** @hidden */
  69046. _thinInstanceInitializeUserStorage(): void;
  69047. /** @hidden */
  69048. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  69049. /** @hidden */
  69050. _userThinInstanceBuffersStorage: {
  69051. data: {
  69052. [key: string]: Float32Array;
  69053. };
  69054. sizes: {
  69055. [key: string]: number;
  69056. };
  69057. vertexBuffers: {
  69058. [key: string]: Nullable<VertexBuffer>;
  69059. };
  69060. strides: {
  69061. [key: string]: number;
  69062. };
  69063. };
  69064. }
  69065. }
  69066. }
  69067. declare module "babylonjs/Meshes/index" {
  69068. export * from "babylonjs/Meshes/abstractMesh";
  69069. export * from "babylonjs/Meshes/buffer";
  69070. export * from "babylonjs/Meshes/Compression/index";
  69071. export * from "babylonjs/Meshes/csg";
  69072. export * from "babylonjs/Meshes/geometry";
  69073. export * from "babylonjs/Meshes/groundMesh";
  69074. export * from "babylonjs/Meshes/trailMesh";
  69075. export * from "babylonjs/Meshes/instancedMesh";
  69076. export * from "babylonjs/Meshes/linesMesh";
  69077. export * from "babylonjs/Meshes/mesh";
  69078. export * from "babylonjs/Meshes/mesh.vertexData";
  69079. export * from "babylonjs/Meshes/meshBuilder";
  69080. export * from "babylonjs/Meshes/meshSimplification";
  69081. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  69082. export * from "babylonjs/Meshes/polygonMesh";
  69083. export * from "babylonjs/Meshes/subMesh";
  69084. export * from "babylonjs/Meshes/meshLODLevel";
  69085. export * from "babylonjs/Meshes/transformNode";
  69086. export * from "babylonjs/Meshes/Builders/index";
  69087. export * from "babylonjs/Meshes/dataBuffer";
  69088. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  69089. import "babylonjs/Meshes/thinInstanceMesh";
  69090. export * from "babylonjs/Meshes/thinInstanceMesh";
  69091. }
  69092. declare module "babylonjs/Morph/index" {
  69093. export * from "babylonjs/Morph/morphTarget";
  69094. export * from "babylonjs/Morph/morphTargetManager";
  69095. }
  69096. declare module "babylonjs/Navigation/INavigationEngine" {
  69097. import { TransformNode } from "babylonjs/Meshes/transformNode";
  69098. import { Vector3 } from "babylonjs/Maths/math";
  69099. import { Mesh } from "babylonjs/Meshes/mesh";
  69100. import { Scene } from "babylonjs/scene";
  69101. /**
  69102. * Navigation plugin interface to add navigation constrained by a navigation mesh
  69103. */
  69104. export interface INavigationEnginePlugin {
  69105. /**
  69106. * plugin name
  69107. */
  69108. name: string;
  69109. /**
  69110. * Creates a navigation mesh
  69111. * @param meshes array of all the geometry used to compute the navigatio mesh
  69112. * @param parameters bunch of parameters used to filter geometry
  69113. */
  69114. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  69115. /**
  69116. * Create a navigation mesh debug mesh
  69117. * @param scene is where the mesh will be added
  69118. * @returns debug display mesh
  69119. */
  69120. createDebugNavMesh(scene: Scene): Mesh;
  69121. /**
  69122. * Get a navigation mesh constrained position, closest to the parameter position
  69123. * @param position world position
  69124. * @returns the closest point to position constrained by the navigation mesh
  69125. */
  69126. getClosestPoint(position: Vector3): Vector3;
  69127. /**
  69128. * Get a navigation mesh constrained position, closest to the parameter position
  69129. * @param position world position
  69130. * @param result output the closest point to position constrained by the navigation mesh
  69131. */
  69132. getClosestPointToRef(position: Vector3, result: Vector3): void;
  69133. /**
  69134. * Get a navigation mesh constrained position, within a particular radius
  69135. * @param position world position
  69136. * @param maxRadius the maximum distance to the constrained world position
  69137. * @returns the closest point to position constrained by the navigation mesh
  69138. */
  69139. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  69140. /**
  69141. * Get a navigation mesh constrained position, within a particular radius
  69142. * @param position world position
  69143. * @param maxRadius the maximum distance to the constrained world position
  69144. * @param result output the closest point to position constrained by the navigation mesh
  69145. */
  69146. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  69147. /**
  69148. * Compute the final position from a segment made of destination-position
  69149. * @param position world position
  69150. * @param destination world position
  69151. * @returns the resulting point along the navmesh
  69152. */
  69153. moveAlong(position: Vector3, destination: Vector3): Vector3;
  69154. /**
  69155. * Compute the final position from a segment made of destination-position
  69156. * @param position world position
  69157. * @param destination world position
  69158. * @param result output the resulting point along the navmesh
  69159. */
  69160. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  69161. /**
  69162. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  69163. * @param start world position
  69164. * @param end world position
  69165. * @returns array containing world position composing the path
  69166. */
  69167. computePath(start: Vector3, end: Vector3): Vector3[];
  69168. /**
  69169. * If this plugin is supported
  69170. * @returns true if plugin is supported
  69171. */
  69172. isSupported(): boolean;
  69173. /**
  69174. * Create a new Crowd so you can add agents
  69175. * @param maxAgents the maximum agent count in the crowd
  69176. * @param maxAgentRadius the maximum radius an agent can have
  69177. * @param scene to attach the crowd to
  69178. * @returns the crowd you can add agents to
  69179. */
  69180. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  69181. /**
  69182. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  69183. * The queries will try to find a solution within those bounds
  69184. * default is (1,1,1)
  69185. * @param extent x,y,z value that define the extent around the queries point of reference
  69186. */
  69187. setDefaultQueryExtent(extent: Vector3): void;
  69188. /**
  69189. * Get the Bounding box extent specified by setDefaultQueryExtent
  69190. * @returns the box extent values
  69191. */
  69192. getDefaultQueryExtent(): Vector3;
  69193. /**
  69194. * build the navmesh from a previously saved state using getNavmeshData
  69195. * @param data the Uint8Array returned by getNavmeshData
  69196. */
  69197. buildFromNavmeshData(data: Uint8Array): void;
  69198. /**
  69199. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  69200. * @returns data the Uint8Array that can be saved and reused
  69201. */
  69202. getNavmeshData(): Uint8Array;
  69203. /**
  69204. * Get the Bounding box extent result specified by setDefaultQueryExtent
  69205. * @param result output the box extent values
  69206. */
  69207. getDefaultQueryExtentToRef(result: Vector3): void;
  69208. /**
  69209. * Release all resources
  69210. */
  69211. dispose(): void;
  69212. }
  69213. /**
  69214. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  69215. */
  69216. export interface ICrowd {
  69217. /**
  69218. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  69219. * You can attach anything to that node. The node position is updated in the scene update tick.
  69220. * @param pos world position that will be constrained by the navigation mesh
  69221. * @param parameters agent parameters
  69222. * @param transform hooked to the agent that will be update by the scene
  69223. * @returns agent index
  69224. */
  69225. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  69226. /**
  69227. * Returns the agent position in world space
  69228. * @param index agent index returned by addAgent
  69229. * @returns world space position
  69230. */
  69231. getAgentPosition(index: number): Vector3;
  69232. /**
  69233. * Gets the agent position result in world space
  69234. * @param index agent index returned by addAgent
  69235. * @param result output world space position
  69236. */
  69237. getAgentPositionToRef(index: number, result: Vector3): void;
  69238. /**
  69239. * Gets the agent velocity in world space
  69240. * @param index agent index returned by addAgent
  69241. * @returns world space velocity
  69242. */
  69243. getAgentVelocity(index: number): Vector3;
  69244. /**
  69245. * Gets the agent velocity result in world space
  69246. * @param index agent index returned by addAgent
  69247. * @param result output world space velocity
  69248. */
  69249. getAgentVelocityToRef(index: number, result: Vector3): void;
  69250. /**
  69251. * remove a particular agent previously created
  69252. * @param index agent index returned by addAgent
  69253. */
  69254. removeAgent(index: number): void;
  69255. /**
  69256. * get the list of all agents attached to this crowd
  69257. * @returns list of agent indices
  69258. */
  69259. getAgents(): number[];
  69260. /**
  69261. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  69262. * @param deltaTime in seconds
  69263. */
  69264. update(deltaTime: number): void;
  69265. /**
  69266. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  69267. * @param index agent index returned by addAgent
  69268. * @param destination targeted world position
  69269. */
  69270. agentGoto(index: number, destination: Vector3): void;
  69271. /**
  69272. * Teleport the agent to a new position
  69273. * @param index agent index returned by addAgent
  69274. * @param destination targeted world position
  69275. */
  69276. agentTeleport(index: number, destination: Vector3): void;
  69277. /**
  69278. * Update agent parameters
  69279. * @param index agent index returned by addAgent
  69280. * @param parameters agent parameters
  69281. */
  69282. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  69283. /**
  69284. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  69285. * The queries will try to find a solution within those bounds
  69286. * default is (1,1,1)
  69287. * @param extent x,y,z value that define the extent around the queries point of reference
  69288. */
  69289. setDefaultQueryExtent(extent: Vector3): void;
  69290. /**
  69291. * Get the Bounding box extent specified by setDefaultQueryExtent
  69292. * @returns the box extent values
  69293. */
  69294. getDefaultQueryExtent(): Vector3;
  69295. /**
  69296. * Get the Bounding box extent result specified by setDefaultQueryExtent
  69297. * @param result output the box extent values
  69298. */
  69299. getDefaultQueryExtentToRef(result: Vector3): void;
  69300. /**
  69301. * Release all resources
  69302. */
  69303. dispose(): void;
  69304. }
  69305. /**
  69306. * Configures an agent
  69307. */
  69308. export interface IAgentParameters {
  69309. /**
  69310. * Agent radius. [Limit: >= 0]
  69311. */
  69312. radius: number;
  69313. /**
  69314. * Agent height. [Limit: > 0]
  69315. */
  69316. height: number;
  69317. /**
  69318. * Maximum allowed acceleration. [Limit: >= 0]
  69319. */
  69320. maxAcceleration: number;
  69321. /**
  69322. * Maximum allowed speed. [Limit: >= 0]
  69323. */
  69324. maxSpeed: number;
  69325. /**
  69326. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  69327. */
  69328. collisionQueryRange: number;
  69329. /**
  69330. * The path visibility optimization range. [Limit: > 0]
  69331. */
  69332. pathOptimizationRange: number;
  69333. /**
  69334. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  69335. */
  69336. separationWeight: number;
  69337. }
  69338. /**
  69339. * Configures the navigation mesh creation
  69340. */
  69341. export interface INavMeshParameters {
  69342. /**
  69343. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  69344. */
  69345. cs: number;
  69346. /**
  69347. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  69348. */
  69349. ch: number;
  69350. /**
  69351. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  69352. */
  69353. walkableSlopeAngle: number;
  69354. /**
  69355. * Minimum floor to 'ceiling' height that will still allow the floor area to
  69356. * be considered walkable. [Limit: >= 3] [Units: vx]
  69357. */
  69358. walkableHeight: number;
  69359. /**
  69360. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  69361. */
  69362. walkableClimb: number;
  69363. /**
  69364. * The distance to erode/shrink the walkable area of the heightfield away from
  69365. * obstructions. [Limit: >=0] [Units: vx]
  69366. */
  69367. walkableRadius: number;
  69368. /**
  69369. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  69370. */
  69371. maxEdgeLen: number;
  69372. /**
  69373. * The maximum distance a simplfied contour's border edges should deviate
  69374. * the original raw contour. [Limit: >=0] [Units: vx]
  69375. */
  69376. maxSimplificationError: number;
  69377. /**
  69378. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  69379. */
  69380. minRegionArea: number;
  69381. /**
  69382. * Any regions with a span count smaller than this value will, if possible,
  69383. * be merged with larger regions. [Limit: >=0] [Units: vx]
  69384. */
  69385. mergeRegionArea: number;
  69386. /**
  69387. * The maximum number of vertices allowed for polygons generated during the
  69388. * contour to polygon conversion process. [Limit: >= 3]
  69389. */
  69390. maxVertsPerPoly: number;
  69391. /**
  69392. * Sets the sampling distance to use when generating the detail mesh.
  69393. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  69394. */
  69395. detailSampleDist: number;
  69396. /**
  69397. * The maximum distance the detail mesh surface should deviate from heightfield
  69398. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  69399. */
  69400. detailSampleMaxError: number;
  69401. }
  69402. }
  69403. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  69404. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  69405. import { Mesh } from "babylonjs/Meshes/mesh";
  69406. import { Scene } from "babylonjs/scene";
  69407. import { Vector3 } from "babylonjs/Maths/math";
  69408. import { TransformNode } from "babylonjs/Meshes/transformNode";
  69409. /**
  69410. * RecastJS navigation plugin
  69411. */
  69412. export class RecastJSPlugin implements INavigationEnginePlugin {
  69413. /**
  69414. * Reference to the Recast library
  69415. */
  69416. bjsRECAST: any;
  69417. /**
  69418. * plugin name
  69419. */
  69420. name: string;
  69421. /**
  69422. * the first navmesh created. We might extend this to support multiple navmeshes
  69423. */
  69424. navMesh: any;
  69425. /**
  69426. * Initializes the recastJS plugin
  69427. * @param recastInjection can be used to inject your own recast reference
  69428. */
  69429. constructor(recastInjection?: any);
  69430. /**
  69431. * Creates a navigation mesh
  69432. * @param meshes array of all the geometry used to compute the navigatio mesh
  69433. * @param parameters bunch of parameters used to filter geometry
  69434. */
  69435. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  69436. /**
  69437. * Create a navigation mesh debug mesh
  69438. * @param scene is where the mesh will be added
  69439. * @returns debug display mesh
  69440. */
  69441. createDebugNavMesh(scene: Scene): Mesh;
  69442. /**
  69443. * Get a navigation mesh constrained position, closest to the parameter position
  69444. * @param position world position
  69445. * @returns the closest point to position constrained by the navigation mesh
  69446. */
  69447. getClosestPoint(position: Vector3): Vector3;
  69448. /**
  69449. * Get a navigation mesh constrained position, closest to the parameter position
  69450. * @param position world position
  69451. * @param result output the closest point to position constrained by the navigation mesh
  69452. */
  69453. getClosestPointToRef(position: Vector3, result: Vector3): void;
  69454. /**
  69455. * Get a navigation mesh constrained position, within a particular radius
  69456. * @param position world position
  69457. * @param maxRadius the maximum distance to the constrained world position
  69458. * @returns the closest point to position constrained by the navigation mesh
  69459. */
  69460. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  69461. /**
  69462. * Get a navigation mesh constrained position, within a particular radius
  69463. * @param position world position
  69464. * @param maxRadius the maximum distance to the constrained world position
  69465. * @param result output the closest point to position constrained by the navigation mesh
  69466. */
  69467. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  69468. /**
  69469. * Compute the final position from a segment made of destination-position
  69470. * @param position world position
  69471. * @param destination world position
  69472. * @returns the resulting point along the navmesh
  69473. */
  69474. moveAlong(position: Vector3, destination: Vector3): Vector3;
  69475. /**
  69476. * Compute the final position from a segment made of destination-position
  69477. * @param position world position
  69478. * @param destination world position
  69479. * @param result output the resulting point along the navmesh
  69480. */
  69481. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  69482. /**
  69483. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  69484. * @param start world position
  69485. * @param end world position
  69486. * @returns array containing world position composing the path
  69487. */
  69488. computePath(start: Vector3, end: Vector3): Vector3[];
  69489. /**
  69490. * Create a new Crowd so you can add agents
  69491. * @param maxAgents the maximum agent count in the crowd
  69492. * @param maxAgentRadius the maximum radius an agent can have
  69493. * @param scene to attach the crowd to
  69494. * @returns the crowd you can add agents to
  69495. */
  69496. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  69497. /**
  69498. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  69499. * The queries will try to find a solution within those bounds
  69500. * default is (1,1,1)
  69501. * @param extent x,y,z value that define the extent around the queries point of reference
  69502. */
  69503. setDefaultQueryExtent(extent: Vector3): void;
  69504. /**
  69505. * Get the Bounding box extent specified by setDefaultQueryExtent
  69506. * @returns the box extent values
  69507. */
  69508. getDefaultQueryExtent(): Vector3;
  69509. /**
  69510. * build the navmesh from a previously saved state using getNavmeshData
  69511. * @param data the Uint8Array returned by getNavmeshData
  69512. */
  69513. buildFromNavmeshData(data: Uint8Array): void;
  69514. /**
  69515. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  69516. * @returns data the Uint8Array that can be saved and reused
  69517. */
  69518. getNavmeshData(): Uint8Array;
  69519. /**
  69520. * Get the Bounding box extent result specified by setDefaultQueryExtent
  69521. * @param result output the box extent values
  69522. */
  69523. getDefaultQueryExtentToRef(result: Vector3): void;
  69524. /**
  69525. * Disposes
  69526. */
  69527. dispose(): void;
  69528. /**
  69529. * If this plugin is supported
  69530. * @returns true if plugin is supported
  69531. */
  69532. isSupported(): boolean;
  69533. }
  69534. /**
  69535. * Recast detour crowd implementation
  69536. */
  69537. export class RecastJSCrowd implements ICrowd {
  69538. /**
  69539. * Recast/detour plugin
  69540. */
  69541. bjsRECASTPlugin: RecastJSPlugin;
  69542. /**
  69543. * Link to the detour crowd
  69544. */
  69545. recastCrowd: any;
  69546. /**
  69547. * One transform per agent
  69548. */
  69549. transforms: TransformNode[];
  69550. /**
  69551. * All agents created
  69552. */
  69553. agents: number[];
  69554. /**
  69555. * Link to the scene is kept to unregister the crowd from the scene
  69556. */
  69557. private _scene;
  69558. /**
  69559. * Observer for crowd updates
  69560. */
  69561. private _onBeforeAnimationsObserver;
  69562. /**
  69563. * Constructor
  69564. * @param plugin recastJS plugin
  69565. * @param maxAgents the maximum agent count in the crowd
  69566. * @param maxAgentRadius the maximum radius an agent can have
  69567. * @param scene to attach the crowd to
  69568. * @returns the crowd you can add agents to
  69569. */
  69570. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  69571. /**
  69572. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  69573. * You can attach anything to that node. The node position is updated in the scene update tick.
  69574. * @param pos world position that will be constrained by the navigation mesh
  69575. * @param parameters agent parameters
  69576. * @param transform hooked to the agent that will be update by the scene
  69577. * @returns agent index
  69578. */
  69579. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  69580. /**
  69581. * Returns the agent position in world space
  69582. * @param index agent index returned by addAgent
  69583. * @returns world space position
  69584. */
  69585. getAgentPosition(index: number): Vector3;
  69586. /**
  69587. * Returns the agent position result in world space
  69588. * @param index agent index returned by addAgent
  69589. * @param result output world space position
  69590. */
  69591. getAgentPositionToRef(index: number, result: Vector3): void;
  69592. /**
  69593. * Returns the agent velocity in world space
  69594. * @param index agent index returned by addAgent
  69595. * @returns world space velocity
  69596. */
  69597. getAgentVelocity(index: number): Vector3;
  69598. /**
  69599. * Returns the agent velocity result in world space
  69600. * @param index agent index returned by addAgent
  69601. * @param result output world space velocity
  69602. */
  69603. getAgentVelocityToRef(index: number, result: Vector3): void;
  69604. /**
  69605. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  69606. * @param index agent index returned by addAgent
  69607. * @param destination targeted world position
  69608. */
  69609. agentGoto(index: number, destination: Vector3): void;
  69610. /**
  69611. * Teleport the agent to a new position
  69612. * @param index agent index returned by addAgent
  69613. * @param destination targeted world position
  69614. */
  69615. agentTeleport(index: number, destination: Vector3): void;
  69616. /**
  69617. * Update agent parameters
  69618. * @param index agent index returned by addAgent
  69619. * @param parameters agent parameters
  69620. */
  69621. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  69622. /**
  69623. * remove a particular agent previously created
  69624. * @param index agent index returned by addAgent
  69625. */
  69626. removeAgent(index: number): void;
  69627. /**
  69628. * get the list of all agents attached to this crowd
  69629. * @returns list of agent indices
  69630. */
  69631. getAgents(): number[];
  69632. /**
  69633. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  69634. * @param deltaTime in seconds
  69635. */
  69636. update(deltaTime: number): void;
  69637. /**
  69638. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  69639. * The queries will try to find a solution within those bounds
  69640. * default is (1,1,1)
  69641. * @param extent x,y,z value that define the extent around the queries point of reference
  69642. */
  69643. setDefaultQueryExtent(extent: Vector3): void;
  69644. /**
  69645. * Get the Bounding box extent specified by setDefaultQueryExtent
  69646. * @returns the box extent values
  69647. */
  69648. getDefaultQueryExtent(): Vector3;
  69649. /**
  69650. * Get the Bounding box extent result specified by setDefaultQueryExtent
  69651. * @param result output the box extent values
  69652. */
  69653. getDefaultQueryExtentToRef(result: Vector3): void;
  69654. /**
  69655. * Release all resources
  69656. */
  69657. dispose(): void;
  69658. }
  69659. }
  69660. declare module "babylonjs/Navigation/Plugins/index" {
  69661. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  69662. }
  69663. declare module "babylonjs/Navigation/index" {
  69664. export * from "babylonjs/Navigation/INavigationEngine";
  69665. export * from "babylonjs/Navigation/Plugins/index";
  69666. }
  69667. declare module "babylonjs/Offline/database" {
  69668. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  69669. /**
  69670. * Class used to enable access to IndexedDB
  69671. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  69672. */
  69673. export class Database implements IOfflineProvider {
  69674. private _callbackManifestChecked;
  69675. private _currentSceneUrl;
  69676. private _db;
  69677. private _enableSceneOffline;
  69678. private _enableTexturesOffline;
  69679. private _manifestVersionFound;
  69680. private _mustUpdateRessources;
  69681. private _hasReachedQuota;
  69682. private _isSupported;
  69683. private _idbFactory;
  69684. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  69685. private static IsUASupportingBlobStorage;
  69686. /**
  69687. * Gets a boolean indicating if Database storate is enabled (off by default)
  69688. */
  69689. static IDBStorageEnabled: boolean;
  69690. /**
  69691. * Gets a boolean indicating if scene must be saved in the database
  69692. */
  69693. get enableSceneOffline(): boolean;
  69694. /**
  69695. * Gets a boolean indicating if textures must be saved in the database
  69696. */
  69697. get enableTexturesOffline(): boolean;
  69698. /**
  69699. * Creates a new Database
  69700. * @param urlToScene defines the url to load the scene
  69701. * @param callbackManifestChecked defines the callback to use when manifest is checked
  69702. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  69703. */
  69704. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  69705. private static _ParseURL;
  69706. private static _ReturnFullUrlLocation;
  69707. private _checkManifestFile;
  69708. /**
  69709. * Open the database and make it available
  69710. * @param successCallback defines the callback to call on success
  69711. * @param errorCallback defines the callback to call on error
  69712. */
  69713. open(successCallback: () => void, errorCallback: () => void): void;
  69714. /**
  69715. * Loads an image from the database
  69716. * @param url defines the url to load from
  69717. * @param image defines the target DOM image
  69718. */
  69719. loadImage(url: string, image: HTMLImageElement): void;
  69720. private _loadImageFromDBAsync;
  69721. private _saveImageIntoDBAsync;
  69722. private _checkVersionFromDB;
  69723. private _loadVersionFromDBAsync;
  69724. private _saveVersionIntoDBAsync;
  69725. /**
  69726. * Loads a file from database
  69727. * @param url defines the URL to load from
  69728. * @param sceneLoaded defines a callback to call on success
  69729. * @param progressCallBack defines a callback to call when progress changed
  69730. * @param errorCallback defines a callback to call on error
  69731. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  69732. */
  69733. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  69734. private _loadFileAsync;
  69735. private _saveFileAsync;
  69736. /**
  69737. * Validates if xhr data is correct
  69738. * @param xhr defines the request to validate
  69739. * @param dataType defines the expected data type
  69740. * @returns true if data is correct
  69741. */
  69742. private static _ValidateXHRData;
  69743. }
  69744. }
  69745. declare module "babylonjs/Offline/index" {
  69746. export * from "babylonjs/Offline/database";
  69747. export * from "babylonjs/Offline/IOfflineProvider";
  69748. }
  69749. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  69750. /** @hidden */
  69751. export var gpuUpdateParticlesPixelShader: {
  69752. name: string;
  69753. shader: string;
  69754. };
  69755. }
  69756. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  69757. /** @hidden */
  69758. export var gpuUpdateParticlesVertexShader: {
  69759. name: string;
  69760. shader: string;
  69761. };
  69762. }
  69763. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  69764. /** @hidden */
  69765. export var clipPlaneFragmentDeclaration2: {
  69766. name: string;
  69767. shader: string;
  69768. };
  69769. }
  69770. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  69771. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  69772. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  69773. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  69774. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  69775. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  69776. /** @hidden */
  69777. export var gpuRenderParticlesPixelShader: {
  69778. name: string;
  69779. shader: string;
  69780. };
  69781. }
  69782. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  69783. /** @hidden */
  69784. export var clipPlaneVertexDeclaration2: {
  69785. name: string;
  69786. shader: string;
  69787. };
  69788. }
  69789. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  69790. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  69791. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  69792. /** @hidden */
  69793. export var gpuRenderParticlesVertexShader: {
  69794. name: string;
  69795. shader: string;
  69796. };
  69797. }
  69798. declare module "babylonjs/Particles/gpuParticleSystem" {
  69799. import { Nullable } from "babylonjs/types";
  69800. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  69801. import { Observable } from "babylonjs/Misc/observable";
  69802. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69803. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  69804. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  69805. import { Scene, IDisposable } from "babylonjs/scene";
  69806. import { Effect } from "babylonjs/Materials/effect";
  69807. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  69808. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  69809. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  69810. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  69811. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  69812. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  69813. /**
  69814. * This represents a GPU particle system in Babylon
  69815. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  69816. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  69817. */
  69818. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  69819. /**
  69820. * The layer mask we are rendering the particles through.
  69821. */
  69822. layerMask: number;
  69823. private _capacity;
  69824. private _activeCount;
  69825. private _currentActiveCount;
  69826. private _accumulatedCount;
  69827. private _renderEffect;
  69828. private _updateEffect;
  69829. private _buffer0;
  69830. private _buffer1;
  69831. private _spriteBuffer;
  69832. private _updateVAO;
  69833. private _renderVAO;
  69834. private _targetIndex;
  69835. private _sourceBuffer;
  69836. private _targetBuffer;
  69837. private _engine;
  69838. private _currentRenderId;
  69839. private _started;
  69840. private _stopped;
  69841. private _timeDelta;
  69842. private _randomTexture;
  69843. private _randomTexture2;
  69844. private _attributesStrideSize;
  69845. private _updateEffectOptions;
  69846. private _randomTextureSize;
  69847. private _actualFrame;
  69848. private _customEffect;
  69849. private readonly _rawTextureWidth;
  69850. /**
  69851. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  69852. */
  69853. static get IsSupported(): boolean;
  69854. /**
  69855. * An event triggered when the system is disposed.
  69856. */
  69857. onDisposeObservable: Observable<IParticleSystem>;
  69858. /**
  69859. * Gets the maximum number of particles active at the same time.
  69860. * @returns The max number of active particles.
  69861. */
  69862. getCapacity(): number;
  69863. /**
  69864. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  69865. * to override the particles.
  69866. */
  69867. forceDepthWrite: boolean;
  69868. /**
  69869. * Gets or set the number of active particles
  69870. */
  69871. get activeParticleCount(): number;
  69872. set activeParticleCount(value: number);
  69873. private _preWarmDone;
  69874. /**
  69875. * Specifies if the particles are updated in emitter local space or world space.
  69876. */
  69877. isLocal: boolean;
  69878. /**
  69879. * Is this system ready to be used/rendered
  69880. * @return true if the system is ready
  69881. */
  69882. isReady(): boolean;
  69883. /**
  69884. * Gets if the system has been started. (Note: this will still be true after stop is called)
  69885. * @returns True if it has been started, otherwise false.
  69886. */
  69887. isStarted(): boolean;
  69888. /**
  69889. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  69890. * @returns True if it has been stopped, otherwise false.
  69891. */
  69892. isStopped(): boolean;
  69893. /**
  69894. * Gets a boolean indicating that the system is stopping
  69895. * @returns true if the system is currently stopping
  69896. */
  69897. isStopping(): boolean;
  69898. /**
  69899. * Gets the number of particles active at the same time.
  69900. * @returns The number of active particles.
  69901. */
  69902. getActiveCount(): number;
  69903. /**
  69904. * Starts the particle system and begins to emit
  69905. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  69906. */
  69907. start(delay?: number): void;
  69908. /**
  69909. * Stops the particle system.
  69910. */
  69911. stop(): void;
  69912. /**
  69913. * Remove all active particles
  69914. */
  69915. reset(): void;
  69916. /**
  69917. * Returns the string "GPUParticleSystem"
  69918. * @returns a string containing the class name
  69919. */
  69920. getClassName(): string;
  69921. /**
  69922. * Gets the custom effect used to render the particles
  69923. * @param blendMode Blend mode for which the effect should be retrieved
  69924. * @returns The effect
  69925. */
  69926. getCustomEffect(blendMode?: number): Nullable<Effect>;
  69927. /**
  69928. * Sets the custom effect used to render the particles
  69929. * @param effect The effect to set
  69930. * @param blendMode Blend mode for which the effect should be set
  69931. */
  69932. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  69933. /** @hidden */
  69934. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  69935. /**
  69936. * Observable that will be called just before the particles are drawn
  69937. */
  69938. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  69939. /**
  69940. * Gets the name of the particle vertex shader
  69941. */
  69942. get vertexShaderName(): string;
  69943. private _colorGradientsTexture;
  69944. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  69945. /**
  69946. * Adds a new color gradient
  69947. * @param gradient defines the gradient to use (between 0 and 1)
  69948. * @param color1 defines the color to affect to the specified gradient
  69949. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  69950. * @returns the current particle system
  69951. */
  69952. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  69953. private _refreshColorGradient;
  69954. /** Force the system to rebuild all gradients that need to be resync */
  69955. forceRefreshGradients(): void;
  69956. /**
  69957. * Remove a specific color gradient
  69958. * @param gradient defines the gradient to remove
  69959. * @returns the current particle system
  69960. */
  69961. removeColorGradient(gradient: number): GPUParticleSystem;
  69962. private _angularSpeedGradientsTexture;
  69963. private _sizeGradientsTexture;
  69964. private _velocityGradientsTexture;
  69965. private _limitVelocityGradientsTexture;
  69966. private _dragGradientsTexture;
  69967. private _addFactorGradient;
  69968. /**
  69969. * Adds a new size gradient
  69970. * @param gradient defines the gradient to use (between 0 and 1)
  69971. * @param factor defines the size factor to affect to the specified gradient
  69972. * @returns the current particle system
  69973. */
  69974. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  69975. /**
  69976. * Remove a specific size gradient
  69977. * @param gradient defines the gradient to remove
  69978. * @returns the current particle system
  69979. */
  69980. removeSizeGradient(gradient: number): GPUParticleSystem;
  69981. private _refreshFactorGradient;
  69982. /**
  69983. * Adds a new angular speed gradient
  69984. * @param gradient defines the gradient to use (between 0 and 1)
  69985. * @param factor defines the angular speed to affect to the specified gradient
  69986. * @returns the current particle system
  69987. */
  69988. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  69989. /**
  69990. * Remove a specific angular speed gradient
  69991. * @param gradient defines the gradient to remove
  69992. * @returns the current particle system
  69993. */
  69994. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  69995. /**
  69996. * Adds a new velocity gradient
  69997. * @param gradient defines the gradient to use (between 0 and 1)
  69998. * @param factor defines the velocity to affect to the specified gradient
  69999. * @returns the current particle system
  70000. */
  70001. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  70002. /**
  70003. * Remove a specific velocity gradient
  70004. * @param gradient defines the gradient to remove
  70005. * @returns the current particle system
  70006. */
  70007. removeVelocityGradient(gradient: number): GPUParticleSystem;
  70008. /**
  70009. * Adds a new limit velocity gradient
  70010. * @param gradient defines the gradient to use (between 0 and 1)
  70011. * @param factor defines the limit velocity value to affect to the specified gradient
  70012. * @returns the current particle system
  70013. */
  70014. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  70015. /**
  70016. * Remove a specific limit velocity gradient
  70017. * @param gradient defines the gradient to remove
  70018. * @returns the current particle system
  70019. */
  70020. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  70021. /**
  70022. * Adds a new drag gradient
  70023. * @param gradient defines the gradient to use (between 0 and 1)
  70024. * @param factor defines the drag value to affect to the specified gradient
  70025. * @returns the current particle system
  70026. */
  70027. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  70028. /**
  70029. * Remove a specific drag gradient
  70030. * @param gradient defines the gradient to remove
  70031. * @returns the current particle system
  70032. */
  70033. removeDragGradient(gradient: number): GPUParticleSystem;
  70034. /**
  70035. * Not supported by GPUParticleSystem
  70036. * @param gradient defines the gradient to use (between 0 and 1)
  70037. * @param factor defines the emit rate value to affect to the specified gradient
  70038. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  70039. * @returns the current particle system
  70040. */
  70041. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  70042. /**
  70043. * Not supported by GPUParticleSystem
  70044. * @param gradient defines the gradient to remove
  70045. * @returns the current particle system
  70046. */
  70047. removeEmitRateGradient(gradient: number): IParticleSystem;
  70048. /**
  70049. * Not supported by GPUParticleSystem
  70050. * @param gradient defines the gradient to use (between 0 and 1)
  70051. * @param factor defines the start size value to affect to the specified gradient
  70052. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  70053. * @returns the current particle system
  70054. */
  70055. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  70056. /**
  70057. * Not supported by GPUParticleSystem
  70058. * @param gradient defines the gradient to remove
  70059. * @returns the current particle system
  70060. */
  70061. removeStartSizeGradient(gradient: number): IParticleSystem;
  70062. /**
  70063. * Not supported by GPUParticleSystem
  70064. * @param gradient defines the gradient to use (between 0 and 1)
  70065. * @param min defines the color remap minimal range
  70066. * @param max defines the color remap maximal range
  70067. * @returns the current particle system
  70068. */
  70069. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  70070. /**
  70071. * Not supported by GPUParticleSystem
  70072. * @param gradient defines the gradient to remove
  70073. * @returns the current particle system
  70074. */
  70075. removeColorRemapGradient(): IParticleSystem;
  70076. /**
  70077. * Not supported by GPUParticleSystem
  70078. * @param gradient defines the gradient to use (between 0 and 1)
  70079. * @param min defines the alpha remap minimal range
  70080. * @param max defines the alpha remap maximal range
  70081. * @returns the current particle system
  70082. */
  70083. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  70084. /**
  70085. * Not supported by GPUParticleSystem
  70086. * @param gradient defines the gradient to remove
  70087. * @returns the current particle system
  70088. */
  70089. removeAlphaRemapGradient(): IParticleSystem;
  70090. /**
  70091. * Not supported by GPUParticleSystem
  70092. * @param gradient defines the gradient to use (between 0 and 1)
  70093. * @param color defines the color to affect to the specified gradient
  70094. * @returns the current particle system
  70095. */
  70096. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  70097. /**
  70098. * Not supported by GPUParticleSystem
  70099. * @param gradient defines the gradient to remove
  70100. * @returns the current particle system
  70101. */
  70102. removeRampGradient(): IParticleSystem;
  70103. /**
  70104. * Not supported by GPUParticleSystem
  70105. * @returns the list of ramp gradients
  70106. */
  70107. getRampGradients(): Nullable<Array<Color3Gradient>>;
  70108. /**
  70109. * Not supported by GPUParticleSystem
  70110. * Gets or sets a boolean indicating that ramp gradients must be used
  70111. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  70112. */
  70113. get useRampGradients(): boolean;
  70114. set useRampGradients(value: boolean);
  70115. /**
  70116. * Not supported by GPUParticleSystem
  70117. * @param gradient defines the gradient to use (between 0 and 1)
  70118. * @param factor defines the life time factor to affect to the specified gradient
  70119. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  70120. * @returns the current particle system
  70121. */
  70122. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  70123. /**
  70124. * Not supported by GPUParticleSystem
  70125. * @param gradient defines the gradient to remove
  70126. * @returns the current particle system
  70127. */
  70128. removeLifeTimeGradient(gradient: number): IParticleSystem;
  70129. /**
  70130. * Instantiates a GPU particle system.
  70131. * 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.
  70132. * @param name The name of the particle system
  70133. * @param options The options used to create the system
  70134. * @param scene The scene the particle system belongs to
  70135. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  70136. * @param customEffect a custom effect used to change the way particles are rendered by default
  70137. */
  70138. constructor(name: string, options: Partial<{
  70139. capacity: number;
  70140. randomTextureSize: number;
  70141. }>, scene: Scene, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  70142. protected _reset(): void;
  70143. private _createUpdateVAO;
  70144. private _createRenderVAO;
  70145. private _initialize;
  70146. /** @hidden */
  70147. _recreateUpdateEffect(): void;
  70148. private _getEffect;
  70149. /**
  70150. * Fill the defines array according to the current settings of the particle system
  70151. * @param defines Array to be updated
  70152. * @param blendMode blend mode to take into account when updating the array
  70153. */
  70154. fillDefines(defines: Array<string>, blendMode?: number): void;
  70155. /**
  70156. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  70157. * @param uniforms Uniforms array to fill
  70158. * @param attributes Attributes array to fill
  70159. * @param samplers Samplers array to fill
  70160. */
  70161. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  70162. /** @hidden */
  70163. _recreateRenderEffect(): Effect;
  70164. /**
  70165. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  70166. * @param preWarm defines if we are in the pre-warmimg phase
  70167. */
  70168. animate(preWarm?: boolean): void;
  70169. private _createFactorGradientTexture;
  70170. private _createSizeGradientTexture;
  70171. private _createAngularSpeedGradientTexture;
  70172. private _createVelocityGradientTexture;
  70173. private _createLimitVelocityGradientTexture;
  70174. private _createDragGradientTexture;
  70175. private _createColorGradientTexture;
  70176. /**
  70177. * Renders the particle system in its current state
  70178. * @param preWarm defines if the system should only update the particles but not render them
  70179. * @returns the current number of particles
  70180. */
  70181. render(preWarm?: boolean): number;
  70182. /**
  70183. * Rebuilds the particle system
  70184. */
  70185. rebuild(): void;
  70186. private _releaseBuffers;
  70187. private _releaseVAOs;
  70188. /**
  70189. * Disposes the particle system and free the associated resources
  70190. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  70191. */
  70192. dispose(disposeTexture?: boolean): void;
  70193. /**
  70194. * Clones the particle system.
  70195. * @param name The name of the cloned object
  70196. * @param newEmitter The new emitter to use
  70197. * @returns the cloned particle system
  70198. */
  70199. clone(name: string, newEmitter: any): GPUParticleSystem;
  70200. /**
  70201. * Serializes the particle system to a JSON object
  70202. * @param serializeTexture defines if the texture must be serialized as well
  70203. * @returns the JSON object
  70204. */
  70205. serialize(serializeTexture?: boolean): any;
  70206. /**
  70207. * Parses a JSON object to create a GPU particle system.
  70208. * @param parsedParticleSystem The JSON object to parse
  70209. * @param scene The scene to create the particle system in
  70210. * @param rootUrl The root url to use to load external dependencies like texture
  70211. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  70212. * @returns the parsed GPU particle system
  70213. */
  70214. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  70215. }
  70216. }
  70217. declare module "babylonjs/Particles/particleSystemSet" {
  70218. import { Nullable } from "babylonjs/types";
  70219. import { Color3 } from "babylonjs/Maths/math.color";
  70220. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70221. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  70222. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70223. import { Scene, IDisposable } from "babylonjs/scene";
  70224. /**
  70225. * Represents a set of particle systems working together to create a specific effect
  70226. */
  70227. export class ParticleSystemSet implements IDisposable {
  70228. /**
  70229. * Gets or sets base Assets URL
  70230. */
  70231. static BaseAssetsUrl: string;
  70232. private _emitterCreationOptions;
  70233. private _emitterNode;
  70234. /**
  70235. * Gets the particle system list
  70236. */
  70237. systems: IParticleSystem[];
  70238. /**
  70239. * Gets the emitter node used with this set
  70240. */
  70241. get emitterNode(): Nullable<TransformNode>;
  70242. /**
  70243. * Creates a new emitter mesh as a sphere
  70244. * @param options defines the options used to create the sphere
  70245. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  70246. * @param scene defines the hosting scene
  70247. */
  70248. setEmitterAsSphere(options: {
  70249. diameter: number;
  70250. segments: number;
  70251. color: Color3;
  70252. }, renderingGroupId: number, scene: Scene): void;
  70253. /**
  70254. * Starts all particle systems of the set
  70255. * @param emitter defines an optional mesh to use as emitter for the particle systems
  70256. */
  70257. start(emitter?: AbstractMesh): void;
  70258. /**
  70259. * Release all associated resources
  70260. */
  70261. dispose(): void;
  70262. /**
  70263. * Serialize the set into a JSON compatible object
  70264. * @param serializeTexture defines if the texture must be serialized as well
  70265. * @returns a JSON compatible representation of the set
  70266. */
  70267. serialize(serializeTexture?: boolean): any;
  70268. /**
  70269. * Parse a new ParticleSystemSet from a serialized source
  70270. * @param data defines a JSON compatible representation of the set
  70271. * @param scene defines the hosting scene
  70272. * @param gpu defines if we want GPU particles or CPU particles
  70273. * @returns a new ParticleSystemSet
  70274. */
  70275. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  70276. }
  70277. }
  70278. declare module "babylonjs/Particles/particleHelper" {
  70279. import { Nullable } from "babylonjs/types";
  70280. import { Scene } from "babylonjs/scene";
  70281. import { Vector3 } from "babylonjs/Maths/math.vector";
  70282. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  70283. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70284. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  70285. /**
  70286. * This class is made for on one-liner static method to help creating particle system set.
  70287. */
  70288. export class ParticleHelper {
  70289. /**
  70290. * Gets or sets base Assets URL
  70291. */
  70292. static BaseAssetsUrl: string;
  70293. /** Define the Url to load snippets */
  70294. static SnippetUrl: string;
  70295. /**
  70296. * Create a default particle system that you can tweak
  70297. * @param emitter defines the emitter to use
  70298. * @param capacity defines the system capacity (default is 500 particles)
  70299. * @param scene defines the hosting scene
  70300. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  70301. * @returns the new Particle system
  70302. */
  70303. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  70304. /**
  70305. * This is the main static method (one-liner) of this helper to create different particle systems
  70306. * @param type This string represents the type to the particle system to create
  70307. * @param scene The scene where the particle system should live
  70308. * @param gpu If the system will use gpu
  70309. * @returns the ParticleSystemSet created
  70310. */
  70311. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  70312. /**
  70313. * Static function used to export a particle system to a ParticleSystemSet variable.
  70314. * Please note that the emitter shape is not exported
  70315. * @param systems defines the particle systems to export
  70316. * @returns the created particle system set
  70317. */
  70318. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  70319. /**
  70320. * Creates a particle system from a snippet saved in a remote file
  70321. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  70322. * @param url defines the url to load from
  70323. * @param scene defines the hosting scene
  70324. * @param gpu If the system will use gpu
  70325. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  70326. * @returns a promise that will resolve to the new particle system
  70327. */
  70328. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  70329. /**
  70330. * Creates a particle system from a snippet saved by the particle system editor
  70331. * @param snippetId defines the snippet to load
  70332. * @param scene defines the hosting scene
  70333. * @param gpu If the system will use gpu
  70334. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  70335. * @returns a promise that will resolve to the new particle system
  70336. */
  70337. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  70338. }
  70339. }
  70340. declare module "babylonjs/Particles/particleSystemComponent" {
  70341. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70342. import { Effect } from "babylonjs/Materials/effect";
  70343. import "babylonjs/Shaders/particles.vertex";
  70344. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  70345. module "babylonjs/Engines/engine" {
  70346. interface Engine {
  70347. /**
  70348. * Create an effect to use with particle systems.
  70349. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  70350. * the particle system for which you want to create a custom effect in the last parameter
  70351. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  70352. * @param uniformsNames defines a list of attribute names
  70353. * @param samplers defines an array of string used to represent textures
  70354. * @param defines defines the string containing the defines to use to compile the shaders
  70355. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  70356. * @param onCompiled defines a function to call when the effect creation is successful
  70357. * @param onError defines a function to call when the effect creation has failed
  70358. * @param particleSystem the particle system you want to create the effect for
  70359. * @returns the new Effect
  70360. */
  70361. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  70362. }
  70363. }
  70364. module "babylonjs/Meshes/mesh" {
  70365. interface Mesh {
  70366. /**
  70367. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  70368. * @returns an array of IParticleSystem
  70369. */
  70370. getEmittedParticleSystems(): IParticleSystem[];
  70371. /**
  70372. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  70373. * @returns an array of IParticleSystem
  70374. */
  70375. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  70376. }
  70377. }
  70378. }
  70379. declare module "babylonjs/Particles/pointsCloudSystem" {
  70380. import { Color4 } from "babylonjs/Maths/math";
  70381. import { Mesh } from "babylonjs/Meshes/mesh";
  70382. import { Scene, IDisposable } from "babylonjs/scene";
  70383. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  70384. /** Defines the 4 color options */
  70385. export enum PointColor {
  70386. /** color value */
  70387. Color = 2,
  70388. /** uv value */
  70389. UV = 1,
  70390. /** random value */
  70391. Random = 0,
  70392. /** stated value */
  70393. Stated = 3
  70394. }
  70395. /**
  70396. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  70397. * 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.
  70398. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  70399. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  70400. *
  70401. * Full documentation here : TO BE ENTERED
  70402. */
  70403. export class PointsCloudSystem implements IDisposable {
  70404. /**
  70405. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  70406. * Example : var p = SPS.particles[i];
  70407. */
  70408. particles: CloudPoint[];
  70409. /**
  70410. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  70411. */
  70412. nbParticles: number;
  70413. /**
  70414. * This a counter for your own usage. It's not set by any SPS functions.
  70415. */
  70416. counter: number;
  70417. /**
  70418. * The PCS name. This name is also given to the underlying mesh.
  70419. */
  70420. name: string;
  70421. /**
  70422. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  70423. */
  70424. mesh: Mesh;
  70425. /**
  70426. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  70427. * Please read :
  70428. */
  70429. vars: any;
  70430. /**
  70431. * @hidden
  70432. */
  70433. _size: number;
  70434. private _scene;
  70435. private _promises;
  70436. private _positions;
  70437. private _indices;
  70438. private _normals;
  70439. private _colors;
  70440. private _uvs;
  70441. private _indices32;
  70442. private _positions32;
  70443. private _colors32;
  70444. private _uvs32;
  70445. private _updatable;
  70446. private _isVisibilityBoxLocked;
  70447. private _alwaysVisible;
  70448. private _groups;
  70449. private _groupCounter;
  70450. private _computeParticleColor;
  70451. private _computeParticleTexture;
  70452. private _computeParticleRotation;
  70453. private _computeBoundingBox;
  70454. private _isReady;
  70455. /**
  70456. * Creates a PCS (Points Cloud System) object
  70457. * @param name (String) is the PCS name, this will be the underlying mesh name
  70458. * @param pointSize (number) is the size for each point
  70459. * @param scene (Scene) is the scene in which the PCS is added
  70460. * @param options defines the options of the PCS e.g.
  70461. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  70462. */
  70463. constructor(name: string, pointSize: number, scene: Scene, options?: {
  70464. updatable?: boolean;
  70465. });
  70466. /**
  70467. * Builds the PCS underlying mesh. Returns a standard Mesh.
  70468. * If no points were added to the PCS, the returned mesh is just a single point.
  70469. * @returns a promise for the created mesh
  70470. */
  70471. buildMeshAsync(): Promise<Mesh>;
  70472. /**
  70473. * @hidden
  70474. */
  70475. private _buildMesh;
  70476. private _addParticle;
  70477. private _randomUnitVector;
  70478. private _getColorIndicesForCoord;
  70479. private _setPointsColorOrUV;
  70480. private _colorFromTexture;
  70481. private _calculateDensity;
  70482. /**
  70483. * Adds points to the PCS in random positions within a unit sphere
  70484. * @param nb (positive integer) the number of particles to be created from this model
  70485. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  70486. * @returns the number of groups in the system
  70487. */
  70488. addPoints(nb: number, pointFunction?: any): number;
  70489. /**
  70490. * Adds points to the PCS from the surface of the model shape
  70491. * @param mesh is any Mesh object that will be used as a surface model for the points
  70492. * @param nb (positive integer) the number of particles to be created from this model
  70493. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  70494. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  70495. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  70496. * @returns the number of groups in the system
  70497. */
  70498. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  70499. /**
  70500. * Adds points to the PCS inside the model shape
  70501. * @param mesh is any Mesh object that will be used as a surface model for the points
  70502. * @param nb (positive integer) the number of particles to be created from this model
  70503. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  70504. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  70505. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  70506. * @returns the number of groups in the system
  70507. */
  70508. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  70509. /**
  70510. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  70511. * This method calls `updateParticle()` for each particle of the SPS.
  70512. * For an animated SPS, it is usually called within the render loop.
  70513. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  70514. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  70515. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  70516. * @returns the PCS.
  70517. */
  70518. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  70519. /**
  70520. * Disposes the PCS.
  70521. */
  70522. dispose(): void;
  70523. /**
  70524. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  70525. * doc :
  70526. * @returns the PCS.
  70527. */
  70528. refreshVisibleSize(): PointsCloudSystem;
  70529. /**
  70530. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  70531. * @param size the size (float) of the visibility box
  70532. * note : this doesn't lock the PCS mesh bounding box.
  70533. * doc :
  70534. */
  70535. setVisibilityBox(size: number): void;
  70536. /**
  70537. * Gets whether the PCS is always visible or not
  70538. * doc :
  70539. */
  70540. get isAlwaysVisible(): boolean;
  70541. /**
  70542. * Sets the PCS as always visible or not
  70543. * doc :
  70544. */
  70545. set isAlwaysVisible(val: boolean);
  70546. /**
  70547. * Tells to `setParticles()` to compute the particle rotations or not
  70548. * Default value : false. The PCS is faster when it's set to false
  70549. * Note : particle rotations are only applied to parent particles
  70550. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  70551. */
  70552. set computeParticleRotation(val: boolean);
  70553. /**
  70554. * Tells to `setParticles()` to compute the particle colors or not.
  70555. * Default value : true. The PCS is faster when it's set to false.
  70556. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  70557. */
  70558. set computeParticleColor(val: boolean);
  70559. set computeParticleTexture(val: boolean);
  70560. /**
  70561. * Gets if `setParticles()` computes the particle colors or not.
  70562. * Default value : false. The PCS is faster when it's set to false.
  70563. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  70564. */
  70565. get computeParticleColor(): boolean;
  70566. /**
  70567. * Gets if `setParticles()` computes the particle textures or not.
  70568. * Default value : false. The PCS is faster when it's set to false.
  70569. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  70570. */
  70571. get computeParticleTexture(): boolean;
  70572. /**
  70573. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  70574. */
  70575. set computeBoundingBox(val: boolean);
  70576. /**
  70577. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  70578. */
  70579. get computeBoundingBox(): boolean;
  70580. /**
  70581. * This function does nothing. It may be overwritten to set all the particle first values.
  70582. * The PCS doesn't call this function, you may have to call it by your own.
  70583. * doc :
  70584. */
  70585. initParticles(): void;
  70586. /**
  70587. * This function does nothing. It may be overwritten to recycle a particle
  70588. * The PCS doesn't call this function, you can to call it
  70589. * doc :
  70590. * @param particle The particle to recycle
  70591. * @returns the recycled particle
  70592. */
  70593. recycleParticle(particle: CloudPoint): CloudPoint;
  70594. /**
  70595. * Updates a particle : this function should be overwritten by the user.
  70596. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  70597. * doc :
  70598. * @example : just set a particle position or velocity and recycle conditions
  70599. * @param particle The particle to update
  70600. * @returns the updated particle
  70601. */
  70602. updateParticle(particle: CloudPoint): CloudPoint;
  70603. /**
  70604. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  70605. * This does nothing and may be overwritten by the user.
  70606. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  70607. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  70608. * @param update the boolean update value actually passed to setParticles()
  70609. */
  70610. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  70611. /**
  70612. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  70613. * This will be passed three parameters.
  70614. * This does nothing and may be overwritten by the user.
  70615. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  70616. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  70617. * @param update the boolean update value actually passed to setParticles()
  70618. */
  70619. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  70620. }
  70621. }
  70622. declare module "babylonjs/Particles/cloudPoint" {
  70623. import { Nullable } from "babylonjs/types";
  70624. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  70625. import { Mesh } from "babylonjs/Meshes/mesh";
  70626. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  70627. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  70628. /**
  70629. * Represents one particle of a points cloud system.
  70630. */
  70631. export class CloudPoint {
  70632. /**
  70633. * particle global index
  70634. */
  70635. idx: number;
  70636. /**
  70637. * The color of the particle
  70638. */
  70639. color: Nullable<Color4>;
  70640. /**
  70641. * The world space position of the particle.
  70642. */
  70643. position: Vector3;
  70644. /**
  70645. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  70646. */
  70647. rotation: Vector3;
  70648. /**
  70649. * The world space rotation quaternion of the particle.
  70650. */
  70651. rotationQuaternion: Nullable<Quaternion>;
  70652. /**
  70653. * The uv of the particle.
  70654. */
  70655. uv: Nullable<Vector2>;
  70656. /**
  70657. * The current speed of the particle.
  70658. */
  70659. velocity: Vector3;
  70660. /**
  70661. * The pivot point in the particle local space.
  70662. */
  70663. pivot: Vector3;
  70664. /**
  70665. * Must the particle be translated from its pivot point in its local space ?
  70666. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  70667. * Default : false
  70668. */
  70669. translateFromPivot: boolean;
  70670. /**
  70671. * Index of this particle in the global "positions" array (Internal use)
  70672. * @hidden
  70673. */
  70674. _pos: number;
  70675. /**
  70676. * @hidden Index of this particle in the global "indices" array (Internal use)
  70677. */
  70678. _ind: number;
  70679. /**
  70680. * Group this particle belongs to
  70681. */
  70682. _group: PointsGroup;
  70683. /**
  70684. * Group id of this particle
  70685. */
  70686. groupId: number;
  70687. /**
  70688. * Index of the particle in its group id (Internal use)
  70689. */
  70690. idxInGroup: number;
  70691. /**
  70692. * @hidden Particle BoundingInfo object (Internal use)
  70693. */
  70694. _boundingInfo: BoundingInfo;
  70695. /**
  70696. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  70697. */
  70698. _pcs: PointsCloudSystem;
  70699. /**
  70700. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  70701. */
  70702. _stillInvisible: boolean;
  70703. /**
  70704. * @hidden Last computed particle rotation matrix
  70705. */
  70706. _rotationMatrix: number[];
  70707. /**
  70708. * Parent particle Id, if any.
  70709. * Default null.
  70710. */
  70711. parentId: Nullable<number>;
  70712. /**
  70713. * @hidden Internal global position in the PCS.
  70714. */
  70715. _globalPosition: Vector3;
  70716. /**
  70717. * Creates a Point Cloud object.
  70718. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  70719. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  70720. * @param group (PointsGroup) is the group the particle belongs to
  70721. * @param groupId (integer) is the group identifier in the PCS.
  70722. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  70723. * @param pcs defines the PCS it is associated to
  70724. */
  70725. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  70726. /**
  70727. * get point size
  70728. */
  70729. get size(): Vector3;
  70730. /**
  70731. * Set point size
  70732. */
  70733. set size(scale: Vector3);
  70734. /**
  70735. * Legacy support, changed quaternion to rotationQuaternion
  70736. */
  70737. get quaternion(): Nullable<Quaternion>;
  70738. /**
  70739. * Legacy support, changed quaternion to rotationQuaternion
  70740. */
  70741. set quaternion(q: Nullable<Quaternion>);
  70742. /**
  70743. * Returns a boolean. True if the particle intersects a mesh, else false
  70744. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  70745. * @param target is the object (point or mesh) what the intersection is computed against
  70746. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  70747. * @returns true if it intersects
  70748. */
  70749. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  70750. /**
  70751. * get the rotation matrix of the particle
  70752. * @hidden
  70753. */
  70754. getRotationMatrix(m: Matrix): void;
  70755. }
  70756. /**
  70757. * Represents a group of points in a points cloud system
  70758. * * PCS internal tool, don't use it manually.
  70759. */
  70760. export class PointsGroup {
  70761. /**
  70762. * The group id
  70763. * @hidden
  70764. */
  70765. groupID: number;
  70766. /**
  70767. * image data for group (internal use)
  70768. * @hidden
  70769. */
  70770. _groupImageData: Nullable<ArrayBufferView>;
  70771. /**
  70772. * Image Width (internal use)
  70773. * @hidden
  70774. */
  70775. _groupImgWidth: number;
  70776. /**
  70777. * Image Height (internal use)
  70778. * @hidden
  70779. */
  70780. _groupImgHeight: number;
  70781. /**
  70782. * Custom position function (internal use)
  70783. * @hidden
  70784. */
  70785. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  70786. /**
  70787. * density per facet for surface points
  70788. * @hidden
  70789. */
  70790. _groupDensity: number[];
  70791. /**
  70792. * Only when points are colored by texture carries pointer to texture list array
  70793. * @hidden
  70794. */
  70795. _textureNb: number;
  70796. /**
  70797. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  70798. * PCS internal tool, don't use it manually.
  70799. * @hidden
  70800. */
  70801. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  70802. }
  70803. }
  70804. declare module "babylonjs/Particles/index" {
  70805. export * from "babylonjs/Particles/baseParticleSystem";
  70806. export * from "babylonjs/Particles/EmitterTypes/index";
  70807. export * from "babylonjs/Particles/gpuParticleSystem";
  70808. export * from "babylonjs/Particles/IParticleSystem";
  70809. export * from "babylonjs/Particles/particle";
  70810. export * from "babylonjs/Particles/particleHelper";
  70811. export * from "babylonjs/Particles/particleSystem";
  70812. import "babylonjs/Particles/particleSystemComponent";
  70813. export * from "babylonjs/Particles/particleSystemComponent";
  70814. export * from "babylonjs/Particles/particleSystemSet";
  70815. export * from "babylonjs/Particles/solidParticle";
  70816. export * from "babylonjs/Particles/solidParticleSystem";
  70817. export * from "babylonjs/Particles/cloudPoint";
  70818. export * from "babylonjs/Particles/pointsCloudSystem";
  70819. export * from "babylonjs/Particles/subEmitter";
  70820. }
  70821. declare module "babylonjs/Physics/physicsEngineComponent" {
  70822. import { Nullable } from "babylonjs/types";
  70823. import { Observable, Observer } from "babylonjs/Misc/observable";
  70824. import { Vector3 } from "babylonjs/Maths/math.vector";
  70825. import { Mesh } from "babylonjs/Meshes/mesh";
  70826. import { ISceneComponent } from "babylonjs/sceneComponent";
  70827. import { Scene } from "babylonjs/scene";
  70828. import { Node } from "babylonjs/node";
  70829. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  70830. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  70831. module "babylonjs/scene" {
  70832. interface Scene {
  70833. /** @hidden (Backing field) */
  70834. _physicsEngine: Nullable<IPhysicsEngine>;
  70835. /** @hidden */
  70836. _physicsTimeAccumulator: number;
  70837. /**
  70838. * Gets the current physics engine
  70839. * @returns a IPhysicsEngine or null if none attached
  70840. */
  70841. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  70842. /**
  70843. * Enables physics to the current scene
  70844. * @param gravity defines the scene's gravity for the physics engine
  70845. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  70846. * @return a boolean indicating if the physics engine was initialized
  70847. */
  70848. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  70849. /**
  70850. * Disables and disposes the physics engine associated with the scene
  70851. */
  70852. disablePhysicsEngine(): void;
  70853. /**
  70854. * Gets a boolean indicating if there is an active physics engine
  70855. * @returns a boolean indicating if there is an active physics engine
  70856. */
  70857. isPhysicsEnabled(): boolean;
  70858. /**
  70859. * Deletes a physics compound impostor
  70860. * @param compound defines the compound to delete
  70861. */
  70862. deleteCompoundImpostor(compound: any): void;
  70863. /**
  70864. * An event triggered when physic simulation is about to be run
  70865. */
  70866. onBeforePhysicsObservable: Observable<Scene>;
  70867. /**
  70868. * An event triggered when physic simulation has been done
  70869. */
  70870. onAfterPhysicsObservable: Observable<Scene>;
  70871. }
  70872. }
  70873. module "babylonjs/Meshes/abstractMesh" {
  70874. interface AbstractMesh {
  70875. /** @hidden */
  70876. _physicsImpostor: Nullable<PhysicsImpostor>;
  70877. /**
  70878. * Gets or sets impostor used for physic simulation
  70879. * @see http://doc.babylonjs.com/features/physics_engine
  70880. */
  70881. physicsImpostor: Nullable<PhysicsImpostor>;
  70882. /**
  70883. * Gets the current physics impostor
  70884. * @see http://doc.babylonjs.com/features/physics_engine
  70885. * @returns a physics impostor or null
  70886. */
  70887. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  70888. /** Apply a physic impulse to the mesh
  70889. * @param force defines the force to apply
  70890. * @param contactPoint defines where to apply the force
  70891. * @returns the current mesh
  70892. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  70893. */
  70894. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  70895. /**
  70896. * Creates a physic joint between two meshes
  70897. * @param otherMesh defines the other mesh to use
  70898. * @param pivot1 defines the pivot to use on this mesh
  70899. * @param pivot2 defines the pivot to use on the other mesh
  70900. * @param options defines additional options (can be plugin dependent)
  70901. * @returns the current mesh
  70902. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  70903. */
  70904. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  70905. /** @hidden */
  70906. _disposePhysicsObserver: Nullable<Observer<Node>>;
  70907. }
  70908. }
  70909. /**
  70910. * Defines the physics engine scene component responsible to manage a physics engine
  70911. */
  70912. export class PhysicsEngineSceneComponent implements ISceneComponent {
  70913. /**
  70914. * The component name helpful to identify the component in the list of scene components.
  70915. */
  70916. readonly name: string;
  70917. /**
  70918. * The scene the component belongs to.
  70919. */
  70920. scene: Scene;
  70921. /**
  70922. * Creates a new instance of the component for the given scene
  70923. * @param scene Defines the scene to register the component in
  70924. */
  70925. constructor(scene: Scene);
  70926. /**
  70927. * Registers the component in a given scene
  70928. */
  70929. register(): void;
  70930. /**
  70931. * Rebuilds the elements related to this component in case of
  70932. * context lost for instance.
  70933. */
  70934. rebuild(): void;
  70935. /**
  70936. * Disposes the component and the associated ressources
  70937. */
  70938. dispose(): void;
  70939. }
  70940. }
  70941. declare module "babylonjs/Physics/physicsHelper" {
  70942. import { Nullable } from "babylonjs/types";
  70943. import { Vector3 } from "babylonjs/Maths/math.vector";
  70944. import { Mesh } from "babylonjs/Meshes/mesh";
  70945. import { Scene } from "babylonjs/scene";
  70946. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  70947. /**
  70948. * A helper for physics simulations
  70949. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70950. */
  70951. export class PhysicsHelper {
  70952. private _scene;
  70953. private _physicsEngine;
  70954. /**
  70955. * Initializes the Physics helper
  70956. * @param scene Babylon.js scene
  70957. */
  70958. constructor(scene: Scene);
  70959. /**
  70960. * Applies a radial explosion impulse
  70961. * @param origin the origin of the explosion
  70962. * @param radiusOrEventOptions the radius or the options of radial explosion
  70963. * @param strength the explosion strength
  70964. * @param falloff possible options: Constant & Linear. Defaults to Constant
  70965. * @returns A physics radial explosion event, or null
  70966. */
  70967. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  70968. /**
  70969. * Applies a radial explosion force
  70970. * @param origin the origin of the explosion
  70971. * @param radiusOrEventOptions the radius or the options of radial explosion
  70972. * @param strength the explosion strength
  70973. * @param falloff possible options: Constant & Linear. Defaults to Constant
  70974. * @returns A physics radial explosion event, or null
  70975. */
  70976. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  70977. /**
  70978. * Creates a gravitational field
  70979. * @param origin the origin of the explosion
  70980. * @param radiusOrEventOptions the radius or the options of radial explosion
  70981. * @param strength the explosion strength
  70982. * @param falloff possible options: Constant & Linear. Defaults to Constant
  70983. * @returns A physics gravitational field event, or null
  70984. */
  70985. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  70986. /**
  70987. * Creates a physics updraft event
  70988. * @param origin the origin of the updraft
  70989. * @param radiusOrEventOptions the radius or the options of the updraft
  70990. * @param strength the strength of the updraft
  70991. * @param height the height of the updraft
  70992. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  70993. * @returns A physics updraft event, or null
  70994. */
  70995. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  70996. /**
  70997. * Creates a physics vortex event
  70998. * @param origin the of the vortex
  70999. * @param radiusOrEventOptions the radius or the options of the vortex
  71000. * @param strength the strength of the vortex
  71001. * @param height the height of the vortex
  71002. * @returns a Physics vortex event, or null
  71003. * A physics vortex event or null
  71004. */
  71005. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  71006. }
  71007. /**
  71008. * Represents a physics radial explosion event
  71009. */
  71010. class PhysicsRadialExplosionEvent {
  71011. private _scene;
  71012. private _options;
  71013. private _sphere;
  71014. private _dataFetched;
  71015. /**
  71016. * Initializes a radial explosioin event
  71017. * @param _scene BabylonJS scene
  71018. * @param _options The options for the vortex event
  71019. */
  71020. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  71021. /**
  71022. * Returns the data related to the radial explosion event (sphere).
  71023. * @returns The radial explosion event data
  71024. */
  71025. getData(): PhysicsRadialExplosionEventData;
  71026. /**
  71027. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  71028. * @param impostor A physics imposter
  71029. * @param origin the origin of the explosion
  71030. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  71031. */
  71032. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  71033. /**
  71034. * Triggers affecterd impostors callbacks
  71035. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  71036. */
  71037. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  71038. /**
  71039. * Disposes the sphere.
  71040. * @param force Specifies if the sphere should be disposed by force
  71041. */
  71042. dispose(force?: boolean): void;
  71043. /*** Helpers ***/
  71044. private _prepareSphere;
  71045. private _intersectsWithSphere;
  71046. }
  71047. /**
  71048. * Represents a gravitational field event
  71049. */
  71050. class PhysicsGravitationalFieldEvent {
  71051. private _physicsHelper;
  71052. private _scene;
  71053. private _origin;
  71054. private _options;
  71055. private _tickCallback;
  71056. private _sphere;
  71057. private _dataFetched;
  71058. /**
  71059. * Initializes the physics gravitational field event
  71060. * @param _physicsHelper A physics helper
  71061. * @param _scene BabylonJS scene
  71062. * @param _origin The origin position of the gravitational field event
  71063. * @param _options The options for the vortex event
  71064. */
  71065. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  71066. /**
  71067. * Returns the data related to the gravitational field event (sphere).
  71068. * @returns A gravitational field event
  71069. */
  71070. getData(): PhysicsGravitationalFieldEventData;
  71071. /**
  71072. * Enables the gravitational field.
  71073. */
  71074. enable(): void;
  71075. /**
  71076. * Disables the gravitational field.
  71077. */
  71078. disable(): void;
  71079. /**
  71080. * Disposes the sphere.
  71081. * @param force The force to dispose from the gravitational field event
  71082. */
  71083. dispose(force?: boolean): void;
  71084. private _tick;
  71085. }
  71086. /**
  71087. * Represents a physics updraft event
  71088. */
  71089. class PhysicsUpdraftEvent {
  71090. private _scene;
  71091. private _origin;
  71092. private _options;
  71093. private _physicsEngine;
  71094. private _originTop;
  71095. private _originDirection;
  71096. private _tickCallback;
  71097. private _cylinder;
  71098. private _cylinderPosition;
  71099. private _dataFetched;
  71100. /**
  71101. * Initializes the physics updraft event
  71102. * @param _scene BabylonJS scene
  71103. * @param _origin The origin position of the updraft
  71104. * @param _options The options for the updraft event
  71105. */
  71106. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  71107. /**
  71108. * Returns the data related to the updraft event (cylinder).
  71109. * @returns A physics updraft event
  71110. */
  71111. getData(): PhysicsUpdraftEventData;
  71112. /**
  71113. * Enables the updraft.
  71114. */
  71115. enable(): void;
  71116. /**
  71117. * Disables the updraft.
  71118. */
  71119. disable(): void;
  71120. /**
  71121. * Disposes the cylinder.
  71122. * @param force Specifies if the updraft should be disposed by force
  71123. */
  71124. dispose(force?: boolean): void;
  71125. private getImpostorHitData;
  71126. private _tick;
  71127. /*** Helpers ***/
  71128. private _prepareCylinder;
  71129. private _intersectsWithCylinder;
  71130. }
  71131. /**
  71132. * Represents a physics vortex event
  71133. */
  71134. class PhysicsVortexEvent {
  71135. private _scene;
  71136. private _origin;
  71137. private _options;
  71138. private _physicsEngine;
  71139. private _originTop;
  71140. private _tickCallback;
  71141. private _cylinder;
  71142. private _cylinderPosition;
  71143. private _dataFetched;
  71144. /**
  71145. * Initializes the physics vortex event
  71146. * @param _scene The BabylonJS scene
  71147. * @param _origin The origin position of the vortex
  71148. * @param _options The options for the vortex event
  71149. */
  71150. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  71151. /**
  71152. * Returns the data related to the vortex event (cylinder).
  71153. * @returns The physics vortex event data
  71154. */
  71155. getData(): PhysicsVortexEventData;
  71156. /**
  71157. * Enables the vortex.
  71158. */
  71159. enable(): void;
  71160. /**
  71161. * Disables the cortex.
  71162. */
  71163. disable(): void;
  71164. /**
  71165. * Disposes the sphere.
  71166. * @param force
  71167. */
  71168. dispose(force?: boolean): void;
  71169. private getImpostorHitData;
  71170. private _tick;
  71171. /*** Helpers ***/
  71172. private _prepareCylinder;
  71173. private _intersectsWithCylinder;
  71174. }
  71175. /**
  71176. * Options fot the radial explosion event
  71177. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71178. */
  71179. export class PhysicsRadialExplosionEventOptions {
  71180. /**
  71181. * The radius of the sphere for the radial explosion.
  71182. */
  71183. radius: number;
  71184. /**
  71185. * The strenth of the explosion.
  71186. */
  71187. strength: number;
  71188. /**
  71189. * The strenght of the force in correspondence to the distance of the affected object
  71190. */
  71191. falloff: PhysicsRadialImpulseFalloff;
  71192. /**
  71193. * Sphere options for the radial explosion.
  71194. */
  71195. sphere: {
  71196. segments: number;
  71197. diameter: number;
  71198. };
  71199. /**
  71200. * Sphere options for the radial explosion.
  71201. */
  71202. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  71203. }
  71204. /**
  71205. * Options fot the updraft event
  71206. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71207. */
  71208. export class PhysicsUpdraftEventOptions {
  71209. /**
  71210. * The radius of the cylinder for the vortex
  71211. */
  71212. radius: number;
  71213. /**
  71214. * The strenth of the updraft.
  71215. */
  71216. strength: number;
  71217. /**
  71218. * The height of the cylinder for the updraft.
  71219. */
  71220. height: number;
  71221. /**
  71222. * The mode for the the updraft.
  71223. */
  71224. updraftMode: PhysicsUpdraftMode;
  71225. }
  71226. /**
  71227. * Options fot the vortex event
  71228. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71229. */
  71230. export class PhysicsVortexEventOptions {
  71231. /**
  71232. * The radius of the cylinder for the vortex
  71233. */
  71234. radius: number;
  71235. /**
  71236. * The strenth of the vortex.
  71237. */
  71238. strength: number;
  71239. /**
  71240. * The height of the cylinder for the vortex.
  71241. */
  71242. height: number;
  71243. /**
  71244. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  71245. */
  71246. centripetalForceThreshold: number;
  71247. /**
  71248. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  71249. */
  71250. centripetalForceMultiplier: number;
  71251. /**
  71252. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  71253. */
  71254. centrifugalForceMultiplier: number;
  71255. /**
  71256. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  71257. */
  71258. updraftForceMultiplier: number;
  71259. }
  71260. /**
  71261. * The strenght of the force in correspondence to the distance of the affected object
  71262. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71263. */
  71264. export enum PhysicsRadialImpulseFalloff {
  71265. /** Defines that impulse is constant in strength across it's whole radius */
  71266. Constant = 0,
  71267. /** Defines that impulse gets weaker if it's further from the origin */
  71268. Linear = 1
  71269. }
  71270. /**
  71271. * The strength of the force in correspondence to the distance of the affected object
  71272. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71273. */
  71274. export enum PhysicsUpdraftMode {
  71275. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  71276. Center = 0,
  71277. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  71278. Perpendicular = 1
  71279. }
  71280. /**
  71281. * Interface for a physics hit data
  71282. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71283. */
  71284. export interface PhysicsHitData {
  71285. /**
  71286. * The force applied at the contact point
  71287. */
  71288. force: Vector3;
  71289. /**
  71290. * The contact point
  71291. */
  71292. contactPoint: Vector3;
  71293. /**
  71294. * The distance from the origin to the contact point
  71295. */
  71296. distanceFromOrigin: number;
  71297. }
  71298. /**
  71299. * Interface for radial explosion event data
  71300. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71301. */
  71302. export interface PhysicsRadialExplosionEventData {
  71303. /**
  71304. * A sphere used for the radial explosion event
  71305. */
  71306. sphere: Mesh;
  71307. }
  71308. /**
  71309. * Interface for gravitational field event data
  71310. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71311. */
  71312. export interface PhysicsGravitationalFieldEventData {
  71313. /**
  71314. * A sphere mesh used for the gravitational field event
  71315. */
  71316. sphere: Mesh;
  71317. }
  71318. /**
  71319. * Interface for updraft event data
  71320. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71321. */
  71322. export interface PhysicsUpdraftEventData {
  71323. /**
  71324. * A cylinder used for the updraft event
  71325. */
  71326. cylinder: Mesh;
  71327. }
  71328. /**
  71329. * Interface for vortex event data
  71330. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71331. */
  71332. export interface PhysicsVortexEventData {
  71333. /**
  71334. * A cylinder used for the vortex event
  71335. */
  71336. cylinder: Mesh;
  71337. }
  71338. /**
  71339. * Interface for an affected physics impostor
  71340. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71341. */
  71342. export interface PhysicsAffectedImpostorWithData {
  71343. /**
  71344. * The impostor affected by the effect
  71345. */
  71346. impostor: PhysicsImpostor;
  71347. /**
  71348. * The data about the hit/horce from the explosion
  71349. */
  71350. hitData: PhysicsHitData;
  71351. }
  71352. }
  71353. declare module "babylonjs/Physics/Plugins/index" {
  71354. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  71355. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  71356. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  71357. }
  71358. declare module "babylonjs/Physics/index" {
  71359. export * from "babylonjs/Physics/IPhysicsEngine";
  71360. export * from "babylonjs/Physics/physicsEngine";
  71361. export * from "babylonjs/Physics/physicsEngineComponent";
  71362. export * from "babylonjs/Physics/physicsHelper";
  71363. export * from "babylonjs/Physics/physicsImpostor";
  71364. export * from "babylonjs/Physics/physicsJoint";
  71365. export * from "babylonjs/Physics/Plugins/index";
  71366. }
  71367. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  71368. /** @hidden */
  71369. export var blackAndWhitePixelShader: {
  71370. name: string;
  71371. shader: string;
  71372. };
  71373. }
  71374. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  71375. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  71376. import { Camera } from "babylonjs/Cameras/camera";
  71377. import { Engine } from "babylonjs/Engines/engine";
  71378. import "babylonjs/Shaders/blackAndWhite.fragment";
  71379. /**
  71380. * Post process used to render in black and white
  71381. */
  71382. export class BlackAndWhitePostProcess extends PostProcess {
  71383. /**
  71384. * Linear about to convert he result to black and white (default: 1)
  71385. */
  71386. degree: number;
  71387. /**
  71388. * Creates a black and white post process
  71389. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  71390. * @param name The name of the effect.
  71391. * @param options The required width/height ratio to downsize to before computing the render pass.
  71392. * @param camera The camera to apply the render pass to.
  71393. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71394. * @param engine The engine which the post process will be applied. (default: current engine)
  71395. * @param reusable If the post process can be reused on the same frame. (default: false)
  71396. */
  71397. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  71398. }
  71399. }
  71400. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  71401. import { Nullable } from "babylonjs/types";
  71402. import { Camera } from "babylonjs/Cameras/camera";
  71403. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  71404. import { Engine } from "babylonjs/Engines/engine";
  71405. /**
  71406. * This represents a set of one or more post processes in Babylon.
  71407. * A post process can be used to apply a shader to a texture after it is rendered.
  71408. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  71409. */
  71410. export class PostProcessRenderEffect {
  71411. private _postProcesses;
  71412. private _getPostProcesses;
  71413. private _singleInstance;
  71414. private _cameras;
  71415. private _indicesForCamera;
  71416. /**
  71417. * Name of the effect
  71418. * @hidden
  71419. */
  71420. _name: string;
  71421. /**
  71422. * Instantiates a post process render effect.
  71423. * A post process can be used to apply a shader to a texture after it is rendered.
  71424. * @param engine The engine the effect is tied to
  71425. * @param name The name of the effect
  71426. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  71427. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  71428. */
  71429. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  71430. /**
  71431. * Checks if all the post processes in the effect are supported.
  71432. */
  71433. get isSupported(): boolean;
  71434. /**
  71435. * Updates the current state of the effect
  71436. * @hidden
  71437. */
  71438. _update(): void;
  71439. /**
  71440. * Attaches the effect on cameras
  71441. * @param cameras The camera to attach to.
  71442. * @hidden
  71443. */
  71444. _attachCameras(cameras: Camera): void;
  71445. /**
  71446. * Attaches the effect on cameras
  71447. * @param cameras The camera to attach to.
  71448. * @hidden
  71449. */
  71450. _attachCameras(cameras: Camera[]): void;
  71451. /**
  71452. * Detaches the effect on cameras
  71453. * @param cameras The camera to detatch from.
  71454. * @hidden
  71455. */
  71456. _detachCameras(cameras: Camera): void;
  71457. /**
  71458. * Detatches the effect on cameras
  71459. * @param cameras The camera to detatch from.
  71460. * @hidden
  71461. */
  71462. _detachCameras(cameras: Camera[]): void;
  71463. /**
  71464. * Enables the effect on given cameras
  71465. * @param cameras The camera to enable.
  71466. * @hidden
  71467. */
  71468. _enable(cameras: Camera): void;
  71469. /**
  71470. * Enables the effect on given cameras
  71471. * @param cameras The camera to enable.
  71472. * @hidden
  71473. */
  71474. _enable(cameras: Nullable<Camera[]>): void;
  71475. /**
  71476. * Disables the effect on the given cameras
  71477. * @param cameras The camera to disable.
  71478. * @hidden
  71479. */
  71480. _disable(cameras: Camera): void;
  71481. /**
  71482. * Disables the effect on the given cameras
  71483. * @param cameras The camera to disable.
  71484. * @hidden
  71485. */
  71486. _disable(cameras: Nullable<Camera[]>): void;
  71487. /**
  71488. * Gets a list of the post processes contained in the effect.
  71489. * @param camera The camera to get the post processes on.
  71490. * @returns The list of the post processes in the effect.
  71491. */
  71492. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  71493. }
  71494. }
  71495. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  71496. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  71497. /** @hidden */
  71498. export var extractHighlightsPixelShader: {
  71499. name: string;
  71500. shader: string;
  71501. };
  71502. }
  71503. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  71504. import { Nullable } from "babylonjs/types";
  71505. import { Camera } from "babylonjs/Cameras/camera";
  71506. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  71507. import { Engine } from "babylonjs/Engines/engine";
  71508. import "babylonjs/Shaders/extractHighlights.fragment";
  71509. /**
  71510. * 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.
  71511. */
  71512. export class ExtractHighlightsPostProcess extends PostProcess {
  71513. /**
  71514. * The luminance threshold, pixels below this value will be set to black.
  71515. */
  71516. threshold: number;
  71517. /** @hidden */
  71518. _exposure: number;
  71519. /**
  71520. * Post process which has the input texture to be used when performing highlight extraction
  71521. * @hidden
  71522. */
  71523. _inputPostProcess: Nullable<PostProcess>;
  71524. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  71525. }
  71526. }
  71527. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  71528. /** @hidden */
  71529. export var bloomMergePixelShader: {
  71530. name: string;
  71531. shader: string;
  71532. };
  71533. }
  71534. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  71535. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  71536. import { Nullable } from "babylonjs/types";
  71537. import { Engine } from "babylonjs/Engines/engine";
  71538. import { Camera } from "babylonjs/Cameras/camera";
  71539. import "babylonjs/Shaders/bloomMerge.fragment";
  71540. /**
  71541. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  71542. */
  71543. export class BloomMergePostProcess extends PostProcess {
  71544. /** Weight of the bloom to be added to the original input. */
  71545. weight: number;
  71546. /**
  71547. * Creates a new instance of @see BloomMergePostProcess
  71548. * @param name The name of the effect.
  71549. * @param originalFromInput Post process which's input will be used for the merge.
  71550. * @param blurred Blurred highlights post process which's output will be used.
  71551. * @param weight Weight of the bloom to be added to the original input.
  71552. * @param options The required width/height ratio to downsize to before computing the render pass.
  71553. * @param camera The camera to apply the render pass to.
  71554. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71555. * @param engine The engine which the post process will be applied. (default: current engine)
  71556. * @param reusable If the post process can be reused on the same frame. (default: false)
  71557. * @param textureType Type of textures used when performing the post process. (default: 0)
  71558. * @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)
  71559. */
  71560. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  71561. /** Weight of the bloom to be added to the original input. */
  71562. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  71563. }
  71564. }
  71565. declare module "babylonjs/PostProcesses/bloomEffect" {
  71566. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  71567. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  71568. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  71569. import { Camera } from "babylonjs/Cameras/camera";
  71570. import { Scene } from "babylonjs/scene";
  71571. /**
  71572. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  71573. */
  71574. export class BloomEffect extends PostProcessRenderEffect {
  71575. private bloomScale;
  71576. /**
  71577. * @hidden Internal
  71578. */
  71579. _effects: Array<PostProcess>;
  71580. /**
  71581. * @hidden Internal
  71582. */
  71583. _downscale: ExtractHighlightsPostProcess;
  71584. private _blurX;
  71585. private _blurY;
  71586. private _merge;
  71587. /**
  71588. * The luminance threshold to find bright areas of the image to bloom.
  71589. */
  71590. get threshold(): number;
  71591. set threshold(value: number);
  71592. /**
  71593. * The strength of the bloom.
  71594. */
  71595. get weight(): number;
  71596. set weight(value: number);
  71597. /**
  71598. * Specifies the size of the bloom blur kernel, relative to the final output size
  71599. */
  71600. get kernel(): number;
  71601. set kernel(value: number);
  71602. /**
  71603. * Creates a new instance of @see BloomEffect
  71604. * @param scene The scene the effect belongs to.
  71605. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  71606. * @param bloomKernel The size of the kernel to be used when applying the blur.
  71607. * @param bloomWeight The the strength of bloom.
  71608. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  71609. * @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)
  71610. */
  71611. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  71612. /**
  71613. * Disposes each of the internal effects for a given camera.
  71614. * @param camera The camera to dispose the effect on.
  71615. */
  71616. disposeEffects(camera: Camera): void;
  71617. /**
  71618. * @hidden Internal
  71619. */
  71620. _updateEffects(): void;
  71621. /**
  71622. * Internal
  71623. * @returns if all the contained post processes are ready.
  71624. * @hidden
  71625. */
  71626. _isReady(): boolean;
  71627. }
  71628. }
  71629. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  71630. /** @hidden */
  71631. export var chromaticAberrationPixelShader: {
  71632. name: string;
  71633. shader: string;
  71634. };
  71635. }
  71636. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  71637. import { Vector2 } from "babylonjs/Maths/math.vector";
  71638. import { Nullable } from "babylonjs/types";
  71639. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  71640. import { Camera } from "babylonjs/Cameras/camera";
  71641. import { Engine } from "babylonjs/Engines/engine";
  71642. import "babylonjs/Shaders/chromaticAberration.fragment";
  71643. /**
  71644. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  71645. */
  71646. export class ChromaticAberrationPostProcess extends PostProcess {
  71647. /**
  71648. * The amount of seperation of rgb channels (default: 30)
  71649. */
  71650. aberrationAmount: number;
  71651. /**
  71652. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  71653. */
  71654. radialIntensity: number;
  71655. /**
  71656. * 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))
  71657. */
  71658. direction: Vector2;
  71659. /**
  71660. * 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))
  71661. */
  71662. centerPosition: Vector2;
  71663. /**
  71664. * Creates a new instance ChromaticAberrationPostProcess
  71665. * @param name The name of the effect.
  71666. * @param screenWidth The width of the screen to apply the effect on.
  71667. * @param screenHeight The height of the screen to apply the effect on.
  71668. * @param options The required width/height ratio to downsize to before computing the render pass.
  71669. * @param camera The camera to apply the render pass to.
  71670. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71671. * @param engine The engine which the post process will be applied. (default: current engine)
  71672. * @param reusable If the post process can be reused on the same frame. (default: false)
  71673. * @param textureType Type of textures used when performing the post process. (default: 0)
  71674. * @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)
  71675. */
  71676. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  71677. }
  71678. }
  71679. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  71680. /** @hidden */
  71681. export var circleOfConfusionPixelShader: {
  71682. name: string;
  71683. shader: string;
  71684. };
  71685. }
  71686. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  71687. import { Nullable } from "babylonjs/types";
  71688. import { Engine } from "babylonjs/Engines/engine";
  71689. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  71690. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  71691. import { Camera } from "babylonjs/Cameras/camera";
  71692. import "babylonjs/Shaders/circleOfConfusion.fragment";
  71693. /**
  71694. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  71695. */
  71696. export class CircleOfConfusionPostProcess extends PostProcess {
  71697. /**
  71698. * 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.
  71699. */
  71700. lensSize: number;
  71701. /**
  71702. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  71703. */
  71704. fStop: number;
  71705. /**
  71706. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  71707. */
  71708. focusDistance: number;
  71709. /**
  71710. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  71711. */
  71712. focalLength: number;
  71713. private _depthTexture;
  71714. /**
  71715. * Creates a new instance CircleOfConfusionPostProcess
  71716. * @param name The name of the effect.
  71717. * @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.
  71718. * @param options The required width/height ratio to downsize to before computing the render pass.
  71719. * @param camera The camera to apply the render pass to.
  71720. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71721. * @param engine The engine which the post process will be applied. (default: current engine)
  71722. * @param reusable If the post process can be reused on the same frame. (default: false)
  71723. * @param textureType Type of textures used when performing the post process. (default: 0)
  71724. * @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)
  71725. */
  71726. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  71727. /**
  71728. * 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.
  71729. */
  71730. set depthTexture(value: RenderTargetTexture);
  71731. }
  71732. }
  71733. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  71734. /** @hidden */
  71735. export var colorCorrectionPixelShader: {
  71736. name: string;
  71737. shader: string;
  71738. };
  71739. }
  71740. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  71741. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  71742. import { Engine } from "babylonjs/Engines/engine";
  71743. import { Camera } from "babylonjs/Cameras/camera";
  71744. import "babylonjs/Shaders/colorCorrection.fragment";
  71745. /**
  71746. *
  71747. * This post-process allows the modification of rendered colors by using
  71748. * a 'look-up table' (LUT). This effect is also called Color Grading.
  71749. *
  71750. * The object needs to be provided an url to a texture containing the color
  71751. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  71752. * Use an image editing software to tweak the LUT to match your needs.
  71753. *
  71754. * For an example of a color LUT, see here:
  71755. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  71756. * For explanations on color grading, see here:
  71757. * @see http://udn.epicgames.com/Three/ColorGrading.html
  71758. *
  71759. */
  71760. export class ColorCorrectionPostProcess extends PostProcess {
  71761. private _colorTableTexture;
  71762. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  71763. }
  71764. }
  71765. declare module "babylonjs/Shaders/convolution.fragment" {
  71766. /** @hidden */
  71767. export var convolutionPixelShader: {
  71768. name: string;
  71769. shader: string;
  71770. };
  71771. }
  71772. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  71773. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  71774. import { Nullable } from "babylonjs/types";
  71775. import { Camera } from "babylonjs/Cameras/camera";
  71776. import { Engine } from "babylonjs/Engines/engine";
  71777. import "babylonjs/Shaders/convolution.fragment";
  71778. /**
  71779. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  71780. * input texture to perform effects such as edge detection or sharpening
  71781. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  71782. */
  71783. export class ConvolutionPostProcess extends PostProcess {
  71784. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  71785. kernel: number[];
  71786. /**
  71787. * Creates a new instance ConvolutionPostProcess
  71788. * @param name The name of the effect.
  71789. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  71790. * @param options The required width/height ratio to downsize to before computing the render pass.
  71791. * @param camera The camera to apply the render pass to.
  71792. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71793. * @param engine The engine which the post process will be applied. (default: current engine)
  71794. * @param reusable If the post process can be reused on the same frame. (default: false)
  71795. * @param textureType Type of textures used when performing the post process. (default: 0)
  71796. */
  71797. constructor(name: string,
  71798. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  71799. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  71800. /**
  71801. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  71802. */
  71803. static EdgeDetect0Kernel: number[];
  71804. /**
  71805. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  71806. */
  71807. static EdgeDetect1Kernel: number[];
  71808. /**
  71809. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  71810. */
  71811. static EdgeDetect2Kernel: number[];
  71812. /**
  71813. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  71814. */
  71815. static SharpenKernel: number[];
  71816. /**
  71817. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  71818. */
  71819. static EmbossKernel: number[];
  71820. /**
  71821. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  71822. */
  71823. static GaussianKernel: number[];
  71824. }
  71825. }
  71826. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  71827. import { Nullable } from "babylonjs/types";
  71828. import { Vector2 } from "babylonjs/Maths/math.vector";
  71829. import { Camera } from "babylonjs/Cameras/camera";
  71830. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  71831. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  71832. import { Engine } from "babylonjs/Engines/engine";
  71833. import { Scene } from "babylonjs/scene";
  71834. /**
  71835. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  71836. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  71837. * based on samples that have a large difference in distance than the center pixel.
  71838. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  71839. */
  71840. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  71841. direction: Vector2;
  71842. /**
  71843. * Creates a new instance CircleOfConfusionPostProcess
  71844. * @param name The name of the effect.
  71845. * @param scene The scene the effect belongs to.
  71846. * @param direction The direction the blur should be applied.
  71847. * @param kernel The size of the kernel used to blur.
  71848. * @param options The required width/height ratio to downsize to before computing the render pass.
  71849. * @param camera The camera to apply the render pass to.
  71850. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  71851. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  71852. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71853. * @param engine The engine which the post process will be applied. (default: current engine)
  71854. * @param reusable If the post process can be reused on the same frame. (default: false)
  71855. * @param textureType Type of textures used when performing the post process. (default: 0)
  71856. * @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)
  71857. */
  71858. 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);
  71859. }
  71860. }
  71861. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  71862. /** @hidden */
  71863. export var depthOfFieldMergePixelShader: {
  71864. name: string;
  71865. shader: string;
  71866. };
  71867. }
  71868. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  71869. import { Nullable } from "babylonjs/types";
  71870. import { Camera } from "babylonjs/Cameras/camera";
  71871. import { Effect } from "babylonjs/Materials/effect";
  71872. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  71873. import { Engine } from "babylonjs/Engines/engine";
  71874. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  71875. /**
  71876. * Options to be set when merging outputs from the default pipeline.
  71877. */
  71878. export class DepthOfFieldMergePostProcessOptions {
  71879. /**
  71880. * The original image to merge on top of
  71881. */
  71882. originalFromInput: PostProcess;
  71883. /**
  71884. * Parameters to perform the merge of the depth of field effect
  71885. */
  71886. depthOfField?: {
  71887. circleOfConfusion: PostProcess;
  71888. blurSteps: Array<PostProcess>;
  71889. };
  71890. /**
  71891. * Parameters to perform the merge of bloom effect
  71892. */
  71893. bloom?: {
  71894. blurred: PostProcess;
  71895. weight: number;
  71896. };
  71897. }
  71898. /**
  71899. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  71900. */
  71901. export class DepthOfFieldMergePostProcess extends PostProcess {
  71902. private blurSteps;
  71903. /**
  71904. * Creates a new instance of DepthOfFieldMergePostProcess
  71905. * @param name The name of the effect.
  71906. * @param originalFromInput Post process which's input will be used for the merge.
  71907. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  71908. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  71909. * @param options The required width/height ratio to downsize to before computing the render pass.
  71910. * @param camera The camera to apply the render pass to.
  71911. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71912. * @param engine The engine which the post process will be applied. (default: current engine)
  71913. * @param reusable If the post process can be reused on the same frame. (default: false)
  71914. * @param textureType Type of textures used when performing the post process. (default: 0)
  71915. * @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)
  71916. */
  71917. 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);
  71918. /**
  71919. * Updates the effect with the current post process compile time values and recompiles the shader.
  71920. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  71921. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  71922. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  71923. * @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
  71924. * @param onCompiled Called when the shader has been compiled.
  71925. * @param onError Called if there is an error when compiling a shader.
  71926. */
  71927. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  71928. }
  71929. }
  71930. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  71931. import { Nullable } from "babylonjs/types";
  71932. import { Camera } from "babylonjs/Cameras/camera";
  71933. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  71934. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  71935. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  71936. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  71937. import { Scene } from "babylonjs/scene";
  71938. /**
  71939. * Specifies the level of max blur that should be applied when using the depth of field effect
  71940. */
  71941. export enum DepthOfFieldEffectBlurLevel {
  71942. /**
  71943. * Subtle blur
  71944. */
  71945. Low = 0,
  71946. /**
  71947. * Medium blur
  71948. */
  71949. Medium = 1,
  71950. /**
  71951. * Large blur
  71952. */
  71953. High = 2
  71954. }
  71955. /**
  71956. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  71957. */
  71958. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  71959. private _circleOfConfusion;
  71960. /**
  71961. * @hidden Internal, blurs from high to low
  71962. */
  71963. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  71964. private _depthOfFieldBlurY;
  71965. private _dofMerge;
  71966. /**
  71967. * @hidden Internal post processes in depth of field effect
  71968. */
  71969. _effects: Array<PostProcess>;
  71970. /**
  71971. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  71972. */
  71973. set focalLength(value: number);
  71974. get focalLength(): number;
  71975. /**
  71976. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  71977. */
  71978. set fStop(value: number);
  71979. get fStop(): number;
  71980. /**
  71981. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  71982. */
  71983. set focusDistance(value: number);
  71984. get focusDistance(): number;
  71985. /**
  71986. * 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.
  71987. */
  71988. set lensSize(value: number);
  71989. get lensSize(): number;
  71990. /**
  71991. * Creates a new instance DepthOfFieldEffect
  71992. * @param scene The scene the effect belongs to.
  71993. * @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.
  71994. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  71995. * @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)
  71996. */
  71997. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  71998. /**
  71999. * Get the current class name of the current effet
  72000. * @returns "DepthOfFieldEffect"
  72001. */
  72002. getClassName(): string;
  72003. /**
  72004. * 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.
  72005. */
  72006. set depthTexture(value: RenderTargetTexture);
  72007. /**
  72008. * Disposes each of the internal effects for a given camera.
  72009. * @param camera The camera to dispose the effect on.
  72010. */
  72011. disposeEffects(camera: Camera): void;
  72012. /**
  72013. * @hidden Internal
  72014. */
  72015. _updateEffects(): void;
  72016. /**
  72017. * Internal
  72018. * @returns if all the contained post processes are ready.
  72019. * @hidden
  72020. */
  72021. _isReady(): boolean;
  72022. }
  72023. }
  72024. declare module "babylonjs/Shaders/displayPass.fragment" {
  72025. /** @hidden */
  72026. export var displayPassPixelShader: {
  72027. name: string;
  72028. shader: string;
  72029. };
  72030. }
  72031. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  72032. import { Nullable } from "babylonjs/types";
  72033. import { Camera } from "babylonjs/Cameras/camera";
  72034. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72035. import { Engine } from "babylonjs/Engines/engine";
  72036. import "babylonjs/Shaders/displayPass.fragment";
  72037. /**
  72038. * DisplayPassPostProcess which produces an output the same as it's input
  72039. */
  72040. export class DisplayPassPostProcess extends PostProcess {
  72041. /**
  72042. * Creates the DisplayPassPostProcess
  72043. * @param name The name of the effect.
  72044. * @param options The required width/height ratio to downsize to before computing the render pass.
  72045. * @param camera The camera to apply the render pass to.
  72046. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72047. * @param engine The engine which the post process will be applied. (default: current engine)
  72048. * @param reusable If the post process can be reused on the same frame. (default: false)
  72049. */
  72050. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72051. }
  72052. }
  72053. declare module "babylonjs/Shaders/filter.fragment" {
  72054. /** @hidden */
  72055. export var filterPixelShader: {
  72056. name: string;
  72057. shader: string;
  72058. };
  72059. }
  72060. declare module "babylonjs/PostProcesses/filterPostProcess" {
  72061. import { Nullable } from "babylonjs/types";
  72062. import { Matrix } from "babylonjs/Maths/math.vector";
  72063. import { Camera } from "babylonjs/Cameras/camera";
  72064. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72065. import { Engine } from "babylonjs/Engines/engine";
  72066. import "babylonjs/Shaders/filter.fragment";
  72067. /**
  72068. * Applies a kernel filter to the image
  72069. */
  72070. export class FilterPostProcess extends PostProcess {
  72071. /** The matrix to be applied to the image */
  72072. kernelMatrix: Matrix;
  72073. /**
  72074. *
  72075. * @param name The name of the effect.
  72076. * @param kernelMatrix The matrix to be applied to the image
  72077. * @param options The required width/height ratio to downsize to before computing the render pass.
  72078. * @param camera The camera to apply the render pass to.
  72079. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72080. * @param engine The engine which the post process will be applied. (default: current engine)
  72081. * @param reusable If the post process can be reused on the same frame. (default: false)
  72082. */
  72083. constructor(name: string,
  72084. /** The matrix to be applied to the image */
  72085. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72086. }
  72087. }
  72088. declare module "babylonjs/Shaders/fxaa.fragment" {
  72089. /** @hidden */
  72090. export var fxaaPixelShader: {
  72091. name: string;
  72092. shader: string;
  72093. };
  72094. }
  72095. declare module "babylonjs/Shaders/fxaa.vertex" {
  72096. /** @hidden */
  72097. export var fxaaVertexShader: {
  72098. name: string;
  72099. shader: string;
  72100. };
  72101. }
  72102. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  72103. import { Nullable } from "babylonjs/types";
  72104. import { Camera } from "babylonjs/Cameras/camera";
  72105. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72106. import { Engine } from "babylonjs/Engines/engine";
  72107. import "babylonjs/Shaders/fxaa.fragment";
  72108. import "babylonjs/Shaders/fxaa.vertex";
  72109. /**
  72110. * Fxaa post process
  72111. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  72112. */
  72113. export class FxaaPostProcess extends PostProcess {
  72114. /** @hidden */
  72115. texelWidth: number;
  72116. /** @hidden */
  72117. texelHeight: number;
  72118. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72119. private _getDefines;
  72120. }
  72121. }
  72122. declare module "babylonjs/Shaders/grain.fragment" {
  72123. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72124. /** @hidden */
  72125. export var grainPixelShader: {
  72126. name: string;
  72127. shader: string;
  72128. };
  72129. }
  72130. declare module "babylonjs/PostProcesses/grainPostProcess" {
  72131. import { Nullable } from "babylonjs/types";
  72132. import { Camera } from "babylonjs/Cameras/camera";
  72133. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72134. import { Engine } from "babylonjs/Engines/engine";
  72135. import "babylonjs/Shaders/grain.fragment";
  72136. /**
  72137. * The GrainPostProcess adds noise to the image at mid luminance levels
  72138. */
  72139. export class GrainPostProcess extends PostProcess {
  72140. /**
  72141. * The intensity of the grain added (default: 30)
  72142. */
  72143. intensity: number;
  72144. /**
  72145. * If the grain should be randomized on every frame
  72146. */
  72147. animated: boolean;
  72148. /**
  72149. * Creates a new instance of @see GrainPostProcess
  72150. * @param name The name of the effect.
  72151. * @param options The required width/height ratio to downsize to before computing the render pass.
  72152. * @param camera The camera to apply the render pass to.
  72153. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72154. * @param engine The engine which the post process will be applied. (default: current engine)
  72155. * @param reusable If the post process can be reused on the same frame. (default: false)
  72156. * @param textureType Type of textures used when performing the post process. (default: 0)
  72157. * @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)
  72158. */
  72159. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72160. }
  72161. }
  72162. declare module "babylonjs/Shaders/highlights.fragment" {
  72163. /** @hidden */
  72164. export var highlightsPixelShader: {
  72165. name: string;
  72166. shader: string;
  72167. };
  72168. }
  72169. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  72170. import { Nullable } from "babylonjs/types";
  72171. import { Camera } from "babylonjs/Cameras/camera";
  72172. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72173. import { Engine } from "babylonjs/Engines/engine";
  72174. import "babylonjs/Shaders/highlights.fragment";
  72175. /**
  72176. * Extracts highlights from the image
  72177. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  72178. */
  72179. export class HighlightsPostProcess extends PostProcess {
  72180. /**
  72181. * Extracts highlights from the image
  72182. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  72183. * @param name The name of the effect.
  72184. * @param options The required width/height ratio to downsize to before computing the render pass.
  72185. * @param camera The camera to apply the render pass to.
  72186. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72187. * @param engine The engine which the post process will be applied. (default: current engine)
  72188. * @param reusable If the post process can be reused on the same frame. (default: false)
  72189. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  72190. */
  72191. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72192. }
  72193. }
  72194. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  72195. /** @hidden */
  72196. export var mrtFragmentDeclaration: {
  72197. name: string;
  72198. shader: string;
  72199. };
  72200. }
  72201. declare module "babylonjs/Shaders/geometry.fragment" {
  72202. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  72203. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  72204. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  72205. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  72206. /** @hidden */
  72207. export var geometryPixelShader: {
  72208. name: string;
  72209. shader: string;
  72210. };
  72211. }
  72212. declare module "babylonjs/Shaders/geometry.vertex" {
  72213. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  72214. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  72215. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  72216. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  72217. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  72218. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  72219. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  72220. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  72221. /** @hidden */
  72222. export var geometryVertexShader: {
  72223. name: string;
  72224. shader: string;
  72225. };
  72226. }
  72227. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  72228. import { Matrix } from "babylonjs/Maths/math.vector";
  72229. import { SubMesh } from "babylonjs/Meshes/subMesh";
  72230. import { Mesh } from "babylonjs/Meshes/mesh";
  72231. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  72232. import { Effect } from "babylonjs/Materials/effect";
  72233. import { Scene } from "babylonjs/scene";
  72234. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  72235. import "babylonjs/Shaders/geometry.fragment";
  72236. import "babylonjs/Shaders/geometry.vertex";
  72237. /** @hidden */
  72238. interface ISavedTransformationMatrix {
  72239. world: Matrix;
  72240. viewProjection: Matrix;
  72241. }
  72242. /**
  72243. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  72244. */
  72245. export class GeometryBufferRenderer {
  72246. /**
  72247. * Constant used to retrieve the position texture index in the G-Buffer textures array
  72248. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  72249. */
  72250. static readonly POSITION_TEXTURE_TYPE: number;
  72251. /**
  72252. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  72253. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  72254. */
  72255. static readonly VELOCITY_TEXTURE_TYPE: number;
  72256. /**
  72257. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  72258. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  72259. */
  72260. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  72261. /**
  72262. * Dictionary used to store the previous transformation matrices of each rendered mesh
  72263. * in order to compute objects velocities when enableVelocity is set to "true"
  72264. * @hidden
  72265. */
  72266. _previousTransformationMatrices: {
  72267. [index: number]: ISavedTransformationMatrix;
  72268. };
  72269. /**
  72270. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  72271. * in order to compute objects velocities when enableVelocity is set to "true"
  72272. * @hidden
  72273. */
  72274. _previousBonesTransformationMatrices: {
  72275. [index: number]: Float32Array;
  72276. };
  72277. /**
  72278. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  72279. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  72280. */
  72281. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  72282. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  72283. renderTransparentMeshes: boolean;
  72284. private _scene;
  72285. private _multiRenderTarget;
  72286. private _ratio;
  72287. private _enablePosition;
  72288. private _enableVelocity;
  72289. private _enableReflectivity;
  72290. private _positionIndex;
  72291. private _velocityIndex;
  72292. private _reflectivityIndex;
  72293. protected _effect: Effect;
  72294. protected _cachedDefines: string;
  72295. /**
  72296. * Set the render list (meshes to be rendered) used in the G buffer.
  72297. */
  72298. set renderList(meshes: Mesh[]);
  72299. /**
  72300. * Gets wether or not G buffer are supported by the running hardware.
  72301. * This requires draw buffer supports
  72302. */
  72303. get isSupported(): boolean;
  72304. /**
  72305. * Returns the index of the given texture type in the G-Buffer textures array
  72306. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  72307. * @returns the index of the given texture type in the G-Buffer textures array
  72308. */
  72309. getTextureIndex(textureType: number): number;
  72310. /**
  72311. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  72312. */
  72313. get enablePosition(): boolean;
  72314. /**
  72315. * Sets whether or not objects positions are enabled for the G buffer.
  72316. */
  72317. set enablePosition(enable: boolean);
  72318. /**
  72319. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  72320. */
  72321. get enableVelocity(): boolean;
  72322. /**
  72323. * Sets wether or not objects velocities are enabled for the G buffer.
  72324. */
  72325. set enableVelocity(enable: boolean);
  72326. /**
  72327. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  72328. */
  72329. get enableReflectivity(): boolean;
  72330. /**
  72331. * Sets wether or not objects roughness are enabled for the G buffer.
  72332. */
  72333. set enableReflectivity(enable: boolean);
  72334. /**
  72335. * Gets the scene associated with the buffer.
  72336. */
  72337. get scene(): Scene;
  72338. /**
  72339. * Gets the ratio used by the buffer during its creation.
  72340. * How big is the buffer related to the main canvas.
  72341. */
  72342. get ratio(): number;
  72343. /** @hidden */
  72344. static _SceneComponentInitialization: (scene: Scene) => void;
  72345. /**
  72346. * Creates a new G Buffer for the scene
  72347. * @param scene The scene the buffer belongs to
  72348. * @param ratio How big is the buffer related to the main canvas.
  72349. */
  72350. constructor(scene: Scene, ratio?: number);
  72351. /**
  72352. * Checks wether everything is ready to render a submesh to the G buffer.
  72353. * @param subMesh the submesh to check readiness for
  72354. * @param useInstances is the mesh drawn using instance or not
  72355. * @returns true if ready otherwise false
  72356. */
  72357. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  72358. /**
  72359. * Gets the current underlying G Buffer.
  72360. * @returns the buffer
  72361. */
  72362. getGBuffer(): MultiRenderTarget;
  72363. /**
  72364. * Gets the number of samples used to render the buffer (anti aliasing).
  72365. */
  72366. get samples(): number;
  72367. /**
  72368. * Sets the number of samples used to render the buffer (anti aliasing).
  72369. */
  72370. set samples(value: number);
  72371. /**
  72372. * Disposes the renderer and frees up associated resources.
  72373. */
  72374. dispose(): void;
  72375. protected _createRenderTargets(): void;
  72376. private _copyBonesTransformationMatrices;
  72377. }
  72378. }
  72379. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  72380. import { Nullable } from "babylonjs/types";
  72381. import { Scene } from "babylonjs/scene";
  72382. import { ISceneComponent } from "babylonjs/sceneComponent";
  72383. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  72384. module "babylonjs/scene" {
  72385. interface Scene {
  72386. /** @hidden (Backing field) */
  72387. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  72388. /**
  72389. * Gets or Sets the current geometry buffer associated to the scene.
  72390. */
  72391. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  72392. /**
  72393. * Enables a GeometryBufferRender and associates it with the scene
  72394. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  72395. * @returns the GeometryBufferRenderer
  72396. */
  72397. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  72398. /**
  72399. * Disables the GeometryBufferRender associated with the scene
  72400. */
  72401. disableGeometryBufferRenderer(): void;
  72402. }
  72403. }
  72404. /**
  72405. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  72406. * in several rendering techniques.
  72407. */
  72408. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  72409. /**
  72410. * The component name helpful to identify the component in the list of scene components.
  72411. */
  72412. readonly name: string;
  72413. /**
  72414. * The scene the component belongs to.
  72415. */
  72416. scene: Scene;
  72417. /**
  72418. * Creates a new instance of the component for the given scene
  72419. * @param scene Defines the scene to register the component in
  72420. */
  72421. constructor(scene: Scene);
  72422. /**
  72423. * Registers the component in a given scene
  72424. */
  72425. register(): void;
  72426. /**
  72427. * Rebuilds the elements related to this component in case of
  72428. * context lost for instance.
  72429. */
  72430. rebuild(): void;
  72431. /**
  72432. * Disposes the component and the associated ressources
  72433. */
  72434. dispose(): void;
  72435. private _gatherRenderTargets;
  72436. }
  72437. }
  72438. declare module "babylonjs/Shaders/motionBlur.fragment" {
  72439. /** @hidden */
  72440. export var motionBlurPixelShader: {
  72441. name: string;
  72442. shader: string;
  72443. };
  72444. }
  72445. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  72446. import { Nullable } from "babylonjs/types";
  72447. import { Camera } from "babylonjs/Cameras/camera";
  72448. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72449. import { Scene } from "babylonjs/scene";
  72450. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  72451. import "babylonjs/Animations/animatable";
  72452. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  72453. import "babylonjs/Shaders/motionBlur.fragment";
  72454. import { Engine } from "babylonjs/Engines/engine";
  72455. /**
  72456. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  72457. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  72458. * As an example, all you have to do is to create the post-process:
  72459. * var mb = new BABYLON.MotionBlurPostProcess(
  72460. * 'mb', // The name of the effect.
  72461. * scene, // The scene containing the objects to blur according to their velocity.
  72462. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  72463. * camera // The camera to apply the render pass to.
  72464. * );
  72465. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  72466. */
  72467. export class MotionBlurPostProcess extends PostProcess {
  72468. /**
  72469. * Defines how much the image is blurred by the movement. Default value is equal to 1
  72470. */
  72471. motionStrength: number;
  72472. /**
  72473. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  72474. */
  72475. get motionBlurSamples(): number;
  72476. /**
  72477. * Sets the number of iterations to be used for motion blur quality
  72478. */
  72479. set motionBlurSamples(samples: number);
  72480. private _motionBlurSamples;
  72481. private _geometryBufferRenderer;
  72482. /**
  72483. * Creates a new instance MotionBlurPostProcess
  72484. * @param name The name of the effect.
  72485. * @param scene The scene containing the objects to blur according to their velocity.
  72486. * @param options The required width/height ratio to downsize to before computing the render pass.
  72487. * @param camera The camera to apply the render pass to.
  72488. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72489. * @param engine The engine which the post process will be applied. (default: current engine)
  72490. * @param reusable If the post process can be reused on the same frame. (default: false)
  72491. * @param textureType Type of textures used when performing the post process. (default: 0)
  72492. * @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)
  72493. */
  72494. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72495. /**
  72496. * Excludes the given skinned mesh from computing bones velocities.
  72497. * 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.
  72498. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  72499. */
  72500. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  72501. /**
  72502. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  72503. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  72504. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  72505. */
  72506. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  72507. /**
  72508. * Disposes the post process.
  72509. * @param camera The camera to dispose the post process on.
  72510. */
  72511. dispose(camera?: Camera): void;
  72512. }
  72513. }
  72514. declare module "babylonjs/Shaders/refraction.fragment" {
  72515. /** @hidden */
  72516. export var refractionPixelShader: {
  72517. name: string;
  72518. shader: string;
  72519. };
  72520. }
  72521. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  72522. import { Color3 } from "babylonjs/Maths/math.color";
  72523. import { Camera } from "babylonjs/Cameras/camera";
  72524. import { Texture } from "babylonjs/Materials/Textures/texture";
  72525. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72526. import { Engine } from "babylonjs/Engines/engine";
  72527. import "babylonjs/Shaders/refraction.fragment";
  72528. /**
  72529. * Post process which applies a refractin texture
  72530. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  72531. */
  72532. export class RefractionPostProcess extends PostProcess {
  72533. /** the base color of the refraction (used to taint the rendering) */
  72534. color: Color3;
  72535. /** simulated refraction depth */
  72536. depth: number;
  72537. /** the coefficient of the base color (0 to remove base color tainting) */
  72538. colorLevel: number;
  72539. private _refTexture;
  72540. private _ownRefractionTexture;
  72541. /**
  72542. * Gets or sets the refraction texture
  72543. * Please note that you are responsible for disposing the texture if you set it manually
  72544. */
  72545. get refractionTexture(): Texture;
  72546. set refractionTexture(value: Texture);
  72547. /**
  72548. * Initializes the RefractionPostProcess
  72549. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  72550. * @param name The name of the effect.
  72551. * @param refractionTextureUrl Url of the refraction texture to use
  72552. * @param color the base color of the refraction (used to taint the rendering)
  72553. * @param depth simulated refraction depth
  72554. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  72555. * @param camera The camera to apply the render pass to.
  72556. * @param options The required width/height ratio to downsize to before computing the render pass.
  72557. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72558. * @param engine The engine which the post process will be applied. (default: current engine)
  72559. * @param reusable If the post process can be reused on the same frame. (default: false)
  72560. */
  72561. constructor(name: string, refractionTextureUrl: string,
  72562. /** the base color of the refraction (used to taint the rendering) */
  72563. color: Color3,
  72564. /** simulated refraction depth */
  72565. depth: number,
  72566. /** the coefficient of the base color (0 to remove base color tainting) */
  72567. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72568. /**
  72569. * Disposes of the post process
  72570. * @param camera Camera to dispose post process on
  72571. */
  72572. dispose(camera: Camera): void;
  72573. }
  72574. }
  72575. declare module "babylonjs/Shaders/sharpen.fragment" {
  72576. /** @hidden */
  72577. export var sharpenPixelShader: {
  72578. name: string;
  72579. shader: string;
  72580. };
  72581. }
  72582. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  72583. import { Nullable } from "babylonjs/types";
  72584. import { Camera } from "babylonjs/Cameras/camera";
  72585. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72586. import "babylonjs/Shaders/sharpen.fragment";
  72587. import { Engine } from "babylonjs/Engines/engine";
  72588. /**
  72589. * The SharpenPostProcess applies a sharpen kernel to every pixel
  72590. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72591. */
  72592. export class SharpenPostProcess extends PostProcess {
  72593. /**
  72594. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  72595. */
  72596. colorAmount: number;
  72597. /**
  72598. * How much sharpness should be applied (default: 0.3)
  72599. */
  72600. edgeAmount: number;
  72601. /**
  72602. * Creates a new instance ConvolutionPostProcess
  72603. * @param name The name of the effect.
  72604. * @param options The required width/height ratio to downsize to before computing the render pass.
  72605. * @param camera The camera to apply the render pass to.
  72606. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72607. * @param engine The engine which the post process will be applied. (default: current engine)
  72608. * @param reusable If the post process can be reused on the same frame. (default: false)
  72609. * @param textureType Type of textures used when performing the post process. (default: 0)
  72610. * @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)
  72611. */
  72612. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72613. }
  72614. }
  72615. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  72616. import { Nullable } from "babylonjs/types";
  72617. import { Camera } from "babylonjs/Cameras/camera";
  72618. import { Engine } from "babylonjs/Engines/engine";
  72619. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72620. import { IInspectable } from "babylonjs/Misc/iInspectable";
  72621. /**
  72622. * PostProcessRenderPipeline
  72623. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72624. */
  72625. export class PostProcessRenderPipeline {
  72626. private engine;
  72627. private _renderEffects;
  72628. private _renderEffectsForIsolatedPass;
  72629. /**
  72630. * List of inspectable custom properties (used by the Inspector)
  72631. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  72632. */
  72633. inspectableCustomProperties: IInspectable[];
  72634. /**
  72635. * @hidden
  72636. */
  72637. protected _cameras: Camera[];
  72638. /** @hidden */
  72639. _name: string;
  72640. /**
  72641. * Gets pipeline name
  72642. */
  72643. get name(): string;
  72644. /** Gets the list of attached cameras */
  72645. get cameras(): Camera[];
  72646. /**
  72647. * Initializes a PostProcessRenderPipeline
  72648. * @param engine engine to add the pipeline to
  72649. * @param name name of the pipeline
  72650. */
  72651. constructor(engine: Engine, name: string);
  72652. /**
  72653. * Gets the class name
  72654. * @returns "PostProcessRenderPipeline"
  72655. */
  72656. getClassName(): string;
  72657. /**
  72658. * If all the render effects in the pipeline are supported
  72659. */
  72660. get isSupported(): boolean;
  72661. /**
  72662. * Adds an effect to the pipeline
  72663. * @param renderEffect the effect to add
  72664. */
  72665. addEffect(renderEffect: PostProcessRenderEffect): void;
  72666. /** @hidden */
  72667. _rebuild(): void;
  72668. /** @hidden */
  72669. _enableEffect(renderEffectName: string, cameras: Camera): void;
  72670. /** @hidden */
  72671. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  72672. /** @hidden */
  72673. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  72674. /** @hidden */
  72675. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  72676. /** @hidden */
  72677. _attachCameras(cameras: Camera, unique: boolean): void;
  72678. /** @hidden */
  72679. _attachCameras(cameras: Camera[], unique: boolean): void;
  72680. /** @hidden */
  72681. _detachCameras(cameras: Camera): void;
  72682. /** @hidden */
  72683. _detachCameras(cameras: Nullable<Camera[]>): void;
  72684. /** @hidden */
  72685. _update(): void;
  72686. /** @hidden */
  72687. _reset(): void;
  72688. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  72689. /**
  72690. * Disposes of the pipeline
  72691. */
  72692. dispose(): void;
  72693. }
  72694. }
  72695. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  72696. import { Camera } from "babylonjs/Cameras/camera";
  72697. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  72698. /**
  72699. * PostProcessRenderPipelineManager class
  72700. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72701. */
  72702. export class PostProcessRenderPipelineManager {
  72703. private _renderPipelines;
  72704. /**
  72705. * Initializes a PostProcessRenderPipelineManager
  72706. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72707. */
  72708. constructor();
  72709. /**
  72710. * Gets the list of supported render pipelines
  72711. */
  72712. get supportedPipelines(): PostProcessRenderPipeline[];
  72713. /**
  72714. * Adds a pipeline to the manager
  72715. * @param renderPipeline The pipeline to add
  72716. */
  72717. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  72718. /**
  72719. * Attaches a camera to the pipeline
  72720. * @param renderPipelineName The name of the pipeline to attach to
  72721. * @param cameras the camera to attach
  72722. * @param unique if the camera can be attached multiple times to the pipeline
  72723. */
  72724. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  72725. /**
  72726. * Detaches a camera from the pipeline
  72727. * @param renderPipelineName The name of the pipeline to detach from
  72728. * @param cameras the camera to detach
  72729. */
  72730. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  72731. /**
  72732. * Enables an effect by name on a pipeline
  72733. * @param renderPipelineName the name of the pipeline to enable the effect in
  72734. * @param renderEffectName the name of the effect to enable
  72735. * @param cameras the cameras that the effect should be enabled on
  72736. */
  72737. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  72738. /**
  72739. * Disables an effect by name on a pipeline
  72740. * @param renderPipelineName the name of the pipeline to disable the effect in
  72741. * @param renderEffectName the name of the effect to disable
  72742. * @param cameras the cameras that the effect should be disabled on
  72743. */
  72744. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  72745. /**
  72746. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  72747. */
  72748. update(): void;
  72749. /** @hidden */
  72750. _rebuild(): void;
  72751. /**
  72752. * Disposes of the manager and pipelines
  72753. */
  72754. dispose(): void;
  72755. }
  72756. }
  72757. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  72758. import { ISceneComponent } from "babylonjs/sceneComponent";
  72759. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  72760. import { Scene } from "babylonjs/scene";
  72761. module "babylonjs/scene" {
  72762. interface Scene {
  72763. /** @hidden (Backing field) */
  72764. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  72765. /**
  72766. * Gets the postprocess render pipeline manager
  72767. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72768. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  72769. */
  72770. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  72771. }
  72772. }
  72773. /**
  72774. * Defines the Render Pipeline scene component responsible to rendering pipelines
  72775. */
  72776. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  72777. /**
  72778. * The component name helpfull to identify the component in the list of scene components.
  72779. */
  72780. readonly name: string;
  72781. /**
  72782. * The scene the component belongs to.
  72783. */
  72784. scene: Scene;
  72785. /**
  72786. * Creates a new instance of the component for the given scene
  72787. * @param scene Defines the scene to register the component in
  72788. */
  72789. constructor(scene: Scene);
  72790. /**
  72791. * Registers the component in a given scene
  72792. */
  72793. register(): void;
  72794. /**
  72795. * Rebuilds the elements related to this component in case of
  72796. * context lost for instance.
  72797. */
  72798. rebuild(): void;
  72799. /**
  72800. * Disposes the component and the associated ressources
  72801. */
  72802. dispose(): void;
  72803. private _gatherRenderTargets;
  72804. }
  72805. }
  72806. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  72807. import { Nullable } from "babylonjs/types";
  72808. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  72809. import { Camera } from "babylonjs/Cameras/camera";
  72810. import { IDisposable } from "babylonjs/scene";
  72811. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  72812. import { Scene } from "babylonjs/scene";
  72813. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  72814. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  72815. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  72816. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  72817. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  72818. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  72819. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  72820. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  72821. import { Animation } from "babylonjs/Animations/animation";
  72822. /**
  72823. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  72824. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  72825. */
  72826. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  72827. private _scene;
  72828. private _camerasToBeAttached;
  72829. /**
  72830. * ID of the sharpen post process,
  72831. */
  72832. private readonly SharpenPostProcessId;
  72833. /**
  72834. * @ignore
  72835. * ID of the image processing post process;
  72836. */
  72837. readonly ImageProcessingPostProcessId: string;
  72838. /**
  72839. * @ignore
  72840. * ID of the Fast Approximate Anti-Aliasing post process;
  72841. */
  72842. readonly FxaaPostProcessId: string;
  72843. /**
  72844. * ID of the chromatic aberration post process,
  72845. */
  72846. private readonly ChromaticAberrationPostProcessId;
  72847. /**
  72848. * ID of the grain post process
  72849. */
  72850. private readonly GrainPostProcessId;
  72851. /**
  72852. * Sharpen post process which will apply a sharpen convolution to enhance edges
  72853. */
  72854. sharpen: SharpenPostProcess;
  72855. private _sharpenEffect;
  72856. private bloom;
  72857. /**
  72858. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  72859. */
  72860. depthOfField: DepthOfFieldEffect;
  72861. /**
  72862. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  72863. */
  72864. fxaa: FxaaPostProcess;
  72865. /**
  72866. * Image post processing pass used to perform operations such as tone mapping or color grading.
  72867. */
  72868. imageProcessing: ImageProcessingPostProcess;
  72869. /**
  72870. * Chromatic aberration post process which will shift rgb colors in the image
  72871. */
  72872. chromaticAberration: ChromaticAberrationPostProcess;
  72873. private _chromaticAberrationEffect;
  72874. /**
  72875. * Grain post process which add noise to the image
  72876. */
  72877. grain: GrainPostProcess;
  72878. private _grainEffect;
  72879. /**
  72880. * Glow post process which adds a glow to emissive areas of the image
  72881. */
  72882. private _glowLayer;
  72883. /**
  72884. * Animations which can be used to tweak settings over a period of time
  72885. */
  72886. animations: Animation[];
  72887. private _imageProcessingConfigurationObserver;
  72888. private _sharpenEnabled;
  72889. private _bloomEnabled;
  72890. private _depthOfFieldEnabled;
  72891. private _depthOfFieldBlurLevel;
  72892. private _fxaaEnabled;
  72893. private _imageProcessingEnabled;
  72894. private _defaultPipelineTextureType;
  72895. private _bloomScale;
  72896. private _chromaticAberrationEnabled;
  72897. private _grainEnabled;
  72898. private _buildAllowed;
  72899. /**
  72900. * Gets active scene
  72901. */
  72902. get scene(): Scene;
  72903. /**
  72904. * Enable or disable the sharpen process from the pipeline
  72905. */
  72906. set sharpenEnabled(enabled: boolean);
  72907. get sharpenEnabled(): boolean;
  72908. private _resizeObserver;
  72909. private _hardwareScaleLevel;
  72910. private _bloomKernel;
  72911. /**
  72912. * Specifies the size of the bloom blur kernel, relative to the final output size
  72913. */
  72914. get bloomKernel(): number;
  72915. set bloomKernel(value: number);
  72916. /**
  72917. * Specifies the weight of the bloom in the final rendering
  72918. */
  72919. private _bloomWeight;
  72920. /**
  72921. * Specifies the luma threshold for the area that will be blurred by the bloom
  72922. */
  72923. private _bloomThreshold;
  72924. private _hdr;
  72925. /**
  72926. * The strength of the bloom.
  72927. */
  72928. set bloomWeight(value: number);
  72929. get bloomWeight(): number;
  72930. /**
  72931. * The strength of the bloom.
  72932. */
  72933. set bloomThreshold(value: number);
  72934. get bloomThreshold(): number;
  72935. /**
  72936. * The scale of the bloom, lower value will provide better performance.
  72937. */
  72938. set bloomScale(value: number);
  72939. get bloomScale(): number;
  72940. /**
  72941. * Enable or disable the bloom from the pipeline
  72942. */
  72943. set bloomEnabled(enabled: boolean);
  72944. get bloomEnabled(): boolean;
  72945. private _rebuildBloom;
  72946. /**
  72947. * If the depth of field is enabled.
  72948. */
  72949. get depthOfFieldEnabled(): boolean;
  72950. set depthOfFieldEnabled(enabled: boolean);
  72951. /**
  72952. * Blur level of the depth of field effect. (Higher blur will effect performance)
  72953. */
  72954. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  72955. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  72956. /**
  72957. * If the anti aliasing is enabled.
  72958. */
  72959. set fxaaEnabled(enabled: boolean);
  72960. get fxaaEnabled(): boolean;
  72961. private _samples;
  72962. /**
  72963. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  72964. */
  72965. set samples(sampleCount: number);
  72966. get samples(): number;
  72967. /**
  72968. * If image processing is enabled.
  72969. */
  72970. set imageProcessingEnabled(enabled: boolean);
  72971. get imageProcessingEnabled(): boolean;
  72972. /**
  72973. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  72974. */
  72975. set glowLayerEnabled(enabled: boolean);
  72976. get glowLayerEnabled(): boolean;
  72977. /**
  72978. * Gets the glow layer (or null if not defined)
  72979. */
  72980. get glowLayer(): Nullable<GlowLayer>;
  72981. /**
  72982. * Enable or disable the chromaticAberration process from the pipeline
  72983. */
  72984. set chromaticAberrationEnabled(enabled: boolean);
  72985. get chromaticAberrationEnabled(): boolean;
  72986. /**
  72987. * Enable or disable the grain process from the pipeline
  72988. */
  72989. set grainEnabled(enabled: boolean);
  72990. get grainEnabled(): boolean;
  72991. /**
  72992. * @constructor
  72993. * @param name - The rendering pipeline name (default: "")
  72994. * @param hdr - If high dynamic range textures should be used (default: true)
  72995. * @param scene - The scene linked to this pipeline (default: the last created scene)
  72996. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  72997. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  72998. */
  72999. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  73000. /**
  73001. * Get the class name
  73002. * @returns "DefaultRenderingPipeline"
  73003. */
  73004. getClassName(): string;
  73005. /**
  73006. * Force the compilation of the entire pipeline.
  73007. */
  73008. prepare(): void;
  73009. private _hasCleared;
  73010. private _prevPostProcess;
  73011. private _prevPrevPostProcess;
  73012. private _setAutoClearAndTextureSharing;
  73013. private _depthOfFieldSceneObserver;
  73014. private _buildPipeline;
  73015. private _disposePostProcesses;
  73016. /**
  73017. * Adds a camera to the pipeline
  73018. * @param camera the camera to be added
  73019. */
  73020. addCamera(camera: Camera): void;
  73021. /**
  73022. * Removes a camera from the pipeline
  73023. * @param camera the camera to remove
  73024. */
  73025. removeCamera(camera: Camera): void;
  73026. /**
  73027. * Dispose of the pipeline and stop all post processes
  73028. */
  73029. dispose(): void;
  73030. /**
  73031. * Serialize the rendering pipeline (Used when exporting)
  73032. * @returns the serialized object
  73033. */
  73034. serialize(): any;
  73035. /**
  73036. * Parse the serialized pipeline
  73037. * @param source Source pipeline.
  73038. * @param scene The scene to load the pipeline to.
  73039. * @param rootUrl The URL of the serialized pipeline.
  73040. * @returns An instantiated pipeline from the serialized object.
  73041. */
  73042. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  73043. }
  73044. }
  73045. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  73046. /** @hidden */
  73047. export var lensHighlightsPixelShader: {
  73048. name: string;
  73049. shader: string;
  73050. };
  73051. }
  73052. declare module "babylonjs/Shaders/depthOfField.fragment" {
  73053. /** @hidden */
  73054. export var depthOfFieldPixelShader: {
  73055. name: string;
  73056. shader: string;
  73057. };
  73058. }
  73059. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  73060. import { Camera } from "babylonjs/Cameras/camera";
  73061. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73062. import { Scene } from "babylonjs/scene";
  73063. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73064. import "babylonjs/Shaders/chromaticAberration.fragment";
  73065. import "babylonjs/Shaders/lensHighlights.fragment";
  73066. import "babylonjs/Shaders/depthOfField.fragment";
  73067. /**
  73068. * BABYLON.JS Chromatic Aberration GLSL Shader
  73069. * Author: Olivier Guyot
  73070. * Separates very slightly R, G and B colors on the edges of the screen
  73071. * Inspired by Francois Tarlier & Martins Upitis
  73072. */
  73073. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  73074. /**
  73075. * @ignore
  73076. * The chromatic aberration PostProcess id in the pipeline
  73077. */
  73078. LensChromaticAberrationEffect: string;
  73079. /**
  73080. * @ignore
  73081. * The highlights enhancing PostProcess id in the pipeline
  73082. */
  73083. HighlightsEnhancingEffect: string;
  73084. /**
  73085. * @ignore
  73086. * The depth-of-field PostProcess id in the pipeline
  73087. */
  73088. LensDepthOfFieldEffect: string;
  73089. private _scene;
  73090. private _depthTexture;
  73091. private _grainTexture;
  73092. private _chromaticAberrationPostProcess;
  73093. private _highlightsPostProcess;
  73094. private _depthOfFieldPostProcess;
  73095. private _edgeBlur;
  73096. private _grainAmount;
  73097. private _chromaticAberration;
  73098. private _distortion;
  73099. private _highlightsGain;
  73100. private _highlightsThreshold;
  73101. private _dofDistance;
  73102. private _dofAperture;
  73103. private _dofDarken;
  73104. private _dofPentagon;
  73105. private _blurNoise;
  73106. /**
  73107. * @constructor
  73108. *
  73109. * Effect parameters are as follow:
  73110. * {
  73111. * chromatic_aberration: number; // from 0 to x (1 for realism)
  73112. * edge_blur: number; // from 0 to x (1 for realism)
  73113. * distortion: number; // from 0 to x (1 for realism)
  73114. * grain_amount: number; // from 0 to 1
  73115. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  73116. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  73117. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  73118. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  73119. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  73120. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  73121. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  73122. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  73123. * }
  73124. * Note: if an effect parameter is unset, effect is disabled
  73125. *
  73126. * @param name The rendering pipeline name
  73127. * @param parameters - An object containing all parameters (see above)
  73128. * @param scene The scene linked to this pipeline
  73129. * @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)
  73130. * @param cameras The array of cameras that the rendering pipeline will be attached to
  73131. */
  73132. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  73133. /**
  73134. * Get the class name
  73135. * @returns "LensRenderingPipeline"
  73136. */
  73137. getClassName(): string;
  73138. /**
  73139. * Gets associated scene
  73140. */
  73141. get scene(): Scene;
  73142. /**
  73143. * Gets or sets the edge blur
  73144. */
  73145. get edgeBlur(): number;
  73146. set edgeBlur(value: number);
  73147. /**
  73148. * Gets or sets the grain amount
  73149. */
  73150. get grainAmount(): number;
  73151. set grainAmount(value: number);
  73152. /**
  73153. * Gets or sets the chromatic aberration amount
  73154. */
  73155. get chromaticAberration(): number;
  73156. set chromaticAberration(value: number);
  73157. /**
  73158. * Gets or sets the depth of field aperture
  73159. */
  73160. get dofAperture(): number;
  73161. set dofAperture(value: number);
  73162. /**
  73163. * Gets or sets the edge distortion
  73164. */
  73165. get edgeDistortion(): number;
  73166. set edgeDistortion(value: number);
  73167. /**
  73168. * Gets or sets the depth of field distortion
  73169. */
  73170. get dofDistortion(): number;
  73171. set dofDistortion(value: number);
  73172. /**
  73173. * Gets or sets the darken out of focus amount
  73174. */
  73175. get darkenOutOfFocus(): number;
  73176. set darkenOutOfFocus(value: number);
  73177. /**
  73178. * Gets or sets a boolean indicating if blur noise is enabled
  73179. */
  73180. get blurNoise(): boolean;
  73181. set blurNoise(value: boolean);
  73182. /**
  73183. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  73184. */
  73185. get pentagonBokeh(): boolean;
  73186. set pentagonBokeh(value: boolean);
  73187. /**
  73188. * Gets or sets the highlight grain amount
  73189. */
  73190. get highlightsGain(): number;
  73191. set highlightsGain(value: number);
  73192. /**
  73193. * Gets or sets the highlight threshold
  73194. */
  73195. get highlightsThreshold(): number;
  73196. set highlightsThreshold(value: number);
  73197. /**
  73198. * Sets the amount of blur at the edges
  73199. * @param amount blur amount
  73200. */
  73201. setEdgeBlur(amount: number): void;
  73202. /**
  73203. * Sets edge blur to 0
  73204. */
  73205. disableEdgeBlur(): void;
  73206. /**
  73207. * Sets the amout of grain
  73208. * @param amount Amount of grain
  73209. */
  73210. setGrainAmount(amount: number): void;
  73211. /**
  73212. * Set grain amount to 0
  73213. */
  73214. disableGrain(): void;
  73215. /**
  73216. * Sets the chromatic aberration amount
  73217. * @param amount amount of chromatic aberration
  73218. */
  73219. setChromaticAberration(amount: number): void;
  73220. /**
  73221. * Sets chromatic aberration amount to 0
  73222. */
  73223. disableChromaticAberration(): void;
  73224. /**
  73225. * Sets the EdgeDistortion amount
  73226. * @param amount amount of EdgeDistortion
  73227. */
  73228. setEdgeDistortion(amount: number): void;
  73229. /**
  73230. * Sets edge distortion to 0
  73231. */
  73232. disableEdgeDistortion(): void;
  73233. /**
  73234. * Sets the FocusDistance amount
  73235. * @param amount amount of FocusDistance
  73236. */
  73237. setFocusDistance(amount: number): void;
  73238. /**
  73239. * Disables depth of field
  73240. */
  73241. disableDepthOfField(): void;
  73242. /**
  73243. * Sets the Aperture amount
  73244. * @param amount amount of Aperture
  73245. */
  73246. setAperture(amount: number): void;
  73247. /**
  73248. * Sets the DarkenOutOfFocus amount
  73249. * @param amount amount of DarkenOutOfFocus
  73250. */
  73251. setDarkenOutOfFocus(amount: number): void;
  73252. private _pentagonBokehIsEnabled;
  73253. /**
  73254. * Creates a pentagon bokeh effect
  73255. */
  73256. enablePentagonBokeh(): void;
  73257. /**
  73258. * Disables the pentagon bokeh effect
  73259. */
  73260. disablePentagonBokeh(): void;
  73261. /**
  73262. * Enables noise blur
  73263. */
  73264. enableNoiseBlur(): void;
  73265. /**
  73266. * Disables noise blur
  73267. */
  73268. disableNoiseBlur(): void;
  73269. /**
  73270. * Sets the HighlightsGain amount
  73271. * @param amount amount of HighlightsGain
  73272. */
  73273. setHighlightsGain(amount: number): void;
  73274. /**
  73275. * Sets the HighlightsThreshold amount
  73276. * @param amount amount of HighlightsThreshold
  73277. */
  73278. setHighlightsThreshold(amount: number): void;
  73279. /**
  73280. * Disables highlights
  73281. */
  73282. disableHighlights(): void;
  73283. /**
  73284. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  73285. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  73286. */
  73287. dispose(disableDepthRender?: boolean): void;
  73288. private _createChromaticAberrationPostProcess;
  73289. private _createHighlightsPostProcess;
  73290. private _createDepthOfFieldPostProcess;
  73291. private _createGrainTexture;
  73292. }
  73293. }
  73294. declare module "babylonjs/Shaders/ssao2.fragment" {
  73295. /** @hidden */
  73296. export var ssao2PixelShader: {
  73297. name: string;
  73298. shader: string;
  73299. };
  73300. }
  73301. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  73302. /** @hidden */
  73303. export var ssaoCombinePixelShader: {
  73304. name: string;
  73305. shader: string;
  73306. };
  73307. }
  73308. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  73309. import { Camera } from "babylonjs/Cameras/camera";
  73310. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73311. import { Scene } from "babylonjs/scene";
  73312. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73313. import "babylonjs/Shaders/ssao2.fragment";
  73314. import "babylonjs/Shaders/ssaoCombine.fragment";
  73315. /**
  73316. * Render pipeline to produce ssao effect
  73317. */
  73318. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  73319. /**
  73320. * @ignore
  73321. * The PassPostProcess id in the pipeline that contains the original scene color
  73322. */
  73323. SSAOOriginalSceneColorEffect: string;
  73324. /**
  73325. * @ignore
  73326. * The SSAO PostProcess id in the pipeline
  73327. */
  73328. SSAORenderEffect: string;
  73329. /**
  73330. * @ignore
  73331. * The horizontal blur PostProcess id in the pipeline
  73332. */
  73333. SSAOBlurHRenderEffect: string;
  73334. /**
  73335. * @ignore
  73336. * The vertical blur PostProcess id in the pipeline
  73337. */
  73338. SSAOBlurVRenderEffect: string;
  73339. /**
  73340. * @ignore
  73341. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  73342. */
  73343. SSAOCombineRenderEffect: string;
  73344. /**
  73345. * The output strength of the SSAO post-process. Default value is 1.0.
  73346. */
  73347. totalStrength: number;
  73348. /**
  73349. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  73350. */
  73351. maxZ: number;
  73352. /**
  73353. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  73354. */
  73355. minZAspect: number;
  73356. private _samples;
  73357. /**
  73358. * Number of samples used for the SSAO calculations. Default value is 8
  73359. */
  73360. set samples(n: number);
  73361. get samples(): number;
  73362. private _textureSamples;
  73363. /**
  73364. * Number of samples to use for antialiasing
  73365. */
  73366. set textureSamples(n: number);
  73367. get textureSamples(): number;
  73368. /**
  73369. * Ratio object used for SSAO ratio and blur ratio
  73370. */
  73371. private _ratio;
  73372. /**
  73373. * Dynamically generated sphere sampler.
  73374. */
  73375. private _sampleSphere;
  73376. /**
  73377. * Blur filter offsets
  73378. */
  73379. private _samplerOffsets;
  73380. private _expensiveBlur;
  73381. /**
  73382. * If bilateral blur should be used
  73383. */
  73384. set expensiveBlur(b: boolean);
  73385. get expensiveBlur(): boolean;
  73386. /**
  73387. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  73388. */
  73389. radius: number;
  73390. /**
  73391. * The base color of the SSAO post-process
  73392. * The final result is "base + ssao" between [0, 1]
  73393. */
  73394. base: number;
  73395. /**
  73396. * Support test.
  73397. */
  73398. static get IsSupported(): boolean;
  73399. private _scene;
  73400. private _depthTexture;
  73401. private _normalTexture;
  73402. private _randomTexture;
  73403. private _originalColorPostProcess;
  73404. private _ssaoPostProcess;
  73405. private _blurHPostProcess;
  73406. private _blurVPostProcess;
  73407. private _ssaoCombinePostProcess;
  73408. /**
  73409. * Gets active scene
  73410. */
  73411. get scene(): Scene;
  73412. /**
  73413. * @constructor
  73414. * @param name The rendering pipeline name
  73415. * @param scene The scene linked to this pipeline
  73416. * @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 }
  73417. * @param cameras The array of cameras that the rendering pipeline will be attached to
  73418. */
  73419. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  73420. /**
  73421. * Get the class name
  73422. * @returns "SSAO2RenderingPipeline"
  73423. */
  73424. getClassName(): string;
  73425. /**
  73426. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  73427. */
  73428. dispose(disableGeometryBufferRenderer?: boolean): void;
  73429. private _createBlurPostProcess;
  73430. /** @hidden */
  73431. _rebuild(): void;
  73432. private _bits;
  73433. private _radicalInverse_VdC;
  73434. private _hammersley;
  73435. private _hemisphereSample_uniform;
  73436. private _generateHemisphere;
  73437. private _createSSAOPostProcess;
  73438. private _createSSAOCombinePostProcess;
  73439. private _createRandomTexture;
  73440. /**
  73441. * Serialize the rendering pipeline (Used when exporting)
  73442. * @returns the serialized object
  73443. */
  73444. serialize(): any;
  73445. /**
  73446. * Parse the serialized pipeline
  73447. * @param source Source pipeline.
  73448. * @param scene The scene to load the pipeline to.
  73449. * @param rootUrl The URL of the serialized pipeline.
  73450. * @returns An instantiated pipeline from the serialized object.
  73451. */
  73452. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  73453. }
  73454. }
  73455. declare module "babylonjs/Shaders/ssao.fragment" {
  73456. /** @hidden */
  73457. export var ssaoPixelShader: {
  73458. name: string;
  73459. shader: string;
  73460. };
  73461. }
  73462. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  73463. import { Camera } from "babylonjs/Cameras/camera";
  73464. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73465. import { Scene } from "babylonjs/scene";
  73466. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73467. import "babylonjs/Shaders/ssao.fragment";
  73468. import "babylonjs/Shaders/ssaoCombine.fragment";
  73469. /**
  73470. * Render pipeline to produce ssao effect
  73471. */
  73472. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  73473. /**
  73474. * @ignore
  73475. * The PassPostProcess id in the pipeline that contains the original scene color
  73476. */
  73477. SSAOOriginalSceneColorEffect: string;
  73478. /**
  73479. * @ignore
  73480. * The SSAO PostProcess id in the pipeline
  73481. */
  73482. SSAORenderEffect: string;
  73483. /**
  73484. * @ignore
  73485. * The horizontal blur PostProcess id in the pipeline
  73486. */
  73487. SSAOBlurHRenderEffect: string;
  73488. /**
  73489. * @ignore
  73490. * The vertical blur PostProcess id in the pipeline
  73491. */
  73492. SSAOBlurVRenderEffect: string;
  73493. /**
  73494. * @ignore
  73495. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  73496. */
  73497. SSAOCombineRenderEffect: string;
  73498. /**
  73499. * The output strength of the SSAO post-process. Default value is 1.0.
  73500. */
  73501. totalStrength: number;
  73502. /**
  73503. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  73504. */
  73505. radius: number;
  73506. /**
  73507. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  73508. * Must not be equal to fallOff and superior to fallOff.
  73509. * Default value is 0.0075
  73510. */
  73511. area: number;
  73512. /**
  73513. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  73514. * Must not be equal to area and inferior to area.
  73515. * Default value is 0.000001
  73516. */
  73517. fallOff: number;
  73518. /**
  73519. * The base color of the SSAO post-process
  73520. * The final result is "base + ssao" between [0, 1]
  73521. */
  73522. base: number;
  73523. private _scene;
  73524. private _depthTexture;
  73525. private _randomTexture;
  73526. private _originalColorPostProcess;
  73527. private _ssaoPostProcess;
  73528. private _blurHPostProcess;
  73529. private _blurVPostProcess;
  73530. private _ssaoCombinePostProcess;
  73531. private _firstUpdate;
  73532. /**
  73533. * Gets active scene
  73534. */
  73535. get scene(): Scene;
  73536. /**
  73537. * @constructor
  73538. * @param name - The rendering pipeline name
  73539. * @param scene - The scene linked to this pipeline
  73540. * @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 }
  73541. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  73542. */
  73543. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  73544. /**
  73545. * Get the class name
  73546. * @returns "SSAORenderingPipeline"
  73547. */
  73548. getClassName(): string;
  73549. /**
  73550. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  73551. */
  73552. dispose(disableDepthRender?: boolean): void;
  73553. private _createBlurPostProcess;
  73554. /** @hidden */
  73555. _rebuild(): void;
  73556. private _createSSAOPostProcess;
  73557. private _createSSAOCombinePostProcess;
  73558. private _createRandomTexture;
  73559. }
  73560. }
  73561. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  73562. /** @hidden */
  73563. export var screenSpaceReflectionPixelShader: {
  73564. name: string;
  73565. shader: string;
  73566. };
  73567. }
  73568. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  73569. import { Nullable } from "babylonjs/types";
  73570. import { Camera } from "babylonjs/Cameras/camera";
  73571. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73572. import { Scene } from "babylonjs/scene";
  73573. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  73574. import { Engine } from "babylonjs/Engines/engine";
  73575. /**
  73576. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  73577. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  73578. */
  73579. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  73580. /**
  73581. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  73582. */
  73583. threshold: number;
  73584. /**
  73585. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  73586. */
  73587. strength: number;
  73588. /**
  73589. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  73590. */
  73591. reflectionSpecularFalloffExponent: number;
  73592. /**
  73593. * Gets or sets the step size used to iterate until the effect finds the color of the reflection's pixel. Typically in interval [0.1, 1.0]
  73594. */
  73595. step: number;
  73596. /**
  73597. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  73598. */
  73599. roughnessFactor: number;
  73600. private _geometryBufferRenderer;
  73601. private _enableSmoothReflections;
  73602. private _reflectionSamples;
  73603. private _smoothSteps;
  73604. /**
  73605. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  73606. * @param name The name of the effect.
  73607. * @param scene The scene containing the objects to calculate reflections.
  73608. * @param options The required width/height ratio to downsize to before computing the render pass.
  73609. * @param camera The camera to apply the render pass to.
  73610. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73611. * @param engine The engine which the post process will be applied. (default: current engine)
  73612. * @param reusable If the post process can be reused on the same frame. (default: false)
  73613. * @param textureType Type of textures used when performing the post process. (default: 0)
  73614. * @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)
  73615. */
  73616. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73617. /**
  73618. * Gets wether or not smoothing reflections is enabled.
  73619. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  73620. */
  73621. get enableSmoothReflections(): boolean;
  73622. /**
  73623. * Sets wether or not smoothing reflections is enabled.
  73624. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  73625. */
  73626. set enableSmoothReflections(enabled: boolean);
  73627. /**
  73628. * Gets the number of samples taken while computing reflections. More samples count is high,
  73629. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  73630. */
  73631. get reflectionSamples(): number;
  73632. /**
  73633. * Sets the number of samples taken while computing reflections. More samples count is high,
  73634. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  73635. */
  73636. set reflectionSamples(samples: number);
  73637. /**
  73638. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  73639. * more the post-process will require GPU power and can generate a drop in FPS.
  73640. * Default value (5.0) work pretty well in all cases but can be adjusted.
  73641. */
  73642. get smoothSteps(): number;
  73643. set smoothSteps(steps: number);
  73644. private _updateEffectDefines;
  73645. }
  73646. }
  73647. declare module "babylonjs/Shaders/standard.fragment" {
  73648. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  73649. /** @hidden */
  73650. export var standardPixelShader: {
  73651. name: string;
  73652. shader: string;
  73653. };
  73654. }
  73655. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  73656. import { Nullable } from "babylonjs/types";
  73657. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  73658. import { Camera } from "babylonjs/Cameras/camera";
  73659. import { Texture } from "babylonjs/Materials/Textures/texture";
  73660. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73661. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73662. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  73663. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  73664. import { IDisposable } from "babylonjs/scene";
  73665. import { SpotLight } from "babylonjs/Lights/spotLight";
  73666. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  73667. import { Scene } from "babylonjs/scene";
  73668. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  73669. import { Animation } from "babylonjs/Animations/animation";
  73670. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73671. import "babylonjs/Shaders/standard.fragment";
  73672. /**
  73673. * Standard rendering pipeline
  73674. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  73675. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  73676. */
  73677. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  73678. /**
  73679. * Public members
  73680. */
  73681. /**
  73682. * Post-process which contains the original scene color before the pipeline applies all the effects
  73683. */
  73684. originalPostProcess: Nullable<PostProcess>;
  73685. /**
  73686. * Post-process used to down scale an image x4
  73687. */
  73688. downSampleX4PostProcess: Nullable<PostProcess>;
  73689. /**
  73690. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  73691. */
  73692. brightPassPostProcess: Nullable<PostProcess>;
  73693. /**
  73694. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  73695. */
  73696. blurHPostProcesses: PostProcess[];
  73697. /**
  73698. * Post-process array storing all the vertical blur post-processes used by the pipeline
  73699. */
  73700. blurVPostProcesses: PostProcess[];
  73701. /**
  73702. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  73703. */
  73704. textureAdderPostProcess: Nullable<PostProcess>;
  73705. /**
  73706. * Post-process used to create volumetric lighting effect
  73707. */
  73708. volumetricLightPostProcess: Nullable<PostProcess>;
  73709. /**
  73710. * Post-process used to smooth the previous volumetric light post-process on the X axis
  73711. */
  73712. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  73713. /**
  73714. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  73715. */
  73716. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  73717. /**
  73718. * Post-process used to merge the volumetric light effect and the real scene color
  73719. */
  73720. volumetricLightMergePostProces: Nullable<PostProcess>;
  73721. /**
  73722. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  73723. */
  73724. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  73725. /**
  73726. * Base post-process used to calculate the average luminance of the final image for HDR
  73727. */
  73728. luminancePostProcess: Nullable<PostProcess>;
  73729. /**
  73730. * Post-processes used to create down sample post-processes in order to get
  73731. * the average luminance of the final image for HDR
  73732. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  73733. */
  73734. luminanceDownSamplePostProcesses: PostProcess[];
  73735. /**
  73736. * Post-process used to create a HDR effect (light adaptation)
  73737. */
  73738. hdrPostProcess: Nullable<PostProcess>;
  73739. /**
  73740. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  73741. */
  73742. textureAdderFinalPostProcess: Nullable<PostProcess>;
  73743. /**
  73744. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  73745. */
  73746. lensFlareFinalPostProcess: Nullable<PostProcess>;
  73747. /**
  73748. * Post-process used to merge the final HDR post-process and the real scene color
  73749. */
  73750. hdrFinalPostProcess: Nullable<PostProcess>;
  73751. /**
  73752. * Post-process used to create a lens flare effect
  73753. */
  73754. lensFlarePostProcess: Nullable<PostProcess>;
  73755. /**
  73756. * Post-process that merges the result of the lens flare post-process and the real scene color
  73757. */
  73758. lensFlareComposePostProcess: Nullable<PostProcess>;
  73759. /**
  73760. * Post-process used to create a motion blur effect
  73761. */
  73762. motionBlurPostProcess: Nullable<PostProcess>;
  73763. /**
  73764. * Post-process used to create a depth of field effect
  73765. */
  73766. depthOfFieldPostProcess: Nullable<PostProcess>;
  73767. /**
  73768. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  73769. */
  73770. fxaaPostProcess: Nullable<FxaaPostProcess>;
  73771. /**
  73772. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  73773. */
  73774. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  73775. /**
  73776. * Represents the brightness threshold in order to configure the illuminated surfaces
  73777. */
  73778. brightThreshold: number;
  73779. /**
  73780. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  73781. */
  73782. blurWidth: number;
  73783. /**
  73784. * Sets if the blur for highlighted surfaces must be only horizontal
  73785. */
  73786. horizontalBlur: boolean;
  73787. /**
  73788. * Gets the overall exposure used by the pipeline
  73789. */
  73790. get exposure(): number;
  73791. /**
  73792. * Sets the overall exposure used by the pipeline
  73793. */
  73794. set exposure(value: number);
  73795. /**
  73796. * Texture used typically to simulate "dirty" on camera lens
  73797. */
  73798. lensTexture: Nullable<Texture>;
  73799. /**
  73800. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  73801. */
  73802. volumetricLightCoefficient: number;
  73803. /**
  73804. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  73805. */
  73806. volumetricLightPower: number;
  73807. /**
  73808. * Used the set the blur intensity to smooth the volumetric lights
  73809. */
  73810. volumetricLightBlurScale: number;
  73811. /**
  73812. * Light (spot or directional) used to generate the volumetric lights rays
  73813. * The source light must have a shadow generate so the pipeline can get its
  73814. * depth map
  73815. */
  73816. sourceLight: Nullable<SpotLight | DirectionalLight>;
  73817. /**
  73818. * For eye adaptation, represents the minimum luminance the eye can see
  73819. */
  73820. hdrMinimumLuminance: number;
  73821. /**
  73822. * For eye adaptation, represents the decrease luminance speed
  73823. */
  73824. hdrDecreaseRate: number;
  73825. /**
  73826. * For eye adaptation, represents the increase luminance speed
  73827. */
  73828. hdrIncreaseRate: number;
  73829. /**
  73830. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  73831. */
  73832. get hdrAutoExposure(): boolean;
  73833. /**
  73834. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  73835. */
  73836. set hdrAutoExposure(value: boolean);
  73837. /**
  73838. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  73839. */
  73840. lensColorTexture: Nullable<Texture>;
  73841. /**
  73842. * The overall strengh for the lens flare effect
  73843. */
  73844. lensFlareStrength: number;
  73845. /**
  73846. * Dispersion coefficient for lens flare ghosts
  73847. */
  73848. lensFlareGhostDispersal: number;
  73849. /**
  73850. * Main lens flare halo width
  73851. */
  73852. lensFlareHaloWidth: number;
  73853. /**
  73854. * Based on the lens distortion effect, defines how much the lens flare result
  73855. * is distorted
  73856. */
  73857. lensFlareDistortionStrength: number;
  73858. /**
  73859. * Configures the blur intensity used for for lens flare (halo)
  73860. */
  73861. lensFlareBlurWidth: number;
  73862. /**
  73863. * Lens star texture must be used to simulate rays on the flares and is available
  73864. * in the documentation
  73865. */
  73866. lensStarTexture: Nullable<Texture>;
  73867. /**
  73868. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  73869. * flare effect by taking account of the dirt texture
  73870. */
  73871. lensFlareDirtTexture: Nullable<Texture>;
  73872. /**
  73873. * Represents the focal length for the depth of field effect
  73874. */
  73875. depthOfFieldDistance: number;
  73876. /**
  73877. * Represents the blur intensity for the blurred part of the depth of field effect
  73878. */
  73879. depthOfFieldBlurWidth: number;
  73880. /**
  73881. * Gets how much the image is blurred by the movement while using the motion blur post-process
  73882. */
  73883. get motionStrength(): number;
  73884. /**
  73885. * Sets how much the image is blurred by the movement while using the motion blur post-process
  73886. */
  73887. set motionStrength(strength: number);
  73888. /**
  73889. * Gets wether or not the motion blur post-process is object based or screen based.
  73890. */
  73891. get objectBasedMotionBlur(): boolean;
  73892. /**
  73893. * Sets wether or not the motion blur post-process should be object based or screen based
  73894. */
  73895. set objectBasedMotionBlur(value: boolean);
  73896. /**
  73897. * List of animations for the pipeline (IAnimatable implementation)
  73898. */
  73899. animations: Animation[];
  73900. /**
  73901. * Private members
  73902. */
  73903. private _scene;
  73904. private _currentDepthOfFieldSource;
  73905. private _basePostProcess;
  73906. private _fixedExposure;
  73907. private _currentExposure;
  73908. private _hdrAutoExposure;
  73909. private _hdrCurrentLuminance;
  73910. private _motionStrength;
  73911. private _isObjectBasedMotionBlur;
  73912. private _floatTextureType;
  73913. private _camerasToBeAttached;
  73914. private _ratio;
  73915. private _bloomEnabled;
  73916. private _depthOfFieldEnabled;
  73917. private _vlsEnabled;
  73918. private _lensFlareEnabled;
  73919. private _hdrEnabled;
  73920. private _motionBlurEnabled;
  73921. private _fxaaEnabled;
  73922. private _screenSpaceReflectionsEnabled;
  73923. private _motionBlurSamples;
  73924. private _volumetricLightStepsCount;
  73925. private _samples;
  73926. /**
  73927. * @ignore
  73928. * Specifies if the bloom pipeline is enabled
  73929. */
  73930. get BloomEnabled(): boolean;
  73931. set BloomEnabled(enabled: boolean);
  73932. /**
  73933. * @ignore
  73934. * Specifies if the depth of field pipeline is enabed
  73935. */
  73936. get DepthOfFieldEnabled(): boolean;
  73937. set DepthOfFieldEnabled(enabled: boolean);
  73938. /**
  73939. * @ignore
  73940. * Specifies if the lens flare pipeline is enabed
  73941. */
  73942. get LensFlareEnabled(): boolean;
  73943. set LensFlareEnabled(enabled: boolean);
  73944. /**
  73945. * @ignore
  73946. * Specifies if the HDR pipeline is enabled
  73947. */
  73948. get HDREnabled(): boolean;
  73949. set HDREnabled(enabled: boolean);
  73950. /**
  73951. * @ignore
  73952. * Specifies if the volumetric lights scattering effect is enabled
  73953. */
  73954. get VLSEnabled(): boolean;
  73955. set VLSEnabled(enabled: boolean);
  73956. /**
  73957. * @ignore
  73958. * Specifies if the motion blur effect is enabled
  73959. */
  73960. get MotionBlurEnabled(): boolean;
  73961. set MotionBlurEnabled(enabled: boolean);
  73962. /**
  73963. * Specifies if anti-aliasing is enabled
  73964. */
  73965. get fxaaEnabled(): boolean;
  73966. set fxaaEnabled(enabled: boolean);
  73967. /**
  73968. * Specifies if screen space reflections are enabled.
  73969. */
  73970. get screenSpaceReflectionsEnabled(): boolean;
  73971. set screenSpaceReflectionsEnabled(enabled: boolean);
  73972. /**
  73973. * Specifies the number of steps used to calculate the volumetric lights
  73974. * Typically in interval [50, 200]
  73975. */
  73976. get volumetricLightStepsCount(): number;
  73977. set volumetricLightStepsCount(count: number);
  73978. /**
  73979. * Specifies the number of samples used for the motion blur effect
  73980. * Typically in interval [16, 64]
  73981. */
  73982. get motionBlurSamples(): number;
  73983. set motionBlurSamples(samples: number);
  73984. /**
  73985. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  73986. */
  73987. get samples(): number;
  73988. set samples(sampleCount: number);
  73989. /**
  73990. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  73991. * @constructor
  73992. * @param name The rendering pipeline name
  73993. * @param scene The scene linked to this pipeline
  73994. * @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)
  73995. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  73996. * @param cameras The array of cameras that the rendering pipeline will be attached to
  73997. */
  73998. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  73999. private _buildPipeline;
  74000. private _createDownSampleX4PostProcess;
  74001. private _createBrightPassPostProcess;
  74002. private _createBlurPostProcesses;
  74003. private _createTextureAdderPostProcess;
  74004. private _createVolumetricLightPostProcess;
  74005. private _createLuminancePostProcesses;
  74006. private _createHdrPostProcess;
  74007. private _createLensFlarePostProcess;
  74008. private _createDepthOfFieldPostProcess;
  74009. private _createMotionBlurPostProcess;
  74010. private _getDepthTexture;
  74011. private _disposePostProcesses;
  74012. /**
  74013. * Dispose of the pipeline and stop all post processes
  74014. */
  74015. dispose(): void;
  74016. /**
  74017. * Serialize the rendering pipeline (Used when exporting)
  74018. * @returns the serialized object
  74019. */
  74020. serialize(): any;
  74021. /**
  74022. * Parse the serialized pipeline
  74023. * @param source Source pipeline.
  74024. * @param scene The scene to load the pipeline to.
  74025. * @param rootUrl The URL of the serialized pipeline.
  74026. * @returns An instantiated pipeline from the serialized object.
  74027. */
  74028. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  74029. /**
  74030. * Luminance steps
  74031. */
  74032. static LuminanceSteps: number;
  74033. }
  74034. }
  74035. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  74036. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  74037. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  74038. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  74039. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  74040. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  74041. }
  74042. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  74043. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  74044. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  74045. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74046. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  74047. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74048. }
  74049. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  74050. /** @hidden */
  74051. export var stereoscopicInterlacePixelShader: {
  74052. name: string;
  74053. shader: string;
  74054. };
  74055. }
  74056. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  74057. import { Camera } from "babylonjs/Cameras/camera";
  74058. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74059. import { Engine } from "babylonjs/Engines/engine";
  74060. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  74061. /**
  74062. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  74063. */
  74064. export class StereoscopicInterlacePostProcessI extends PostProcess {
  74065. private _stepSize;
  74066. private _passedProcess;
  74067. /**
  74068. * Initializes a StereoscopicInterlacePostProcessI
  74069. * @param name The name of the effect.
  74070. * @param rigCameras The rig cameras to be appled to the post process
  74071. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  74072. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  74073. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74074. * @param engine The engine which the post process will be applied. (default: current engine)
  74075. * @param reusable If the post process can be reused on the same frame. (default: false)
  74076. */
  74077. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74078. }
  74079. /**
  74080. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  74081. */
  74082. export class StereoscopicInterlacePostProcess extends PostProcess {
  74083. private _stepSize;
  74084. private _passedProcess;
  74085. /**
  74086. * Initializes a StereoscopicInterlacePostProcess
  74087. * @param name The name of the effect.
  74088. * @param rigCameras The rig cameras to be appled to the post process
  74089. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  74090. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74091. * @param engine The engine which the post process will be applied. (default: current engine)
  74092. * @param reusable If the post process can be reused on the same frame. (default: false)
  74093. */
  74094. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74095. }
  74096. }
  74097. declare module "babylonjs/Shaders/tonemap.fragment" {
  74098. /** @hidden */
  74099. export var tonemapPixelShader: {
  74100. name: string;
  74101. shader: string;
  74102. };
  74103. }
  74104. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  74105. import { Camera } from "babylonjs/Cameras/camera";
  74106. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74107. import "babylonjs/Shaders/tonemap.fragment";
  74108. import { Engine } from "babylonjs/Engines/engine";
  74109. /** Defines operator used for tonemapping */
  74110. export enum TonemappingOperator {
  74111. /** Hable */
  74112. Hable = 0,
  74113. /** Reinhard */
  74114. Reinhard = 1,
  74115. /** HejiDawson */
  74116. HejiDawson = 2,
  74117. /** Photographic */
  74118. Photographic = 3
  74119. }
  74120. /**
  74121. * Defines a post process to apply tone mapping
  74122. */
  74123. export class TonemapPostProcess extends PostProcess {
  74124. private _operator;
  74125. /** Defines the required exposure adjustement */
  74126. exposureAdjustment: number;
  74127. /**
  74128. * Creates a new TonemapPostProcess
  74129. * @param name defines the name of the postprocess
  74130. * @param _operator defines the operator to use
  74131. * @param exposureAdjustment defines the required exposure adjustement
  74132. * @param camera defines the camera to use (can be null)
  74133. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  74134. * @param engine defines the hosting engine (can be ignore if camera is set)
  74135. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  74136. */
  74137. constructor(name: string, _operator: TonemappingOperator,
  74138. /** Defines the required exposure adjustement */
  74139. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  74140. }
  74141. }
  74142. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  74143. /** @hidden */
  74144. export var volumetricLightScatteringPixelShader: {
  74145. name: string;
  74146. shader: string;
  74147. };
  74148. }
  74149. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  74150. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  74151. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  74152. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  74153. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  74154. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  74155. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  74156. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  74157. /** @hidden */
  74158. export var volumetricLightScatteringPassVertexShader: {
  74159. name: string;
  74160. shader: string;
  74161. };
  74162. }
  74163. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  74164. /** @hidden */
  74165. export var volumetricLightScatteringPassPixelShader: {
  74166. name: string;
  74167. shader: string;
  74168. };
  74169. }
  74170. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  74171. import { Vector3 } from "babylonjs/Maths/math.vector";
  74172. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  74173. import { Mesh } from "babylonjs/Meshes/mesh";
  74174. import { Camera } from "babylonjs/Cameras/camera";
  74175. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  74176. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74177. import { Scene } from "babylonjs/scene";
  74178. import "babylonjs/Meshes/Builders/planeBuilder";
  74179. import "babylonjs/Shaders/depth.vertex";
  74180. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  74181. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  74182. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  74183. import { Engine } from "babylonjs/Engines/engine";
  74184. /**
  74185. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  74186. */
  74187. export class VolumetricLightScatteringPostProcess extends PostProcess {
  74188. private _volumetricLightScatteringPass;
  74189. private _volumetricLightScatteringRTT;
  74190. private _viewPort;
  74191. private _screenCoordinates;
  74192. private _cachedDefines;
  74193. /**
  74194. * If not undefined, the mesh position is computed from the attached node position
  74195. */
  74196. attachedNode: {
  74197. position: Vector3;
  74198. };
  74199. /**
  74200. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  74201. */
  74202. customMeshPosition: Vector3;
  74203. /**
  74204. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  74205. */
  74206. useCustomMeshPosition: boolean;
  74207. /**
  74208. * If the post-process should inverse the light scattering direction
  74209. */
  74210. invert: boolean;
  74211. /**
  74212. * The internal mesh used by the post-process
  74213. */
  74214. mesh: Mesh;
  74215. /**
  74216. * @hidden
  74217. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  74218. */
  74219. get useDiffuseColor(): boolean;
  74220. set useDiffuseColor(useDiffuseColor: boolean);
  74221. /**
  74222. * Array containing the excluded meshes not rendered in the internal pass
  74223. */
  74224. excludedMeshes: AbstractMesh[];
  74225. /**
  74226. * Controls the overall intensity of the post-process
  74227. */
  74228. exposure: number;
  74229. /**
  74230. * Dissipates each sample's contribution in range [0, 1]
  74231. */
  74232. decay: number;
  74233. /**
  74234. * Controls the overall intensity of each sample
  74235. */
  74236. weight: number;
  74237. /**
  74238. * Controls the density of each sample
  74239. */
  74240. density: number;
  74241. /**
  74242. * @constructor
  74243. * @param name The post-process name
  74244. * @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)
  74245. * @param camera The camera that the post-process will be attached to
  74246. * @param mesh The mesh used to create the light scattering
  74247. * @param samples The post-process quality, default 100
  74248. * @param samplingModeThe post-process filtering mode
  74249. * @param engine The babylon engine
  74250. * @param reusable If the post-process is reusable
  74251. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  74252. */
  74253. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  74254. /**
  74255. * Returns the string "VolumetricLightScatteringPostProcess"
  74256. * @returns "VolumetricLightScatteringPostProcess"
  74257. */
  74258. getClassName(): string;
  74259. private _isReady;
  74260. /**
  74261. * Sets the new light position for light scattering effect
  74262. * @param position The new custom light position
  74263. */
  74264. setCustomMeshPosition(position: Vector3): void;
  74265. /**
  74266. * Returns the light position for light scattering effect
  74267. * @return Vector3 The custom light position
  74268. */
  74269. getCustomMeshPosition(): Vector3;
  74270. /**
  74271. * Disposes the internal assets and detaches the post-process from the camera
  74272. */
  74273. dispose(camera: Camera): void;
  74274. /**
  74275. * Returns the render target texture used by the post-process
  74276. * @return the render target texture used by the post-process
  74277. */
  74278. getPass(): RenderTargetTexture;
  74279. private _meshExcluded;
  74280. private _createPass;
  74281. private _updateMeshScreenCoordinates;
  74282. /**
  74283. * Creates a default mesh for the Volumeric Light Scattering post-process
  74284. * @param name The mesh name
  74285. * @param scene The scene where to create the mesh
  74286. * @return the default mesh
  74287. */
  74288. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  74289. }
  74290. }
  74291. declare module "babylonjs/PostProcesses/index" {
  74292. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  74293. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  74294. export * from "babylonjs/PostProcesses/bloomEffect";
  74295. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  74296. export * from "babylonjs/PostProcesses/blurPostProcess";
  74297. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74298. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  74299. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  74300. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  74301. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  74302. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  74303. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  74304. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  74305. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  74306. export * from "babylonjs/PostProcesses/filterPostProcess";
  74307. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  74308. export * from "babylonjs/PostProcesses/grainPostProcess";
  74309. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  74310. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74311. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  74312. export * from "babylonjs/PostProcesses/passPostProcess";
  74313. export * from "babylonjs/PostProcesses/postProcess";
  74314. export * from "babylonjs/PostProcesses/postProcessManager";
  74315. export * from "babylonjs/PostProcesses/refractionPostProcess";
  74316. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  74317. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  74318. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  74319. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  74320. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  74321. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  74322. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  74323. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74324. }
  74325. declare module "babylonjs/Probes/index" {
  74326. export * from "babylonjs/Probes/reflectionProbe";
  74327. }
  74328. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  74329. import { Scene } from "babylonjs/scene";
  74330. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  74331. import { SmartArray } from "babylonjs/Misc/smartArray";
  74332. import { ISceneComponent } from "babylonjs/sceneComponent";
  74333. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  74334. import "babylonjs/Meshes/Builders/boxBuilder";
  74335. import "babylonjs/Shaders/color.fragment";
  74336. import "babylonjs/Shaders/color.vertex";
  74337. import { Color3 } from "babylonjs/Maths/math.color";
  74338. import { Observable } from "babylonjs/Misc/observable";
  74339. module "babylonjs/scene" {
  74340. interface Scene {
  74341. /** @hidden (Backing field) */
  74342. _boundingBoxRenderer: BoundingBoxRenderer;
  74343. /** @hidden (Backing field) */
  74344. _forceShowBoundingBoxes: boolean;
  74345. /**
  74346. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  74347. */
  74348. forceShowBoundingBoxes: boolean;
  74349. /**
  74350. * Gets the bounding box renderer associated with the scene
  74351. * @returns a BoundingBoxRenderer
  74352. */
  74353. getBoundingBoxRenderer(): BoundingBoxRenderer;
  74354. }
  74355. }
  74356. module "babylonjs/Meshes/abstractMesh" {
  74357. interface AbstractMesh {
  74358. /** @hidden (Backing field) */
  74359. _showBoundingBox: boolean;
  74360. /**
  74361. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  74362. */
  74363. showBoundingBox: boolean;
  74364. }
  74365. }
  74366. /**
  74367. * Component responsible of rendering the bounding box of the meshes in a scene.
  74368. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  74369. */
  74370. export class BoundingBoxRenderer implements ISceneComponent {
  74371. /**
  74372. * The component name helpfull to identify the component in the list of scene components.
  74373. */
  74374. readonly name: string;
  74375. /**
  74376. * The scene the component belongs to.
  74377. */
  74378. scene: Scene;
  74379. /**
  74380. * Color of the bounding box lines placed in front of an object
  74381. */
  74382. frontColor: Color3;
  74383. /**
  74384. * Color of the bounding box lines placed behind an object
  74385. */
  74386. backColor: Color3;
  74387. /**
  74388. * Defines if the renderer should show the back lines or not
  74389. */
  74390. showBackLines: boolean;
  74391. /**
  74392. * Observable raised before rendering a bounding box
  74393. */
  74394. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  74395. /**
  74396. * Observable raised after rendering a bounding box
  74397. */
  74398. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  74399. /**
  74400. * @hidden
  74401. */
  74402. renderList: SmartArray<BoundingBox>;
  74403. private _colorShader;
  74404. private _vertexBuffers;
  74405. private _indexBuffer;
  74406. private _fillIndexBuffer;
  74407. private _fillIndexData;
  74408. /**
  74409. * Instantiates a new bounding box renderer in a scene.
  74410. * @param scene the scene the renderer renders in
  74411. */
  74412. constructor(scene: Scene);
  74413. /**
  74414. * Registers the component in a given scene
  74415. */
  74416. register(): void;
  74417. private _evaluateSubMesh;
  74418. private _activeMesh;
  74419. private _prepareRessources;
  74420. private _createIndexBuffer;
  74421. /**
  74422. * Rebuilds the elements related to this component in case of
  74423. * context lost for instance.
  74424. */
  74425. rebuild(): void;
  74426. /**
  74427. * @hidden
  74428. */
  74429. reset(): void;
  74430. /**
  74431. * Render the bounding boxes of a specific rendering group
  74432. * @param renderingGroupId defines the rendering group to render
  74433. */
  74434. render(renderingGroupId: number): void;
  74435. /**
  74436. * In case of occlusion queries, we can render the occlusion bounding box through this method
  74437. * @param mesh Define the mesh to render the occlusion bounding box for
  74438. */
  74439. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  74440. /**
  74441. * Dispose and release the resources attached to this renderer.
  74442. */
  74443. dispose(): void;
  74444. }
  74445. }
  74446. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  74447. import { Nullable } from "babylonjs/types";
  74448. import { Scene } from "babylonjs/scene";
  74449. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  74450. import { Camera } from "babylonjs/Cameras/camera";
  74451. import { ISceneComponent } from "babylonjs/sceneComponent";
  74452. module "babylonjs/scene" {
  74453. interface Scene {
  74454. /** @hidden (Backing field) */
  74455. _depthRenderer: {
  74456. [id: string]: DepthRenderer;
  74457. };
  74458. /**
  74459. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  74460. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  74461. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  74462. * @returns the created depth renderer
  74463. */
  74464. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  74465. /**
  74466. * Disables a depth renderer for a given camera
  74467. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  74468. */
  74469. disableDepthRenderer(camera?: Nullable<Camera>): void;
  74470. }
  74471. }
  74472. /**
  74473. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  74474. * in several rendering techniques.
  74475. */
  74476. export class DepthRendererSceneComponent implements ISceneComponent {
  74477. /**
  74478. * The component name helpfull to identify the component in the list of scene components.
  74479. */
  74480. readonly name: string;
  74481. /**
  74482. * The scene the component belongs to.
  74483. */
  74484. scene: Scene;
  74485. /**
  74486. * Creates a new instance of the component for the given scene
  74487. * @param scene Defines the scene to register the component in
  74488. */
  74489. constructor(scene: Scene);
  74490. /**
  74491. * Registers the component in a given scene
  74492. */
  74493. register(): void;
  74494. /**
  74495. * Rebuilds the elements related to this component in case of
  74496. * context lost for instance.
  74497. */
  74498. rebuild(): void;
  74499. /**
  74500. * Disposes the component and the associated ressources
  74501. */
  74502. dispose(): void;
  74503. private _gatherRenderTargets;
  74504. private _gatherActiveCameraRenderTargets;
  74505. }
  74506. }
  74507. declare module "babylonjs/Shaders/outline.fragment" {
  74508. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  74509. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  74510. /** @hidden */
  74511. export var outlinePixelShader: {
  74512. name: string;
  74513. shader: string;
  74514. };
  74515. }
  74516. declare module "babylonjs/Shaders/outline.vertex" {
  74517. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  74518. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  74519. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  74520. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  74521. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  74522. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  74523. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  74524. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  74525. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  74526. /** @hidden */
  74527. export var outlineVertexShader: {
  74528. name: string;
  74529. shader: string;
  74530. };
  74531. }
  74532. declare module "babylonjs/Rendering/outlineRenderer" {
  74533. import { SubMesh } from "babylonjs/Meshes/subMesh";
  74534. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  74535. import { Scene } from "babylonjs/scene";
  74536. import { ISceneComponent } from "babylonjs/sceneComponent";
  74537. import "babylonjs/Shaders/outline.fragment";
  74538. import "babylonjs/Shaders/outline.vertex";
  74539. module "babylonjs/scene" {
  74540. interface Scene {
  74541. /** @hidden */
  74542. _outlineRenderer: OutlineRenderer;
  74543. /**
  74544. * Gets the outline renderer associated with the scene
  74545. * @returns a OutlineRenderer
  74546. */
  74547. getOutlineRenderer(): OutlineRenderer;
  74548. }
  74549. }
  74550. module "babylonjs/Meshes/abstractMesh" {
  74551. interface AbstractMesh {
  74552. /** @hidden (Backing field) */
  74553. _renderOutline: boolean;
  74554. /**
  74555. * Gets or sets a boolean indicating if the outline must be rendered as well
  74556. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  74557. */
  74558. renderOutline: boolean;
  74559. /** @hidden (Backing field) */
  74560. _renderOverlay: boolean;
  74561. /**
  74562. * Gets or sets a boolean indicating if the overlay must be rendered as well
  74563. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  74564. */
  74565. renderOverlay: boolean;
  74566. }
  74567. }
  74568. /**
  74569. * This class is responsible to draw bothe outline/overlay of meshes.
  74570. * It should not be used directly but through the available method on mesh.
  74571. */
  74572. export class OutlineRenderer implements ISceneComponent {
  74573. /**
  74574. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  74575. */
  74576. private static _StencilReference;
  74577. /**
  74578. * The name of the component. Each component must have a unique name.
  74579. */
  74580. name: string;
  74581. /**
  74582. * The scene the component belongs to.
  74583. */
  74584. scene: Scene;
  74585. /**
  74586. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  74587. */
  74588. zOffset: number;
  74589. private _engine;
  74590. private _effect;
  74591. private _cachedDefines;
  74592. private _savedDepthWrite;
  74593. /**
  74594. * Instantiates a new outline renderer. (There could be only one per scene).
  74595. * @param scene Defines the scene it belongs to
  74596. */
  74597. constructor(scene: Scene);
  74598. /**
  74599. * Register the component to one instance of a scene.
  74600. */
  74601. register(): void;
  74602. /**
  74603. * Rebuilds the elements related to this component in case of
  74604. * context lost for instance.
  74605. */
  74606. rebuild(): void;
  74607. /**
  74608. * Disposes the component and the associated ressources.
  74609. */
  74610. dispose(): void;
  74611. /**
  74612. * Renders the outline in the canvas.
  74613. * @param subMesh Defines the sumesh to render
  74614. * @param batch Defines the batch of meshes in case of instances
  74615. * @param useOverlay Defines if the rendering is for the overlay or the outline
  74616. */
  74617. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  74618. /**
  74619. * Returns whether or not the outline renderer is ready for a given submesh.
  74620. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  74621. * @param subMesh Defines the submesh to check readyness for
  74622. * @param useInstances Defines wheter wee are trying to render instances or not
  74623. * @returns true if ready otherwise false
  74624. */
  74625. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  74626. private _beforeRenderingMesh;
  74627. private _afterRenderingMesh;
  74628. }
  74629. }
  74630. declare module "babylonjs/Rendering/index" {
  74631. export * from "babylonjs/Rendering/boundingBoxRenderer";
  74632. export * from "babylonjs/Rendering/depthRenderer";
  74633. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  74634. export * from "babylonjs/Rendering/edgesRenderer";
  74635. export * from "babylonjs/Rendering/geometryBufferRenderer";
  74636. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  74637. export * from "babylonjs/Rendering/outlineRenderer";
  74638. export * from "babylonjs/Rendering/renderingGroup";
  74639. export * from "babylonjs/Rendering/renderingManager";
  74640. export * from "babylonjs/Rendering/utilityLayerRenderer";
  74641. }
  74642. declare module "babylonjs/Sprites/ISprites" {
  74643. /**
  74644. * Defines the basic options interface of a Sprite Frame Source Size.
  74645. */
  74646. export interface ISpriteJSONSpriteSourceSize {
  74647. /**
  74648. * number of the original width of the Frame
  74649. */
  74650. w: number;
  74651. /**
  74652. * number of the original height of the Frame
  74653. */
  74654. h: number;
  74655. }
  74656. /**
  74657. * Defines the basic options interface of a Sprite Frame Data.
  74658. */
  74659. export interface ISpriteJSONSpriteFrameData {
  74660. /**
  74661. * number of the x offset of the Frame
  74662. */
  74663. x: number;
  74664. /**
  74665. * number of the y offset of the Frame
  74666. */
  74667. y: number;
  74668. /**
  74669. * number of the width of the Frame
  74670. */
  74671. w: number;
  74672. /**
  74673. * number of the height of the Frame
  74674. */
  74675. h: number;
  74676. }
  74677. /**
  74678. * Defines the basic options interface of a JSON Sprite.
  74679. */
  74680. export interface ISpriteJSONSprite {
  74681. /**
  74682. * string name of the Frame
  74683. */
  74684. filename: string;
  74685. /**
  74686. * ISpriteJSONSpriteFrame basic object of the frame data
  74687. */
  74688. frame: ISpriteJSONSpriteFrameData;
  74689. /**
  74690. * boolean to flag is the frame was rotated.
  74691. */
  74692. rotated: boolean;
  74693. /**
  74694. * boolean to flag is the frame was trimmed.
  74695. */
  74696. trimmed: boolean;
  74697. /**
  74698. * ISpriteJSONSpriteFrame basic object of the source data
  74699. */
  74700. spriteSourceSize: ISpriteJSONSpriteFrameData;
  74701. /**
  74702. * ISpriteJSONSpriteFrame basic object of the source data
  74703. */
  74704. sourceSize: ISpriteJSONSpriteSourceSize;
  74705. }
  74706. /**
  74707. * Defines the basic options interface of a JSON atlas.
  74708. */
  74709. export interface ISpriteJSONAtlas {
  74710. /**
  74711. * Array of objects that contain the frame data.
  74712. */
  74713. frames: Array<ISpriteJSONSprite>;
  74714. /**
  74715. * object basic object containing the sprite meta data.
  74716. */
  74717. meta?: object;
  74718. }
  74719. }
  74720. declare module "babylonjs/Shaders/spriteMap.fragment" {
  74721. /** @hidden */
  74722. export var spriteMapPixelShader: {
  74723. name: string;
  74724. shader: string;
  74725. };
  74726. }
  74727. declare module "babylonjs/Shaders/spriteMap.vertex" {
  74728. /** @hidden */
  74729. export var spriteMapVertexShader: {
  74730. name: string;
  74731. shader: string;
  74732. };
  74733. }
  74734. declare module "babylonjs/Sprites/spriteMap" {
  74735. import { IDisposable, Scene } from "babylonjs/scene";
  74736. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  74737. import { Texture } from "babylonjs/Materials/Textures/texture";
  74738. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  74739. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  74740. import "babylonjs/Meshes/Builders/planeBuilder";
  74741. import "babylonjs/Shaders/spriteMap.fragment";
  74742. import "babylonjs/Shaders/spriteMap.vertex";
  74743. /**
  74744. * Defines the basic options interface of a SpriteMap
  74745. */
  74746. export interface ISpriteMapOptions {
  74747. /**
  74748. * Vector2 of the number of cells in the grid.
  74749. */
  74750. stageSize?: Vector2;
  74751. /**
  74752. * Vector2 of the size of the output plane in World Units.
  74753. */
  74754. outputSize?: Vector2;
  74755. /**
  74756. * Vector3 of the position of the output plane in World Units.
  74757. */
  74758. outputPosition?: Vector3;
  74759. /**
  74760. * Vector3 of the rotation of the output plane.
  74761. */
  74762. outputRotation?: Vector3;
  74763. /**
  74764. * number of layers that the system will reserve in resources.
  74765. */
  74766. layerCount?: number;
  74767. /**
  74768. * number of max animation frames a single cell will reserve in resources.
  74769. */
  74770. maxAnimationFrames?: number;
  74771. /**
  74772. * number cell index of the base tile when the system compiles.
  74773. */
  74774. baseTile?: number;
  74775. /**
  74776. * boolean flip the sprite after its been repositioned by the framing data.
  74777. */
  74778. flipU?: boolean;
  74779. /**
  74780. * Vector3 scalar of the global RGB values of the SpriteMap.
  74781. */
  74782. colorMultiply?: Vector3;
  74783. }
  74784. /**
  74785. * Defines the IDisposable interface in order to be cleanable from resources.
  74786. */
  74787. export interface ISpriteMap extends IDisposable {
  74788. /**
  74789. * String name of the SpriteMap.
  74790. */
  74791. name: string;
  74792. /**
  74793. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  74794. */
  74795. atlasJSON: ISpriteJSONAtlas;
  74796. /**
  74797. * Texture of the SpriteMap.
  74798. */
  74799. spriteSheet: Texture;
  74800. /**
  74801. * The parameters to initialize the SpriteMap with.
  74802. */
  74803. options: ISpriteMapOptions;
  74804. }
  74805. /**
  74806. * Class used to manage a grid restricted sprite deployment on an Output plane.
  74807. */
  74808. export class SpriteMap implements ISpriteMap {
  74809. /** The Name of the spriteMap */
  74810. name: string;
  74811. /** The JSON file with the frame and meta data */
  74812. atlasJSON: ISpriteJSONAtlas;
  74813. /** The systems Sprite Sheet Texture */
  74814. spriteSheet: Texture;
  74815. /** Arguments passed with the Constructor */
  74816. options: ISpriteMapOptions;
  74817. /** Public Sprite Storage array, parsed from atlasJSON */
  74818. sprites: Array<ISpriteJSONSprite>;
  74819. /** Returns the Number of Sprites in the System */
  74820. get spriteCount(): number;
  74821. /** Returns the Position of Output Plane*/
  74822. get position(): Vector3;
  74823. /** Returns the Position of Output Plane*/
  74824. set position(v: Vector3);
  74825. /** Returns the Rotation of Output Plane*/
  74826. get rotation(): Vector3;
  74827. /** Returns the Rotation of Output Plane*/
  74828. set rotation(v: Vector3);
  74829. /** Sets the AnimationMap*/
  74830. get animationMap(): RawTexture;
  74831. /** Sets the AnimationMap*/
  74832. set animationMap(v: RawTexture);
  74833. /** Scene that the SpriteMap was created in */
  74834. private _scene;
  74835. /** Texture Buffer of Float32 that holds tile frame data*/
  74836. private _frameMap;
  74837. /** Texture Buffers of Float32 that holds tileMap data*/
  74838. private _tileMaps;
  74839. /** Texture Buffer of Float32 that holds Animation Data*/
  74840. private _animationMap;
  74841. /** Custom ShaderMaterial Central to the System*/
  74842. private _material;
  74843. /** Custom ShaderMaterial Central to the System*/
  74844. private _output;
  74845. /** Systems Time Ticker*/
  74846. private _time;
  74847. /**
  74848. * Creates a new SpriteMap
  74849. * @param name defines the SpriteMaps Name
  74850. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  74851. * @param spriteSheet is the Texture that the Sprites are on.
  74852. * @param options a basic deployment configuration
  74853. * @param scene The Scene that the map is deployed on
  74854. */
  74855. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  74856. /**
  74857. * Returns tileID location
  74858. * @returns Vector2 the cell position ID
  74859. */
  74860. getTileID(): Vector2;
  74861. /**
  74862. * Gets the UV location of the mouse over the SpriteMap.
  74863. * @returns Vector2 the UV position of the mouse interaction
  74864. */
  74865. getMousePosition(): Vector2;
  74866. /**
  74867. * Creates the "frame" texture Buffer
  74868. * -------------------------------------
  74869. * Structure of frames
  74870. * "filename": "Falling-Water-2.png",
  74871. * "frame": {"x":69,"y":103,"w":24,"h":32},
  74872. * "rotated": true,
  74873. * "trimmed": true,
  74874. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  74875. * "sourceSize": {"w":32,"h":32}
  74876. * @returns RawTexture of the frameMap
  74877. */
  74878. private _createFrameBuffer;
  74879. /**
  74880. * Creates the tileMap texture Buffer
  74881. * @param buffer normally and array of numbers, or a false to generate from scratch
  74882. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  74883. * @returns RawTexture of the tileMap
  74884. */
  74885. private _createTileBuffer;
  74886. /**
  74887. * Modifies the data of the tileMaps
  74888. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  74889. * @param pos is the iVector2 Coordinates of the Tile
  74890. * @param tile The SpriteIndex of the new Tile
  74891. */
  74892. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  74893. /**
  74894. * Creates the animationMap texture Buffer
  74895. * @param buffer normally and array of numbers, or a false to generate from scratch
  74896. * @returns RawTexture of the animationMap
  74897. */
  74898. private _createTileAnimationBuffer;
  74899. /**
  74900. * Modifies the data of the animationMap
  74901. * @param cellID is the Index of the Sprite
  74902. * @param _frame is the target Animation frame
  74903. * @param toCell is the Target Index of the next frame of the animation
  74904. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  74905. * @param speed is a global scalar of the time variable on the map.
  74906. */
  74907. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  74908. /**
  74909. * Exports the .tilemaps file
  74910. */
  74911. saveTileMaps(): void;
  74912. /**
  74913. * Imports the .tilemaps file
  74914. * @param url of the .tilemaps file
  74915. */
  74916. loadTileMaps(url: string): void;
  74917. /**
  74918. * Release associated resources
  74919. */
  74920. dispose(): void;
  74921. }
  74922. }
  74923. declare module "babylonjs/Sprites/spritePackedManager" {
  74924. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  74925. import { Scene } from "babylonjs/scene";
  74926. /**
  74927. * Class used to manage multiple sprites of different sizes on the same spritesheet
  74928. * @see http://doc.babylonjs.com/babylon101/sprites
  74929. */
  74930. export class SpritePackedManager extends SpriteManager {
  74931. /** defines the packed manager's name */
  74932. name: string;
  74933. /**
  74934. * Creates a new sprite manager from a packed sprite sheet
  74935. * @param name defines the manager's name
  74936. * @param imgUrl defines the sprite sheet url
  74937. * @param capacity defines the maximum allowed number of sprites
  74938. * @param scene defines the hosting scene
  74939. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  74940. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  74941. * @param samplingMode defines the smapling mode to use with spritesheet
  74942. * @param fromPacked set to true; do not alter
  74943. */
  74944. constructor(
  74945. /** defines the packed manager's name */
  74946. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  74947. }
  74948. }
  74949. declare module "babylonjs/Sprites/index" {
  74950. export * from "babylonjs/Sprites/sprite";
  74951. export * from "babylonjs/Sprites/ISprites";
  74952. export * from "babylonjs/Sprites/spriteManager";
  74953. export * from "babylonjs/Sprites/spriteMap";
  74954. export * from "babylonjs/Sprites/spritePackedManager";
  74955. export * from "babylonjs/Sprites/spriteSceneComponent";
  74956. }
  74957. declare module "babylonjs/States/index" {
  74958. export * from "babylonjs/States/alphaCullingState";
  74959. export * from "babylonjs/States/depthCullingState";
  74960. export * from "babylonjs/States/stencilState";
  74961. }
  74962. declare module "babylonjs/Misc/assetsManager" {
  74963. import { Scene } from "babylonjs/scene";
  74964. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  74965. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  74966. import { Skeleton } from "babylonjs/Bones/skeleton";
  74967. import { Observable } from "babylonjs/Misc/observable";
  74968. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  74969. import { Texture } from "babylonjs/Materials/Textures/texture";
  74970. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  74971. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  74972. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  74973. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  74974. /**
  74975. * Defines the list of states available for a task inside a AssetsManager
  74976. */
  74977. export enum AssetTaskState {
  74978. /**
  74979. * Initialization
  74980. */
  74981. INIT = 0,
  74982. /**
  74983. * Running
  74984. */
  74985. RUNNING = 1,
  74986. /**
  74987. * Done
  74988. */
  74989. DONE = 2,
  74990. /**
  74991. * Error
  74992. */
  74993. ERROR = 3
  74994. }
  74995. /**
  74996. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  74997. */
  74998. export abstract class AbstractAssetTask {
  74999. /**
  75000. * Task name
  75001. */ name: string;
  75002. /**
  75003. * Callback called when the task is successful
  75004. */
  75005. onSuccess: (task: any) => void;
  75006. /**
  75007. * Callback called when the task is not successful
  75008. */
  75009. onError: (task: any, message?: string, exception?: any) => void;
  75010. /**
  75011. * Creates a new AssetsManager
  75012. * @param name defines the name of the task
  75013. */
  75014. constructor(
  75015. /**
  75016. * Task name
  75017. */ name: string);
  75018. private _isCompleted;
  75019. private _taskState;
  75020. private _errorObject;
  75021. /**
  75022. * Get if the task is completed
  75023. */
  75024. get isCompleted(): boolean;
  75025. /**
  75026. * Gets the current state of the task
  75027. */
  75028. get taskState(): AssetTaskState;
  75029. /**
  75030. * Gets the current error object (if task is in error)
  75031. */
  75032. get errorObject(): {
  75033. message?: string;
  75034. exception?: any;
  75035. };
  75036. /**
  75037. * Internal only
  75038. * @hidden
  75039. */
  75040. _setErrorObject(message?: string, exception?: any): void;
  75041. /**
  75042. * Execute the current task
  75043. * @param scene defines the scene where you want your assets to be loaded
  75044. * @param onSuccess is a callback called when the task is successfully executed
  75045. * @param onError is a callback called if an error occurs
  75046. */
  75047. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75048. /**
  75049. * Execute the current task
  75050. * @param scene defines the scene where you want your assets to be loaded
  75051. * @param onSuccess is a callback called when the task is successfully executed
  75052. * @param onError is a callback called if an error occurs
  75053. */
  75054. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75055. /**
  75056. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  75057. * This can be used with failed tasks that have the reason for failure fixed.
  75058. */
  75059. reset(): void;
  75060. private onErrorCallback;
  75061. private onDoneCallback;
  75062. }
  75063. /**
  75064. * Define the interface used by progress events raised during assets loading
  75065. */
  75066. export interface IAssetsProgressEvent {
  75067. /**
  75068. * Defines the number of remaining tasks to process
  75069. */
  75070. remainingCount: number;
  75071. /**
  75072. * Defines the total number of tasks
  75073. */
  75074. totalCount: number;
  75075. /**
  75076. * Defines the task that was just processed
  75077. */
  75078. task: AbstractAssetTask;
  75079. }
  75080. /**
  75081. * Class used to share progress information about assets loading
  75082. */
  75083. export class AssetsProgressEvent implements IAssetsProgressEvent {
  75084. /**
  75085. * Defines the number of remaining tasks to process
  75086. */
  75087. remainingCount: number;
  75088. /**
  75089. * Defines the total number of tasks
  75090. */
  75091. totalCount: number;
  75092. /**
  75093. * Defines the task that was just processed
  75094. */
  75095. task: AbstractAssetTask;
  75096. /**
  75097. * Creates a AssetsProgressEvent
  75098. * @param remainingCount defines the number of remaining tasks to process
  75099. * @param totalCount defines the total number of tasks
  75100. * @param task defines the task that was just processed
  75101. */
  75102. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  75103. }
  75104. /**
  75105. * Define a task used by AssetsManager to load meshes
  75106. */
  75107. export class MeshAssetTask extends AbstractAssetTask {
  75108. /**
  75109. * Defines the name of the task
  75110. */
  75111. name: string;
  75112. /**
  75113. * Defines the list of mesh's names you want to load
  75114. */
  75115. meshesNames: any;
  75116. /**
  75117. * Defines the root url to use as a base to load your meshes and associated resources
  75118. */
  75119. rootUrl: string;
  75120. /**
  75121. * Defines the filename or File of the scene to load from
  75122. */
  75123. sceneFilename: string | File;
  75124. /**
  75125. * Gets the list of loaded meshes
  75126. */
  75127. loadedMeshes: Array<AbstractMesh>;
  75128. /**
  75129. * Gets the list of loaded particle systems
  75130. */
  75131. loadedParticleSystems: Array<IParticleSystem>;
  75132. /**
  75133. * Gets the list of loaded skeletons
  75134. */
  75135. loadedSkeletons: Array<Skeleton>;
  75136. /**
  75137. * Gets the list of loaded animation groups
  75138. */
  75139. loadedAnimationGroups: Array<AnimationGroup>;
  75140. /**
  75141. * Callback called when the task is successful
  75142. */
  75143. onSuccess: (task: MeshAssetTask) => void;
  75144. /**
  75145. * Callback called when the task is successful
  75146. */
  75147. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  75148. /**
  75149. * Creates a new MeshAssetTask
  75150. * @param name defines the name of the task
  75151. * @param meshesNames defines the list of mesh's names you want to load
  75152. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  75153. * @param sceneFilename defines the filename or File of the scene to load from
  75154. */
  75155. constructor(
  75156. /**
  75157. * Defines the name of the task
  75158. */
  75159. name: string,
  75160. /**
  75161. * Defines the list of mesh's names you want to load
  75162. */
  75163. meshesNames: any,
  75164. /**
  75165. * Defines the root url to use as a base to load your meshes and associated resources
  75166. */
  75167. rootUrl: string,
  75168. /**
  75169. * Defines the filename or File of the scene to load from
  75170. */
  75171. sceneFilename: string | File);
  75172. /**
  75173. * Execute the current task
  75174. * @param scene defines the scene where you want your assets to be loaded
  75175. * @param onSuccess is a callback called when the task is successfully executed
  75176. * @param onError is a callback called if an error occurs
  75177. */
  75178. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75179. }
  75180. /**
  75181. * Define a task used by AssetsManager to load text content
  75182. */
  75183. export class TextFileAssetTask extends AbstractAssetTask {
  75184. /**
  75185. * Defines the name of the task
  75186. */
  75187. name: string;
  75188. /**
  75189. * Defines the location of the file to load
  75190. */
  75191. url: string;
  75192. /**
  75193. * Gets the loaded text string
  75194. */
  75195. text: string;
  75196. /**
  75197. * Callback called when the task is successful
  75198. */
  75199. onSuccess: (task: TextFileAssetTask) => void;
  75200. /**
  75201. * Callback called when the task is successful
  75202. */
  75203. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  75204. /**
  75205. * Creates a new TextFileAssetTask object
  75206. * @param name defines the name of the task
  75207. * @param url defines the location of the file to load
  75208. */
  75209. constructor(
  75210. /**
  75211. * Defines the name of the task
  75212. */
  75213. name: string,
  75214. /**
  75215. * Defines the location of the file to load
  75216. */
  75217. url: string);
  75218. /**
  75219. * Execute the current task
  75220. * @param scene defines the scene where you want your assets to be loaded
  75221. * @param onSuccess is a callback called when the task is successfully executed
  75222. * @param onError is a callback called if an error occurs
  75223. */
  75224. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75225. }
  75226. /**
  75227. * Define a task used by AssetsManager to load binary data
  75228. */
  75229. export class BinaryFileAssetTask extends AbstractAssetTask {
  75230. /**
  75231. * Defines the name of the task
  75232. */
  75233. name: string;
  75234. /**
  75235. * Defines the location of the file to load
  75236. */
  75237. url: string;
  75238. /**
  75239. * Gets the lodaded data (as an array buffer)
  75240. */
  75241. data: ArrayBuffer;
  75242. /**
  75243. * Callback called when the task is successful
  75244. */
  75245. onSuccess: (task: BinaryFileAssetTask) => void;
  75246. /**
  75247. * Callback called when the task is successful
  75248. */
  75249. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  75250. /**
  75251. * Creates a new BinaryFileAssetTask object
  75252. * @param name defines the name of the new task
  75253. * @param url defines the location of the file to load
  75254. */
  75255. constructor(
  75256. /**
  75257. * Defines the name of the task
  75258. */
  75259. name: string,
  75260. /**
  75261. * Defines the location of the file to load
  75262. */
  75263. url: string);
  75264. /**
  75265. * Execute the current task
  75266. * @param scene defines the scene where you want your assets to be loaded
  75267. * @param onSuccess is a callback called when the task is successfully executed
  75268. * @param onError is a callback called if an error occurs
  75269. */
  75270. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75271. }
  75272. /**
  75273. * Define a task used by AssetsManager to load images
  75274. */
  75275. export class ImageAssetTask extends AbstractAssetTask {
  75276. /**
  75277. * Defines the name of the task
  75278. */
  75279. name: string;
  75280. /**
  75281. * Defines the location of the image to load
  75282. */
  75283. url: string;
  75284. /**
  75285. * Gets the loaded images
  75286. */
  75287. image: HTMLImageElement;
  75288. /**
  75289. * Callback called when the task is successful
  75290. */
  75291. onSuccess: (task: ImageAssetTask) => void;
  75292. /**
  75293. * Callback called when the task is successful
  75294. */
  75295. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  75296. /**
  75297. * Creates a new ImageAssetTask
  75298. * @param name defines the name of the task
  75299. * @param url defines the location of the image to load
  75300. */
  75301. constructor(
  75302. /**
  75303. * Defines the name of the task
  75304. */
  75305. name: string,
  75306. /**
  75307. * Defines the location of the image to load
  75308. */
  75309. url: string);
  75310. /**
  75311. * Execute the current task
  75312. * @param scene defines the scene where you want your assets to be loaded
  75313. * @param onSuccess is a callback called when the task is successfully executed
  75314. * @param onError is a callback called if an error occurs
  75315. */
  75316. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75317. }
  75318. /**
  75319. * Defines the interface used by texture loading tasks
  75320. */
  75321. export interface ITextureAssetTask<TEX extends BaseTexture> {
  75322. /**
  75323. * Gets the loaded texture
  75324. */
  75325. texture: TEX;
  75326. }
  75327. /**
  75328. * Define a task used by AssetsManager to load 2D textures
  75329. */
  75330. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  75331. /**
  75332. * Defines the name of the task
  75333. */
  75334. name: string;
  75335. /**
  75336. * Defines the location of the file to load
  75337. */
  75338. url: string;
  75339. /**
  75340. * Defines if mipmap should not be generated (default is false)
  75341. */
  75342. noMipmap?: boolean | undefined;
  75343. /**
  75344. * Defines if texture must be inverted on Y axis (default is true)
  75345. */
  75346. invertY: boolean;
  75347. /**
  75348. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  75349. */
  75350. samplingMode: number;
  75351. /**
  75352. * Gets the loaded texture
  75353. */
  75354. texture: Texture;
  75355. /**
  75356. * Callback called when the task is successful
  75357. */
  75358. onSuccess: (task: TextureAssetTask) => void;
  75359. /**
  75360. * Callback called when the task is successful
  75361. */
  75362. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  75363. /**
  75364. * Creates a new TextureAssetTask object
  75365. * @param name defines the name of the task
  75366. * @param url defines the location of the file to load
  75367. * @param noMipmap defines if mipmap should not be generated (default is false)
  75368. * @param invertY defines if texture must be inverted on Y axis (default is true)
  75369. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  75370. */
  75371. constructor(
  75372. /**
  75373. * Defines the name of the task
  75374. */
  75375. name: string,
  75376. /**
  75377. * Defines the location of the file to load
  75378. */
  75379. url: string,
  75380. /**
  75381. * Defines if mipmap should not be generated (default is false)
  75382. */
  75383. noMipmap?: boolean | undefined,
  75384. /**
  75385. * Defines if texture must be inverted on Y axis (default is true)
  75386. */
  75387. invertY?: boolean,
  75388. /**
  75389. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  75390. */
  75391. samplingMode?: number);
  75392. /**
  75393. * Execute the current task
  75394. * @param scene defines the scene where you want your assets to be loaded
  75395. * @param onSuccess is a callback called when the task is successfully executed
  75396. * @param onError is a callback called if an error occurs
  75397. */
  75398. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75399. }
  75400. /**
  75401. * Define a task used by AssetsManager to load cube textures
  75402. */
  75403. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  75404. /**
  75405. * Defines the name of the task
  75406. */
  75407. name: string;
  75408. /**
  75409. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  75410. */
  75411. url: string;
  75412. /**
  75413. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  75414. */
  75415. extensions?: string[] | undefined;
  75416. /**
  75417. * Defines if mipmaps should not be generated (default is false)
  75418. */
  75419. noMipmap?: boolean | undefined;
  75420. /**
  75421. * Defines the explicit list of files (undefined by default)
  75422. */
  75423. files?: string[] | undefined;
  75424. /**
  75425. * Gets the loaded texture
  75426. */
  75427. texture: CubeTexture;
  75428. /**
  75429. * Callback called when the task is successful
  75430. */
  75431. onSuccess: (task: CubeTextureAssetTask) => void;
  75432. /**
  75433. * Callback called when the task is successful
  75434. */
  75435. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  75436. /**
  75437. * Creates a new CubeTextureAssetTask
  75438. * @param name defines the name of the task
  75439. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  75440. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  75441. * @param noMipmap defines if mipmaps should not be generated (default is false)
  75442. * @param files defines the explicit list of files (undefined by default)
  75443. */
  75444. constructor(
  75445. /**
  75446. * Defines the name of the task
  75447. */
  75448. name: string,
  75449. /**
  75450. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  75451. */
  75452. url: string,
  75453. /**
  75454. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  75455. */
  75456. extensions?: string[] | undefined,
  75457. /**
  75458. * Defines if mipmaps should not be generated (default is false)
  75459. */
  75460. noMipmap?: boolean | undefined,
  75461. /**
  75462. * Defines the explicit list of files (undefined by default)
  75463. */
  75464. files?: string[] | undefined);
  75465. /**
  75466. * Execute the current task
  75467. * @param scene defines the scene where you want your assets to be loaded
  75468. * @param onSuccess is a callback called when the task is successfully executed
  75469. * @param onError is a callback called if an error occurs
  75470. */
  75471. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75472. }
  75473. /**
  75474. * Define a task used by AssetsManager to load HDR cube textures
  75475. */
  75476. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  75477. /**
  75478. * Defines the name of the task
  75479. */
  75480. name: string;
  75481. /**
  75482. * Defines the location of the file to load
  75483. */
  75484. url: string;
  75485. /**
  75486. * Defines the desired size (the more it increases the longer the generation will be)
  75487. */
  75488. size: number;
  75489. /**
  75490. * Defines if mipmaps should not be generated (default is false)
  75491. */
  75492. noMipmap: boolean;
  75493. /**
  75494. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  75495. */
  75496. generateHarmonics: boolean;
  75497. /**
  75498. * 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)
  75499. */
  75500. gammaSpace: boolean;
  75501. /**
  75502. * Internal Use Only
  75503. */
  75504. reserved: boolean;
  75505. /**
  75506. * Gets the loaded texture
  75507. */
  75508. texture: HDRCubeTexture;
  75509. /**
  75510. * Callback called when the task is successful
  75511. */
  75512. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  75513. /**
  75514. * Callback called when the task is successful
  75515. */
  75516. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  75517. /**
  75518. * Creates a new HDRCubeTextureAssetTask object
  75519. * @param name defines the name of the task
  75520. * @param url defines the location of the file to load
  75521. * @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.
  75522. * @param noMipmap defines if mipmaps should not be generated (default is false)
  75523. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  75524. * @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)
  75525. * @param reserved Internal use only
  75526. */
  75527. constructor(
  75528. /**
  75529. * Defines the name of the task
  75530. */
  75531. name: string,
  75532. /**
  75533. * Defines the location of the file to load
  75534. */
  75535. url: string,
  75536. /**
  75537. * Defines the desired size (the more it increases the longer the generation will be)
  75538. */
  75539. size: number,
  75540. /**
  75541. * Defines if mipmaps should not be generated (default is false)
  75542. */
  75543. noMipmap?: boolean,
  75544. /**
  75545. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  75546. */
  75547. generateHarmonics?: boolean,
  75548. /**
  75549. * 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)
  75550. */
  75551. gammaSpace?: boolean,
  75552. /**
  75553. * Internal Use Only
  75554. */
  75555. reserved?: boolean);
  75556. /**
  75557. * Execute the current task
  75558. * @param scene defines the scene where you want your assets to be loaded
  75559. * @param onSuccess is a callback called when the task is successfully executed
  75560. * @param onError is a callback called if an error occurs
  75561. */
  75562. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75563. }
  75564. /**
  75565. * Define a task used by AssetsManager to load Equirectangular cube textures
  75566. */
  75567. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  75568. /**
  75569. * Defines the name of the task
  75570. */
  75571. name: string;
  75572. /**
  75573. * Defines the location of the file to load
  75574. */
  75575. url: string;
  75576. /**
  75577. * Defines the desired size (the more it increases the longer the generation will be)
  75578. */
  75579. size: number;
  75580. /**
  75581. * Defines if mipmaps should not be generated (default is false)
  75582. */
  75583. noMipmap: boolean;
  75584. /**
  75585. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  75586. * but the standard material would require them in Gamma space) (default is true)
  75587. */
  75588. gammaSpace: boolean;
  75589. /**
  75590. * Gets the loaded texture
  75591. */
  75592. texture: EquiRectangularCubeTexture;
  75593. /**
  75594. * Callback called when the task is successful
  75595. */
  75596. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  75597. /**
  75598. * Callback called when the task is successful
  75599. */
  75600. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  75601. /**
  75602. * Creates a new EquiRectangularCubeTextureAssetTask object
  75603. * @param name defines the name of the task
  75604. * @param url defines the location of the file to load
  75605. * @param size defines the desired size (the more it increases the longer the generation will be)
  75606. * If the size is omitted this implies you are using a preprocessed cubemap.
  75607. * @param noMipmap defines if mipmaps should not be generated (default is false)
  75608. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  75609. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  75610. * (default is true)
  75611. */
  75612. constructor(
  75613. /**
  75614. * Defines the name of the task
  75615. */
  75616. name: string,
  75617. /**
  75618. * Defines the location of the file to load
  75619. */
  75620. url: string,
  75621. /**
  75622. * Defines the desired size (the more it increases the longer the generation will be)
  75623. */
  75624. size: number,
  75625. /**
  75626. * Defines if mipmaps should not be generated (default is false)
  75627. */
  75628. noMipmap?: boolean,
  75629. /**
  75630. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  75631. * but the standard material would require them in Gamma space) (default is true)
  75632. */
  75633. gammaSpace?: boolean);
  75634. /**
  75635. * Execute the current task
  75636. * @param scene defines the scene where you want your assets to be loaded
  75637. * @param onSuccess is a callback called when the task is successfully executed
  75638. * @param onError is a callback called if an error occurs
  75639. */
  75640. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75641. }
  75642. /**
  75643. * This class can be used to easily import assets into a scene
  75644. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  75645. */
  75646. export class AssetsManager {
  75647. private _scene;
  75648. private _isLoading;
  75649. protected _tasks: AbstractAssetTask[];
  75650. protected _waitingTasksCount: number;
  75651. protected _totalTasksCount: number;
  75652. /**
  75653. * Callback called when all tasks are processed
  75654. */
  75655. onFinish: (tasks: AbstractAssetTask[]) => void;
  75656. /**
  75657. * Callback called when a task is successful
  75658. */
  75659. onTaskSuccess: (task: AbstractAssetTask) => void;
  75660. /**
  75661. * Callback called when a task had an error
  75662. */
  75663. onTaskError: (task: AbstractAssetTask) => void;
  75664. /**
  75665. * Callback called when a task is done (whatever the result is)
  75666. */
  75667. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  75668. /**
  75669. * Observable called when all tasks are processed
  75670. */
  75671. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  75672. /**
  75673. * Observable called when a task had an error
  75674. */
  75675. onTaskErrorObservable: Observable<AbstractAssetTask>;
  75676. /**
  75677. * Observable called when all tasks were executed
  75678. */
  75679. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  75680. /**
  75681. * Observable called when a task is done (whatever the result is)
  75682. */
  75683. onProgressObservable: Observable<IAssetsProgressEvent>;
  75684. /**
  75685. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  75686. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  75687. */
  75688. useDefaultLoadingScreen: boolean;
  75689. /**
  75690. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  75691. * when all assets have been downloaded.
  75692. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  75693. */
  75694. autoHideLoadingUI: boolean;
  75695. /**
  75696. * Creates a new AssetsManager
  75697. * @param scene defines the scene to work on
  75698. */
  75699. constructor(scene: Scene);
  75700. /**
  75701. * Add a MeshAssetTask to the list of active tasks
  75702. * @param taskName defines the name of the new task
  75703. * @param meshesNames defines the name of meshes to load
  75704. * @param rootUrl defines the root url to use to locate files
  75705. * @param sceneFilename defines the filename of the scene file
  75706. * @returns a new MeshAssetTask object
  75707. */
  75708. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  75709. /**
  75710. * Add a TextFileAssetTask to the list of active tasks
  75711. * @param taskName defines the name of the new task
  75712. * @param url defines the url of the file to load
  75713. * @returns a new TextFileAssetTask object
  75714. */
  75715. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  75716. /**
  75717. * Add a BinaryFileAssetTask to the list of active tasks
  75718. * @param taskName defines the name of the new task
  75719. * @param url defines the url of the file to load
  75720. * @returns a new BinaryFileAssetTask object
  75721. */
  75722. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  75723. /**
  75724. * Add a ImageAssetTask to the list of active tasks
  75725. * @param taskName defines the name of the new task
  75726. * @param url defines the url of the file to load
  75727. * @returns a new ImageAssetTask object
  75728. */
  75729. addImageTask(taskName: string, url: string): ImageAssetTask;
  75730. /**
  75731. * Add a TextureAssetTask to the list of active tasks
  75732. * @param taskName defines the name of the new task
  75733. * @param url defines the url of the file to load
  75734. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  75735. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  75736. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  75737. * @returns a new TextureAssetTask object
  75738. */
  75739. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  75740. /**
  75741. * Add a CubeTextureAssetTask to the list of active tasks
  75742. * @param taskName defines the name of the new task
  75743. * @param url defines the url of the file to load
  75744. * @param extensions defines the extension to use to load the cube map (can be null)
  75745. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  75746. * @param files defines the list of files to load (can be null)
  75747. * @returns a new CubeTextureAssetTask object
  75748. */
  75749. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  75750. /**
  75751. *
  75752. * Add a HDRCubeTextureAssetTask to the list of active tasks
  75753. * @param taskName defines the name of the new task
  75754. * @param url defines the url of the file to load
  75755. * @param size defines the size you want for the cubemap (can be null)
  75756. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  75757. * @param generateHarmonics defines if you want to automatically generate (true by default)
  75758. * @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)
  75759. * @param reserved Internal use only
  75760. * @returns a new HDRCubeTextureAssetTask object
  75761. */
  75762. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  75763. /**
  75764. *
  75765. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  75766. * @param taskName defines the name of the new task
  75767. * @param url defines the url of the file to load
  75768. * @param size defines the size you want for the cubemap (can be null)
  75769. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  75770. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  75771. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  75772. * @returns a new EquiRectangularCubeTextureAssetTask object
  75773. */
  75774. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  75775. /**
  75776. * Remove a task from the assets manager.
  75777. * @param task the task to remove
  75778. */
  75779. removeTask(task: AbstractAssetTask): void;
  75780. private _decreaseWaitingTasksCount;
  75781. private _runTask;
  75782. /**
  75783. * Reset the AssetsManager and remove all tasks
  75784. * @return the current instance of the AssetsManager
  75785. */
  75786. reset(): AssetsManager;
  75787. /**
  75788. * Start the loading process
  75789. * @return the current instance of the AssetsManager
  75790. */
  75791. load(): AssetsManager;
  75792. /**
  75793. * Start the loading process as an async operation
  75794. * @return a promise returning the list of failed tasks
  75795. */
  75796. loadAsync(): Promise<void>;
  75797. }
  75798. }
  75799. declare module "babylonjs/Misc/deferred" {
  75800. /**
  75801. * Wrapper class for promise with external resolve and reject.
  75802. */
  75803. export class Deferred<T> {
  75804. /**
  75805. * The promise associated with this deferred object.
  75806. */
  75807. readonly promise: Promise<T>;
  75808. private _resolve;
  75809. private _reject;
  75810. /**
  75811. * The resolve method of the promise associated with this deferred object.
  75812. */
  75813. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  75814. /**
  75815. * The reject method of the promise associated with this deferred object.
  75816. */
  75817. get reject(): (reason?: any) => void;
  75818. /**
  75819. * Constructor for this deferred object.
  75820. */
  75821. constructor();
  75822. }
  75823. }
  75824. declare module "babylonjs/Misc/meshExploder" {
  75825. import { Mesh } from "babylonjs/Meshes/mesh";
  75826. /**
  75827. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  75828. */
  75829. export class MeshExploder {
  75830. private _centerMesh;
  75831. private _meshes;
  75832. private _meshesOrigins;
  75833. private _toCenterVectors;
  75834. private _scaledDirection;
  75835. private _newPosition;
  75836. private _centerPosition;
  75837. /**
  75838. * Explodes meshes from a center mesh.
  75839. * @param meshes The meshes to explode.
  75840. * @param centerMesh The mesh to be center of explosion.
  75841. */
  75842. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  75843. private _setCenterMesh;
  75844. /**
  75845. * Get class name
  75846. * @returns "MeshExploder"
  75847. */
  75848. getClassName(): string;
  75849. /**
  75850. * "Exploded meshes"
  75851. * @returns Array of meshes with the centerMesh at index 0.
  75852. */
  75853. getMeshes(): Array<Mesh>;
  75854. /**
  75855. * Explodes meshes giving a specific direction
  75856. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  75857. */
  75858. explode(direction?: number): void;
  75859. }
  75860. }
  75861. declare module "babylonjs/Misc/filesInput" {
  75862. import { Engine } from "babylonjs/Engines/engine";
  75863. import { Scene } from "babylonjs/scene";
  75864. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  75865. /**
  75866. * Class used to help managing file picking and drag'n'drop
  75867. */
  75868. export class FilesInput {
  75869. /**
  75870. * List of files ready to be loaded
  75871. */
  75872. static get FilesToLoad(): {
  75873. [key: string]: File;
  75874. };
  75875. /**
  75876. * Callback called when a file is processed
  75877. */
  75878. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  75879. private _engine;
  75880. private _currentScene;
  75881. private _sceneLoadedCallback;
  75882. private _progressCallback;
  75883. private _additionalRenderLoopLogicCallback;
  75884. private _textureLoadingCallback;
  75885. private _startingProcessingFilesCallback;
  75886. private _onReloadCallback;
  75887. private _errorCallback;
  75888. private _elementToMonitor;
  75889. private _sceneFileToLoad;
  75890. private _filesToLoad;
  75891. /**
  75892. * Creates a new FilesInput
  75893. * @param engine defines the rendering engine
  75894. * @param scene defines the hosting scene
  75895. * @param sceneLoadedCallback callback called when scene is loaded
  75896. * @param progressCallback callback called to track progress
  75897. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  75898. * @param textureLoadingCallback callback called when a texture is loading
  75899. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  75900. * @param onReloadCallback callback called when a reload is requested
  75901. * @param errorCallback callback call if an error occurs
  75902. */
  75903. constructor(engine: Engine, scene: Scene, sceneLoadedCallback: (sceneFile: File, scene: Scene) => void, progressCallback: (progress: ISceneLoaderProgressEvent) => void, additionalRenderLoopLogicCallback: () => void, textureLoadingCallback: (remaining: number) => void, startingProcessingFilesCallback: (files?: File[]) => void, onReloadCallback: (sceneFile: File) => void, errorCallback: (sceneFile: File, scene: Scene, message: string) => void);
  75904. private _dragEnterHandler;
  75905. private _dragOverHandler;
  75906. private _dropHandler;
  75907. /**
  75908. * Calls this function to listen to drag'n'drop events on a specific DOM element
  75909. * @param elementToMonitor defines the DOM element to track
  75910. */
  75911. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  75912. /**
  75913. * Release all associated resources
  75914. */
  75915. dispose(): void;
  75916. private renderFunction;
  75917. private drag;
  75918. private drop;
  75919. private _traverseFolder;
  75920. private _processFiles;
  75921. /**
  75922. * Load files from a drop event
  75923. * @param event defines the drop event to use as source
  75924. */
  75925. loadFiles(event: any): void;
  75926. private _processReload;
  75927. /**
  75928. * Reload the current scene from the loaded files
  75929. */
  75930. reload(): void;
  75931. }
  75932. }
  75933. declare module "babylonjs/Misc/HighDynamicRange/index" {
  75934. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  75935. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  75936. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  75937. }
  75938. declare module "babylonjs/Misc/sceneOptimizer" {
  75939. import { Scene, IDisposable } from "babylonjs/scene";
  75940. import { Observable } from "babylonjs/Misc/observable";
  75941. /**
  75942. * Defines the root class used to create scene optimization to use with SceneOptimizer
  75943. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75944. */
  75945. export class SceneOptimization {
  75946. /**
  75947. * Defines the priority of this optimization (0 by default which means first in the list)
  75948. */
  75949. priority: number;
  75950. /**
  75951. * Gets a string describing the action executed by the current optimization
  75952. * @returns description string
  75953. */
  75954. getDescription(): string;
  75955. /**
  75956. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  75957. * @param scene defines the current scene where to apply this optimization
  75958. * @param optimizer defines the current optimizer
  75959. * @returns true if everything that can be done was applied
  75960. */
  75961. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  75962. /**
  75963. * Creates the SceneOptimization object
  75964. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  75965. * @param desc defines the description associated with the optimization
  75966. */
  75967. constructor(
  75968. /**
  75969. * Defines the priority of this optimization (0 by default which means first in the list)
  75970. */
  75971. priority?: number);
  75972. }
  75973. /**
  75974. * Defines an optimization used to reduce the size of render target textures
  75975. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75976. */
  75977. export class TextureOptimization extends SceneOptimization {
  75978. /**
  75979. * Defines the priority of this optimization (0 by default which means first in the list)
  75980. */
  75981. priority: number;
  75982. /**
  75983. * 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
  75984. */
  75985. maximumSize: number;
  75986. /**
  75987. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  75988. */
  75989. step: number;
  75990. /**
  75991. * Gets a string describing the action executed by the current optimization
  75992. * @returns description string
  75993. */
  75994. getDescription(): string;
  75995. /**
  75996. * Creates the TextureOptimization object
  75997. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  75998. * @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
  75999. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  76000. */
  76001. constructor(
  76002. /**
  76003. * Defines the priority of this optimization (0 by default which means first in the list)
  76004. */
  76005. priority?: number,
  76006. /**
  76007. * 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
  76008. */
  76009. maximumSize?: number,
  76010. /**
  76011. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  76012. */
  76013. step?: number);
  76014. /**
  76015. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76016. * @param scene defines the current scene where to apply this optimization
  76017. * @param optimizer defines the current optimizer
  76018. * @returns true if everything that can be done was applied
  76019. */
  76020. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76021. }
  76022. /**
  76023. * Defines an optimization used to increase or decrease the rendering resolution
  76024. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76025. */
  76026. export class HardwareScalingOptimization extends SceneOptimization {
  76027. /**
  76028. * Defines the priority of this optimization (0 by default which means first in the list)
  76029. */
  76030. priority: number;
  76031. /**
  76032. * Defines the maximum scale to use (2 by default)
  76033. */
  76034. maximumScale: number;
  76035. /**
  76036. * Defines the step to use between two passes (0.5 by default)
  76037. */
  76038. step: number;
  76039. private _currentScale;
  76040. private _directionOffset;
  76041. /**
  76042. * Gets a string describing the action executed by the current optimization
  76043. * @return description string
  76044. */
  76045. getDescription(): string;
  76046. /**
  76047. * Creates the HardwareScalingOptimization object
  76048. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  76049. * @param maximumScale defines the maximum scale to use (2 by default)
  76050. * @param step defines the step to use between two passes (0.5 by default)
  76051. */
  76052. constructor(
  76053. /**
  76054. * Defines the priority of this optimization (0 by default which means first in the list)
  76055. */
  76056. priority?: number,
  76057. /**
  76058. * Defines the maximum scale to use (2 by default)
  76059. */
  76060. maximumScale?: number,
  76061. /**
  76062. * Defines the step to use between two passes (0.5 by default)
  76063. */
  76064. step?: number);
  76065. /**
  76066. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76067. * @param scene defines the current scene where to apply this optimization
  76068. * @param optimizer defines the current optimizer
  76069. * @returns true if everything that can be done was applied
  76070. */
  76071. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76072. }
  76073. /**
  76074. * Defines an optimization used to remove shadows
  76075. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76076. */
  76077. export class ShadowsOptimization extends SceneOptimization {
  76078. /**
  76079. * Gets a string describing the action executed by the current optimization
  76080. * @return description string
  76081. */
  76082. getDescription(): string;
  76083. /**
  76084. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76085. * @param scene defines the current scene where to apply this optimization
  76086. * @param optimizer defines the current optimizer
  76087. * @returns true if everything that can be done was applied
  76088. */
  76089. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76090. }
  76091. /**
  76092. * Defines an optimization used to turn post-processes off
  76093. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76094. */
  76095. export class PostProcessesOptimization extends SceneOptimization {
  76096. /**
  76097. * Gets a string describing the action executed by the current optimization
  76098. * @return description string
  76099. */
  76100. getDescription(): string;
  76101. /**
  76102. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76103. * @param scene defines the current scene where to apply this optimization
  76104. * @param optimizer defines the current optimizer
  76105. * @returns true if everything that can be done was applied
  76106. */
  76107. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76108. }
  76109. /**
  76110. * Defines an optimization used to turn lens flares off
  76111. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76112. */
  76113. export class LensFlaresOptimization extends SceneOptimization {
  76114. /**
  76115. * Gets a string describing the action executed by the current optimization
  76116. * @return description string
  76117. */
  76118. getDescription(): string;
  76119. /**
  76120. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76121. * @param scene defines the current scene where to apply this optimization
  76122. * @param optimizer defines the current optimizer
  76123. * @returns true if everything that can be done was applied
  76124. */
  76125. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76126. }
  76127. /**
  76128. * Defines an optimization based on user defined callback.
  76129. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76130. */
  76131. export class CustomOptimization extends SceneOptimization {
  76132. /**
  76133. * Callback called to apply the custom optimization.
  76134. */
  76135. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  76136. /**
  76137. * Callback called to get custom description
  76138. */
  76139. onGetDescription: () => string;
  76140. /**
  76141. * Gets a string describing the action executed by the current optimization
  76142. * @returns description string
  76143. */
  76144. getDescription(): string;
  76145. /**
  76146. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76147. * @param scene defines the current scene where to apply this optimization
  76148. * @param optimizer defines the current optimizer
  76149. * @returns true if everything that can be done was applied
  76150. */
  76151. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76152. }
  76153. /**
  76154. * Defines an optimization used to turn particles off
  76155. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76156. */
  76157. export class ParticlesOptimization extends SceneOptimization {
  76158. /**
  76159. * Gets a string describing the action executed by the current optimization
  76160. * @return description string
  76161. */
  76162. getDescription(): string;
  76163. /**
  76164. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76165. * @param scene defines the current scene where to apply this optimization
  76166. * @param optimizer defines the current optimizer
  76167. * @returns true if everything that can be done was applied
  76168. */
  76169. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76170. }
  76171. /**
  76172. * Defines an optimization used to turn render targets off
  76173. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76174. */
  76175. export class RenderTargetsOptimization extends SceneOptimization {
  76176. /**
  76177. * Gets a string describing the action executed by the current optimization
  76178. * @return description string
  76179. */
  76180. getDescription(): string;
  76181. /**
  76182. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76183. * @param scene defines the current scene where to apply this optimization
  76184. * @param optimizer defines the current optimizer
  76185. * @returns true if everything that can be done was applied
  76186. */
  76187. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76188. }
  76189. /**
  76190. * Defines an optimization used to merge meshes with compatible materials
  76191. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76192. */
  76193. export class MergeMeshesOptimization extends SceneOptimization {
  76194. private static _UpdateSelectionTree;
  76195. /**
  76196. * Gets or sets a boolean which defines if optimization octree has to be updated
  76197. */
  76198. static get UpdateSelectionTree(): boolean;
  76199. /**
  76200. * Gets or sets a boolean which defines if optimization octree has to be updated
  76201. */
  76202. static set UpdateSelectionTree(value: boolean);
  76203. /**
  76204. * Gets a string describing the action executed by the current optimization
  76205. * @return description string
  76206. */
  76207. getDescription(): string;
  76208. private _canBeMerged;
  76209. /**
  76210. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76211. * @param scene defines the current scene where to apply this optimization
  76212. * @param optimizer defines the current optimizer
  76213. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  76214. * @returns true if everything that can be done was applied
  76215. */
  76216. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  76217. }
  76218. /**
  76219. * Defines a list of options used by SceneOptimizer
  76220. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76221. */
  76222. export class SceneOptimizerOptions {
  76223. /**
  76224. * Defines the target frame rate to reach (60 by default)
  76225. */
  76226. targetFrameRate: number;
  76227. /**
  76228. * Defines the interval between two checkes (2000ms by default)
  76229. */
  76230. trackerDuration: number;
  76231. /**
  76232. * Gets the list of optimizations to apply
  76233. */
  76234. optimizations: SceneOptimization[];
  76235. /**
  76236. * Creates a new list of options used by SceneOptimizer
  76237. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  76238. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  76239. */
  76240. constructor(
  76241. /**
  76242. * Defines the target frame rate to reach (60 by default)
  76243. */
  76244. targetFrameRate?: number,
  76245. /**
  76246. * Defines the interval between two checkes (2000ms by default)
  76247. */
  76248. trackerDuration?: number);
  76249. /**
  76250. * Add a new optimization
  76251. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  76252. * @returns the current SceneOptimizerOptions
  76253. */
  76254. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  76255. /**
  76256. * Add a new custom optimization
  76257. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  76258. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  76259. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  76260. * @returns the current SceneOptimizerOptions
  76261. */
  76262. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  76263. /**
  76264. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  76265. * @param targetFrameRate defines the target frame rate (60 by default)
  76266. * @returns a SceneOptimizerOptions object
  76267. */
  76268. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  76269. /**
  76270. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  76271. * @param targetFrameRate defines the target frame rate (60 by default)
  76272. * @returns a SceneOptimizerOptions object
  76273. */
  76274. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  76275. /**
  76276. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  76277. * @param targetFrameRate defines the target frame rate (60 by default)
  76278. * @returns a SceneOptimizerOptions object
  76279. */
  76280. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  76281. }
  76282. /**
  76283. * Class used to run optimizations in order to reach a target frame rate
  76284. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76285. */
  76286. export class SceneOptimizer implements IDisposable {
  76287. private _isRunning;
  76288. private _options;
  76289. private _scene;
  76290. private _currentPriorityLevel;
  76291. private _targetFrameRate;
  76292. private _trackerDuration;
  76293. private _currentFrameRate;
  76294. private _sceneDisposeObserver;
  76295. private _improvementMode;
  76296. /**
  76297. * Defines an observable called when the optimizer reaches the target frame rate
  76298. */
  76299. onSuccessObservable: Observable<SceneOptimizer>;
  76300. /**
  76301. * Defines an observable called when the optimizer enables an optimization
  76302. */
  76303. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  76304. /**
  76305. * Defines an observable called when the optimizer is not able to reach the target frame rate
  76306. */
  76307. onFailureObservable: Observable<SceneOptimizer>;
  76308. /**
  76309. * Gets a boolean indicating if the optimizer is in improvement mode
  76310. */
  76311. get isInImprovementMode(): boolean;
  76312. /**
  76313. * Gets the current priority level (0 at start)
  76314. */
  76315. get currentPriorityLevel(): number;
  76316. /**
  76317. * Gets the current frame rate checked by the SceneOptimizer
  76318. */
  76319. get currentFrameRate(): number;
  76320. /**
  76321. * Gets or sets the current target frame rate (60 by default)
  76322. */
  76323. get targetFrameRate(): number;
  76324. /**
  76325. * Gets or sets the current target frame rate (60 by default)
  76326. */
  76327. set targetFrameRate(value: number);
  76328. /**
  76329. * Gets or sets the current interval between two checks (every 2000ms by default)
  76330. */
  76331. get trackerDuration(): number;
  76332. /**
  76333. * Gets or sets the current interval between two checks (every 2000ms by default)
  76334. */
  76335. set trackerDuration(value: number);
  76336. /**
  76337. * Gets the list of active optimizations
  76338. */
  76339. get optimizations(): SceneOptimization[];
  76340. /**
  76341. * Creates a new SceneOptimizer
  76342. * @param scene defines the scene to work on
  76343. * @param options defines the options to use with the SceneOptimizer
  76344. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  76345. * @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)
  76346. */
  76347. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  76348. /**
  76349. * Stops the current optimizer
  76350. */
  76351. stop(): void;
  76352. /**
  76353. * Reset the optimizer to initial step (current priority level = 0)
  76354. */
  76355. reset(): void;
  76356. /**
  76357. * Start the optimizer. By default it will try to reach a specific framerate
  76358. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  76359. */
  76360. start(): void;
  76361. private _checkCurrentState;
  76362. /**
  76363. * Release all resources
  76364. */
  76365. dispose(): void;
  76366. /**
  76367. * Helper function to create a SceneOptimizer with one single line of code
  76368. * @param scene defines the scene to work on
  76369. * @param options defines the options to use with the SceneOptimizer
  76370. * @param onSuccess defines a callback to call on success
  76371. * @param onFailure defines a callback to call on failure
  76372. * @returns the new SceneOptimizer object
  76373. */
  76374. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  76375. }
  76376. }
  76377. declare module "babylonjs/Misc/sceneSerializer" {
  76378. import { Scene } from "babylonjs/scene";
  76379. /**
  76380. * Class used to serialize a scene into a string
  76381. */
  76382. export class SceneSerializer {
  76383. /**
  76384. * Clear cache used by a previous serialization
  76385. */
  76386. static ClearCache(): void;
  76387. /**
  76388. * Serialize a scene into a JSON compatible object
  76389. * @param scene defines the scene to serialize
  76390. * @returns a JSON compatible object
  76391. */
  76392. static Serialize(scene: Scene): any;
  76393. /**
  76394. * Serialize a mesh into a JSON compatible object
  76395. * @param toSerialize defines the mesh to serialize
  76396. * @param withParents defines if parents must be serialized as well
  76397. * @param withChildren defines if children must be serialized as well
  76398. * @returns a JSON compatible object
  76399. */
  76400. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  76401. }
  76402. }
  76403. declare module "babylonjs/Misc/textureTools" {
  76404. import { Texture } from "babylonjs/Materials/Textures/texture";
  76405. /**
  76406. * Class used to host texture specific utilities
  76407. */
  76408. export class TextureTools {
  76409. /**
  76410. * Uses the GPU to create a copy texture rescaled at a given size
  76411. * @param texture Texture to copy from
  76412. * @param width defines the desired width
  76413. * @param height defines the desired height
  76414. * @param useBilinearMode defines if bilinear mode has to be used
  76415. * @return the generated texture
  76416. */
  76417. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  76418. }
  76419. }
  76420. declare module "babylonjs/Misc/videoRecorder" {
  76421. import { Nullable } from "babylonjs/types";
  76422. import { Engine } from "babylonjs/Engines/engine";
  76423. /**
  76424. * This represents the different options available for the video capture.
  76425. */
  76426. export interface VideoRecorderOptions {
  76427. /** Defines the mime type of the video. */
  76428. mimeType: string;
  76429. /** Defines the FPS the video should be recorded at. */
  76430. fps: number;
  76431. /** Defines the chunk size for the recording data. */
  76432. recordChunckSize: number;
  76433. /** The audio tracks to attach to the recording. */
  76434. audioTracks?: MediaStreamTrack[];
  76435. }
  76436. /**
  76437. * This can help with recording videos from BabylonJS.
  76438. * This is based on the available WebRTC functionalities of the browser.
  76439. *
  76440. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  76441. */
  76442. export class VideoRecorder {
  76443. private static readonly _defaultOptions;
  76444. /**
  76445. * Returns whether or not the VideoRecorder is available in your browser.
  76446. * @param engine Defines the Babylon Engine.
  76447. * @returns true if supported otherwise false.
  76448. */
  76449. static IsSupported(engine: Engine): boolean;
  76450. private readonly _options;
  76451. private _canvas;
  76452. private _mediaRecorder;
  76453. private _recordedChunks;
  76454. private _fileName;
  76455. private _resolve;
  76456. private _reject;
  76457. /**
  76458. * True when a recording is already in progress.
  76459. */
  76460. get isRecording(): boolean;
  76461. /**
  76462. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  76463. * @param engine Defines the BabylonJS Engine you wish to record.
  76464. * @param options Defines options that can be used to customize the capture.
  76465. */
  76466. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  76467. /**
  76468. * Stops the current recording before the default capture timeout passed in the startRecording function.
  76469. */
  76470. stopRecording(): void;
  76471. /**
  76472. * Starts recording the canvas for a max duration specified in parameters.
  76473. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  76474. * If null no automatic download will start and you can rely on the promise to get the data back.
  76475. * @param maxDuration Defines the maximum recording time in seconds.
  76476. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  76477. * @return A promise callback at the end of the recording with the video data in Blob.
  76478. */
  76479. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  76480. /**
  76481. * Releases internal resources used during the recording.
  76482. */
  76483. dispose(): void;
  76484. private _handleDataAvailable;
  76485. private _handleError;
  76486. private _handleStop;
  76487. }
  76488. }
  76489. declare module "babylonjs/Misc/screenshotTools" {
  76490. import { Camera } from "babylonjs/Cameras/camera";
  76491. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  76492. import { Engine } from "babylonjs/Engines/engine";
  76493. /**
  76494. * Class containing a set of static utilities functions for screenshots
  76495. */
  76496. export class ScreenshotTools {
  76497. /**
  76498. * Captures a screenshot of the current rendering
  76499. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  76500. * @param engine defines the rendering engine
  76501. * @param camera defines the source camera
  76502. * @param size This parameter can be set to a single number or to an object with the
  76503. * following (optional) properties: precision, width, height. If a single number is passed,
  76504. * it will be used for both width and height. If an object is passed, the screenshot size
  76505. * will be derived from the parameters. The precision property is a multiplier allowing
  76506. * rendering at a higher or lower resolution
  76507. * @param successCallback defines the callback receives a single parameter which contains the
  76508. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  76509. * src parameter of an <img> to display it
  76510. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  76511. * Check your browser for supported MIME types
  76512. */
  76513. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  76514. /**
  76515. * Captures a screenshot of the current rendering
  76516. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  76517. * @param engine defines the rendering engine
  76518. * @param camera defines the source camera
  76519. * @param size This parameter can be set to a single number or to an object with the
  76520. * following (optional) properties: precision, width, height. If a single number is passed,
  76521. * it will be used for both width and height. If an object is passed, the screenshot size
  76522. * will be derived from the parameters. The precision property is a multiplier allowing
  76523. * rendering at a higher or lower resolution
  76524. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  76525. * Check your browser for supported MIME types
  76526. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  76527. * to the src parameter of an <img> to display it
  76528. */
  76529. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  76530. /**
  76531. * Generates an image screenshot from the specified camera.
  76532. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  76533. * @param engine The engine to use for rendering
  76534. * @param camera The camera to use for rendering
  76535. * @param size This parameter can be set to a single number or to an object with the
  76536. * following (optional) properties: precision, width, height. If a single number is passed,
  76537. * it will be used for both width and height. If an object is passed, the screenshot size
  76538. * will be derived from the parameters. The precision property is a multiplier allowing
  76539. * rendering at a higher or lower resolution
  76540. * @param successCallback The callback receives a single parameter which contains the
  76541. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  76542. * src parameter of an <img> to display it
  76543. * @param mimeType The MIME type of the screenshot image (default: image/png).
  76544. * Check your browser for supported MIME types
  76545. * @param samples Texture samples (default: 1)
  76546. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  76547. * @param fileName A name for for the downloaded file.
  76548. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  76549. */
  76550. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): void;
  76551. /**
  76552. * Generates an image screenshot from the specified camera.
  76553. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  76554. * @param engine The engine to use for rendering
  76555. * @param camera The camera to use for rendering
  76556. * @param size This parameter can be set to a single number or to an object with the
  76557. * following (optional) properties: precision, width, height. If a single number is passed,
  76558. * it will be used for both width and height. If an object is passed, the screenshot size
  76559. * will be derived from the parameters. The precision property is a multiplier allowing
  76560. * rendering at a higher or lower resolution
  76561. * @param mimeType The MIME type of the screenshot image (default: image/png).
  76562. * Check your browser for supported MIME types
  76563. * @param samples Texture samples (default: 1)
  76564. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  76565. * @param fileName A name for for the downloaded file.
  76566. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  76567. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  76568. * to the src parameter of an <img> to display it
  76569. */
  76570. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  76571. /**
  76572. * Gets height and width for screenshot size
  76573. * @private
  76574. */
  76575. private static _getScreenshotSize;
  76576. }
  76577. }
  76578. declare module "babylonjs/Misc/dataReader" {
  76579. /**
  76580. * Interface for a data buffer
  76581. */
  76582. export interface IDataBuffer {
  76583. /**
  76584. * Reads bytes from the data buffer.
  76585. * @param byteOffset The byte offset to read
  76586. * @param byteLength The byte length to read
  76587. * @returns A promise that resolves when the bytes are read
  76588. */
  76589. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  76590. /**
  76591. * The byte length of the buffer.
  76592. */
  76593. readonly byteLength: number;
  76594. }
  76595. /**
  76596. * Utility class for reading from a data buffer
  76597. */
  76598. export class DataReader {
  76599. /**
  76600. * The data buffer associated with this data reader.
  76601. */
  76602. readonly buffer: IDataBuffer;
  76603. /**
  76604. * The current byte offset from the beginning of the data buffer.
  76605. */
  76606. byteOffset: number;
  76607. private _dataView;
  76608. private _dataByteOffset;
  76609. /**
  76610. * Constructor
  76611. * @param buffer The buffer to read
  76612. */
  76613. constructor(buffer: IDataBuffer);
  76614. /**
  76615. * Loads the given byte length.
  76616. * @param byteLength The byte length to load
  76617. * @returns A promise that resolves when the load is complete
  76618. */
  76619. loadAsync(byteLength: number): Promise<void>;
  76620. /**
  76621. * Read a unsigned 32-bit integer from the currently loaded data range.
  76622. * @returns The 32-bit integer read
  76623. */
  76624. readUint32(): number;
  76625. /**
  76626. * Read a byte array from the currently loaded data range.
  76627. * @param byteLength The byte length to read
  76628. * @returns The byte array read
  76629. */
  76630. readUint8Array(byteLength: number): Uint8Array;
  76631. /**
  76632. * Read a string from the currently loaded data range.
  76633. * @param byteLength The byte length to read
  76634. * @returns The string read
  76635. */
  76636. readString(byteLength: number): string;
  76637. /**
  76638. * Skips the given byte length the currently loaded data range.
  76639. * @param byteLength The byte length to skip
  76640. */
  76641. skipBytes(byteLength: number): void;
  76642. }
  76643. }
  76644. declare module "babylonjs/Misc/dataStorage" {
  76645. /**
  76646. * Class for storing data to local storage if available or in-memory storage otherwise
  76647. */
  76648. export class DataStorage {
  76649. private static _Storage;
  76650. private static _GetStorage;
  76651. /**
  76652. * Reads a string from the data storage
  76653. * @param key The key to read
  76654. * @param defaultValue The value if the key doesn't exist
  76655. * @returns The string value
  76656. */
  76657. static ReadString(key: string, defaultValue: string): string;
  76658. /**
  76659. * Writes a string to the data storage
  76660. * @param key The key to write
  76661. * @param value The value to write
  76662. */
  76663. static WriteString(key: string, value: string): void;
  76664. /**
  76665. * Reads a boolean from the data storage
  76666. * @param key The key to read
  76667. * @param defaultValue The value if the key doesn't exist
  76668. * @returns The boolean value
  76669. */
  76670. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  76671. /**
  76672. * Writes a boolean to the data storage
  76673. * @param key The key to write
  76674. * @param value The value to write
  76675. */
  76676. static WriteBoolean(key: string, value: boolean): void;
  76677. /**
  76678. * Reads a number from the data storage
  76679. * @param key The key to read
  76680. * @param defaultValue The value if the key doesn't exist
  76681. * @returns The number value
  76682. */
  76683. static ReadNumber(key: string, defaultValue: number): number;
  76684. /**
  76685. * Writes a number to the data storage
  76686. * @param key The key to write
  76687. * @param value The value to write
  76688. */
  76689. static WriteNumber(key: string, value: number): void;
  76690. }
  76691. }
  76692. declare module "babylonjs/Misc/index" {
  76693. export * from "babylonjs/Misc/andOrNotEvaluator";
  76694. export * from "babylonjs/Misc/assetsManager";
  76695. export * from "babylonjs/Misc/basis";
  76696. export * from "babylonjs/Misc/dds";
  76697. export * from "babylonjs/Misc/decorators";
  76698. export * from "babylonjs/Misc/deferred";
  76699. export * from "babylonjs/Misc/environmentTextureTools";
  76700. export * from "babylonjs/Misc/meshExploder";
  76701. export * from "babylonjs/Misc/filesInput";
  76702. export * from "babylonjs/Misc/HighDynamicRange/index";
  76703. export * from "babylonjs/Misc/khronosTextureContainer";
  76704. export * from "babylonjs/Misc/observable";
  76705. export * from "babylonjs/Misc/performanceMonitor";
  76706. export * from "babylonjs/Misc/promise";
  76707. export * from "babylonjs/Misc/sceneOptimizer";
  76708. export * from "babylonjs/Misc/sceneSerializer";
  76709. export * from "babylonjs/Misc/smartArray";
  76710. export * from "babylonjs/Misc/stringDictionary";
  76711. export * from "babylonjs/Misc/tags";
  76712. export * from "babylonjs/Misc/textureTools";
  76713. export * from "babylonjs/Misc/tga";
  76714. export * from "babylonjs/Misc/tools";
  76715. export * from "babylonjs/Misc/videoRecorder";
  76716. export * from "babylonjs/Misc/virtualJoystick";
  76717. export * from "babylonjs/Misc/workerPool";
  76718. export * from "babylonjs/Misc/logger";
  76719. export * from "babylonjs/Misc/typeStore";
  76720. export * from "babylonjs/Misc/filesInputStore";
  76721. export * from "babylonjs/Misc/deepCopier";
  76722. export * from "babylonjs/Misc/pivotTools";
  76723. export * from "babylonjs/Misc/precisionDate";
  76724. export * from "babylonjs/Misc/screenshotTools";
  76725. export * from "babylonjs/Misc/typeStore";
  76726. export * from "babylonjs/Misc/webRequest";
  76727. export * from "babylonjs/Misc/iInspectable";
  76728. export * from "babylonjs/Misc/brdfTextureTools";
  76729. export * from "babylonjs/Misc/rgbdTextureTools";
  76730. export * from "babylonjs/Misc/gradients";
  76731. export * from "babylonjs/Misc/perfCounter";
  76732. export * from "babylonjs/Misc/fileRequest";
  76733. export * from "babylonjs/Misc/customAnimationFrameRequester";
  76734. export * from "babylonjs/Misc/retryStrategy";
  76735. export * from "babylonjs/Misc/interfaces/screenshotSize";
  76736. export * from "babylonjs/Misc/canvasGenerator";
  76737. export * from "babylonjs/Misc/fileTools";
  76738. export * from "babylonjs/Misc/stringTools";
  76739. export * from "babylonjs/Misc/dataReader";
  76740. export * from "babylonjs/Misc/minMaxReducer";
  76741. export * from "babylonjs/Misc/depthReducer";
  76742. export * from "babylonjs/Misc/dataStorage";
  76743. }
  76744. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  76745. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  76746. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  76747. import { Observable } from "babylonjs/Misc/observable";
  76748. import { Matrix } from "babylonjs/Maths/math.vector";
  76749. import { TransformNode } from "babylonjs/Meshes/transformNode";
  76750. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  76751. /**
  76752. * An interface for all Hit test features
  76753. */
  76754. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  76755. /**
  76756. * Triggered when new babylon (transformed) hit test results are available
  76757. */
  76758. onHitTestResultObservable: Observable<T[]>;
  76759. }
  76760. /**
  76761. * Options used for hit testing
  76762. */
  76763. export interface IWebXRLegacyHitTestOptions {
  76764. /**
  76765. * Only test when user interacted with the scene. Default - hit test every frame
  76766. */
  76767. testOnPointerDownOnly?: boolean;
  76768. /**
  76769. * The node to use to transform the local results to world coordinates
  76770. */
  76771. worldParentNode?: TransformNode;
  76772. }
  76773. /**
  76774. * Interface defining the babylon result of raycasting/hit-test
  76775. */
  76776. export interface IWebXRLegacyHitResult {
  76777. /**
  76778. * Transformation matrix that can be applied to a node that will put it in the hit point location
  76779. */
  76780. transformationMatrix: Matrix;
  76781. /**
  76782. * The native hit test result
  76783. */
  76784. xrHitResult: XRHitResult | XRHitTestResult;
  76785. }
  76786. /**
  76787. * The currently-working hit-test module.
  76788. * Hit test (or Ray-casting) is used to interact with the real world.
  76789. * For further information read here - https://github.com/immersive-web/hit-test
  76790. */
  76791. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  76792. /**
  76793. * options to use when constructing this feature
  76794. */
  76795. readonly options: IWebXRLegacyHitTestOptions;
  76796. private _direction;
  76797. private _mat;
  76798. private _onSelectEnabled;
  76799. private _origin;
  76800. /**
  76801. * The module's name
  76802. */
  76803. static readonly Name: string;
  76804. /**
  76805. * The (Babylon) version of this module.
  76806. * This is an integer representing the implementation version.
  76807. * This number does not correspond to the WebXR specs version
  76808. */
  76809. static readonly Version: number;
  76810. /**
  76811. * Populated with the last native XR Hit Results
  76812. */
  76813. lastNativeXRHitResults: XRHitResult[];
  76814. /**
  76815. * Triggered when new babylon (transformed) hit test results are available
  76816. */
  76817. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  76818. /**
  76819. * Creates a new instance of the (legacy version) hit test feature
  76820. * @param _xrSessionManager an instance of WebXRSessionManager
  76821. * @param options options to use when constructing this feature
  76822. */
  76823. constructor(_xrSessionManager: WebXRSessionManager,
  76824. /**
  76825. * options to use when constructing this feature
  76826. */
  76827. options?: IWebXRLegacyHitTestOptions);
  76828. /**
  76829. * execute a hit test with an XR Ray
  76830. *
  76831. * @param xrSession a native xrSession that will execute this hit test
  76832. * @param xrRay the ray (position and direction) to use for ray-casting
  76833. * @param referenceSpace native XR reference space to use for the hit-test
  76834. * @param filter filter function that will filter the results
  76835. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  76836. */
  76837. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  76838. /**
  76839. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  76840. * @param event the (select) event to use to select with
  76841. * @param referenceSpace the reference space to use for this hit test
  76842. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  76843. */
  76844. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  76845. /**
  76846. * attach this feature
  76847. * Will usually be called by the features manager
  76848. *
  76849. * @returns true if successful.
  76850. */
  76851. attach(): boolean;
  76852. /**
  76853. * detach this feature.
  76854. * Will usually be called by the features manager
  76855. *
  76856. * @returns true if successful.
  76857. */
  76858. detach(): boolean;
  76859. /**
  76860. * Dispose this feature and all of the resources attached
  76861. */
  76862. dispose(): void;
  76863. protected _onXRFrame(frame: XRFrame): void;
  76864. private _onHitTestResults;
  76865. private _onSelect;
  76866. }
  76867. }
  76868. declare module "babylonjs/XR/features/WebXRHitTest" {
  76869. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  76870. import { Observable } from "babylonjs/Misc/observable";
  76871. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  76872. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  76873. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  76874. /**
  76875. * Options used for hit testing (version 2)
  76876. */
  76877. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  76878. /**
  76879. * Do not create a permanent hit test. Will usually be used when only
  76880. * transient inputs are needed.
  76881. */
  76882. disablePermanentHitTest?: boolean;
  76883. /**
  76884. * Enable transient (for example touch-based) hit test inspections
  76885. */
  76886. enableTransientHitTest?: boolean;
  76887. /**
  76888. * Offset ray for the permanent hit test
  76889. */
  76890. offsetRay?: Vector3;
  76891. /**
  76892. * Offset ray for the transient hit test
  76893. */
  76894. transientOffsetRay?: Vector3;
  76895. /**
  76896. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  76897. */
  76898. useReferenceSpace?: boolean;
  76899. }
  76900. /**
  76901. * Interface defining the babylon result of hit-test
  76902. */
  76903. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  76904. /**
  76905. * The input source that generated this hit test (if transient)
  76906. */
  76907. inputSource?: XRInputSource;
  76908. /**
  76909. * Is this a transient hit test
  76910. */
  76911. isTransient?: boolean;
  76912. /**
  76913. * Position of the hit test result
  76914. */
  76915. position: Vector3;
  76916. /**
  76917. * Rotation of the hit test result
  76918. */
  76919. rotationQuaternion: Quaternion;
  76920. /**
  76921. * The native hit test result
  76922. */
  76923. xrHitResult: XRHitTestResult;
  76924. }
  76925. /**
  76926. * The currently-working hit-test module.
  76927. * Hit test (or Ray-casting) is used to interact with the real world.
  76928. * For further information read here - https://github.com/immersive-web/hit-test
  76929. *
  76930. * Tested on chrome (mobile) 80.
  76931. */
  76932. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  76933. /**
  76934. * options to use when constructing this feature
  76935. */
  76936. readonly options: IWebXRHitTestOptions;
  76937. private _tmpMat;
  76938. private _tmpPos;
  76939. private _tmpQuat;
  76940. private _transientXrHitTestSource;
  76941. private _xrHitTestSource;
  76942. private initHitTestSource;
  76943. /**
  76944. * The module's name
  76945. */
  76946. static readonly Name: string;
  76947. /**
  76948. * The (Babylon) version of this module.
  76949. * This is an integer representing the implementation version.
  76950. * This number does not correspond to the WebXR specs version
  76951. */
  76952. static readonly Version: number;
  76953. /**
  76954. * When set to true, each hit test will have its own position/rotation objects
  76955. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  76956. * the developers will clone them or copy them as they see fit.
  76957. */
  76958. autoCloneTransformation: boolean;
  76959. /**
  76960. * Triggered when new babylon (transformed) hit test results are available
  76961. */
  76962. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  76963. /**
  76964. * Use this to temporarily pause hit test checks.
  76965. */
  76966. paused: boolean;
  76967. /**
  76968. * Creates a new instance of the hit test feature
  76969. * @param _xrSessionManager an instance of WebXRSessionManager
  76970. * @param options options to use when constructing this feature
  76971. */
  76972. constructor(_xrSessionManager: WebXRSessionManager,
  76973. /**
  76974. * options to use when constructing this feature
  76975. */
  76976. options?: IWebXRHitTestOptions);
  76977. /**
  76978. * attach this feature
  76979. * Will usually be called by the features manager
  76980. *
  76981. * @returns true if successful.
  76982. */
  76983. attach(): boolean;
  76984. /**
  76985. * detach this feature.
  76986. * Will usually be called by the features manager
  76987. *
  76988. * @returns true if successful.
  76989. */
  76990. detach(): boolean;
  76991. /**
  76992. * Dispose this feature and all of the resources attached
  76993. */
  76994. dispose(): void;
  76995. protected _onXRFrame(frame: XRFrame): void;
  76996. private _processWebXRHitTestResult;
  76997. }
  76998. }
  76999. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  77000. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77001. import { Observable } from "babylonjs/Misc/observable";
  77002. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  77003. import { TransformNode } from "babylonjs/Meshes/transformNode";
  77004. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77005. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  77006. /**
  77007. * Configuration options of the anchor system
  77008. */
  77009. export interface IWebXRAnchorSystemOptions {
  77010. /**
  77011. * a node that will be used to convert local to world coordinates
  77012. */
  77013. worldParentNode?: TransformNode;
  77014. /**
  77015. * If set to true a reference of the created anchors will be kept until the next session starts
  77016. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  77017. */
  77018. doNotRemoveAnchorsOnSessionEnded?: boolean;
  77019. }
  77020. /**
  77021. * A babylon container for an XR Anchor
  77022. */
  77023. export interface IWebXRAnchor {
  77024. /**
  77025. * A babylon-assigned ID for this anchor
  77026. */
  77027. id: number;
  77028. /**
  77029. * Transformation matrix to apply to an object attached to this anchor
  77030. */
  77031. transformationMatrix: Matrix;
  77032. /**
  77033. * The native anchor object
  77034. */
  77035. xrAnchor: XRAnchor;
  77036. /**
  77037. * if defined, this object will be constantly updated by the anchor's position and rotation
  77038. */
  77039. attachedNode?: TransformNode;
  77040. }
  77041. /**
  77042. * An implementation of the anchor system for WebXR.
  77043. * For further information see https://github.com/immersive-web/anchors/
  77044. */
  77045. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  77046. private _options;
  77047. private _lastFrameDetected;
  77048. private _trackedAnchors;
  77049. private _referenceSpaceForFrameAnchors;
  77050. private _futureAnchors;
  77051. /**
  77052. * The module's name
  77053. */
  77054. static readonly Name: string;
  77055. /**
  77056. * The (Babylon) version of this module.
  77057. * This is an integer representing the implementation version.
  77058. * This number does not correspond to the WebXR specs version
  77059. */
  77060. static readonly Version: number;
  77061. /**
  77062. * Observers registered here will be executed when a new anchor was added to the session
  77063. */
  77064. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  77065. /**
  77066. * Observers registered here will be executed when an anchor was removed from the session
  77067. */
  77068. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  77069. /**
  77070. * Observers registered here will be executed when an existing anchor updates
  77071. * This can execute N times every frame
  77072. */
  77073. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  77074. /**
  77075. * Set the reference space to use for anchor creation, when not using a hit test.
  77076. * Will default to the session's reference space if not defined
  77077. */
  77078. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  77079. /**
  77080. * constructs a new anchor system
  77081. * @param _xrSessionManager an instance of WebXRSessionManager
  77082. * @param _options configuration object for this feature
  77083. */
  77084. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  77085. private _tmpVector;
  77086. private _tmpQuaternion;
  77087. private _populateTmpTransformation;
  77088. /**
  77089. * Create a new anchor point using a hit test result at a specific point in the scene
  77090. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  77091. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  77092. *
  77093. * @param hitTestResult The hit test result to use for this anchor creation
  77094. * @param position an optional position offset for this anchor
  77095. * @param rotationQuaternion an optional rotation offset for this anchor
  77096. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  77097. */
  77098. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  77099. /**
  77100. * Add a new anchor at a specific position and rotation
  77101. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  77102. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  77103. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  77104. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  77105. *
  77106. * @param position the position in which to add an anchor
  77107. * @param rotationQuaternion an optional rotation for the anchor transformation
  77108. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  77109. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  77110. */
  77111. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  77112. /**
  77113. * detach this feature.
  77114. * Will usually be called by the features manager
  77115. *
  77116. * @returns true if successful.
  77117. */
  77118. detach(): boolean;
  77119. /**
  77120. * Dispose this feature and all of the resources attached
  77121. */
  77122. dispose(): void;
  77123. protected _onXRFrame(frame: XRFrame): void;
  77124. /**
  77125. * avoiding using Array.find for global support.
  77126. * @param xrAnchor the plane to find in the array
  77127. */
  77128. private _findIndexInAnchorArray;
  77129. private _updateAnchorWithXRFrame;
  77130. private _createAnchorAtTransformation;
  77131. }
  77132. }
  77133. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  77134. import { TransformNode } from "babylonjs/Meshes/transformNode";
  77135. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77136. import { Observable } from "babylonjs/Misc/observable";
  77137. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  77138. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77139. /**
  77140. * Options used in the plane detector module
  77141. */
  77142. export interface IWebXRPlaneDetectorOptions {
  77143. /**
  77144. * The node to use to transform the local results to world coordinates
  77145. */
  77146. worldParentNode?: TransformNode;
  77147. /**
  77148. * If set to true a reference of the created planes will be kept until the next session starts
  77149. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  77150. */
  77151. doNotRemovePlanesOnSessionEnded?: boolean;
  77152. }
  77153. /**
  77154. * A babylon interface for a WebXR plane.
  77155. * A Plane is actually a polygon, built from N points in space
  77156. *
  77157. * Supported in chrome 79, not supported in canary 81 ATM
  77158. */
  77159. export interface IWebXRPlane {
  77160. /**
  77161. * a babylon-assigned ID for this polygon
  77162. */
  77163. id: number;
  77164. /**
  77165. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  77166. */
  77167. polygonDefinition: Array<Vector3>;
  77168. /**
  77169. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  77170. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  77171. */
  77172. transformationMatrix: Matrix;
  77173. /**
  77174. * the native xr-plane object
  77175. */
  77176. xrPlane: XRPlane;
  77177. }
  77178. /**
  77179. * The plane detector is used to detect planes in the real world when in AR
  77180. * For more information see https://github.com/immersive-web/real-world-geometry/
  77181. */
  77182. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  77183. private _options;
  77184. private _detectedPlanes;
  77185. private _enabled;
  77186. private _lastFrameDetected;
  77187. /**
  77188. * The module's name
  77189. */
  77190. static readonly Name: string;
  77191. /**
  77192. * The (Babylon) version of this module.
  77193. * This is an integer representing the implementation version.
  77194. * This number does not correspond to the WebXR specs version
  77195. */
  77196. static readonly Version: number;
  77197. /**
  77198. * Observers registered here will be executed when a new plane was added to the session
  77199. */
  77200. onPlaneAddedObservable: Observable<IWebXRPlane>;
  77201. /**
  77202. * Observers registered here will be executed when a plane is no longer detected in the session
  77203. */
  77204. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  77205. /**
  77206. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  77207. * This can execute N times every frame
  77208. */
  77209. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  77210. /**
  77211. * construct a new Plane Detector
  77212. * @param _xrSessionManager an instance of xr Session manager
  77213. * @param _options configuration to use when constructing this feature
  77214. */
  77215. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  77216. /**
  77217. * detach this feature.
  77218. * Will usually be called by the features manager
  77219. *
  77220. * @returns true if successful.
  77221. */
  77222. detach(): boolean;
  77223. /**
  77224. * Dispose this feature and all of the resources attached
  77225. */
  77226. dispose(): void;
  77227. protected _onXRFrame(frame: XRFrame): void;
  77228. private _init;
  77229. private _updatePlaneWithXRPlane;
  77230. /**
  77231. * avoiding using Array.find for global support.
  77232. * @param xrPlane the plane to find in the array
  77233. */
  77234. private findIndexInPlaneArray;
  77235. }
  77236. }
  77237. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  77238. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77239. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  77240. import { Observable } from "babylonjs/Misc/observable";
  77241. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77242. /**
  77243. * Options interface for the background remover plugin
  77244. */
  77245. export interface IWebXRBackgroundRemoverOptions {
  77246. /**
  77247. * Further background meshes to disable when entering AR
  77248. */
  77249. backgroundMeshes?: AbstractMesh[];
  77250. /**
  77251. * flags to configure the removal of the environment helper.
  77252. * If not set, the entire background will be removed. If set, flags should be set as well.
  77253. */
  77254. environmentHelperRemovalFlags?: {
  77255. /**
  77256. * Should the skybox be removed (default false)
  77257. */
  77258. skyBox?: boolean;
  77259. /**
  77260. * Should the ground be removed (default false)
  77261. */
  77262. ground?: boolean;
  77263. };
  77264. /**
  77265. * don't disable the environment helper
  77266. */
  77267. ignoreEnvironmentHelper?: boolean;
  77268. }
  77269. /**
  77270. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  77271. */
  77272. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  77273. /**
  77274. * read-only options to be used in this module
  77275. */
  77276. readonly options: IWebXRBackgroundRemoverOptions;
  77277. /**
  77278. * The module's name
  77279. */
  77280. static readonly Name: string;
  77281. /**
  77282. * The (Babylon) version of this module.
  77283. * This is an integer representing the implementation version.
  77284. * This number does not correspond to the WebXR specs version
  77285. */
  77286. static readonly Version: number;
  77287. /**
  77288. * registered observers will be triggered when the background state changes
  77289. */
  77290. onBackgroundStateChangedObservable: Observable<boolean>;
  77291. /**
  77292. * constructs a new background remover module
  77293. * @param _xrSessionManager the session manager for this module
  77294. * @param options read-only options to be used in this module
  77295. */
  77296. constructor(_xrSessionManager: WebXRSessionManager,
  77297. /**
  77298. * read-only options to be used in this module
  77299. */
  77300. options?: IWebXRBackgroundRemoverOptions);
  77301. /**
  77302. * attach this feature
  77303. * Will usually be called by the features manager
  77304. *
  77305. * @returns true if successful.
  77306. */
  77307. attach(): boolean;
  77308. /**
  77309. * detach this feature.
  77310. * Will usually be called by the features manager
  77311. *
  77312. * @returns true if successful.
  77313. */
  77314. detach(): boolean;
  77315. /**
  77316. * Dispose this feature and all of the resources attached
  77317. */
  77318. dispose(): void;
  77319. protected _onXRFrame(_xrFrame: XRFrame): void;
  77320. private _setBackgroundState;
  77321. }
  77322. }
  77323. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  77324. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77325. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  77326. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  77327. import { WebXRInput } from "babylonjs/XR/webXRInput";
  77328. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77329. import { Nullable } from "babylonjs/types";
  77330. /**
  77331. * Options for the controller physics feature
  77332. */
  77333. export class IWebXRControllerPhysicsOptions {
  77334. /**
  77335. * Should the headset get its own impostor
  77336. */
  77337. enableHeadsetImpostor?: boolean;
  77338. /**
  77339. * Optional parameters for the headset impostor
  77340. */
  77341. headsetImpostorParams?: {
  77342. /**
  77343. * The type of impostor to create. Default is sphere
  77344. */
  77345. impostorType: number;
  77346. /**
  77347. * the size of the impostor. Defaults to 10cm
  77348. */
  77349. impostorSize?: number | {
  77350. width: number;
  77351. height: number;
  77352. depth: number;
  77353. };
  77354. /**
  77355. * Friction definitions
  77356. */
  77357. friction?: number;
  77358. /**
  77359. * Restitution
  77360. */
  77361. restitution?: number;
  77362. };
  77363. /**
  77364. * The physics properties of the future impostors
  77365. */
  77366. physicsProperties?: {
  77367. /**
  77368. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  77369. * Note that this requires a physics engine that supports mesh impostors!
  77370. */
  77371. useControllerMesh?: boolean;
  77372. /**
  77373. * The type of impostor to create. Default is sphere
  77374. */
  77375. impostorType?: number;
  77376. /**
  77377. * the size of the impostor. Defaults to 10cm
  77378. */
  77379. impostorSize?: number | {
  77380. width: number;
  77381. height: number;
  77382. depth: number;
  77383. };
  77384. /**
  77385. * Friction definitions
  77386. */
  77387. friction?: number;
  77388. /**
  77389. * Restitution
  77390. */
  77391. restitution?: number;
  77392. };
  77393. /**
  77394. * the xr input to use with this pointer selection
  77395. */
  77396. xrInput: WebXRInput;
  77397. }
  77398. /**
  77399. * Add physics impostor to your webxr controllers,
  77400. * including naive calculation of their linear and angular velocity
  77401. */
  77402. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  77403. private readonly _options;
  77404. private _attachController;
  77405. private _controllers;
  77406. private _debugMode;
  77407. private _delta;
  77408. private _headsetImpostor?;
  77409. private _headsetMesh?;
  77410. private _lastTimestamp;
  77411. private _tmpQuaternion;
  77412. private _tmpVector;
  77413. /**
  77414. * The module's name
  77415. */
  77416. static readonly Name: string;
  77417. /**
  77418. * The (Babylon) version of this module.
  77419. * This is an integer representing the implementation version.
  77420. * This number does not correspond to the webxr specs version
  77421. */
  77422. static readonly Version: number;
  77423. /**
  77424. * Construct a new Controller Physics Feature
  77425. * @param _xrSessionManager the corresponding xr session manager
  77426. * @param _options options to create this feature with
  77427. */
  77428. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  77429. /**
  77430. * @hidden
  77431. * enable debugging - will show console outputs and the impostor mesh
  77432. */
  77433. _enablePhysicsDebug(): void;
  77434. /**
  77435. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  77436. * @param xrController the controller to add
  77437. */
  77438. addController(xrController: WebXRInputSource): void;
  77439. /**
  77440. * attach this feature
  77441. * Will usually be called by the features manager
  77442. *
  77443. * @returns true if successful.
  77444. */
  77445. attach(): boolean;
  77446. /**
  77447. * detach this feature.
  77448. * Will usually be called by the features manager
  77449. *
  77450. * @returns true if successful.
  77451. */
  77452. detach(): boolean;
  77453. /**
  77454. * Get the headset impostor, if enabled
  77455. * @returns the impostor
  77456. */
  77457. getHeadsetImpostor(): PhysicsImpostor | undefined;
  77458. /**
  77459. * Get the physics impostor of a specific controller.
  77460. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  77461. * @param controller the controller or the controller id of which to get the impostor
  77462. * @returns the impostor or null
  77463. */
  77464. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  77465. /**
  77466. * Update the physics properties provided in the constructor
  77467. * @param newProperties the new properties object
  77468. */
  77469. setPhysicsProperties(newProperties: {
  77470. impostorType?: number;
  77471. impostorSize?: number | {
  77472. width: number;
  77473. height: number;
  77474. depth: number;
  77475. };
  77476. friction?: number;
  77477. restitution?: number;
  77478. }): void;
  77479. protected _onXRFrame(_xrFrame: any): void;
  77480. private _detachController;
  77481. }
  77482. }
  77483. declare module "babylonjs/XR/features/index" {
  77484. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  77485. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  77486. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  77487. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  77488. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  77489. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  77490. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  77491. export * from "babylonjs/XR/features/WebXRHitTest";
  77492. }
  77493. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  77494. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  77495. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  77496. import { Scene } from "babylonjs/scene";
  77497. /**
  77498. * The motion controller class for all microsoft mixed reality controllers
  77499. */
  77500. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  77501. protected readonly _mapping: {
  77502. defaultButton: {
  77503. valueNodeName: string;
  77504. unpressedNodeName: string;
  77505. pressedNodeName: string;
  77506. };
  77507. defaultAxis: {
  77508. valueNodeName: string;
  77509. minNodeName: string;
  77510. maxNodeName: string;
  77511. };
  77512. buttons: {
  77513. "xr-standard-trigger": {
  77514. rootNodeName: string;
  77515. componentProperty: string;
  77516. states: string[];
  77517. };
  77518. "xr-standard-squeeze": {
  77519. rootNodeName: string;
  77520. componentProperty: string;
  77521. states: string[];
  77522. };
  77523. "xr-standard-touchpad": {
  77524. rootNodeName: string;
  77525. labelAnchorNodeName: string;
  77526. touchPointNodeName: string;
  77527. };
  77528. "xr-standard-thumbstick": {
  77529. rootNodeName: string;
  77530. componentProperty: string;
  77531. states: string[];
  77532. };
  77533. };
  77534. axes: {
  77535. "xr-standard-touchpad": {
  77536. "x-axis": {
  77537. rootNodeName: string;
  77538. };
  77539. "y-axis": {
  77540. rootNodeName: string;
  77541. };
  77542. };
  77543. "xr-standard-thumbstick": {
  77544. "x-axis": {
  77545. rootNodeName: string;
  77546. };
  77547. "y-axis": {
  77548. rootNodeName: string;
  77549. };
  77550. };
  77551. };
  77552. };
  77553. /**
  77554. * The base url used to load the left and right controller models
  77555. */
  77556. static MODEL_BASE_URL: string;
  77557. /**
  77558. * The name of the left controller model file
  77559. */
  77560. static MODEL_LEFT_FILENAME: string;
  77561. /**
  77562. * The name of the right controller model file
  77563. */
  77564. static MODEL_RIGHT_FILENAME: string;
  77565. profileId: string;
  77566. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  77567. protected _getFilenameAndPath(): {
  77568. filename: string;
  77569. path: string;
  77570. };
  77571. protected _getModelLoadingConstraints(): boolean;
  77572. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  77573. protected _setRootMesh(meshes: AbstractMesh[]): void;
  77574. protected _updateModel(): void;
  77575. }
  77576. }
  77577. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  77578. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  77579. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  77580. import { Scene } from "babylonjs/scene";
  77581. /**
  77582. * The motion controller class for oculus touch (quest, rift).
  77583. * This class supports legacy mapping as well the standard xr mapping
  77584. */
  77585. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  77586. private _forceLegacyControllers;
  77587. private _modelRootNode;
  77588. /**
  77589. * The base url used to load the left and right controller models
  77590. */
  77591. static MODEL_BASE_URL: string;
  77592. /**
  77593. * The name of the left controller model file
  77594. */
  77595. static MODEL_LEFT_FILENAME: string;
  77596. /**
  77597. * The name of the right controller model file
  77598. */
  77599. static MODEL_RIGHT_FILENAME: string;
  77600. /**
  77601. * Base Url for the Quest controller model.
  77602. */
  77603. static QUEST_MODEL_BASE_URL: string;
  77604. profileId: string;
  77605. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  77606. protected _getFilenameAndPath(): {
  77607. filename: string;
  77608. path: string;
  77609. };
  77610. protected _getModelLoadingConstraints(): boolean;
  77611. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  77612. protected _setRootMesh(meshes: AbstractMesh[]): void;
  77613. protected _updateModel(): void;
  77614. /**
  77615. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  77616. * between the touch and touch 2.
  77617. */
  77618. private _isQuest;
  77619. }
  77620. }
  77621. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  77622. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  77623. import { Scene } from "babylonjs/scene";
  77624. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  77625. /**
  77626. * The motion controller class for the standard HTC-Vive controllers
  77627. */
  77628. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  77629. private _modelRootNode;
  77630. /**
  77631. * The base url used to load the left and right controller models
  77632. */
  77633. static MODEL_BASE_URL: string;
  77634. /**
  77635. * File name for the controller model.
  77636. */
  77637. static MODEL_FILENAME: string;
  77638. profileId: string;
  77639. /**
  77640. * Create a new Vive motion controller object
  77641. * @param scene the scene to use to create this controller
  77642. * @param gamepadObject the corresponding gamepad object
  77643. * @param handedness the handedness of the controller
  77644. */
  77645. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  77646. protected _getFilenameAndPath(): {
  77647. filename: string;
  77648. path: string;
  77649. };
  77650. protected _getModelLoadingConstraints(): boolean;
  77651. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  77652. protected _setRootMesh(meshes: AbstractMesh[]): void;
  77653. protected _updateModel(): void;
  77654. }
  77655. }
  77656. declare module "babylonjs/XR/motionController/index" {
  77657. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  77658. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  77659. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  77660. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  77661. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  77662. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  77663. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  77664. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  77665. }
  77666. declare module "babylonjs/XR/index" {
  77667. export * from "babylonjs/XR/webXRCamera";
  77668. export * from "babylonjs/XR/webXREnterExitUI";
  77669. export * from "babylonjs/XR/webXRExperienceHelper";
  77670. export * from "babylonjs/XR/webXRInput";
  77671. export * from "babylonjs/XR/webXRInputSource";
  77672. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  77673. export * from "babylonjs/XR/webXRTypes";
  77674. export * from "babylonjs/XR/webXRSessionManager";
  77675. export * from "babylonjs/XR/webXRDefaultExperience";
  77676. export * from "babylonjs/XR/webXRFeaturesManager";
  77677. export * from "babylonjs/XR/features/index";
  77678. export * from "babylonjs/XR/motionController/index";
  77679. }
  77680. declare module "babylonjs/index" {
  77681. export * from "babylonjs/abstractScene";
  77682. export * from "babylonjs/Actions/index";
  77683. export * from "babylonjs/Animations/index";
  77684. export * from "babylonjs/assetContainer";
  77685. export * from "babylonjs/Audio/index";
  77686. export * from "babylonjs/Behaviors/index";
  77687. export * from "babylonjs/Bones/index";
  77688. export * from "babylonjs/Cameras/index";
  77689. export * from "babylonjs/Collisions/index";
  77690. export * from "babylonjs/Culling/index";
  77691. export * from "babylonjs/Debug/index";
  77692. export * from "babylonjs/DeviceInput/index";
  77693. export * from "babylonjs/Engines/index";
  77694. export * from "babylonjs/Events/index";
  77695. export * from "babylonjs/Gamepads/index";
  77696. export * from "babylonjs/Gizmos/index";
  77697. export * from "babylonjs/Helpers/index";
  77698. export * from "babylonjs/Instrumentation/index";
  77699. export * from "babylonjs/Layers/index";
  77700. export * from "babylonjs/LensFlares/index";
  77701. export * from "babylonjs/Lights/index";
  77702. export * from "babylonjs/Loading/index";
  77703. export * from "babylonjs/Materials/index";
  77704. export * from "babylonjs/Maths/index";
  77705. export * from "babylonjs/Meshes/index";
  77706. export * from "babylonjs/Morph/index";
  77707. export * from "babylonjs/Navigation/index";
  77708. export * from "babylonjs/node";
  77709. export * from "babylonjs/Offline/index";
  77710. export * from "babylonjs/Particles/index";
  77711. export * from "babylonjs/Physics/index";
  77712. export * from "babylonjs/PostProcesses/index";
  77713. export * from "babylonjs/Probes/index";
  77714. export * from "babylonjs/Rendering/index";
  77715. export * from "babylonjs/scene";
  77716. export * from "babylonjs/sceneComponent";
  77717. export * from "babylonjs/Sprites/index";
  77718. export * from "babylonjs/States/index";
  77719. export * from "babylonjs/Misc/index";
  77720. export * from "babylonjs/XR/index";
  77721. export * from "babylonjs/types";
  77722. }
  77723. declare module "babylonjs/Animations/pathCursor" {
  77724. import { Vector3 } from "babylonjs/Maths/math.vector";
  77725. import { Path2 } from "babylonjs/Maths/math.path";
  77726. /**
  77727. * A cursor which tracks a point on a path
  77728. */
  77729. export class PathCursor {
  77730. private path;
  77731. /**
  77732. * Stores path cursor callbacks for when an onchange event is triggered
  77733. */
  77734. private _onchange;
  77735. /**
  77736. * The value of the path cursor
  77737. */
  77738. value: number;
  77739. /**
  77740. * The animation array of the path cursor
  77741. */
  77742. animations: Animation[];
  77743. /**
  77744. * Initializes the path cursor
  77745. * @param path The path to track
  77746. */
  77747. constructor(path: Path2);
  77748. /**
  77749. * Gets the cursor point on the path
  77750. * @returns A point on the path cursor at the cursor location
  77751. */
  77752. getPoint(): Vector3;
  77753. /**
  77754. * Moves the cursor ahead by the step amount
  77755. * @param step The amount to move the cursor forward
  77756. * @returns This path cursor
  77757. */
  77758. moveAhead(step?: number): PathCursor;
  77759. /**
  77760. * Moves the cursor behind by the step amount
  77761. * @param step The amount to move the cursor back
  77762. * @returns This path cursor
  77763. */
  77764. moveBack(step?: number): PathCursor;
  77765. /**
  77766. * Moves the cursor by the step amount
  77767. * If the step amount is greater than one, an exception is thrown
  77768. * @param step The amount to move the cursor
  77769. * @returns This path cursor
  77770. */
  77771. move(step: number): PathCursor;
  77772. /**
  77773. * Ensures that the value is limited between zero and one
  77774. * @returns This path cursor
  77775. */
  77776. private ensureLimits;
  77777. /**
  77778. * Runs onchange callbacks on change (used by the animation engine)
  77779. * @returns This path cursor
  77780. */
  77781. private raiseOnChange;
  77782. /**
  77783. * Executes a function on change
  77784. * @param f A path cursor onchange callback
  77785. * @returns This path cursor
  77786. */
  77787. onchange(f: (cursor: PathCursor) => void): PathCursor;
  77788. }
  77789. }
  77790. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  77791. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  77792. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  77793. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  77794. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  77795. }
  77796. declare module "babylonjs/Engines/Processors/Expressions/index" {
  77797. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  77798. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  77799. }
  77800. declare module "babylonjs/Engines/Processors/index" {
  77801. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  77802. export * from "babylonjs/Engines/Processors/Expressions/index";
  77803. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  77804. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  77805. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  77806. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  77807. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  77808. export * from "babylonjs/Engines/Processors/shaderProcessor";
  77809. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  77810. }
  77811. declare module "babylonjs/Legacy/legacy" {
  77812. import * as Babylon from "babylonjs/index";
  77813. export * from "babylonjs/index";
  77814. }
  77815. declare module "babylonjs/Shaders/blur.fragment" {
  77816. /** @hidden */
  77817. export var blurPixelShader: {
  77818. name: string;
  77819. shader: string;
  77820. };
  77821. }
  77822. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  77823. /** @hidden */
  77824. export var pointCloudVertexDeclaration: {
  77825. name: string;
  77826. shader: string;
  77827. };
  77828. }
  77829. declare module "babylonjs" {
  77830. export * from "babylonjs/Legacy/legacy";
  77831. }
  77832. declare module BABYLON {
  77833. /** Alias type for value that can be null */
  77834. export type Nullable<T> = T | null;
  77835. /**
  77836. * Alias type for number that are floats
  77837. * @ignorenaming
  77838. */
  77839. export type float = number;
  77840. /**
  77841. * Alias type for number that are doubles.
  77842. * @ignorenaming
  77843. */
  77844. export type double = number;
  77845. /**
  77846. * Alias type for number that are integer
  77847. * @ignorenaming
  77848. */
  77849. export type int = number;
  77850. /** Alias type for number array or Float32Array */
  77851. export type FloatArray = number[] | Float32Array;
  77852. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  77853. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  77854. /**
  77855. * Alias for types that can be used by a Buffer or VertexBuffer.
  77856. */
  77857. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  77858. /**
  77859. * Alias type for primitive types
  77860. * @ignorenaming
  77861. */
  77862. type Primitive = undefined | null | boolean | string | number | Function;
  77863. /**
  77864. * Type modifier to make all the properties of an object Readonly
  77865. */
  77866. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  77867. /**
  77868. * Type modifier to make all the properties of an object Readonly recursively
  77869. */
  77870. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  77871. /**
  77872. * Type modifier to make object properties readonly.
  77873. */
  77874. export type DeepImmutableObject<T> = {
  77875. readonly [K in keyof T]: DeepImmutable<T[K]>;
  77876. };
  77877. /** @hidden */
  77878. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  77879. }
  77880. }
  77881. declare module BABYLON {
  77882. /**
  77883. * A class serves as a medium between the observable and its observers
  77884. */
  77885. export class EventState {
  77886. /**
  77887. * Create a new EventState
  77888. * @param mask defines the mask associated with this state
  77889. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  77890. * @param target defines the original target of the state
  77891. * @param currentTarget defines the current target of the state
  77892. */
  77893. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  77894. /**
  77895. * Initialize the current event state
  77896. * @param mask defines the mask associated with this state
  77897. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  77898. * @param target defines the original target of the state
  77899. * @param currentTarget defines the current target of the state
  77900. * @returns the current event state
  77901. */
  77902. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  77903. /**
  77904. * An Observer can set this property to true to prevent subsequent observers of being notified
  77905. */
  77906. skipNextObservers: boolean;
  77907. /**
  77908. * Get the mask value that were used to trigger the event corresponding to this EventState object
  77909. */
  77910. mask: number;
  77911. /**
  77912. * The object that originally notified the event
  77913. */
  77914. target?: any;
  77915. /**
  77916. * The current object in the bubbling phase
  77917. */
  77918. currentTarget?: any;
  77919. /**
  77920. * This will be populated with the return value of the last function that was executed.
  77921. * If it is the first function in the callback chain it will be the event data.
  77922. */
  77923. lastReturnValue?: any;
  77924. }
  77925. /**
  77926. * Represent an Observer registered to a given Observable object.
  77927. */
  77928. export class Observer<T> {
  77929. /**
  77930. * Defines the callback to call when the observer is notified
  77931. */
  77932. callback: (eventData: T, eventState: EventState) => void;
  77933. /**
  77934. * Defines the mask of the observer (used to filter notifications)
  77935. */
  77936. mask: number;
  77937. /**
  77938. * Defines the current scope used to restore the JS context
  77939. */
  77940. scope: any;
  77941. /** @hidden */
  77942. _willBeUnregistered: boolean;
  77943. /**
  77944. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  77945. */
  77946. unregisterOnNextCall: boolean;
  77947. /**
  77948. * Creates a new observer
  77949. * @param callback defines the callback to call when the observer is notified
  77950. * @param mask defines the mask of the observer (used to filter notifications)
  77951. * @param scope defines the current scope used to restore the JS context
  77952. */
  77953. constructor(
  77954. /**
  77955. * Defines the callback to call when the observer is notified
  77956. */
  77957. callback: (eventData: T, eventState: EventState) => void,
  77958. /**
  77959. * Defines the mask of the observer (used to filter notifications)
  77960. */
  77961. mask: number,
  77962. /**
  77963. * Defines the current scope used to restore the JS context
  77964. */
  77965. scope?: any);
  77966. }
  77967. /**
  77968. * Represent a list of observers registered to multiple Observables object.
  77969. */
  77970. export class MultiObserver<T> {
  77971. private _observers;
  77972. private _observables;
  77973. /**
  77974. * Release associated resources
  77975. */
  77976. dispose(): void;
  77977. /**
  77978. * Raise a callback when one of the observable will notify
  77979. * @param observables defines a list of observables to watch
  77980. * @param callback defines the callback to call on notification
  77981. * @param mask defines the mask used to filter notifications
  77982. * @param scope defines the current scope used to restore the JS context
  77983. * @returns the new MultiObserver
  77984. */
  77985. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  77986. }
  77987. /**
  77988. * The Observable class is a simple implementation of the Observable pattern.
  77989. *
  77990. * 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.
  77991. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  77992. * 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).
  77993. * 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.
  77994. */
  77995. export class Observable<T> {
  77996. private _observers;
  77997. private _eventState;
  77998. private _onObserverAdded;
  77999. /**
  78000. * Gets the list of observers
  78001. */
  78002. get observers(): Array<Observer<T>>;
  78003. /**
  78004. * Creates a new observable
  78005. * @param onObserverAdded defines a callback to call when a new observer is added
  78006. */
  78007. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  78008. /**
  78009. * Create a new Observer with the specified callback
  78010. * @param callback the callback that will be executed for that Observer
  78011. * @param mask the mask used to filter observers
  78012. * @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.
  78013. * @param scope optional scope for the callback to be called from
  78014. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  78015. * @returns the new observer created for the callback
  78016. */
  78017. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  78018. /**
  78019. * Create a new Observer with the specified callback and unregisters after the next notification
  78020. * @param callback the callback that will be executed for that Observer
  78021. * @returns the new observer created for the callback
  78022. */
  78023. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  78024. /**
  78025. * Remove an Observer from the Observable object
  78026. * @param observer the instance of the Observer to remove
  78027. * @returns false if it doesn't belong to this Observable
  78028. */
  78029. remove(observer: Nullable<Observer<T>>): boolean;
  78030. /**
  78031. * Remove a callback from the Observable object
  78032. * @param callback the callback to remove
  78033. * @param scope optional scope. If used only the callbacks with this scope will be removed
  78034. * @returns false if it doesn't belong to this Observable
  78035. */
  78036. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  78037. private _deferUnregister;
  78038. private _remove;
  78039. /**
  78040. * Moves the observable to the top of the observer list making it get called first when notified
  78041. * @param observer the observer to move
  78042. */
  78043. makeObserverTopPriority(observer: Observer<T>): void;
  78044. /**
  78045. * Moves the observable to the bottom of the observer list making it get called last when notified
  78046. * @param observer the observer to move
  78047. */
  78048. makeObserverBottomPriority(observer: Observer<T>): void;
  78049. /**
  78050. * Notify all Observers by calling their respective callback with the given data
  78051. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  78052. * @param eventData defines the data to send to all observers
  78053. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  78054. * @param target defines the original target of the state
  78055. * @param currentTarget defines the current target of the state
  78056. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  78057. */
  78058. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  78059. /**
  78060. * Calling this will execute each callback, expecting it to be a promise or return a value.
  78061. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  78062. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  78063. * and it is crucial that all callbacks will be executed.
  78064. * The order of the callbacks is kept, callbacks are not executed parallel.
  78065. *
  78066. * @param eventData The data to be sent to each callback
  78067. * @param mask is used to filter observers defaults to -1
  78068. * @param target defines the callback target (see EventState)
  78069. * @param currentTarget defines he current object in the bubbling phase
  78070. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  78071. */
  78072. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  78073. /**
  78074. * Notify a specific observer
  78075. * @param observer defines the observer to notify
  78076. * @param eventData defines the data to be sent to each callback
  78077. * @param mask is used to filter observers defaults to -1
  78078. */
  78079. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  78080. /**
  78081. * Gets a boolean indicating if the observable has at least one observer
  78082. * @returns true is the Observable has at least one Observer registered
  78083. */
  78084. hasObservers(): boolean;
  78085. /**
  78086. * Clear the list of observers
  78087. */
  78088. clear(): void;
  78089. /**
  78090. * Clone the current observable
  78091. * @returns a new observable
  78092. */
  78093. clone(): Observable<T>;
  78094. /**
  78095. * Does this observable handles observer registered with a given mask
  78096. * @param mask defines the mask to be tested
  78097. * @return whether or not one observer registered with the given mask is handeled
  78098. **/
  78099. hasSpecificMask(mask?: number): boolean;
  78100. }
  78101. }
  78102. declare module BABYLON {
  78103. /**
  78104. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  78105. * Babylon.js
  78106. */
  78107. export class DomManagement {
  78108. /**
  78109. * Checks if the window object exists
  78110. * @returns true if the window object exists
  78111. */
  78112. static IsWindowObjectExist(): boolean;
  78113. /**
  78114. * Checks if the navigator object exists
  78115. * @returns true if the navigator object exists
  78116. */
  78117. static IsNavigatorAvailable(): boolean;
  78118. /**
  78119. * Check if the document object exists
  78120. * @returns true if the document object exists
  78121. */
  78122. static IsDocumentAvailable(): boolean;
  78123. /**
  78124. * Extracts text content from a DOM element hierarchy
  78125. * @param element defines the root element
  78126. * @returns a string
  78127. */
  78128. static GetDOMTextContent(element: HTMLElement): string;
  78129. }
  78130. }
  78131. declare module BABYLON {
  78132. /**
  78133. * Logger used througouht the application to allow configuration of
  78134. * the log level required for the messages.
  78135. */
  78136. export class Logger {
  78137. /**
  78138. * No log
  78139. */
  78140. static readonly NoneLogLevel: number;
  78141. /**
  78142. * Only message logs
  78143. */
  78144. static readonly MessageLogLevel: number;
  78145. /**
  78146. * Only warning logs
  78147. */
  78148. static readonly WarningLogLevel: number;
  78149. /**
  78150. * Only error logs
  78151. */
  78152. static readonly ErrorLogLevel: number;
  78153. /**
  78154. * All logs
  78155. */
  78156. static readonly AllLogLevel: number;
  78157. private static _LogCache;
  78158. /**
  78159. * Gets a value indicating the number of loading errors
  78160. * @ignorenaming
  78161. */
  78162. static errorsCount: number;
  78163. /**
  78164. * Callback called when a new log is added
  78165. */
  78166. static OnNewCacheEntry: (entry: string) => void;
  78167. private static _AddLogEntry;
  78168. private static _FormatMessage;
  78169. private static _LogDisabled;
  78170. private static _LogEnabled;
  78171. private static _WarnDisabled;
  78172. private static _WarnEnabled;
  78173. private static _ErrorDisabled;
  78174. private static _ErrorEnabled;
  78175. /**
  78176. * Log a message to the console
  78177. */
  78178. static Log: (message: string) => void;
  78179. /**
  78180. * Write a warning message to the console
  78181. */
  78182. static Warn: (message: string) => void;
  78183. /**
  78184. * Write an error message to the console
  78185. */
  78186. static Error: (message: string) => void;
  78187. /**
  78188. * Gets current log cache (list of logs)
  78189. */
  78190. static get LogCache(): string;
  78191. /**
  78192. * Clears the log cache
  78193. */
  78194. static ClearLogCache(): void;
  78195. /**
  78196. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  78197. */
  78198. static set LogLevels(level: number);
  78199. }
  78200. }
  78201. declare module BABYLON {
  78202. /** @hidden */
  78203. export class _TypeStore {
  78204. /** @hidden */
  78205. static RegisteredTypes: {
  78206. [key: string]: Object;
  78207. };
  78208. /** @hidden */
  78209. static GetClass(fqdn: string): any;
  78210. }
  78211. }
  78212. declare module BABYLON {
  78213. /**
  78214. * Helper to manipulate strings
  78215. */
  78216. export class StringTools {
  78217. /**
  78218. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  78219. * @param str Source string
  78220. * @param suffix Suffix to search for in the source string
  78221. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  78222. */
  78223. static EndsWith(str: string, suffix: string): boolean;
  78224. /**
  78225. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  78226. * @param str Source string
  78227. * @param suffix Suffix to search for in the source string
  78228. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  78229. */
  78230. static StartsWith(str: string, suffix: string): boolean;
  78231. /**
  78232. * Decodes a buffer into a string
  78233. * @param buffer The buffer to decode
  78234. * @returns The decoded string
  78235. */
  78236. static Decode(buffer: Uint8Array | Uint16Array): string;
  78237. /**
  78238. * Encode a buffer to a base64 string
  78239. * @param buffer defines the buffer to encode
  78240. * @returns the encoded string
  78241. */
  78242. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  78243. /**
  78244. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  78245. * @param num the number to convert and pad
  78246. * @param length the expected length of the string
  78247. * @returns the padded string
  78248. */
  78249. static PadNumber(num: number, length: number): string;
  78250. }
  78251. }
  78252. declare module BABYLON {
  78253. /**
  78254. * Class containing a set of static utilities functions for deep copy.
  78255. */
  78256. export class DeepCopier {
  78257. /**
  78258. * Tries to copy an object by duplicating every property
  78259. * @param source defines the source object
  78260. * @param destination defines the target object
  78261. * @param doNotCopyList defines a list of properties to avoid
  78262. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  78263. */
  78264. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  78265. }
  78266. }
  78267. declare module BABYLON {
  78268. /**
  78269. * Class containing a set of static utilities functions for precision date
  78270. */
  78271. export class PrecisionDate {
  78272. /**
  78273. * Gets either window.performance.now() if supported or Date.now() else
  78274. */
  78275. static get Now(): number;
  78276. }
  78277. }
  78278. declare module BABYLON {
  78279. /** @hidden */
  78280. export class _DevTools {
  78281. static WarnImport(name: string): string;
  78282. }
  78283. }
  78284. declare module BABYLON {
  78285. /**
  78286. * Interface used to define the mechanism to get data from the network
  78287. */
  78288. export interface IWebRequest {
  78289. /**
  78290. * Returns client's response url
  78291. */
  78292. responseURL: string;
  78293. /**
  78294. * Returns client's status
  78295. */
  78296. status: number;
  78297. /**
  78298. * Returns client's status as a text
  78299. */
  78300. statusText: string;
  78301. }
  78302. }
  78303. declare module BABYLON {
  78304. /**
  78305. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  78306. */
  78307. export class WebRequest implements IWebRequest {
  78308. private _xhr;
  78309. /**
  78310. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  78311. * i.e. when loading files, where the server/service expects an Authorization header
  78312. */
  78313. static CustomRequestHeaders: {
  78314. [key: string]: string;
  78315. };
  78316. /**
  78317. * Add callback functions in this array to update all the requests before they get sent to the network
  78318. */
  78319. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  78320. private _injectCustomRequestHeaders;
  78321. /**
  78322. * Gets or sets a function to be called when loading progress changes
  78323. */
  78324. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  78325. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  78326. /**
  78327. * Returns client's state
  78328. */
  78329. get readyState(): number;
  78330. /**
  78331. * Returns client's status
  78332. */
  78333. get status(): number;
  78334. /**
  78335. * Returns client's status as a text
  78336. */
  78337. get statusText(): string;
  78338. /**
  78339. * Returns client's response
  78340. */
  78341. get response(): any;
  78342. /**
  78343. * Returns client's response url
  78344. */
  78345. get responseURL(): string;
  78346. /**
  78347. * Returns client's response as text
  78348. */
  78349. get responseText(): string;
  78350. /**
  78351. * Gets or sets the expected response type
  78352. */
  78353. get responseType(): XMLHttpRequestResponseType;
  78354. set responseType(value: XMLHttpRequestResponseType);
  78355. /** @hidden */
  78356. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  78357. /** @hidden */
  78358. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  78359. /**
  78360. * Cancels any network activity
  78361. */
  78362. abort(): void;
  78363. /**
  78364. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  78365. * @param body defines an optional request body
  78366. */
  78367. send(body?: Document | BodyInit | null): void;
  78368. /**
  78369. * Sets the request method, request URL
  78370. * @param method defines the method to use (GET, POST, etc..)
  78371. * @param url defines the url to connect with
  78372. */
  78373. open(method: string, url: string): void;
  78374. /**
  78375. * Sets the value of a request header.
  78376. * @param name The name of the header whose value is to be set
  78377. * @param value The value to set as the body of the header
  78378. */
  78379. setRequestHeader(name: string, value: string): void;
  78380. /**
  78381. * Get the string containing the text of a particular header's value.
  78382. * @param name The name of the header
  78383. * @returns The string containing the text of the given header name
  78384. */
  78385. getResponseHeader(name: string): Nullable<string>;
  78386. }
  78387. }
  78388. declare module BABYLON {
  78389. /**
  78390. * File request interface
  78391. */
  78392. export interface IFileRequest {
  78393. /**
  78394. * Raised when the request is complete (success or error).
  78395. */
  78396. onCompleteObservable: Observable<IFileRequest>;
  78397. /**
  78398. * Aborts the request for a file.
  78399. */
  78400. abort: () => void;
  78401. }
  78402. }
  78403. declare module BABYLON {
  78404. /**
  78405. * Define options used to create a render target texture
  78406. */
  78407. export class RenderTargetCreationOptions {
  78408. /**
  78409. * Specifies is mipmaps must be generated
  78410. */
  78411. generateMipMaps?: boolean;
  78412. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  78413. generateDepthBuffer?: boolean;
  78414. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  78415. generateStencilBuffer?: boolean;
  78416. /** Defines texture type (int by default) */
  78417. type?: number;
  78418. /** Defines sampling mode (trilinear by default) */
  78419. samplingMode?: number;
  78420. /** Defines format (RGBA by default) */
  78421. format?: number;
  78422. }
  78423. }
  78424. declare module BABYLON {
  78425. /** Defines the cross module used constants to avoid circular dependncies */
  78426. export class Constants {
  78427. /** Defines that alpha blending is disabled */
  78428. static readonly ALPHA_DISABLE: number;
  78429. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  78430. static readonly ALPHA_ADD: number;
  78431. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  78432. static readonly ALPHA_COMBINE: number;
  78433. /** Defines that alpha blending is DEST - SRC * DEST */
  78434. static readonly ALPHA_SUBTRACT: number;
  78435. /** Defines that alpha blending is SRC * DEST */
  78436. static readonly ALPHA_MULTIPLY: number;
  78437. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  78438. static readonly ALPHA_MAXIMIZED: number;
  78439. /** Defines that alpha blending is SRC + DEST */
  78440. static readonly ALPHA_ONEONE: number;
  78441. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  78442. static readonly ALPHA_PREMULTIPLIED: number;
  78443. /**
  78444. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  78445. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  78446. */
  78447. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  78448. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  78449. static readonly ALPHA_INTERPOLATE: number;
  78450. /**
  78451. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  78452. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  78453. */
  78454. static readonly ALPHA_SCREENMODE: number;
  78455. /**
  78456. * Defines that alpha blending is SRC + DST
  78457. * Alpha will be set to SRC ALPHA + DST ALPHA
  78458. */
  78459. static readonly ALPHA_ONEONE_ONEONE: number;
  78460. /**
  78461. * Defines that alpha blending is SRC * DST ALPHA + DST
  78462. * Alpha will be set to 0
  78463. */
  78464. static readonly ALPHA_ALPHATOCOLOR: number;
  78465. /**
  78466. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  78467. */
  78468. static readonly ALPHA_REVERSEONEMINUS: number;
  78469. /**
  78470. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  78471. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  78472. */
  78473. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  78474. /**
  78475. * Defines that alpha blending is SRC + DST
  78476. * Alpha will be set to SRC ALPHA
  78477. */
  78478. static readonly ALPHA_ONEONE_ONEZERO: number;
  78479. /**
  78480. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  78481. * Alpha will be set to DST ALPHA
  78482. */
  78483. static readonly ALPHA_EXCLUSION: number;
  78484. /** Defines that alpha blending equation a SUM */
  78485. static readonly ALPHA_EQUATION_ADD: number;
  78486. /** Defines that alpha blending equation a SUBSTRACTION */
  78487. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  78488. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  78489. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  78490. /** Defines that alpha blending equation a MAX operation */
  78491. static readonly ALPHA_EQUATION_MAX: number;
  78492. /** Defines that alpha blending equation a MIN operation */
  78493. static readonly ALPHA_EQUATION_MIN: number;
  78494. /**
  78495. * Defines that alpha blending equation a DARKEN operation:
  78496. * It takes the min of the src and sums the alpha channels.
  78497. */
  78498. static readonly ALPHA_EQUATION_DARKEN: number;
  78499. /** Defines that the ressource is not delayed*/
  78500. static readonly DELAYLOADSTATE_NONE: number;
  78501. /** Defines that the ressource was successfully delay loaded */
  78502. static readonly DELAYLOADSTATE_LOADED: number;
  78503. /** Defines that the ressource is currently delay loading */
  78504. static readonly DELAYLOADSTATE_LOADING: number;
  78505. /** Defines that the ressource is delayed and has not started loading */
  78506. static readonly DELAYLOADSTATE_NOTLOADED: number;
  78507. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  78508. static readonly NEVER: number;
  78509. /** 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 */
  78510. static readonly ALWAYS: number;
  78511. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  78512. static readonly LESS: number;
  78513. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  78514. static readonly EQUAL: number;
  78515. /** 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 */
  78516. static readonly LEQUAL: number;
  78517. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  78518. static readonly GREATER: number;
  78519. /** 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 */
  78520. static readonly GEQUAL: number;
  78521. /** 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 */
  78522. static readonly NOTEQUAL: number;
  78523. /** Passed to stencilOperation to specify that stencil value must be kept */
  78524. static readonly KEEP: number;
  78525. /** Passed to stencilOperation to specify that stencil value must be replaced */
  78526. static readonly REPLACE: number;
  78527. /** Passed to stencilOperation to specify that stencil value must be incremented */
  78528. static readonly INCR: number;
  78529. /** Passed to stencilOperation to specify that stencil value must be decremented */
  78530. static readonly DECR: number;
  78531. /** Passed to stencilOperation to specify that stencil value must be inverted */
  78532. static readonly INVERT: number;
  78533. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  78534. static readonly INCR_WRAP: number;
  78535. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  78536. static readonly DECR_WRAP: number;
  78537. /** Texture is not repeating outside of 0..1 UVs */
  78538. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  78539. /** Texture is repeating outside of 0..1 UVs */
  78540. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  78541. /** Texture is repeating and mirrored */
  78542. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  78543. /** ALPHA */
  78544. static readonly TEXTUREFORMAT_ALPHA: number;
  78545. /** LUMINANCE */
  78546. static readonly TEXTUREFORMAT_LUMINANCE: number;
  78547. /** LUMINANCE_ALPHA */
  78548. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  78549. /** RGB */
  78550. static readonly TEXTUREFORMAT_RGB: number;
  78551. /** RGBA */
  78552. static readonly TEXTUREFORMAT_RGBA: number;
  78553. /** RED */
  78554. static readonly TEXTUREFORMAT_RED: number;
  78555. /** RED (2nd reference) */
  78556. static readonly TEXTUREFORMAT_R: number;
  78557. /** RG */
  78558. static readonly TEXTUREFORMAT_RG: number;
  78559. /** RED_INTEGER */
  78560. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  78561. /** RED_INTEGER (2nd reference) */
  78562. static readonly TEXTUREFORMAT_R_INTEGER: number;
  78563. /** RG_INTEGER */
  78564. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  78565. /** RGB_INTEGER */
  78566. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  78567. /** RGBA_INTEGER */
  78568. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  78569. /** UNSIGNED_BYTE */
  78570. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  78571. /** UNSIGNED_BYTE (2nd reference) */
  78572. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  78573. /** FLOAT */
  78574. static readonly TEXTURETYPE_FLOAT: number;
  78575. /** HALF_FLOAT */
  78576. static readonly TEXTURETYPE_HALF_FLOAT: number;
  78577. /** BYTE */
  78578. static readonly TEXTURETYPE_BYTE: number;
  78579. /** SHORT */
  78580. static readonly TEXTURETYPE_SHORT: number;
  78581. /** UNSIGNED_SHORT */
  78582. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  78583. /** INT */
  78584. static readonly TEXTURETYPE_INT: number;
  78585. /** UNSIGNED_INT */
  78586. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  78587. /** UNSIGNED_SHORT_4_4_4_4 */
  78588. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  78589. /** UNSIGNED_SHORT_5_5_5_1 */
  78590. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  78591. /** UNSIGNED_SHORT_5_6_5 */
  78592. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  78593. /** UNSIGNED_INT_2_10_10_10_REV */
  78594. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  78595. /** UNSIGNED_INT_24_8 */
  78596. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  78597. /** UNSIGNED_INT_10F_11F_11F_REV */
  78598. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  78599. /** UNSIGNED_INT_5_9_9_9_REV */
  78600. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  78601. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  78602. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  78603. /** nearest is mag = nearest and min = nearest and no mip */
  78604. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  78605. /** mag = nearest and min = nearest and mip = none */
  78606. static readonly TEXTURE_NEAREST_NEAREST: number;
  78607. /** Bilinear is mag = linear and min = linear and no mip */
  78608. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  78609. /** mag = linear and min = linear and mip = none */
  78610. static readonly TEXTURE_LINEAR_LINEAR: number;
  78611. /** Trilinear is mag = linear and min = linear and mip = linear */
  78612. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  78613. /** Trilinear is mag = linear and min = linear and mip = linear */
  78614. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  78615. /** mag = nearest and min = nearest and mip = nearest */
  78616. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  78617. /** mag = nearest and min = linear and mip = nearest */
  78618. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  78619. /** mag = nearest and min = linear and mip = linear */
  78620. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  78621. /** mag = nearest and min = linear and mip = none */
  78622. static readonly TEXTURE_NEAREST_LINEAR: number;
  78623. /** nearest is mag = nearest and min = nearest and mip = linear */
  78624. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  78625. /** mag = linear and min = nearest and mip = nearest */
  78626. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  78627. /** mag = linear and min = nearest and mip = linear */
  78628. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  78629. /** Bilinear is mag = linear and min = linear and mip = nearest */
  78630. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  78631. /** mag = linear and min = nearest and mip = none */
  78632. static readonly TEXTURE_LINEAR_NEAREST: number;
  78633. /** Explicit coordinates mode */
  78634. static readonly TEXTURE_EXPLICIT_MODE: number;
  78635. /** Spherical coordinates mode */
  78636. static readonly TEXTURE_SPHERICAL_MODE: number;
  78637. /** Planar coordinates mode */
  78638. static readonly TEXTURE_PLANAR_MODE: number;
  78639. /** Cubic coordinates mode */
  78640. static readonly TEXTURE_CUBIC_MODE: number;
  78641. /** Projection coordinates mode */
  78642. static readonly TEXTURE_PROJECTION_MODE: number;
  78643. /** Skybox coordinates mode */
  78644. static readonly TEXTURE_SKYBOX_MODE: number;
  78645. /** Inverse Cubic coordinates mode */
  78646. static readonly TEXTURE_INVCUBIC_MODE: number;
  78647. /** Equirectangular coordinates mode */
  78648. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  78649. /** Equirectangular Fixed coordinates mode */
  78650. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  78651. /** Equirectangular Fixed Mirrored coordinates mode */
  78652. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  78653. /** Offline (baking) quality for texture filtering */
  78654. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  78655. /** High quality for texture filtering */
  78656. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  78657. /** Medium quality for texture filtering */
  78658. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  78659. /** Low quality for texture filtering */
  78660. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  78661. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  78662. static readonly SCALEMODE_FLOOR: number;
  78663. /** Defines that texture rescaling will look for the nearest power of 2 size */
  78664. static readonly SCALEMODE_NEAREST: number;
  78665. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  78666. static readonly SCALEMODE_CEILING: number;
  78667. /**
  78668. * The dirty texture flag value
  78669. */
  78670. static readonly MATERIAL_TextureDirtyFlag: number;
  78671. /**
  78672. * The dirty light flag value
  78673. */
  78674. static readonly MATERIAL_LightDirtyFlag: number;
  78675. /**
  78676. * The dirty fresnel flag value
  78677. */
  78678. static readonly MATERIAL_FresnelDirtyFlag: number;
  78679. /**
  78680. * The dirty attribute flag value
  78681. */
  78682. static readonly MATERIAL_AttributesDirtyFlag: number;
  78683. /**
  78684. * The dirty misc flag value
  78685. */
  78686. static readonly MATERIAL_MiscDirtyFlag: number;
  78687. /**
  78688. * The all dirty flag value
  78689. */
  78690. static readonly MATERIAL_AllDirtyFlag: number;
  78691. /**
  78692. * Returns the triangle fill mode
  78693. */
  78694. static readonly MATERIAL_TriangleFillMode: number;
  78695. /**
  78696. * Returns the wireframe mode
  78697. */
  78698. static readonly MATERIAL_WireFrameFillMode: number;
  78699. /**
  78700. * Returns the point fill mode
  78701. */
  78702. static readonly MATERIAL_PointFillMode: number;
  78703. /**
  78704. * Returns the point list draw mode
  78705. */
  78706. static readonly MATERIAL_PointListDrawMode: number;
  78707. /**
  78708. * Returns the line list draw mode
  78709. */
  78710. static readonly MATERIAL_LineListDrawMode: number;
  78711. /**
  78712. * Returns the line loop draw mode
  78713. */
  78714. static readonly MATERIAL_LineLoopDrawMode: number;
  78715. /**
  78716. * Returns the line strip draw mode
  78717. */
  78718. static readonly MATERIAL_LineStripDrawMode: number;
  78719. /**
  78720. * Returns the triangle strip draw mode
  78721. */
  78722. static readonly MATERIAL_TriangleStripDrawMode: number;
  78723. /**
  78724. * Returns the triangle fan draw mode
  78725. */
  78726. static readonly MATERIAL_TriangleFanDrawMode: number;
  78727. /**
  78728. * Stores the clock-wise side orientation
  78729. */
  78730. static readonly MATERIAL_ClockWiseSideOrientation: number;
  78731. /**
  78732. * Stores the counter clock-wise side orientation
  78733. */
  78734. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  78735. /**
  78736. * Nothing
  78737. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78738. */
  78739. static readonly ACTION_NothingTrigger: number;
  78740. /**
  78741. * On pick
  78742. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78743. */
  78744. static readonly ACTION_OnPickTrigger: number;
  78745. /**
  78746. * On left pick
  78747. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78748. */
  78749. static readonly ACTION_OnLeftPickTrigger: number;
  78750. /**
  78751. * On right pick
  78752. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78753. */
  78754. static readonly ACTION_OnRightPickTrigger: number;
  78755. /**
  78756. * On center pick
  78757. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78758. */
  78759. static readonly ACTION_OnCenterPickTrigger: number;
  78760. /**
  78761. * On pick down
  78762. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78763. */
  78764. static readonly ACTION_OnPickDownTrigger: number;
  78765. /**
  78766. * On double pick
  78767. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78768. */
  78769. static readonly ACTION_OnDoublePickTrigger: number;
  78770. /**
  78771. * On pick up
  78772. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78773. */
  78774. static readonly ACTION_OnPickUpTrigger: number;
  78775. /**
  78776. * On pick out.
  78777. * This trigger will only be raised if you also declared a OnPickDown
  78778. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78779. */
  78780. static readonly ACTION_OnPickOutTrigger: number;
  78781. /**
  78782. * On long press
  78783. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78784. */
  78785. static readonly ACTION_OnLongPressTrigger: number;
  78786. /**
  78787. * On pointer over
  78788. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78789. */
  78790. static readonly ACTION_OnPointerOverTrigger: number;
  78791. /**
  78792. * On pointer out
  78793. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78794. */
  78795. static readonly ACTION_OnPointerOutTrigger: number;
  78796. /**
  78797. * On every frame
  78798. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78799. */
  78800. static readonly ACTION_OnEveryFrameTrigger: number;
  78801. /**
  78802. * On intersection enter
  78803. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78804. */
  78805. static readonly ACTION_OnIntersectionEnterTrigger: number;
  78806. /**
  78807. * On intersection exit
  78808. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78809. */
  78810. static readonly ACTION_OnIntersectionExitTrigger: number;
  78811. /**
  78812. * On key down
  78813. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78814. */
  78815. static readonly ACTION_OnKeyDownTrigger: number;
  78816. /**
  78817. * On key up
  78818. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78819. */
  78820. static readonly ACTION_OnKeyUpTrigger: number;
  78821. /**
  78822. * Billboard mode will only apply to Y axis
  78823. */
  78824. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  78825. /**
  78826. * Billboard mode will apply to all axes
  78827. */
  78828. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  78829. /**
  78830. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  78831. */
  78832. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  78833. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  78834. * Test order :
  78835. * Is the bounding sphere outside the frustum ?
  78836. * If not, are the bounding box vertices outside the frustum ?
  78837. * It not, then the cullable object is in the frustum.
  78838. */
  78839. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  78840. /** Culling strategy : Bounding Sphere Only.
  78841. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  78842. * It's also less accurate than the standard because some not visible objects can still be selected.
  78843. * Test : is the bounding sphere outside the frustum ?
  78844. * If not, then the cullable object is in the frustum.
  78845. */
  78846. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  78847. /** Culling strategy : Optimistic Inclusion.
  78848. * This in an inclusion test first, then the standard exclusion test.
  78849. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  78850. * 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.
  78851. * Anyway, it's as accurate as the standard strategy.
  78852. * Test :
  78853. * Is the cullable object bounding sphere center in the frustum ?
  78854. * If not, apply the default culling strategy.
  78855. */
  78856. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  78857. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  78858. * This in an inclusion test first, then the bounding sphere only exclusion test.
  78859. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  78860. * 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.
  78861. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  78862. * Test :
  78863. * Is the cullable object bounding sphere center in the frustum ?
  78864. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  78865. */
  78866. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  78867. /**
  78868. * No logging while loading
  78869. */
  78870. static readonly SCENELOADER_NO_LOGGING: number;
  78871. /**
  78872. * Minimal logging while loading
  78873. */
  78874. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  78875. /**
  78876. * Summary logging while loading
  78877. */
  78878. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  78879. /**
  78880. * Detailled logging while loading
  78881. */
  78882. static readonly SCENELOADER_DETAILED_LOGGING: number;
  78883. }
  78884. }
  78885. declare module BABYLON {
  78886. /**
  78887. * This represents the required contract to create a new type of texture loader.
  78888. */
  78889. export interface IInternalTextureLoader {
  78890. /**
  78891. * Defines wether the loader supports cascade loading the different faces.
  78892. */
  78893. supportCascades: boolean;
  78894. /**
  78895. * This returns if the loader support the current file information.
  78896. * @param extension defines the file extension of the file being loaded
  78897. * @returns true if the loader can load the specified file
  78898. */
  78899. canLoad(extension: string): boolean;
  78900. /**
  78901. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  78902. * @param data contains the texture data
  78903. * @param texture defines the BabylonJS internal texture
  78904. * @param createPolynomials will be true if polynomials have been requested
  78905. * @param onLoad defines the callback to trigger once the texture is ready
  78906. * @param onError defines the callback to trigger in case of error
  78907. */
  78908. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  78909. /**
  78910. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  78911. * @param data contains the texture data
  78912. * @param texture defines the BabylonJS internal texture
  78913. * @param callback defines the method to call once ready to upload
  78914. */
  78915. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  78916. }
  78917. }
  78918. declare module BABYLON {
  78919. /**
  78920. * Class used to store and describe the pipeline context associated with an effect
  78921. */
  78922. export interface IPipelineContext {
  78923. /**
  78924. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  78925. */
  78926. isAsync: boolean;
  78927. /**
  78928. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  78929. */
  78930. isReady: boolean;
  78931. /** @hidden */
  78932. _getVertexShaderCode(): string | null;
  78933. /** @hidden */
  78934. _getFragmentShaderCode(): string | null;
  78935. /** @hidden */
  78936. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  78937. }
  78938. }
  78939. declare module BABYLON {
  78940. /**
  78941. * Class used to store gfx data (like WebGLBuffer)
  78942. */
  78943. export class DataBuffer {
  78944. /**
  78945. * Gets or sets the number of objects referencing this buffer
  78946. */
  78947. references: number;
  78948. /** Gets or sets the size of the underlying buffer */
  78949. capacity: number;
  78950. /**
  78951. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  78952. */
  78953. is32Bits: boolean;
  78954. /**
  78955. * Gets the underlying buffer
  78956. */
  78957. get underlyingResource(): any;
  78958. }
  78959. }
  78960. declare module BABYLON {
  78961. /** @hidden */
  78962. export interface IShaderProcessor {
  78963. attributeProcessor?: (attribute: string) => string;
  78964. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  78965. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  78966. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  78967. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  78968. lineProcessor?: (line: string, isFragment: boolean) => string;
  78969. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  78970. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  78971. }
  78972. }
  78973. declare module BABYLON {
  78974. /** @hidden */
  78975. export interface ProcessingOptions {
  78976. defines: string[];
  78977. indexParameters: any;
  78978. isFragment: boolean;
  78979. shouldUseHighPrecisionShader: boolean;
  78980. supportsUniformBuffers: boolean;
  78981. shadersRepository: string;
  78982. includesShadersStore: {
  78983. [key: string]: string;
  78984. };
  78985. processor?: IShaderProcessor;
  78986. version: string;
  78987. platformName: string;
  78988. lookForClosingBracketForUniformBuffer?: boolean;
  78989. }
  78990. }
  78991. declare module BABYLON {
  78992. /** @hidden */
  78993. export class ShaderCodeNode {
  78994. line: string;
  78995. children: ShaderCodeNode[];
  78996. additionalDefineKey?: string;
  78997. additionalDefineValue?: string;
  78998. isValid(preprocessors: {
  78999. [key: string]: string;
  79000. }): boolean;
  79001. process(preprocessors: {
  79002. [key: string]: string;
  79003. }, options: ProcessingOptions): string;
  79004. }
  79005. }
  79006. declare module BABYLON {
  79007. /** @hidden */
  79008. export class ShaderCodeCursor {
  79009. private _lines;
  79010. lineIndex: number;
  79011. get currentLine(): string;
  79012. get canRead(): boolean;
  79013. set lines(value: string[]);
  79014. }
  79015. }
  79016. declare module BABYLON {
  79017. /** @hidden */
  79018. export class ShaderCodeConditionNode extends ShaderCodeNode {
  79019. process(preprocessors: {
  79020. [key: string]: string;
  79021. }, options: ProcessingOptions): string;
  79022. }
  79023. }
  79024. declare module BABYLON {
  79025. /** @hidden */
  79026. export class ShaderDefineExpression {
  79027. isTrue(preprocessors: {
  79028. [key: string]: string;
  79029. }): boolean;
  79030. private static _OperatorPriority;
  79031. private static _Stack;
  79032. static postfixToInfix(postfix: string[]): string;
  79033. static infixToPostfix(infix: string): string[];
  79034. }
  79035. }
  79036. declare module BABYLON {
  79037. /** @hidden */
  79038. export class ShaderCodeTestNode extends ShaderCodeNode {
  79039. testExpression: ShaderDefineExpression;
  79040. isValid(preprocessors: {
  79041. [key: string]: string;
  79042. }): boolean;
  79043. }
  79044. }
  79045. declare module BABYLON {
  79046. /** @hidden */
  79047. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  79048. define: string;
  79049. not: boolean;
  79050. constructor(define: string, not?: boolean);
  79051. isTrue(preprocessors: {
  79052. [key: string]: string;
  79053. }): boolean;
  79054. }
  79055. }
  79056. declare module BABYLON {
  79057. /** @hidden */
  79058. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  79059. leftOperand: ShaderDefineExpression;
  79060. rightOperand: ShaderDefineExpression;
  79061. isTrue(preprocessors: {
  79062. [key: string]: string;
  79063. }): boolean;
  79064. }
  79065. }
  79066. declare module BABYLON {
  79067. /** @hidden */
  79068. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  79069. leftOperand: ShaderDefineExpression;
  79070. rightOperand: ShaderDefineExpression;
  79071. isTrue(preprocessors: {
  79072. [key: string]: string;
  79073. }): boolean;
  79074. }
  79075. }
  79076. declare module BABYLON {
  79077. /** @hidden */
  79078. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  79079. define: string;
  79080. operand: string;
  79081. testValue: string;
  79082. constructor(define: string, operand: string, testValue: string);
  79083. isTrue(preprocessors: {
  79084. [key: string]: string;
  79085. }): boolean;
  79086. }
  79087. }
  79088. declare module BABYLON {
  79089. /**
  79090. * Class used to enable access to offline support
  79091. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  79092. */
  79093. export interface IOfflineProvider {
  79094. /**
  79095. * Gets a boolean indicating if scene must be saved in the database
  79096. */
  79097. enableSceneOffline: boolean;
  79098. /**
  79099. * Gets a boolean indicating if textures must be saved in the database
  79100. */
  79101. enableTexturesOffline: boolean;
  79102. /**
  79103. * Open the offline support and make it available
  79104. * @param successCallback defines the callback to call on success
  79105. * @param errorCallback defines the callback to call on error
  79106. */
  79107. open(successCallback: () => void, errorCallback: () => void): void;
  79108. /**
  79109. * Loads an image from the offline support
  79110. * @param url defines the url to load from
  79111. * @param image defines the target DOM image
  79112. */
  79113. loadImage(url: string, image: HTMLImageElement): void;
  79114. /**
  79115. * Loads a file from offline support
  79116. * @param url defines the URL to load from
  79117. * @param sceneLoaded defines a callback to call on success
  79118. * @param progressCallBack defines a callback to call when progress changed
  79119. * @param errorCallback defines a callback to call on error
  79120. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  79121. */
  79122. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  79123. }
  79124. }
  79125. declare module BABYLON {
  79126. /**
  79127. * Class used to help managing file picking and drag'n'drop
  79128. * File Storage
  79129. */
  79130. export class FilesInputStore {
  79131. /**
  79132. * List of files ready to be loaded
  79133. */
  79134. static FilesToLoad: {
  79135. [key: string]: File;
  79136. };
  79137. }
  79138. }
  79139. declare module BABYLON {
  79140. /**
  79141. * Class used to define a retry strategy when error happens while loading assets
  79142. */
  79143. export class RetryStrategy {
  79144. /**
  79145. * Function used to defines an exponential back off strategy
  79146. * @param maxRetries defines the maximum number of retries (3 by default)
  79147. * @param baseInterval defines the interval between retries
  79148. * @returns the strategy function to use
  79149. */
  79150. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  79151. }
  79152. }
  79153. declare module BABYLON {
  79154. /**
  79155. * @ignore
  79156. * Application error to support additional information when loading a file
  79157. */
  79158. export abstract class BaseError extends Error {
  79159. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  79160. }
  79161. }
  79162. declare module BABYLON {
  79163. /** @ignore */
  79164. export class LoadFileError extends BaseError {
  79165. request?: WebRequest;
  79166. file?: File;
  79167. /**
  79168. * Creates a new LoadFileError
  79169. * @param message defines the message of the error
  79170. * @param request defines the optional web request
  79171. * @param file defines the optional file
  79172. */
  79173. constructor(message: string, object?: WebRequest | File);
  79174. }
  79175. /** @ignore */
  79176. export class RequestFileError extends BaseError {
  79177. request: WebRequest;
  79178. /**
  79179. * Creates a new LoadFileError
  79180. * @param message defines the message of the error
  79181. * @param request defines the optional web request
  79182. */
  79183. constructor(message: string, request: WebRequest);
  79184. }
  79185. /** @ignore */
  79186. export class ReadFileError extends BaseError {
  79187. file: File;
  79188. /**
  79189. * Creates a new ReadFileError
  79190. * @param message defines the message of the error
  79191. * @param file defines the optional file
  79192. */
  79193. constructor(message: string, file: File);
  79194. }
  79195. /**
  79196. * @hidden
  79197. */
  79198. export class FileTools {
  79199. /**
  79200. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  79201. */
  79202. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  79203. /**
  79204. * Gets or sets the base URL to use to load assets
  79205. */
  79206. static BaseUrl: string;
  79207. /**
  79208. * Default behaviour for cors in the application.
  79209. * It can be a string if the expected behavior is identical in the entire app.
  79210. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  79211. */
  79212. static CorsBehavior: string | ((url: string | string[]) => string);
  79213. /**
  79214. * Gets or sets a function used to pre-process url before using them to load assets
  79215. */
  79216. static PreprocessUrl: (url: string) => string;
  79217. /**
  79218. * Removes unwanted characters from an url
  79219. * @param url defines the url to clean
  79220. * @returns the cleaned url
  79221. */
  79222. private static _CleanUrl;
  79223. /**
  79224. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  79225. * @param url define the url we are trying
  79226. * @param element define the dom element where to configure the cors policy
  79227. */
  79228. static SetCorsBehavior(url: string | string[], element: {
  79229. crossOrigin: string | null;
  79230. }): void;
  79231. /**
  79232. * Loads an image as an HTMLImageElement.
  79233. * @param input url string, ArrayBuffer, or Blob to load
  79234. * @param onLoad callback called when the image successfully loads
  79235. * @param onError callback called when the image fails to load
  79236. * @param offlineProvider offline provider for caching
  79237. * @param mimeType optional mime type
  79238. * @returns the HTMLImageElement of the loaded image
  79239. */
  79240. 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>;
  79241. /**
  79242. * Reads a file from a File object
  79243. * @param file defines the file to load
  79244. * @param onSuccess defines the callback to call when data is loaded
  79245. * @param onProgress defines the callback to call during loading process
  79246. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  79247. * @param onError defines the callback to call when an error occurs
  79248. * @returns a file request object
  79249. */
  79250. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  79251. /**
  79252. * Loads a file from a url
  79253. * @param url url to load
  79254. * @param onSuccess callback called when the file successfully loads
  79255. * @param onProgress callback called while file is loading (if the server supports this mode)
  79256. * @param offlineProvider defines the offline provider for caching
  79257. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  79258. * @param onError callback called when the file fails to load
  79259. * @returns a file request object
  79260. */
  79261. 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;
  79262. /**
  79263. * Loads a file
  79264. * @param url url to load
  79265. * @param onSuccess callback called when the file successfully loads
  79266. * @param onProgress callback called while file is loading (if the server supports this mode)
  79267. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  79268. * @param onError callback called when the file fails to load
  79269. * @param onOpened callback called when the web request is opened
  79270. * @returns a file request object
  79271. */
  79272. 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;
  79273. /**
  79274. * Checks if the loaded document was accessed via `file:`-Protocol.
  79275. * @returns boolean
  79276. */
  79277. static IsFileURL(): boolean;
  79278. }
  79279. }
  79280. declare module BABYLON {
  79281. /** @hidden */
  79282. export class ShaderProcessor {
  79283. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  79284. private static _ProcessPrecision;
  79285. private static _ExtractOperation;
  79286. private static _BuildSubExpression;
  79287. private static _BuildExpression;
  79288. private static _MoveCursorWithinIf;
  79289. private static _MoveCursor;
  79290. private static _EvaluatePreProcessors;
  79291. private static _PreparePreProcessors;
  79292. private static _ProcessShaderConversion;
  79293. private static _ProcessIncludes;
  79294. /**
  79295. * Loads a file from a url
  79296. * @param url url to load
  79297. * @param onSuccess callback called when the file successfully loads
  79298. * @param onProgress callback called while file is loading (if the server supports this mode)
  79299. * @param offlineProvider defines the offline provider for caching
  79300. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  79301. * @param onError callback called when the file fails to load
  79302. * @returns a file request object
  79303. * @hidden
  79304. */
  79305. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  79306. }
  79307. }
  79308. declare module BABYLON {
  79309. /**
  79310. * @hidden
  79311. */
  79312. export interface IColor4Like {
  79313. r: float;
  79314. g: float;
  79315. b: float;
  79316. a: float;
  79317. }
  79318. /**
  79319. * @hidden
  79320. */
  79321. export interface IColor3Like {
  79322. r: float;
  79323. g: float;
  79324. b: float;
  79325. }
  79326. /**
  79327. * @hidden
  79328. */
  79329. export interface IVector4Like {
  79330. x: float;
  79331. y: float;
  79332. z: float;
  79333. w: float;
  79334. }
  79335. /**
  79336. * @hidden
  79337. */
  79338. export interface IVector3Like {
  79339. x: float;
  79340. y: float;
  79341. z: float;
  79342. }
  79343. /**
  79344. * @hidden
  79345. */
  79346. export interface IVector2Like {
  79347. x: float;
  79348. y: float;
  79349. }
  79350. /**
  79351. * @hidden
  79352. */
  79353. export interface IMatrixLike {
  79354. toArray(): DeepImmutable<Float32Array>;
  79355. updateFlag: int;
  79356. }
  79357. /**
  79358. * @hidden
  79359. */
  79360. export interface IViewportLike {
  79361. x: float;
  79362. y: float;
  79363. width: float;
  79364. height: float;
  79365. }
  79366. /**
  79367. * @hidden
  79368. */
  79369. export interface IPlaneLike {
  79370. normal: IVector3Like;
  79371. d: float;
  79372. normalize(): void;
  79373. }
  79374. }
  79375. declare module BABYLON {
  79376. /**
  79377. * Interface used to define common properties for effect fallbacks
  79378. */
  79379. export interface IEffectFallbacks {
  79380. /**
  79381. * Removes the defines that should be removed when falling back.
  79382. * @param currentDefines defines the current define statements for the shader.
  79383. * @param effect defines the current effect we try to compile
  79384. * @returns The resulting defines with defines of the current rank removed.
  79385. */
  79386. reduce(currentDefines: string, effect: Effect): string;
  79387. /**
  79388. * Removes the fallback from the bound mesh.
  79389. */
  79390. unBindMesh(): void;
  79391. /**
  79392. * Checks to see if more fallbacks are still availible.
  79393. */
  79394. hasMoreFallbacks: boolean;
  79395. }
  79396. }
  79397. declare module BABYLON {
  79398. /**
  79399. * Class used to evalaute queries containing `and` and `or` operators
  79400. */
  79401. export class AndOrNotEvaluator {
  79402. /**
  79403. * Evaluate a query
  79404. * @param query defines the query to evaluate
  79405. * @param evaluateCallback defines the callback used to filter result
  79406. * @returns true if the query matches
  79407. */
  79408. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  79409. private static _HandleParenthesisContent;
  79410. private static _SimplifyNegation;
  79411. }
  79412. }
  79413. declare module BABYLON {
  79414. /**
  79415. * Class used to store custom tags
  79416. */
  79417. export class Tags {
  79418. /**
  79419. * Adds support for tags on the given object
  79420. * @param obj defines the object to use
  79421. */
  79422. static EnableFor(obj: any): void;
  79423. /**
  79424. * Removes tags support
  79425. * @param obj defines the object to use
  79426. */
  79427. static DisableFor(obj: any): void;
  79428. /**
  79429. * Gets a boolean indicating if the given object has tags
  79430. * @param obj defines the object to use
  79431. * @returns a boolean
  79432. */
  79433. static HasTags(obj: any): boolean;
  79434. /**
  79435. * Gets the tags available on a given object
  79436. * @param obj defines the object to use
  79437. * @param asString defines if the tags must be returned as a string instead of an array of strings
  79438. * @returns the tags
  79439. */
  79440. static GetTags(obj: any, asString?: boolean): any;
  79441. /**
  79442. * Adds tags to an object
  79443. * @param obj defines the object to use
  79444. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  79445. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  79446. */
  79447. static AddTagsTo(obj: any, tagsString: string): void;
  79448. /**
  79449. * @hidden
  79450. */
  79451. static _AddTagTo(obj: any, tag: string): void;
  79452. /**
  79453. * Removes specific tags from a specific object
  79454. * @param obj defines the object to use
  79455. * @param tagsString defines the tags to remove
  79456. */
  79457. static RemoveTagsFrom(obj: any, tagsString: string): void;
  79458. /**
  79459. * @hidden
  79460. */
  79461. static _RemoveTagFrom(obj: any, tag: string): void;
  79462. /**
  79463. * Defines if tags hosted on an object match a given query
  79464. * @param obj defines the object to use
  79465. * @param tagsQuery defines the tag query
  79466. * @returns a boolean
  79467. */
  79468. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  79469. }
  79470. }
  79471. declare module BABYLON {
  79472. /**
  79473. * Scalar computation library
  79474. */
  79475. export class Scalar {
  79476. /**
  79477. * Two pi constants convenient for computation.
  79478. */
  79479. static TwoPi: number;
  79480. /**
  79481. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  79482. * @param a number
  79483. * @param b number
  79484. * @param epsilon (default = 1.401298E-45)
  79485. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  79486. */
  79487. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  79488. /**
  79489. * Returns a string : the upper case translation of the number i to hexadecimal.
  79490. * @param i number
  79491. * @returns the upper case translation of the number i to hexadecimal.
  79492. */
  79493. static ToHex(i: number): string;
  79494. /**
  79495. * Returns -1 if value is negative and +1 is value is positive.
  79496. * @param value the value
  79497. * @returns the value itself if it's equal to zero.
  79498. */
  79499. static Sign(value: number): number;
  79500. /**
  79501. * Returns the value itself if it's between min and max.
  79502. * Returns min if the value is lower than min.
  79503. * Returns max if the value is greater than max.
  79504. * @param value the value to clmap
  79505. * @param min the min value to clamp to (default: 0)
  79506. * @param max the max value to clamp to (default: 1)
  79507. * @returns the clamped value
  79508. */
  79509. static Clamp(value: number, min?: number, max?: number): number;
  79510. /**
  79511. * the log2 of value.
  79512. * @param value the value to compute log2 of
  79513. * @returns the log2 of value.
  79514. */
  79515. static Log2(value: number): number;
  79516. /**
  79517. * Loops the value, so that it is never larger than length and never smaller than 0.
  79518. *
  79519. * This is similar to the modulo operator but it works with floating point numbers.
  79520. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  79521. * With t = 5 and length = 2.5, the result would be 0.0.
  79522. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  79523. * @param value the value
  79524. * @param length the length
  79525. * @returns the looped value
  79526. */
  79527. static Repeat(value: number, length: number): number;
  79528. /**
  79529. * Normalize the value between 0.0 and 1.0 using min and max values
  79530. * @param value value to normalize
  79531. * @param min max to normalize between
  79532. * @param max min to normalize between
  79533. * @returns the normalized value
  79534. */
  79535. static Normalize(value: number, min: number, max: number): number;
  79536. /**
  79537. * Denormalize the value from 0.0 and 1.0 using min and max values
  79538. * @param normalized value to denormalize
  79539. * @param min max to denormalize between
  79540. * @param max min to denormalize between
  79541. * @returns the denormalized value
  79542. */
  79543. static Denormalize(normalized: number, min: number, max: number): number;
  79544. /**
  79545. * Calculates the shortest difference between two given angles given in degrees.
  79546. * @param current current angle in degrees
  79547. * @param target target angle in degrees
  79548. * @returns the delta
  79549. */
  79550. static DeltaAngle(current: number, target: number): number;
  79551. /**
  79552. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  79553. * @param tx value
  79554. * @param length length
  79555. * @returns The returned value will move back and forth between 0 and length
  79556. */
  79557. static PingPong(tx: number, length: number): number;
  79558. /**
  79559. * Interpolates between min and max with smoothing at the limits.
  79560. *
  79561. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  79562. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  79563. * @param from from
  79564. * @param to to
  79565. * @param tx value
  79566. * @returns the smooth stepped value
  79567. */
  79568. static SmoothStep(from: number, to: number, tx: number): number;
  79569. /**
  79570. * Moves a value current towards target.
  79571. *
  79572. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  79573. * Negative values of maxDelta pushes the value away from target.
  79574. * @param current current value
  79575. * @param target target value
  79576. * @param maxDelta max distance to move
  79577. * @returns resulting value
  79578. */
  79579. static MoveTowards(current: number, target: number, maxDelta: number): number;
  79580. /**
  79581. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  79582. *
  79583. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  79584. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  79585. * @param current current value
  79586. * @param target target value
  79587. * @param maxDelta max distance to move
  79588. * @returns resulting angle
  79589. */
  79590. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  79591. /**
  79592. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  79593. * @param start start value
  79594. * @param end target value
  79595. * @param amount amount to lerp between
  79596. * @returns the lerped value
  79597. */
  79598. static Lerp(start: number, end: number, amount: number): number;
  79599. /**
  79600. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  79601. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  79602. * @param start start value
  79603. * @param end target value
  79604. * @param amount amount to lerp between
  79605. * @returns the lerped value
  79606. */
  79607. static LerpAngle(start: number, end: number, amount: number): number;
  79608. /**
  79609. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  79610. * @param a start value
  79611. * @param b target value
  79612. * @param value value between a and b
  79613. * @returns the inverseLerp value
  79614. */
  79615. static InverseLerp(a: number, b: number, value: number): number;
  79616. /**
  79617. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  79618. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  79619. * @param value1 spline value
  79620. * @param tangent1 spline value
  79621. * @param value2 spline value
  79622. * @param tangent2 spline value
  79623. * @param amount input value
  79624. * @returns hermite result
  79625. */
  79626. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  79627. /**
  79628. * Returns a random float number between and min and max values
  79629. * @param min min value of random
  79630. * @param max max value of random
  79631. * @returns random value
  79632. */
  79633. static RandomRange(min: number, max: number): number;
  79634. /**
  79635. * This function returns percentage of a number in a given range.
  79636. *
  79637. * RangeToPercent(40,20,60) will return 0.5 (50%)
  79638. * RangeToPercent(34,0,100) will return 0.34 (34%)
  79639. * @param number to convert to percentage
  79640. * @param min min range
  79641. * @param max max range
  79642. * @returns the percentage
  79643. */
  79644. static RangeToPercent(number: number, min: number, max: number): number;
  79645. /**
  79646. * This function returns number that corresponds to the percentage in a given range.
  79647. *
  79648. * PercentToRange(0.34,0,100) will return 34.
  79649. * @param percent to convert to number
  79650. * @param min min range
  79651. * @param max max range
  79652. * @returns the number
  79653. */
  79654. static PercentToRange(percent: number, min: number, max: number): number;
  79655. /**
  79656. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  79657. * @param angle The angle to normalize in radian.
  79658. * @return The converted angle.
  79659. */
  79660. static NormalizeRadians(angle: number): number;
  79661. }
  79662. }
  79663. declare module BABYLON {
  79664. /**
  79665. * Constant used to convert a value to gamma space
  79666. * @ignorenaming
  79667. */
  79668. export const ToGammaSpace: number;
  79669. /**
  79670. * Constant used to convert a value to linear space
  79671. * @ignorenaming
  79672. */
  79673. export const ToLinearSpace = 2.2;
  79674. /**
  79675. * Constant used to define the minimal number value in Babylon.js
  79676. * @ignorenaming
  79677. */
  79678. let Epsilon: number;
  79679. }
  79680. declare module BABYLON {
  79681. /**
  79682. * Class used to represent a viewport on screen
  79683. */
  79684. export class Viewport {
  79685. /** viewport left coordinate */
  79686. x: number;
  79687. /** viewport top coordinate */
  79688. y: number;
  79689. /**viewport width */
  79690. width: number;
  79691. /** viewport height */
  79692. height: number;
  79693. /**
  79694. * Creates a Viewport object located at (x, y) and sized (width, height)
  79695. * @param x defines viewport left coordinate
  79696. * @param y defines viewport top coordinate
  79697. * @param width defines the viewport width
  79698. * @param height defines the viewport height
  79699. */
  79700. constructor(
  79701. /** viewport left coordinate */
  79702. x: number,
  79703. /** viewport top coordinate */
  79704. y: number,
  79705. /**viewport width */
  79706. width: number,
  79707. /** viewport height */
  79708. height: number);
  79709. /**
  79710. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  79711. * @param renderWidth defines the rendering width
  79712. * @param renderHeight defines the rendering height
  79713. * @returns a new Viewport
  79714. */
  79715. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  79716. /**
  79717. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  79718. * @param renderWidth defines the rendering width
  79719. * @param renderHeight defines the rendering height
  79720. * @param ref defines the target viewport
  79721. * @returns the current viewport
  79722. */
  79723. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  79724. /**
  79725. * Returns a new Viewport copied from the current one
  79726. * @returns a new Viewport
  79727. */
  79728. clone(): Viewport;
  79729. }
  79730. }
  79731. declare module BABYLON {
  79732. /**
  79733. * Class containing a set of static utilities functions for arrays.
  79734. */
  79735. export class ArrayTools {
  79736. /**
  79737. * Returns an array of the given size filled with element built from the given constructor and the paramters
  79738. * @param size the number of element to construct and put in the array
  79739. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  79740. * @returns a new array filled with new objects
  79741. */
  79742. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  79743. }
  79744. }
  79745. declare module BABYLON {
  79746. /**
  79747. * Represents a plane by the equation ax + by + cz + d = 0
  79748. */
  79749. export class Plane {
  79750. private static _TmpMatrix;
  79751. /**
  79752. * Normal of the plane (a,b,c)
  79753. */
  79754. normal: Vector3;
  79755. /**
  79756. * d component of the plane
  79757. */
  79758. d: number;
  79759. /**
  79760. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  79761. * @param a a component of the plane
  79762. * @param b b component of the plane
  79763. * @param c c component of the plane
  79764. * @param d d component of the plane
  79765. */
  79766. constructor(a: number, b: number, c: number, d: number);
  79767. /**
  79768. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  79769. */
  79770. asArray(): number[];
  79771. /**
  79772. * @returns a new plane copied from the current Plane.
  79773. */
  79774. clone(): Plane;
  79775. /**
  79776. * @returns the string "Plane".
  79777. */
  79778. getClassName(): string;
  79779. /**
  79780. * @returns the Plane hash code.
  79781. */
  79782. getHashCode(): number;
  79783. /**
  79784. * Normalize the current Plane in place.
  79785. * @returns the updated Plane.
  79786. */
  79787. normalize(): Plane;
  79788. /**
  79789. * Applies a transformation the plane and returns the result
  79790. * @param transformation the transformation matrix to be applied to the plane
  79791. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  79792. */
  79793. transform(transformation: DeepImmutable<Matrix>): Plane;
  79794. /**
  79795. * Compute the dot product between the point and the plane normal
  79796. * @param point point to calculate the dot product with
  79797. * @returns the dot product (float) of the point coordinates and the plane normal.
  79798. */
  79799. dotCoordinate(point: DeepImmutable<Vector3>): number;
  79800. /**
  79801. * Updates the current Plane from the plane defined by the three given points.
  79802. * @param point1 one of the points used to contruct the plane
  79803. * @param point2 one of the points used to contruct the plane
  79804. * @param point3 one of the points used to contruct the plane
  79805. * @returns the updated Plane.
  79806. */
  79807. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  79808. /**
  79809. * Checks if the plane is facing a given direction
  79810. * @param direction the direction to check if the plane is facing
  79811. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  79812. * @returns True is the vector "direction" is the same side than the plane normal.
  79813. */
  79814. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  79815. /**
  79816. * Calculates the distance to a point
  79817. * @param point point to calculate distance to
  79818. * @returns the signed distance (float) from the given point to the Plane.
  79819. */
  79820. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  79821. /**
  79822. * Creates a plane from an array
  79823. * @param array the array to create a plane from
  79824. * @returns a new Plane from the given array.
  79825. */
  79826. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  79827. /**
  79828. * Creates a plane from three points
  79829. * @param point1 point used to create the plane
  79830. * @param point2 point used to create the plane
  79831. * @param point3 point used to create the plane
  79832. * @returns a new Plane defined by the three given points.
  79833. */
  79834. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  79835. /**
  79836. * Creates a plane from an origin point and a normal
  79837. * @param origin origin of the plane to be constructed
  79838. * @param normal normal of the plane to be constructed
  79839. * @returns a new Plane the normal vector to this plane at the given origin point.
  79840. * Note : the vector "normal" is updated because normalized.
  79841. */
  79842. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  79843. /**
  79844. * Calculates the distance from a plane and a point
  79845. * @param origin origin of the plane to be constructed
  79846. * @param normal normal of the plane to be constructed
  79847. * @param point point to calculate distance to
  79848. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  79849. */
  79850. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  79851. }
  79852. }
  79853. declare module BABYLON {
  79854. /**
  79855. * Class representing a vector containing 2 coordinates
  79856. */
  79857. export class Vector2 {
  79858. /** defines the first coordinate */
  79859. x: number;
  79860. /** defines the second coordinate */
  79861. y: number;
  79862. /**
  79863. * Creates a new Vector2 from the given x and y coordinates
  79864. * @param x defines the first coordinate
  79865. * @param y defines the second coordinate
  79866. */
  79867. constructor(
  79868. /** defines the first coordinate */
  79869. x?: number,
  79870. /** defines the second coordinate */
  79871. y?: number);
  79872. /**
  79873. * Gets a string with the Vector2 coordinates
  79874. * @returns a string with the Vector2 coordinates
  79875. */
  79876. toString(): string;
  79877. /**
  79878. * Gets class name
  79879. * @returns the string "Vector2"
  79880. */
  79881. getClassName(): string;
  79882. /**
  79883. * Gets current vector hash code
  79884. * @returns the Vector2 hash code as a number
  79885. */
  79886. getHashCode(): number;
  79887. /**
  79888. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  79889. * @param array defines the source array
  79890. * @param index defines the offset in source array
  79891. * @returns the current Vector2
  79892. */
  79893. toArray(array: FloatArray, index?: number): Vector2;
  79894. /**
  79895. * Copy the current vector to an array
  79896. * @returns a new array with 2 elements: the Vector2 coordinates.
  79897. */
  79898. asArray(): number[];
  79899. /**
  79900. * Sets the Vector2 coordinates with the given Vector2 coordinates
  79901. * @param source defines the source Vector2
  79902. * @returns the current updated Vector2
  79903. */
  79904. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  79905. /**
  79906. * Sets the Vector2 coordinates with the given floats
  79907. * @param x defines the first coordinate
  79908. * @param y defines the second coordinate
  79909. * @returns the current updated Vector2
  79910. */
  79911. copyFromFloats(x: number, y: number): Vector2;
  79912. /**
  79913. * Sets the Vector2 coordinates with the given floats
  79914. * @param x defines the first coordinate
  79915. * @param y defines the second coordinate
  79916. * @returns the current updated Vector2
  79917. */
  79918. set(x: number, y: number): Vector2;
  79919. /**
  79920. * Add another vector with the current one
  79921. * @param otherVector defines the other vector
  79922. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  79923. */
  79924. add(otherVector: DeepImmutable<Vector2>): Vector2;
  79925. /**
  79926. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  79927. * @param otherVector defines the other vector
  79928. * @param result defines the target vector
  79929. * @returns the unmodified current Vector2
  79930. */
  79931. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  79932. /**
  79933. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  79934. * @param otherVector defines the other vector
  79935. * @returns the current updated Vector2
  79936. */
  79937. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  79938. /**
  79939. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  79940. * @param otherVector defines the other vector
  79941. * @returns a new Vector2
  79942. */
  79943. addVector3(otherVector: Vector3): Vector2;
  79944. /**
  79945. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  79946. * @param otherVector defines the other vector
  79947. * @returns a new Vector2
  79948. */
  79949. subtract(otherVector: Vector2): Vector2;
  79950. /**
  79951. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  79952. * @param otherVector defines the other vector
  79953. * @param result defines the target vector
  79954. * @returns the unmodified current Vector2
  79955. */
  79956. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  79957. /**
  79958. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  79959. * @param otherVector defines the other vector
  79960. * @returns the current updated Vector2
  79961. */
  79962. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  79963. /**
  79964. * Multiplies in place the current Vector2 coordinates by the given ones
  79965. * @param otherVector defines the other vector
  79966. * @returns the current updated Vector2
  79967. */
  79968. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  79969. /**
  79970. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  79971. * @param otherVector defines the other vector
  79972. * @returns a new Vector2
  79973. */
  79974. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  79975. /**
  79976. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  79977. * @param otherVector defines the other vector
  79978. * @param result defines the target vector
  79979. * @returns the unmodified current Vector2
  79980. */
  79981. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  79982. /**
  79983. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  79984. * @param x defines the first coordinate
  79985. * @param y defines the second coordinate
  79986. * @returns a new Vector2
  79987. */
  79988. multiplyByFloats(x: number, y: number): Vector2;
  79989. /**
  79990. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  79991. * @param otherVector defines the other vector
  79992. * @returns a new Vector2
  79993. */
  79994. divide(otherVector: Vector2): Vector2;
  79995. /**
  79996. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  79997. * @param otherVector defines the other vector
  79998. * @param result defines the target vector
  79999. * @returns the unmodified current Vector2
  80000. */
  80001. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  80002. /**
  80003. * Divides the current Vector2 coordinates by the given ones
  80004. * @param otherVector defines the other vector
  80005. * @returns the current updated Vector2
  80006. */
  80007. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  80008. /**
  80009. * Gets a new Vector2 with current Vector2 negated coordinates
  80010. * @returns a new Vector2
  80011. */
  80012. negate(): Vector2;
  80013. /**
  80014. * Negate this vector in place
  80015. * @returns this
  80016. */
  80017. negateInPlace(): Vector2;
  80018. /**
  80019. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  80020. * @param result defines the Vector3 object where to store the result
  80021. * @returns the current Vector2
  80022. */
  80023. negateToRef(result: Vector2): Vector2;
  80024. /**
  80025. * Multiply the Vector2 coordinates by scale
  80026. * @param scale defines the scaling factor
  80027. * @returns the current updated Vector2
  80028. */
  80029. scaleInPlace(scale: number): Vector2;
  80030. /**
  80031. * Returns a new Vector2 scaled by "scale" from the current Vector2
  80032. * @param scale defines the scaling factor
  80033. * @returns a new Vector2
  80034. */
  80035. scale(scale: number): Vector2;
  80036. /**
  80037. * Scale the current Vector2 values by a factor to a given Vector2
  80038. * @param scale defines the scale factor
  80039. * @param result defines the Vector2 object where to store the result
  80040. * @returns the unmodified current Vector2
  80041. */
  80042. scaleToRef(scale: number, result: Vector2): Vector2;
  80043. /**
  80044. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  80045. * @param scale defines the scale factor
  80046. * @param result defines the Vector2 object where to store the result
  80047. * @returns the unmodified current Vector2
  80048. */
  80049. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  80050. /**
  80051. * Gets a boolean if two vectors are equals
  80052. * @param otherVector defines the other vector
  80053. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  80054. */
  80055. equals(otherVector: DeepImmutable<Vector2>): boolean;
  80056. /**
  80057. * Gets a boolean if two vectors are equals (using an epsilon value)
  80058. * @param otherVector defines the other vector
  80059. * @param epsilon defines the minimal distance to consider equality
  80060. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  80061. */
  80062. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  80063. /**
  80064. * Gets a new Vector2 from current Vector2 floored values
  80065. * @returns a new Vector2
  80066. */
  80067. floor(): Vector2;
  80068. /**
  80069. * Gets a new Vector2 from current Vector2 floored values
  80070. * @returns a new Vector2
  80071. */
  80072. fract(): Vector2;
  80073. /**
  80074. * Gets the length of the vector
  80075. * @returns the vector length (float)
  80076. */
  80077. length(): number;
  80078. /**
  80079. * Gets the vector squared length
  80080. * @returns the vector squared length (float)
  80081. */
  80082. lengthSquared(): number;
  80083. /**
  80084. * Normalize the vector
  80085. * @returns the current updated Vector2
  80086. */
  80087. normalize(): Vector2;
  80088. /**
  80089. * Gets a new Vector2 copied from the Vector2
  80090. * @returns a new Vector2
  80091. */
  80092. clone(): Vector2;
  80093. /**
  80094. * Gets a new Vector2(0, 0)
  80095. * @returns a new Vector2
  80096. */
  80097. static Zero(): Vector2;
  80098. /**
  80099. * Gets a new Vector2(1, 1)
  80100. * @returns a new Vector2
  80101. */
  80102. static One(): Vector2;
  80103. /**
  80104. * Gets a new Vector2 set from the given index element of the given array
  80105. * @param array defines the data source
  80106. * @param offset defines the offset in the data source
  80107. * @returns a new Vector2
  80108. */
  80109. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  80110. /**
  80111. * Sets "result" from the given index element of the given array
  80112. * @param array defines the data source
  80113. * @param offset defines the offset in the data source
  80114. * @param result defines the target vector
  80115. */
  80116. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  80117. /**
  80118. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  80119. * @param value1 defines 1st point of control
  80120. * @param value2 defines 2nd point of control
  80121. * @param value3 defines 3rd point of control
  80122. * @param value4 defines 4th point of control
  80123. * @param amount defines the interpolation factor
  80124. * @returns a new Vector2
  80125. */
  80126. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  80127. /**
  80128. * 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".
  80129. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  80130. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  80131. * @param value defines the value to clamp
  80132. * @param min defines the lower limit
  80133. * @param max defines the upper limit
  80134. * @returns a new Vector2
  80135. */
  80136. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  80137. /**
  80138. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  80139. * @param value1 defines the 1st control point
  80140. * @param tangent1 defines the outgoing tangent
  80141. * @param value2 defines the 2nd control point
  80142. * @param tangent2 defines the incoming tangent
  80143. * @param amount defines the interpolation factor
  80144. * @returns a new Vector2
  80145. */
  80146. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  80147. /**
  80148. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  80149. * @param start defines the start vector
  80150. * @param end defines the end vector
  80151. * @param amount defines the interpolation factor
  80152. * @returns a new Vector2
  80153. */
  80154. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  80155. /**
  80156. * Gets the dot product of the vector "left" and the vector "right"
  80157. * @param left defines first vector
  80158. * @param right defines second vector
  80159. * @returns the dot product (float)
  80160. */
  80161. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  80162. /**
  80163. * Returns a new Vector2 equal to the normalized given vector
  80164. * @param vector defines the vector to normalize
  80165. * @returns a new Vector2
  80166. */
  80167. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  80168. /**
  80169. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  80170. * @param left defines 1st vector
  80171. * @param right defines 2nd vector
  80172. * @returns a new Vector2
  80173. */
  80174. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  80175. /**
  80176. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  80177. * @param left defines 1st vector
  80178. * @param right defines 2nd vector
  80179. * @returns a new Vector2
  80180. */
  80181. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  80182. /**
  80183. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  80184. * @param vector defines the vector to transform
  80185. * @param transformation defines the matrix to apply
  80186. * @returns a new Vector2
  80187. */
  80188. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  80189. /**
  80190. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  80191. * @param vector defines the vector to transform
  80192. * @param transformation defines the matrix to apply
  80193. * @param result defines the target vector
  80194. */
  80195. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  80196. /**
  80197. * Determines if a given vector is included in a triangle
  80198. * @param p defines the vector to test
  80199. * @param p0 defines 1st triangle point
  80200. * @param p1 defines 2nd triangle point
  80201. * @param p2 defines 3rd triangle point
  80202. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  80203. */
  80204. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  80205. /**
  80206. * Gets the distance between the vectors "value1" and "value2"
  80207. * @param value1 defines first vector
  80208. * @param value2 defines second vector
  80209. * @returns the distance between vectors
  80210. */
  80211. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  80212. /**
  80213. * Returns the squared distance between the vectors "value1" and "value2"
  80214. * @param value1 defines first vector
  80215. * @param value2 defines second vector
  80216. * @returns the squared distance between vectors
  80217. */
  80218. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  80219. /**
  80220. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  80221. * @param value1 defines first vector
  80222. * @param value2 defines second vector
  80223. * @returns a new Vector2
  80224. */
  80225. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  80226. /**
  80227. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  80228. * @param p defines the middle point
  80229. * @param segA defines one point of the segment
  80230. * @param segB defines the other point of the segment
  80231. * @returns the shortest distance
  80232. */
  80233. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  80234. }
  80235. /**
  80236. * Class used to store (x,y,z) vector representation
  80237. * A Vector3 is the main object used in 3D geometry
  80238. * It can represent etiher the coordinates of a point the space, either a direction
  80239. * Reminder: js uses a left handed forward facing system
  80240. */
  80241. export class Vector3 {
  80242. private static _UpReadOnly;
  80243. private static _ZeroReadOnly;
  80244. /** @hidden */
  80245. _x: number;
  80246. /** @hidden */
  80247. _y: number;
  80248. /** @hidden */
  80249. _z: number;
  80250. /** @hidden */
  80251. _isDirty: boolean;
  80252. /** Gets or sets the x coordinate */
  80253. get x(): number;
  80254. set x(value: number);
  80255. /** Gets or sets the y coordinate */
  80256. get y(): number;
  80257. set y(value: number);
  80258. /** Gets or sets the z coordinate */
  80259. get z(): number;
  80260. set z(value: number);
  80261. /**
  80262. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  80263. * @param x defines the first coordinates (on X axis)
  80264. * @param y defines the second coordinates (on Y axis)
  80265. * @param z defines the third coordinates (on Z axis)
  80266. */
  80267. constructor(x?: number, y?: number, z?: number);
  80268. /**
  80269. * Creates a string representation of the Vector3
  80270. * @returns a string with the Vector3 coordinates.
  80271. */
  80272. toString(): string;
  80273. /**
  80274. * Gets the class name
  80275. * @returns the string "Vector3"
  80276. */
  80277. getClassName(): string;
  80278. /**
  80279. * Creates the Vector3 hash code
  80280. * @returns a number which tends to be unique between Vector3 instances
  80281. */
  80282. getHashCode(): number;
  80283. /**
  80284. * Creates an array containing three elements : the coordinates of the Vector3
  80285. * @returns a new array of numbers
  80286. */
  80287. asArray(): number[];
  80288. /**
  80289. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  80290. * @param array defines the destination array
  80291. * @param index defines the offset in the destination array
  80292. * @returns the current Vector3
  80293. */
  80294. toArray(array: FloatArray, index?: number): Vector3;
  80295. /**
  80296. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  80297. * @returns a new Quaternion object, computed from the Vector3 coordinates
  80298. */
  80299. toQuaternion(): Quaternion;
  80300. /**
  80301. * Adds the given vector to the current Vector3
  80302. * @param otherVector defines the second operand
  80303. * @returns the current updated Vector3
  80304. */
  80305. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  80306. /**
  80307. * Adds the given coordinates to the current Vector3
  80308. * @param x defines the x coordinate of the operand
  80309. * @param y defines the y coordinate of the operand
  80310. * @param z defines the z coordinate of the operand
  80311. * @returns the current updated Vector3
  80312. */
  80313. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  80314. /**
  80315. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  80316. * @param otherVector defines the second operand
  80317. * @returns the resulting Vector3
  80318. */
  80319. add(otherVector: DeepImmutable<Vector3>): Vector3;
  80320. /**
  80321. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  80322. * @param otherVector defines the second operand
  80323. * @param result defines the Vector3 object where to store the result
  80324. * @returns the current Vector3
  80325. */
  80326. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  80327. /**
  80328. * Subtract the given vector from the current Vector3
  80329. * @param otherVector defines the second operand
  80330. * @returns the current updated Vector3
  80331. */
  80332. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  80333. /**
  80334. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  80335. * @param otherVector defines the second operand
  80336. * @returns the resulting Vector3
  80337. */
  80338. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  80339. /**
  80340. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  80341. * @param otherVector defines the second operand
  80342. * @param result defines the Vector3 object where to store the result
  80343. * @returns the current Vector3
  80344. */
  80345. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  80346. /**
  80347. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  80348. * @param x defines the x coordinate of the operand
  80349. * @param y defines the y coordinate of the operand
  80350. * @param z defines the z coordinate of the operand
  80351. * @returns the resulting Vector3
  80352. */
  80353. subtractFromFloats(x: number, y: number, z: number): Vector3;
  80354. /**
  80355. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  80356. * @param x defines the x coordinate of the operand
  80357. * @param y defines the y coordinate of the operand
  80358. * @param z defines the z coordinate of the operand
  80359. * @param result defines the Vector3 object where to store the result
  80360. * @returns the current Vector3
  80361. */
  80362. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  80363. /**
  80364. * Gets a new Vector3 set with the current Vector3 negated coordinates
  80365. * @returns a new Vector3
  80366. */
  80367. negate(): Vector3;
  80368. /**
  80369. * Negate this vector in place
  80370. * @returns this
  80371. */
  80372. negateInPlace(): Vector3;
  80373. /**
  80374. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  80375. * @param result defines the Vector3 object where to store the result
  80376. * @returns the current Vector3
  80377. */
  80378. negateToRef(result: Vector3): Vector3;
  80379. /**
  80380. * Multiplies the Vector3 coordinates by the float "scale"
  80381. * @param scale defines the multiplier factor
  80382. * @returns the current updated Vector3
  80383. */
  80384. scaleInPlace(scale: number): Vector3;
  80385. /**
  80386. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  80387. * @param scale defines the multiplier factor
  80388. * @returns a new Vector3
  80389. */
  80390. scale(scale: number): Vector3;
  80391. /**
  80392. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  80393. * @param scale defines the multiplier factor
  80394. * @param result defines the Vector3 object where to store the result
  80395. * @returns the current Vector3
  80396. */
  80397. scaleToRef(scale: number, result: Vector3): Vector3;
  80398. /**
  80399. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  80400. * @param scale defines the scale factor
  80401. * @param result defines the Vector3 object where to store the result
  80402. * @returns the unmodified current Vector3
  80403. */
  80404. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  80405. /**
  80406. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  80407. * @param origin defines the origin of the projection ray
  80408. * @param plane defines the plane to project to
  80409. * @returns the projected vector3
  80410. */
  80411. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  80412. /**
  80413. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  80414. * @param origin defines the origin of the projection ray
  80415. * @param plane defines the plane to project to
  80416. * @param result defines the Vector3 where to store the result
  80417. */
  80418. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  80419. /**
  80420. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  80421. * @param otherVector defines the second operand
  80422. * @returns true if both vectors are equals
  80423. */
  80424. equals(otherVector: DeepImmutable<Vector3>): boolean;
  80425. /**
  80426. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  80427. * @param otherVector defines the second operand
  80428. * @param epsilon defines the minimal distance to define values as equals
  80429. * @returns true if both vectors are distant less than epsilon
  80430. */
  80431. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  80432. /**
  80433. * Returns true if the current Vector3 coordinates equals the given floats
  80434. * @param x defines the x coordinate of the operand
  80435. * @param y defines the y coordinate of the operand
  80436. * @param z defines the z coordinate of the operand
  80437. * @returns true if both vectors are equals
  80438. */
  80439. equalsToFloats(x: number, y: number, z: number): boolean;
  80440. /**
  80441. * Multiplies the current Vector3 coordinates by the given ones
  80442. * @param otherVector defines the second operand
  80443. * @returns the current updated Vector3
  80444. */
  80445. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  80446. /**
  80447. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  80448. * @param otherVector defines the second operand
  80449. * @returns the new Vector3
  80450. */
  80451. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  80452. /**
  80453. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  80454. * @param otherVector defines the second operand
  80455. * @param result defines the Vector3 object where to store the result
  80456. * @returns the current Vector3
  80457. */
  80458. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  80459. /**
  80460. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  80461. * @param x defines the x coordinate of the operand
  80462. * @param y defines the y coordinate of the operand
  80463. * @param z defines the z coordinate of the operand
  80464. * @returns the new Vector3
  80465. */
  80466. multiplyByFloats(x: number, y: number, z: number): Vector3;
  80467. /**
  80468. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  80469. * @param otherVector defines the second operand
  80470. * @returns the new Vector3
  80471. */
  80472. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  80473. /**
  80474. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  80475. * @param otherVector defines the second operand
  80476. * @param result defines the Vector3 object where to store the result
  80477. * @returns the current Vector3
  80478. */
  80479. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  80480. /**
  80481. * Divides the current Vector3 coordinates by the given ones.
  80482. * @param otherVector defines the second operand
  80483. * @returns the current updated Vector3
  80484. */
  80485. divideInPlace(otherVector: Vector3): Vector3;
  80486. /**
  80487. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  80488. * @param other defines the second operand
  80489. * @returns the current updated Vector3
  80490. */
  80491. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  80492. /**
  80493. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  80494. * @param other defines the second operand
  80495. * @returns the current updated Vector3
  80496. */
  80497. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  80498. /**
  80499. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  80500. * @param x defines the x coordinate of the operand
  80501. * @param y defines the y coordinate of the operand
  80502. * @param z defines the z coordinate of the operand
  80503. * @returns the current updated Vector3
  80504. */
  80505. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  80506. /**
  80507. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  80508. * @param x defines the x coordinate of the operand
  80509. * @param y defines the y coordinate of the operand
  80510. * @param z defines the z coordinate of the operand
  80511. * @returns the current updated Vector3
  80512. */
  80513. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  80514. /**
  80515. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  80516. * Check if is non uniform within a certain amount of decimal places to account for this
  80517. * @param epsilon the amount the values can differ
  80518. * @returns if the the vector is non uniform to a certain number of decimal places
  80519. */
  80520. isNonUniformWithinEpsilon(epsilon: number): boolean;
  80521. /**
  80522. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  80523. */
  80524. get isNonUniform(): boolean;
  80525. /**
  80526. * Gets a new Vector3 from current Vector3 floored values
  80527. * @returns a new Vector3
  80528. */
  80529. floor(): Vector3;
  80530. /**
  80531. * Gets a new Vector3 from current Vector3 floored values
  80532. * @returns a new Vector3
  80533. */
  80534. fract(): Vector3;
  80535. /**
  80536. * Gets the length of the Vector3
  80537. * @returns the length of the Vector3
  80538. */
  80539. length(): number;
  80540. /**
  80541. * Gets the squared length of the Vector3
  80542. * @returns squared length of the Vector3
  80543. */
  80544. lengthSquared(): number;
  80545. /**
  80546. * Normalize the current Vector3.
  80547. * Please note that this is an in place operation.
  80548. * @returns the current updated Vector3
  80549. */
  80550. normalize(): Vector3;
  80551. /**
  80552. * Reorders the x y z properties of the vector in place
  80553. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  80554. * @returns the current updated vector
  80555. */
  80556. reorderInPlace(order: string): this;
  80557. /**
  80558. * Rotates the vector around 0,0,0 by a quaternion
  80559. * @param quaternion the rotation quaternion
  80560. * @param result vector to store the result
  80561. * @returns the resulting vector
  80562. */
  80563. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  80564. /**
  80565. * Rotates a vector around a given point
  80566. * @param quaternion the rotation quaternion
  80567. * @param point the point to rotate around
  80568. * @param result vector to store the result
  80569. * @returns the resulting vector
  80570. */
  80571. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  80572. /**
  80573. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  80574. * The cross product is then orthogonal to both current and "other"
  80575. * @param other defines the right operand
  80576. * @returns the cross product
  80577. */
  80578. cross(other: Vector3): Vector3;
  80579. /**
  80580. * Normalize the current Vector3 with the given input length.
  80581. * Please note that this is an in place operation.
  80582. * @param len the length of the vector
  80583. * @returns the current updated Vector3
  80584. */
  80585. normalizeFromLength(len: number): Vector3;
  80586. /**
  80587. * Normalize the current Vector3 to a new vector
  80588. * @returns the new Vector3
  80589. */
  80590. normalizeToNew(): Vector3;
  80591. /**
  80592. * Normalize the current Vector3 to the reference
  80593. * @param reference define the Vector3 to update
  80594. * @returns the updated Vector3
  80595. */
  80596. normalizeToRef(reference: Vector3): Vector3;
  80597. /**
  80598. * Creates a new Vector3 copied from the current Vector3
  80599. * @returns the new Vector3
  80600. */
  80601. clone(): Vector3;
  80602. /**
  80603. * Copies the given vector coordinates to the current Vector3 ones
  80604. * @param source defines the source Vector3
  80605. * @returns the current updated Vector3
  80606. */
  80607. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  80608. /**
  80609. * Copies the given floats to the current Vector3 coordinates
  80610. * @param x defines the x coordinate of the operand
  80611. * @param y defines the y coordinate of the operand
  80612. * @param z defines the z coordinate of the operand
  80613. * @returns the current updated Vector3
  80614. */
  80615. copyFromFloats(x: number, y: number, z: number): Vector3;
  80616. /**
  80617. * Copies the given floats to the current Vector3 coordinates
  80618. * @param x defines the x coordinate of the operand
  80619. * @param y defines the y coordinate of the operand
  80620. * @param z defines the z coordinate of the operand
  80621. * @returns the current updated Vector3
  80622. */
  80623. set(x: number, y: number, z: number): Vector3;
  80624. /**
  80625. * Copies the given float to the current Vector3 coordinates
  80626. * @param v defines the x, y and z coordinates of the operand
  80627. * @returns the current updated Vector3
  80628. */
  80629. setAll(v: number): Vector3;
  80630. /**
  80631. * Get the clip factor between two vectors
  80632. * @param vector0 defines the first operand
  80633. * @param vector1 defines the second operand
  80634. * @param axis defines the axis to use
  80635. * @param size defines the size along the axis
  80636. * @returns the clip factor
  80637. */
  80638. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  80639. /**
  80640. * Get angle between two vectors
  80641. * @param vector0 angle between vector0 and vector1
  80642. * @param vector1 angle between vector0 and vector1
  80643. * @param normal direction of the normal
  80644. * @return the angle between vector0 and vector1
  80645. */
  80646. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  80647. /**
  80648. * Returns a new Vector3 set from the index "offset" of the given array
  80649. * @param array defines the source array
  80650. * @param offset defines the offset in the source array
  80651. * @returns the new Vector3
  80652. */
  80653. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  80654. /**
  80655. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  80656. * @param array defines the source array
  80657. * @param offset defines the offset in the source array
  80658. * @returns the new Vector3
  80659. * @deprecated Please use FromArray instead.
  80660. */
  80661. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  80662. /**
  80663. * Sets the given vector "result" with the element values from the index "offset" of the given array
  80664. * @param array defines the source array
  80665. * @param offset defines the offset in the source array
  80666. * @param result defines the Vector3 where to store the result
  80667. */
  80668. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  80669. /**
  80670. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  80671. * @param array defines the source array
  80672. * @param offset defines the offset in the source array
  80673. * @param result defines the Vector3 where to store the result
  80674. * @deprecated Please use FromArrayToRef instead.
  80675. */
  80676. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  80677. /**
  80678. * Sets the given vector "result" with the given floats.
  80679. * @param x defines the x coordinate of the source
  80680. * @param y defines the y coordinate of the source
  80681. * @param z defines the z coordinate of the source
  80682. * @param result defines the Vector3 where to store the result
  80683. */
  80684. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  80685. /**
  80686. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  80687. * @returns a new empty Vector3
  80688. */
  80689. static Zero(): Vector3;
  80690. /**
  80691. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  80692. * @returns a new unit Vector3
  80693. */
  80694. static One(): Vector3;
  80695. /**
  80696. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  80697. * @returns a new up Vector3
  80698. */
  80699. static Up(): Vector3;
  80700. /**
  80701. * Gets a up Vector3 that must not be updated
  80702. */
  80703. static get UpReadOnly(): DeepImmutable<Vector3>;
  80704. /**
  80705. * Gets a zero Vector3 that must not be updated
  80706. */
  80707. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  80708. /**
  80709. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  80710. * @returns a new down Vector3
  80711. */
  80712. static Down(): Vector3;
  80713. /**
  80714. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  80715. * @param rightHandedSystem is the scene right-handed (negative z)
  80716. * @returns a new forward Vector3
  80717. */
  80718. static Forward(rightHandedSystem?: boolean): Vector3;
  80719. /**
  80720. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  80721. * @param rightHandedSystem is the scene right-handed (negative-z)
  80722. * @returns a new forward Vector3
  80723. */
  80724. static Backward(rightHandedSystem?: boolean): Vector3;
  80725. /**
  80726. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  80727. * @returns a new right Vector3
  80728. */
  80729. static Right(): Vector3;
  80730. /**
  80731. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  80732. * @returns a new left Vector3
  80733. */
  80734. static Left(): Vector3;
  80735. /**
  80736. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  80737. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  80738. * @param vector defines the Vector3 to transform
  80739. * @param transformation defines the transformation matrix
  80740. * @returns the transformed Vector3
  80741. */
  80742. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  80743. /**
  80744. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  80745. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  80746. * @param vector defines the Vector3 to transform
  80747. * @param transformation defines the transformation matrix
  80748. * @param result defines the Vector3 where to store the result
  80749. */
  80750. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  80751. /**
  80752. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  80753. * This method computes tranformed coordinates only, not transformed direction vectors
  80754. * @param x define the x coordinate of the source vector
  80755. * @param y define the y coordinate of the source vector
  80756. * @param z define the z coordinate of the source vector
  80757. * @param transformation defines the transformation matrix
  80758. * @param result defines the Vector3 where to store the result
  80759. */
  80760. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  80761. /**
  80762. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  80763. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  80764. * @param vector defines the Vector3 to transform
  80765. * @param transformation defines the transformation matrix
  80766. * @returns the new Vector3
  80767. */
  80768. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  80769. /**
  80770. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  80771. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  80772. * @param vector defines the Vector3 to transform
  80773. * @param transformation defines the transformation matrix
  80774. * @param result defines the Vector3 where to store the result
  80775. */
  80776. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  80777. /**
  80778. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  80779. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  80780. * @param x define the x coordinate of the source vector
  80781. * @param y define the y coordinate of the source vector
  80782. * @param z define the z coordinate of the source vector
  80783. * @param transformation defines the transformation matrix
  80784. * @param result defines the Vector3 where to store the result
  80785. */
  80786. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  80787. /**
  80788. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  80789. * @param value1 defines the first control point
  80790. * @param value2 defines the second control point
  80791. * @param value3 defines the third control point
  80792. * @param value4 defines the fourth control point
  80793. * @param amount defines the amount on the spline to use
  80794. * @returns the new Vector3
  80795. */
  80796. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  80797. /**
  80798. * 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"
  80799. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  80800. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  80801. * @param value defines the current value
  80802. * @param min defines the lower range value
  80803. * @param max defines the upper range value
  80804. * @returns the new Vector3
  80805. */
  80806. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  80807. /**
  80808. * 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"
  80809. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  80810. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  80811. * @param value defines the current value
  80812. * @param min defines the lower range value
  80813. * @param max defines the upper range value
  80814. * @param result defines the Vector3 where to store the result
  80815. */
  80816. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  80817. /**
  80818. * Checks if a given vector is inside a specific range
  80819. * @param v defines the vector to test
  80820. * @param min defines the minimum range
  80821. * @param max defines the maximum range
  80822. */
  80823. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  80824. /**
  80825. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  80826. * @param value1 defines the first control point
  80827. * @param tangent1 defines the first tangent vector
  80828. * @param value2 defines the second control point
  80829. * @param tangent2 defines the second tangent vector
  80830. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  80831. * @returns the new Vector3
  80832. */
  80833. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  80834. /**
  80835. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  80836. * @param start defines the start value
  80837. * @param end defines the end value
  80838. * @param amount max defines amount between both (between 0 and 1)
  80839. * @returns the new Vector3
  80840. */
  80841. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  80842. /**
  80843. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  80844. * @param start defines the start value
  80845. * @param end defines the end value
  80846. * @param amount max defines amount between both (between 0 and 1)
  80847. * @param result defines the Vector3 where to store the result
  80848. */
  80849. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  80850. /**
  80851. * Returns the dot product (float) between the vectors "left" and "right"
  80852. * @param left defines the left operand
  80853. * @param right defines the right operand
  80854. * @returns the dot product
  80855. */
  80856. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  80857. /**
  80858. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  80859. * The cross product is then orthogonal to both "left" and "right"
  80860. * @param left defines the left operand
  80861. * @param right defines the right operand
  80862. * @returns the cross product
  80863. */
  80864. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  80865. /**
  80866. * Sets the given vector "result" with the cross product of "left" and "right"
  80867. * The cross product is then orthogonal to both "left" and "right"
  80868. * @param left defines the left operand
  80869. * @param right defines the right operand
  80870. * @param result defines the Vector3 where to store the result
  80871. */
  80872. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  80873. /**
  80874. * Returns a new Vector3 as the normalization of the given vector
  80875. * @param vector defines the Vector3 to normalize
  80876. * @returns the new Vector3
  80877. */
  80878. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  80879. /**
  80880. * Sets the given vector "result" with the normalization of the given first vector
  80881. * @param vector defines the Vector3 to normalize
  80882. * @param result defines the Vector3 where to store the result
  80883. */
  80884. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  80885. /**
  80886. * Project a Vector3 onto screen space
  80887. * @param vector defines the Vector3 to project
  80888. * @param world defines the world matrix to use
  80889. * @param transform defines the transform (view x projection) matrix to use
  80890. * @param viewport defines the screen viewport to use
  80891. * @returns the new Vector3
  80892. */
  80893. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  80894. /** @hidden */
  80895. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  80896. /**
  80897. * Unproject from screen space to object space
  80898. * @param source defines the screen space Vector3 to use
  80899. * @param viewportWidth defines the current width of the viewport
  80900. * @param viewportHeight defines the current height of the viewport
  80901. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  80902. * @param transform defines the transform (view x projection) matrix to use
  80903. * @returns the new Vector3
  80904. */
  80905. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  80906. /**
  80907. * Unproject from screen space to object space
  80908. * @param source defines the screen space Vector3 to use
  80909. * @param viewportWidth defines the current width of the viewport
  80910. * @param viewportHeight defines the current height of the viewport
  80911. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  80912. * @param view defines the view matrix to use
  80913. * @param projection defines the projection matrix to use
  80914. * @returns the new Vector3
  80915. */
  80916. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  80917. /**
  80918. * Unproject from screen space to object space
  80919. * @param source defines the screen space Vector3 to use
  80920. * @param viewportWidth defines the current width of the viewport
  80921. * @param viewportHeight defines the current height of the viewport
  80922. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  80923. * @param view defines the view matrix to use
  80924. * @param projection defines the projection matrix to use
  80925. * @param result defines the Vector3 where to store the result
  80926. */
  80927. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  80928. /**
  80929. * Unproject from screen space to object space
  80930. * @param sourceX defines the screen space x coordinate to use
  80931. * @param sourceY defines the screen space y coordinate to use
  80932. * @param sourceZ defines the screen space z coordinate to use
  80933. * @param viewportWidth defines the current width of the viewport
  80934. * @param viewportHeight defines the current height of the viewport
  80935. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  80936. * @param view defines the view matrix to use
  80937. * @param projection defines the projection matrix to use
  80938. * @param result defines the Vector3 where to store the result
  80939. */
  80940. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  80941. /**
  80942. * Gets the minimal coordinate values between two Vector3
  80943. * @param left defines the first operand
  80944. * @param right defines the second operand
  80945. * @returns the new Vector3
  80946. */
  80947. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  80948. /**
  80949. * Gets the maximal coordinate values between two Vector3
  80950. * @param left defines the first operand
  80951. * @param right defines the second operand
  80952. * @returns the new Vector3
  80953. */
  80954. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  80955. /**
  80956. * Returns the distance between the vectors "value1" and "value2"
  80957. * @param value1 defines the first operand
  80958. * @param value2 defines the second operand
  80959. * @returns the distance
  80960. */
  80961. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  80962. /**
  80963. * Returns the squared distance between the vectors "value1" and "value2"
  80964. * @param value1 defines the first operand
  80965. * @param value2 defines the second operand
  80966. * @returns the squared distance
  80967. */
  80968. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  80969. /**
  80970. * Returns a new Vector3 located at the center between "value1" and "value2"
  80971. * @param value1 defines the first operand
  80972. * @param value2 defines the second operand
  80973. * @returns the new Vector3
  80974. */
  80975. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  80976. /**
  80977. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  80978. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  80979. * to something in order to rotate it from its local system to the given target system
  80980. * Note: axis1, axis2 and axis3 are normalized during this operation
  80981. * @param axis1 defines the first axis
  80982. * @param axis2 defines the second axis
  80983. * @param axis3 defines the third axis
  80984. * @returns a new Vector3
  80985. */
  80986. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  80987. /**
  80988. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  80989. * @param axis1 defines the first axis
  80990. * @param axis2 defines the second axis
  80991. * @param axis3 defines the third axis
  80992. * @param ref defines the Vector3 where to store the result
  80993. */
  80994. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  80995. }
  80996. /**
  80997. * Vector4 class created for EulerAngle class conversion to Quaternion
  80998. */
  80999. export class Vector4 {
  81000. /** x value of the vector */
  81001. x: number;
  81002. /** y value of the vector */
  81003. y: number;
  81004. /** z value of the vector */
  81005. z: number;
  81006. /** w value of the vector */
  81007. w: number;
  81008. /**
  81009. * Creates a Vector4 object from the given floats.
  81010. * @param x x value of the vector
  81011. * @param y y value of the vector
  81012. * @param z z value of the vector
  81013. * @param w w value of the vector
  81014. */
  81015. constructor(
  81016. /** x value of the vector */
  81017. x: number,
  81018. /** y value of the vector */
  81019. y: number,
  81020. /** z value of the vector */
  81021. z: number,
  81022. /** w value of the vector */
  81023. w: number);
  81024. /**
  81025. * Returns the string with the Vector4 coordinates.
  81026. * @returns a string containing all the vector values
  81027. */
  81028. toString(): string;
  81029. /**
  81030. * Returns the string "Vector4".
  81031. * @returns "Vector4"
  81032. */
  81033. getClassName(): string;
  81034. /**
  81035. * Returns the Vector4 hash code.
  81036. * @returns a unique hash code
  81037. */
  81038. getHashCode(): number;
  81039. /**
  81040. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  81041. * @returns the resulting array
  81042. */
  81043. asArray(): number[];
  81044. /**
  81045. * Populates the given array from the given index with the Vector4 coordinates.
  81046. * @param array array to populate
  81047. * @param index index of the array to start at (default: 0)
  81048. * @returns the Vector4.
  81049. */
  81050. toArray(array: FloatArray, index?: number): Vector4;
  81051. /**
  81052. * Adds the given vector to the current Vector4.
  81053. * @param otherVector the vector to add
  81054. * @returns the updated Vector4.
  81055. */
  81056. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  81057. /**
  81058. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  81059. * @param otherVector the vector to add
  81060. * @returns the resulting vector
  81061. */
  81062. add(otherVector: DeepImmutable<Vector4>): Vector4;
  81063. /**
  81064. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  81065. * @param otherVector the vector to add
  81066. * @param result the vector to store the result
  81067. * @returns the current Vector4.
  81068. */
  81069. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  81070. /**
  81071. * Subtract in place the given vector from the current Vector4.
  81072. * @param otherVector the vector to subtract
  81073. * @returns the updated Vector4.
  81074. */
  81075. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  81076. /**
  81077. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  81078. * @param otherVector the vector to add
  81079. * @returns the new vector with the result
  81080. */
  81081. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  81082. /**
  81083. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  81084. * @param otherVector the vector to subtract
  81085. * @param result the vector to store the result
  81086. * @returns the current Vector4.
  81087. */
  81088. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  81089. /**
  81090. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  81091. */
  81092. /**
  81093. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  81094. * @param x value to subtract
  81095. * @param y value to subtract
  81096. * @param z value to subtract
  81097. * @param w value to subtract
  81098. * @returns new vector containing the result
  81099. */
  81100. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  81101. /**
  81102. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  81103. * @param x value to subtract
  81104. * @param y value to subtract
  81105. * @param z value to subtract
  81106. * @param w value to subtract
  81107. * @param result the vector to store the result in
  81108. * @returns the current Vector4.
  81109. */
  81110. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  81111. /**
  81112. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  81113. * @returns a new vector with the negated values
  81114. */
  81115. negate(): Vector4;
  81116. /**
  81117. * Negate this vector in place
  81118. * @returns this
  81119. */
  81120. negateInPlace(): Vector4;
  81121. /**
  81122. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  81123. * @param result defines the Vector3 object where to store the result
  81124. * @returns the current Vector4
  81125. */
  81126. negateToRef(result: Vector4): Vector4;
  81127. /**
  81128. * Multiplies the current Vector4 coordinates by scale (float).
  81129. * @param scale the number to scale with
  81130. * @returns the updated Vector4.
  81131. */
  81132. scaleInPlace(scale: number): Vector4;
  81133. /**
  81134. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  81135. * @param scale the number to scale with
  81136. * @returns a new vector with the result
  81137. */
  81138. scale(scale: number): Vector4;
  81139. /**
  81140. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  81141. * @param scale the number to scale with
  81142. * @param result a vector to store the result in
  81143. * @returns the current Vector4.
  81144. */
  81145. scaleToRef(scale: number, result: Vector4): Vector4;
  81146. /**
  81147. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  81148. * @param scale defines the scale factor
  81149. * @param result defines the Vector4 object where to store the result
  81150. * @returns the unmodified current Vector4
  81151. */
  81152. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  81153. /**
  81154. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  81155. * @param otherVector the vector to compare against
  81156. * @returns true if they are equal
  81157. */
  81158. equals(otherVector: DeepImmutable<Vector4>): boolean;
  81159. /**
  81160. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  81161. * @param otherVector vector to compare against
  81162. * @param epsilon (Default: very small number)
  81163. * @returns true if they are equal
  81164. */
  81165. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  81166. /**
  81167. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  81168. * @param x x value to compare against
  81169. * @param y y value to compare against
  81170. * @param z z value to compare against
  81171. * @param w w value to compare against
  81172. * @returns true if equal
  81173. */
  81174. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  81175. /**
  81176. * Multiplies in place the current Vector4 by the given one.
  81177. * @param otherVector vector to multiple with
  81178. * @returns the updated Vector4.
  81179. */
  81180. multiplyInPlace(otherVector: Vector4): Vector4;
  81181. /**
  81182. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  81183. * @param otherVector vector to multiple with
  81184. * @returns resulting new vector
  81185. */
  81186. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  81187. /**
  81188. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  81189. * @param otherVector vector to multiple with
  81190. * @param result vector to store the result
  81191. * @returns the current Vector4.
  81192. */
  81193. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  81194. /**
  81195. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  81196. * @param x x value multiply with
  81197. * @param y y value multiply with
  81198. * @param z z value multiply with
  81199. * @param w w value multiply with
  81200. * @returns resulting new vector
  81201. */
  81202. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  81203. /**
  81204. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  81205. * @param otherVector vector to devide with
  81206. * @returns resulting new vector
  81207. */
  81208. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  81209. /**
  81210. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  81211. * @param otherVector vector to devide with
  81212. * @param result vector to store the result
  81213. * @returns the current Vector4.
  81214. */
  81215. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  81216. /**
  81217. * Divides the current Vector3 coordinates by the given ones.
  81218. * @param otherVector vector to devide with
  81219. * @returns the updated Vector3.
  81220. */
  81221. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  81222. /**
  81223. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  81224. * @param other defines the second operand
  81225. * @returns the current updated Vector4
  81226. */
  81227. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  81228. /**
  81229. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  81230. * @param other defines the second operand
  81231. * @returns the current updated Vector4
  81232. */
  81233. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  81234. /**
  81235. * Gets a new Vector4 from current Vector4 floored values
  81236. * @returns a new Vector4
  81237. */
  81238. floor(): Vector4;
  81239. /**
  81240. * Gets a new Vector4 from current Vector3 floored values
  81241. * @returns a new Vector4
  81242. */
  81243. fract(): Vector4;
  81244. /**
  81245. * Returns the Vector4 length (float).
  81246. * @returns the length
  81247. */
  81248. length(): number;
  81249. /**
  81250. * Returns the Vector4 squared length (float).
  81251. * @returns the length squared
  81252. */
  81253. lengthSquared(): number;
  81254. /**
  81255. * Normalizes in place the Vector4.
  81256. * @returns the updated Vector4.
  81257. */
  81258. normalize(): Vector4;
  81259. /**
  81260. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  81261. * @returns this converted to a new vector3
  81262. */
  81263. toVector3(): Vector3;
  81264. /**
  81265. * Returns a new Vector4 copied from the current one.
  81266. * @returns the new cloned vector
  81267. */
  81268. clone(): Vector4;
  81269. /**
  81270. * Updates the current Vector4 with the given one coordinates.
  81271. * @param source the source vector to copy from
  81272. * @returns the updated Vector4.
  81273. */
  81274. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  81275. /**
  81276. * Updates the current Vector4 coordinates with the given floats.
  81277. * @param x float to copy from
  81278. * @param y float to copy from
  81279. * @param z float to copy from
  81280. * @param w float to copy from
  81281. * @returns the updated Vector4.
  81282. */
  81283. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  81284. /**
  81285. * Updates the current Vector4 coordinates with the given floats.
  81286. * @param x float to set from
  81287. * @param y float to set from
  81288. * @param z float to set from
  81289. * @param w float to set from
  81290. * @returns the updated Vector4.
  81291. */
  81292. set(x: number, y: number, z: number, w: number): Vector4;
  81293. /**
  81294. * Copies the given float to the current Vector3 coordinates
  81295. * @param v defines the x, y, z and w coordinates of the operand
  81296. * @returns the current updated Vector3
  81297. */
  81298. setAll(v: number): Vector4;
  81299. /**
  81300. * Returns a new Vector4 set from the starting index of the given array.
  81301. * @param array the array to pull values from
  81302. * @param offset the offset into the array to start at
  81303. * @returns the new vector
  81304. */
  81305. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  81306. /**
  81307. * Updates the given vector "result" from the starting index of the given array.
  81308. * @param array the array to pull values from
  81309. * @param offset the offset into the array to start at
  81310. * @param result the vector to store the result in
  81311. */
  81312. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  81313. /**
  81314. * Updates the given vector "result" from the starting index of the given Float32Array.
  81315. * @param array the array to pull values from
  81316. * @param offset the offset into the array to start at
  81317. * @param result the vector to store the result in
  81318. */
  81319. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  81320. /**
  81321. * Updates the given vector "result" coordinates from the given floats.
  81322. * @param x float to set from
  81323. * @param y float to set from
  81324. * @param z float to set from
  81325. * @param w float to set from
  81326. * @param result the vector to the floats in
  81327. */
  81328. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  81329. /**
  81330. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  81331. * @returns the new vector
  81332. */
  81333. static Zero(): Vector4;
  81334. /**
  81335. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  81336. * @returns the new vector
  81337. */
  81338. static One(): Vector4;
  81339. /**
  81340. * Returns a new normalized Vector4 from the given one.
  81341. * @param vector the vector to normalize
  81342. * @returns the vector
  81343. */
  81344. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  81345. /**
  81346. * Updates the given vector "result" from the normalization of the given one.
  81347. * @param vector the vector to normalize
  81348. * @param result the vector to store the result in
  81349. */
  81350. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  81351. /**
  81352. * Returns a vector with the minimum values from the left and right vectors
  81353. * @param left left vector to minimize
  81354. * @param right right vector to minimize
  81355. * @returns a new vector with the minimum of the left and right vector values
  81356. */
  81357. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  81358. /**
  81359. * Returns a vector with the maximum values from the left and right vectors
  81360. * @param left left vector to maximize
  81361. * @param right right vector to maximize
  81362. * @returns a new vector with the maximum of the left and right vector values
  81363. */
  81364. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  81365. /**
  81366. * Returns the distance (float) between the vectors "value1" and "value2".
  81367. * @param value1 value to calulate the distance between
  81368. * @param value2 value to calulate the distance between
  81369. * @return the distance between the two vectors
  81370. */
  81371. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  81372. /**
  81373. * Returns the squared distance (float) between the vectors "value1" and "value2".
  81374. * @param value1 value to calulate the distance between
  81375. * @param value2 value to calulate the distance between
  81376. * @return the distance between the two vectors squared
  81377. */
  81378. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  81379. /**
  81380. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  81381. * @param value1 value to calulate the center between
  81382. * @param value2 value to calulate the center between
  81383. * @return the center between the two vectors
  81384. */
  81385. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  81386. /**
  81387. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  81388. * This methods computes transformed normalized direction vectors only.
  81389. * @param vector the vector to transform
  81390. * @param transformation the transformation matrix to apply
  81391. * @returns the new vector
  81392. */
  81393. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  81394. /**
  81395. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  81396. * This methods computes transformed normalized direction vectors only.
  81397. * @param vector the vector to transform
  81398. * @param transformation the transformation matrix to apply
  81399. * @param result the vector to store the result in
  81400. */
  81401. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  81402. /**
  81403. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  81404. * This methods computes transformed normalized direction vectors only.
  81405. * @param x value to transform
  81406. * @param y value to transform
  81407. * @param z value to transform
  81408. * @param w value to transform
  81409. * @param transformation the transformation matrix to apply
  81410. * @param result the vector to store the results in
  81411. */
  81412. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  81413. /**
  81414. * Creates a new Vector4 from a Vector3
  81415. * @param source defines the source data
  81416. * @param w defines the 4th component (default is 0)
  81417. * @returns a new Vector4
  81418. */
  81419. static FromVector3(source: Vector3, w?: number): Vector4;
  81420. }
  81421. /**
  81422. * Class used to store quaternion data
  81423. * @see https://en.wikipedia.org/wiki/Quaternion
  81424. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  81425. */
  81426. export class Quaternion {
  81427. /** @hidden */
  81428. _x: number;
  81429. /** @hidden */
  81430. _y: number;
  81431. /** @hidden */
  81432. _z: number;
  81433. /** @hidden */
  81434. _w: number;
  81435. /** @hidden */
  81436. _isDirty: boolean;
  81437. /** Gets or sets the x coordinate */
  81438. get x(): number;
  81439. set x(value: number);
  81440. /** Gets or sets the y coordinate */
  81441. get y(): number;
  81442. set y(value: number);
  81443. /** Gets or sets the z coordinate */
  81444. get z(): number;
  81445. set z(value: number);
  81446. /** Gets or sets the w coordinate */
  81447. get w(): number;
  81448. set w(value: number);
  81449. /**
  81450. * Creates a new Quaternion from the given floats
  81451. * @param x defines the first component (0 by default)
  81452. * @param y defines the second component (0 by default)
  81453. * @param z defines the third component (0 by default)
  81454. * @param w defines the fourth component (1.0 by default)
  81455. */
  81456. constructor(x?: number, y?: number, z?: number, w?: number);
  81457. /**
  81458. * Gets a string representation for the current quaternion
  81459. * @returns a string with the Quaternion coordinates
  81460. */
  81461. toString(): string;
  81462. /**
  81463. * Gets the class name of the quaternion
  81464. * @returns the string "Quaternion"
  81465. */
  81466. getClassName(): string;
  81467. /**
  81468. * Gets a hash code for this quaternion
  81469. * @returns the quaternion hash code
  81470. */
  81471. getHashCode(): number;
  81472. /**
  81473. * Copy the quaternion to an array
  81474. * @returns a new array populated with 4 elements from the quaternion coordinates
  81475. */
  81476. asArray(): number[];
  81477. /**
  81478. * Check if two quaternions are equals
  81479. * @param otherQuaternion defines the second operand
  81480. * @return true if the current quaternion and the given one coordinates are strictly equals
  81481. */
  81482. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  81483. /**
  81484. * Gets a boolean if two quaternions are equals (using an epsilon value)
  81485. * @param otherQuaternion defines the other quaternion
  81486. * @param epsilon defines the minimal distance to consider equality
  81487. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  81488. */
  81489. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  81490. /**
  81491. * Clone the current quaternion
  81492. * @returns a new quaternion copied from the current one
  81493. */
  81494. clone(): Quaternion;
  81495. /**
  81496. * Copy a quaternion to the current one
  81497. * @param other defines the other quaternion
  81498. * @returns the updated current quaternion
  81499. */
  81500. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  81501. /**
  81502. * Updates the current quaternion with the given float coordinates
  81503. * @param x defines the x coordinate
  81504. * @param y defines the y coordinate
  81505. * @param z defines the z coordinate
  81506. * @param w defines the w coordinate
  81507. * @returns the updated current quaternion
  81508. */
  81509. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  81510. /**
  81511. * Updates the current quaternion from the given float coordinates
  81512. * @param x defines the x coordinate
  81513. * @param y defines the y coordinate
  81514. * @param z defines the z coordinate
  81515. * @param w defines the w coordinate
  81516. * @returns the updated current quaternion
  81517. */
  81518. set(x: number, y: number, z: number, w: number): Quaternion;
  81519. /**
  81520. * Adds two quaternions
  81521. * @param other defines the second operand
  81522. * @returns a new quaternion as the addition result of the given one and the current quaternion
  81523. */
  81524. add(other: DeepImmutable<Quaternion>): Quaternion;
  81525. /**
  81526. * Add a quaternion to the current one
  81527. * @param other defines the quaternion to add
  81528. * @returns the current quaternion
  81529. */
  81530. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  81531. /**
  81532. * Subtract two quaternions
  81533. * @param other defines the second operand
  81534. * @returns a new quaternion as the subtraction result of the given one from the current one
  81535. */
  81536. subtract(other: Quaternion): Quaternion;
  81537. /**
  81538. * Multiplies the current quaternion by a scale factor
  81539. * @param value defines the scale factor
  81540. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  81541. */
  81542. scale(value: number): Quaternion;
  81543. /**
  81544. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  81545. * @param scale defines the scale factor
  81546. * @param result defines the Quaternion object where to store the result
  81547. * @returns the unmodified current quaternion
  81548. */
  81549. scaleToRef(scale: number, result: Quaternion): Quaternion;
  81550. /**
  81551. * Multiplies in place the current quaternion by a scale factor
  81552. * @param value defines the scale factor
  81553. * @returns the current modified quaternion
  81554. */
  81555. scaleInPlace(value: number): Quaternion;
  81556. /**
  81557. * Scale the current quaternion values by a factor and add the result to a given quaternion
  81558. * @param scale defines the scale factor
  81559. * @param result defines the Quaternion object where to store the result
  81560. * @returns the unmodified current quaternion
  81561. */
  81562. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  81563. /**
  81564. * Multiplies two quaternions
  81565. * @param q1 defines the second operand
  81566. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  81567. */
  81568. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  81569. /**
  81570. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  81571. * @param q1 defines the second operand
  81572. * @param result defines the target quaternion
  81573. * @returns the current quaternion
  81574. */
  81575. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  81576. /**
  81577. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  81578. * @param q1 defines the second operand
  81579. * @returns the currentupdated quaternion
  81580. */
  81581. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  81582. /**
  81583. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  81584. * @param ref defines the target quaternion
  81585. * @returns the current quaternion
  81586. */
  81587. conjugateToRef(ref: Quaternion): Quaternion;
  81588. /**
  81589. * Conjugates in place (1-q) the current quaternion
  81590. * @returns the current updated quaternion
  81591. */
  81592. conjugateInPlace(): Quaternion;
  81593. /**
  81594. * Conjugates in place (1-q) the current quaternion
  81595. * @returns a new quaternion
  81596. */
  81597. conjugate(): Quaternion;
  81598. /**
  81599. * Gets length of current quaternion
  81600. * @returns the quaternion length (float)
  81601. */
  81602. length(): number;
  81603. /**
  81604. * Normalize in place the current quaternion
  81605. * @returns the current updated quaternion
  81606. */
  81607. normalize(): Quaternion;
  81608. /**
  81609. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  81610. * @param order is a reserved parameter and is ignore for now
  81611. * @returns a new Vector3 containing the Euler angles
  81612. */
  81613. toEulerAngles(order?: string): Vector3;
  81614. /**
  81615. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  81616. * @param result defines the vector which will be filled with the Euler angles
  81617. * @param order is a reserved parameter and is ignore for now
  81618. * @returns the current unchanged quaternion
  81619. */
  81620. toEulerAnglesToRef(result: Vector3): Quaternion;
  81621. /**
  81622. * Updates the given rotation matrix with the current quaternion values
  81623. * @param result defines the target matrix
  81624. * @returns the current unchanged quaternion
  81625. */
  81626. toRotationMatrix(result: Matrix): Quaternion;
  81627. /**
  81628. * Updates the current quaternion from the given rotation matrix values
  81629. * @param matrix defines the source matrix
  81630. * @returns the current updated quaternion
  81631. */
  81632. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  81633. /**
  81634. * Creates a new quaternion from a rotation matrix
  81635. * @param matrix defines the source matrix
  81636. * @returns a new quaternion created from the given rotation matrix values
  81637. */
  81638. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  81639. /**
  81640. * Updates the given quaternion with the given rotation matrix values
  81641. * @param matrix defines the source matrix
  81642. * @param result defines the target quaternion
  81643. */
  81644. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  81645. /**
  81646. * Returns the dot product (float) between the quaternions "left" and "right"
  81647. * @param left defines the left operand
  81648. * @param right defines the right operand
  81649. * @returns the dot product
  81650. */
  81651. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  81652. /**
  81653. * Checks if the two quaternions are close to each other
  81654. * @param quat0 defines the first quaternion to check
  81655. * @param quat1 defines the second quaternion to check
  81656. * @returns true if the two quaternions are close to each other
  81657. */
  81658. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  81659. /**
  81660. * Creates an empty quaternion
  81661. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  81662. */
  81663. static Zero(): Quaternion;
  81664. /**
  81665. * Inverse a given quaternion
  81666. * @param q defines the source quaternion
  81667. * @returns a new quaternion as the inverted current quaternion
  81668. */
  81669. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  81670. /**
  81671. * Inverse a given quaternion
  81672. * @param q defines the source quaternion
  81673. * @param result the quaternion the result will be stored in
  81674. * @returns the result quaternion
  81675. */
  81676. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  81677. /**
  81678. * Creates an identity quaternion
  81679. * @returns the identity quaternion
  81680. */
  81681. static Identity(): Quaternion;
  81682. /**
  81683. * Gets a boolean indicating if the given quaternion is identity
  81684. * @param quaternion defines the quaternion to check
  81685. * @returns true if the quaternion is identity
  81686. */
  81687. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  81688. /**
  81689. * Creates a quaternion from a rotation around an axis
  81690. * @param axis defines the axis to use
  81691. * @param angle defines the angle to use
  81692. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  81693. */
  81694. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  81695. /**
  81696. * Creates a rotation around an axis and stores it into the given quaternion
  81697. * @param axis defines the axis to use
  81698. * @param angle defines the angle to use
  81699. * @param result defines the target quaternion
  81700. * @returns the target quaternion
  81701. */
  81702. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  81703. /**
  81704. * Creates a new quaternion from data stored into an array
  81705. * @param array defines the data source
  81706. * @param offset defines the offset in the source array where the data starts
  81707. * @returns a new quaternion
  81708. */
  81709. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  81710. /**
  81711. * Updates the given quaternion "result" from the starting index of the given array.
  81712. * @param array the array to pull values from
  81713. * @param offset the offset into the array to start at
  81714. * @param result the quaternion to store the result in
  81715. */
  81716. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  81717. /**
  81718. * Create a quaternion from Euler rotation angles
  81719. * @param x Pitch
  81720. * @param y Yaw
  81721. * @param z Roll
  81722. * @returns the new Quaternion
  81723. */
  81724. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  81725. /**
  81726. * Updates a quaternion from Euler rotation angles
  81727. * @param x Pitch
  81728. * @param y Yaw
  81729. * @param z Roll
  81730. * @param result the quaternion to store the result
  81731. * @returns the updated quaternion
  81732. */
  81733. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  81734. /**
  81735. * Create a quaternion from Euler rotation vector
  81736. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  81737. * @returns the new Quaternion
  81738. */
  81739. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  81740. /**
  81741. * Updates a quaternion from Euler rotation vector
  81742. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  81743. * @param result the quaternion to store the result
  81744. * @returns the updated quaternion
  81745. */
  81746. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  81747. /**
  81748. * Creates a new quaternion from the given Euler float angles (y, x, z)
  81749. * @param yaw defines the rotation around Y axis
  81750. * @param pitch defines the rotation around X axis
  81751. * @param roll defines the rotation around Z axis
  81752. * @returns the new quaternion
  81753. */
  81754. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  81755. /**
  81756. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  81757. * @param yaw defines the rotation around Y axis
  81758. * @param pitch defines the rotation around X axis
  81759. * @param roll defines the rotation around Z axis
  81760. * @param result defines the target quaternion
  81761. */
  81762. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  81763. /**
  81764. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  81765. * @param alpha defines the rotation around first axis
  81766. * @param beta defines the rotation around second axis
  81767. * @param gamma defines the rotation around third axis
  81768. * @returns the new quaternion
  81769. */
  81770. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  81771. /**
  81772. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  81773. * @param alpha defines the rotation around first axis
  81774. * @param beta defines the rotation around second axis
  81775. * @param gamma defines the rotation around third axis
  81776. * @param result defines the target quaternion
  81777. */
  81778. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  81779. /**
  81780. * 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)
  81781. * @param axis1 defines the first axis
  81782. * @param axis2 defines the second axis
  81783. * @param axis3 defines the third axis
  81784. * @returns the new quaternion
  81785. */
  81786. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  81787. /**
  81788. * 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
  81789. * @param axis1 defines the first axis
  81790. * @param axis2 defines the second axis
  81791. * @param axis3 defines the third axis
  81792. * @param ref defines the target quaternion
  81793. */
  81794. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  81795. /**
  81796. * Interpolates between two quaternions
  81797. * @param left defines first quaternion
  81798. * @param right defines second quaternion
  81799. * @param amount defines the gradient to use
  81800. * @returns the new interpolated quaternion
  81801. */
  81802. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  81803. /**
  81804. * Interpolates between two quaternions and stores it into a target quaternion
  81805. * @param left defines first quaternion
  81806. * @param right defines second quaternion
  81807. * @param amount defines the gradient to use
  81808. * @param result defines the target quaternion
  81809. */
  81810. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  81811. /**
  81812. * Interpolate between two quaternions using Hermite interpolation
  81813. * @param value1 defines first quaternion
  81814. * @param tangent1 defines the incoming tangent
  81815. * @param value2 defines second quaternion
  81816. * @param tangent2 defines the outgoing tangent
  81817. * @param amount defines the target quaternion
  81818. * @returns the new interpolated quaternion
  81819. */
  81820. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  81821. }
  81822. /**
  81823. * Class used to store matrix data (4x4)
  81824. */
  81825. export class Matrix {
  81826. private static _updateFlagSeed;
  81827. private static _identityReadOnly;
  81828. private _isIdentity;
  81829. private _isIdentityDirty;
  81830. private _isIdentity3x2;
  81831. private _isIdentity3x2Dirty;
  81832. /**
  81833. * Gets the update flag of the matrix which is an unique number for the matrix.
  81834. * It will be incremented every time the matrix data change.
  81835. * You can use it to speed the comparison between two versions of the same matrix.
  81836. */
  81837. updateFlag: number;
  81838. private readonly _m;
  81839. /**
  81840. * Gets the internal data of the matrix
  81841. */
  81842. get m(): DeepImmutable<Float32Array>;
  81843. /** @hidden */
  81844. _markAsUpdated(): void;
  81845. /** @hidden */
  81846. private _updateIdentityStatus;
  81847. /**
  81848. * Creates an empty matrix (filled with zeros)
  81849. */
  81850. constructor();
  81851. /**
  81852. * Check if the current matrix is identity
  81853. * @returns true is the matrix is the identity matrix
  81854. */
  81855. isIdentity(): boolean;
  81856. /**
  81857. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  81858. * @returns true is the matrix is the identity matrix
  81859. */
  81860. isIdentityAs3x2(): boolean;
  81861. /**
  81862. * Gets the determinant of the matrix
  81863. * @returns the matrix determinant
  81864. */
  81865. determinant(): number;
  81866. /**
  81867. * Returns the matrix as a Float32Array
  81868. * @returns the matrix underlying array
  81869. */
  81870. toArray(): DeepImmutable<Float32Array>;
  81871. /**
  81872. * Returns the matrix as a Float32Array
  81873. * @returns the matrix underlying array.
  81874. */
  81875. asArray(): DeepImmutable<Float32Array>;
  81876. /**
  81877. * Inverts the current matrix in place
  81878. * @returns the current inverted matrix
  81879. */
  81880. invert(): Matrix;
  81881. /**
  81882. * Sets all the matrix elements to zero
  81883. * @returns the current matrix
  81884. */
  81885. reset(): Matrix;
  81886. /**
  81887. * Adds the current matrix with a second one
  81888. * @param other defines the matrix to add
  81889. * @returns a new matrix as the addition of the current matrix and the given one
  81890. */
  81891. add(other: DeepImmutable<Matrix>): Matrix;
  81892. /**
  81893. * Sets the given matrix "result" to the addition of the current matrix and the given one
  81894. * @param other defines the matrix to add
  81895. * @param result defines the target matrix
  81896. * @returns the current matrix
  81897. */
  81898. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  81899. /**
  81900. * Adds in place the given matrix to the current matrix
  81901. * @param other defines the second operand
  81902. * @returns the current updated matrix
  81903. */
  81904. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  81905. /**
  81906. * Sets the given matrix to the current inverted Matrix
  81907. * @param other defines the target matrix
  81908. * @returns the unmodified current matrix
  81909. */
  81910. invertToRef(other: Matrix): Matrix;
  81911. /**
  81912. * add a value at the specified position in the current Matrix
  81913. * @param index the index of the value within the matrix. between 0 and 15.
  81914. * @param value the value to be added
  81915. * @returns the current updated matrix
  81916. */
  81917. addAtIndex(index: number, value: number): Matrix;
  81918. /**
  81919. * mutiply the specified position in the current Matrix by a value
  81920. * @param index the index of the value within the matrix. between 0 and 15.
  81921. * @param value the value to be added
  81922. * @returns the current updated matrix
  81923. */
  81924. multiplyAtIndex(index: number, value: number): Matrix;
  81925. /**
  81926. * Inserts the translation vector (using 3 floats) in the current matrix
  81927. * @param x defines the 1st component of the translation
  81928. * @param y defines the 2nd component of the translation
  81929. * @param z defines the 3rd component of the translation
  81930. * @returns the current updated matrix
  81931. */
  81932. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  81933. /**
  81934. * Adds the translation vector (using 3 floats) in the current matrix
  81935. * @param x defines the 1st component of the translation
  81936. * @param y defines the 2nd component of the translation
  81937. * @param z defines the 3rd component of the translation
  81938. * @returns the current updated matrix
  81939. */
  81940. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  81941. /**
  81942. * Inserts the translation vector in the current matrix
  81943. * @param vector3 defines the translation to insert
  81944. * @returns the current updated matrix
  81945. */
  81946. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  81947. /**
  81948. * Gets the translation value of the current matrix
  81949. * @returns a new Vector3 as the extracted translation from the matrix
  81950. */
  81951. getTranslation(): Vector3;
  81952. /**
  81953. * Fill a Vector3 with the extracted translation from the matrix
  81954. * @param result defines the Vector3 where to store the translation
  81955. * @returns the current matrix
  81956. */
  81957. getTranslationToRef(result: Vector3): Matrix;
  81958. /**
  81959. * Remove rotation and scaling part from the matrix
  81960. * @returns the updated matrix
  81961. */
  81962. removeRotationAndScaling(): Matrix;
  81963. /**
  81964. * Multiply two matrices
  81965. * @param other defines the second operand
  81966. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  81967. */
  81968. multiply(other: DeepImmutable<Matrix>): Matrix;
  81969. /**
  81970. * Copy the current matrix from the given one
  81971. * @param other defines the source matrix
  81972. * @returns the current updated matrix
  81973. */
  81974. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  81975. /**
  81976. * Populates the given array from the starting index with the current matrix values
  81977. * @param array defines the target array
  81978. * @param offset defines the offset in the target array where to start storing values
  81979. * @returns the current matrix
  81980. */
  81981. copyToArray(array: Float32Array, offset?: number): Matrix;
  81982. /**
  81983. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  81984. * @param other defines the second operand
  81985. * @param result defines the matrix where to store the multiplication
  81986. * @returns the current matrix
  81987. */
  81988. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  81989. /**
  81990. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  81991. * @param other defines the second operand
  81992. * @param result defines the array where to store the multiplication
  81993. * @param offset defines the offset in the target array where to start storing values
  81994. * @returns the current matrix
  81995. */
  81996. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  81997. /**
  81998. * Check equality between this matrix and a second one
  81999. * @param value defines the second matrix to compare
  82000. * @returns true is the current matrix and the given one values are strictly equal
  82001. */
  82002. equals(value: DeepImmutable<Matrix>): boolean;
  82003. /**
  82004. * Clone the current matrix
  82005. * @returns a new matrix from the current matrix
  82006. */
  82007. clone(): Matrix;
  82008. /**
  82009. * Returns the name of the current matrix class
  82010. * @returns the string "Matrix"
  82011. */
  82012. getClassName(): string;
  82013. /**
  82014. * Gets the hash code of the current matrix
  82015. * @returns the hash code
  82016. */
  82017. getHashCode(): number;
  82018. /**
  82019. * Decomposes the current Matrix into a translation, rotation and scaling components
  82020. * @param scale defines the scale vector3 given as a reference to update
  82021. * @param rotation defines the rotation quaternion given as a reference to update
  82022. * @param translation defines the translation vector3 given as a reference to update
  82023. * @returns true if operation was successful
  82024. */
  82025. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  82026. /**
  82027. * Gets specific row of the matrix
  82028. * @param index defines the number of the row to get
  82029. * @returns the index-th row of the current matrix as a new Vector4
  82030. */
  82031. getRow(index: number): Nullable<Vector4>;
  82032. /**
  82033. * Sets the index-th row of the current matrix to the vector4 values
  82034. * @param index defines the number of the row to set
  82035. * @param row defines the target vector4
  82036. * @returns the updated current matrix
  82037. */
  82038. setRow(index: number, row: Vector4): Matrix;
  82039. /**
  82040. * Compute the transpose of the matrix
  82041. * @returns the new transposed matrix
  82042. */
  82043. transpose(): Matrix;
  82044. /**
  82045. * Compute the transpose of the matrix and store it in a given matrix
  82046. * @param result defines the target matrix
  82047. * @returns the current matrix
  82048. */
  82049. transposeToRef(result: Matrix): Matrix;
  82050. /**
  82051. * Sets the index-th row of the current matrix with the given 4 x float values
  82052. * @param index defines the row index
  82053. * @param x defines the x component to set
  82054. * @param y defines the y component to set
  82055. * @param z defines the z component to set
  82056. * @param w defines the w component to set
  82057. * @returns the updated current matrix
  82058. */
  82059. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  82060. /**
  82061. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  82062. * @param scale defines the scale factor
  82063. * @returns a new matrix
  82064. */
  82065. scale(scale: number): Matrix;
  82066. /**
  82067. * Scale the current matrix values by a factor to a given result matrix
  82068. * @param scale defines the scale factor
  82069. * @param result defines the matrix to store the result
  82070. * @returns the current matrix
  82071. */
  82072. scaleToRef(scale: number, result: Matrix): Matrix;
  82073. /**
  82074. * Scale the current matrix values by a factor and add the result to a given matrix
  82075. * @param scale defines the scale factor
  82076. * @param result defines the Matrix to store the result
  82077. * @returns the current matrix
  82078. */
  82079. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  82080. /**
  82081. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  82082. * @param ref matrix to store the result
  82083. */
  82084. toNormalMatrix(ref: Matrix): void;
  82085. /**
  82086. * Gets only rotation part of the current matrix
  82087. * @returns a new matrix sets to the extracted rotation matrix from the current one
  82088. */
  82089. getRotationMatrix(): Matrix;
  82090. /**
  82091. * Extracts the rotation matrix from the current one and sets it as the given "result"
  82092. * @param result defines the target matrix to store data to
  82093. * @returns the current matrix
  82094. */
  82095. getRotationMatrixToRef(result: Matrix): Matrix;
  82096. /**
  82097. * Toggles model matrix from being right handed to left handed in place and vice versa
  82098. */
  82099. toggleModelMatrixHandInPlace(): void;
  82100. /**
  82101. * Toggles projection matrix from being right handed to left handed in place and vice versa
  82102. */
  82103. toggleProjectionMatrixHandInPlace(): void;
  82104. /**
  82105. * Creates a matrix from an array
  82106. * @param array defines the source array
  82107. * @param offset defines an offset in the source array
  82108. * @returns a new Matrix set from the starting index of the given array
  82109. */
  82110. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  82111. /**
  82112. * Copy the content of an array into a given matrix
  82113. * @param array defines the source array
  82114. * @param offset defines an offset in the source array
  82115. * @param result defines the target matrix
  82116. */
  82117. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  82118. /**
  82119. * Stores an array into a matrix after having multiplied each component by a given factor
  82120. * @param array defines the source array
  82121. * @param offset defines the offset in the source array
  82122. * @param scale defines the scaling factor
  82123. * @param result defines the target matrix
  82124. */
  82125. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  82126. /**
  82127. * Gets an identity matrix that must not be updated
  82128. */
  82129. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  82130. /**
  82131. * Stores a list of values (16) inside a given matrix
  82132. * @param initialM11 defines 1st value of 1st row
  82133. * @param initialM12 defines 2nd value of 1st row
  82134. * @param initialM13 defines 3rd value of 1st row
  82135. * @param initialM14 defines 4th value of 1st row
  82136. * @param initialM21 defines 1st value of 2nd row
  82137. * @param initialM22 defines 2nd value of 2nd row
  82138. * @param initialM23 defines 3rd value of 2nd row
  82139. * @param initialM24 defines 4th value of 2nd row
  82140. * @param initialM31 defines 1st value of 3rd row
  82141. * @param initialM32 defines 2nd value of 3rd row
  82142. * @param initialM33 defines 3rd value of 3rd row
  82143. * @param initialM34 defines 4th value of 3rd row
  82144. * @param initialM41 defines 1st value of 4th row
  82145. * @param initialM42 defines 2nd value of 4th row
  82146. * @param initialM43 defines 3rd value of 4th row
  82147. * @param initialM44 defines 4th value of 4th row
  82148. * @param result defines the target matrix
  82149. */
  82150. 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;
  82151. /**
  82152. * Creates new matrix from a list of values (16)
  82153. * @param initialM11 defines 1st value of 1st row
  82154. * @param initialM12 defines 2nd value of 1st row
  82155. * @param initialM13 defines 3rd value of 1st row
  82156. * @param initialM14 defines 4th value of 1st row
  82157. * @param initialM21 defines 1st value of 2nd row
  82158. * @param initialM22 defines 2nd value of 2nd row
  82159. * @param initialM23 defines 3rd value of 2nd row
  82160. * @param initialM24 defines 4th value of 2nd row
  82161. * @param initialM31 defines 1st value of 3rd row
  82162. * @param initialM32 defines 2nd value of 3rd row
  82163. * @param initialM33 defines 3rd value of 3rd row
  82164. * @param initialM34 defines 4th value of 3rd row
  82165. * @param initialM41 defines 1st value of 4th row
  82166. * @param initialM42 defines 2nd value of 4th row
  82167. * @param initialM43 defines 3rd value of 4th row
  82168. * @param initialM44 defines 4th value of 4th row
  82169. * @returns the new matrix
  82170. */
  82171. 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;
  82172. /**
  82173. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  82174. * @param scale defines the scale vector3
  82175. * @param rotation defines the rotation quaternion
  82176. * @param translation defines the translation vector3
  82177. * @returns a new matrix
  82178. */
  82179. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  82180. /**
  82181. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  82182. * @param scale defines the scale vector3
  82183. * @param rotation defines the rotation quaternion
  82184. * @param translation defines the translation vector3
  82185. * @param result defines the target matrix
  82186. */
  82187. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  82188. /**
  82189. * Creates a new identity matrix
  82190. * @returns a new identity matrix
  82191. */
  82192. static Identity(): Matrix;
  82193. /**
  82194. * Creates a new identity matrix and stores the result in a given matrix
  82195. * @param result defines the target matrix
  82196. */
  82197. static IdentityToRef(result: Matrix): void;
  82198. /**
  82199. * Creates a new zero matrix
  82200. * @returns a new zero matrix
  82201. */
  82202. static Zero(): Matrix;
  82203. /**
  82204. * Creates a new rotation matrix for "angle" radians around the X axis
  82205. * @param angle defines the angle (in radians) to use
  82206. * @return the new matrix
  82207. */
  82208. static RotationX(angle: number): Matrix;
  82209. /**
  82210. * Creates a new matrix as the invert of a given matrix
  82211. * @param source defines the source matrix
  82212. * @returns the new matrix
  82213. */
  82214. static Invert(source: DeepImmutable<Matrix>): Matrix;
  82215. /**
  82216. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  82217. * @param angle defines the angle (in radians) to use
  82218. * @param result defines the target matrix
  82219. */
  82220. static RotationXToRef(angle: number, result: Matrix): void;
  82221. /**
  82222. * Creates a new rotation matrix for "angle" radians around the Y axis
  82223. * @param angle defines the angle (in radians) to use
  82224. * @return the new matrix
  82225. */
  82226. static RotationY(angle: number): Matrix;
  82227. /**
  82228. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  82229. * @param angle defines the angle (in radians) to use
  82230. * @param result defines the target matrix
  82231. */
  82232. static RotationYToRef(angle: number, result: Matrix): void;
  82233. /**
  82234. * Creates a new rotation matrix for "angle" radians around the Z axis
  82235. * @param angle defines the angle (in radians) to use
  82236. * @return the new matrix
  82237. */
  82238. static RotationZ(angle: number): Matrix;
  82239. /**
  82240. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  82241. * @param angle defines the angle (in radians) to use
  82242. * @param result defines the target matrix
  82243. */
  82244. static RotationZToRef(angle: number, result: Matrix): void;
  82245. /**
  82246. * Creates a new rotation matrix for "angle" radians around the given axis
  82247. * @param axis defines the axis to use
  82248. * @param angle defines the angle (in radians) to use
  82249. * @return the new matrix
  82250. */
  82251. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  82252. /**
  82253. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  82254. * @param axis defines the axis to use
  82255. * @param angle defines the angle (in radians) to use
  82256. * @param result defines the target matrix
  82257. */
  82258. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  82259. /**
  82260. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  82261. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  82262. * @param from defines the vector to align
  82263. * @param to defines the vector to align to
  82264. * @param result defines the target matrix
  82265. */
  82266. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  82267. /**
  82268. * Creates a rotation matrix
  82269. * @param yaw defines the yaw angle in radians (Y axis)
  82270. * @param pitch defines the pitch angle in radians (X axis)
  82271. * @param roll defines the roll angle in radians (X axis)
  82272. * @returns the new rotation matrix
  82273. */
  82274. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  82275. /**
  82276. * Creates a rotation matrix and stores it in a given matrix
  82277. * @param yaw defines the yaw angle in radians (Y axis)
  82278. * @param pitch defines the pitch angle in radians (X axis)
  82279. * @param roll defines the roll angle in radians (X axis)
  82280. * @param result defines the target matrix
  82281. */
  82282. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  82283. /**
  82284. * Creates a scaling matrix
  82285. * @param x defines the scale factor on X axis
  82286. * @param y defines the scale factor on Y axis
  82287. * @param z defines the scale factor on Z axis
  82288. * @returns the new matrix
  82289. */
  82290. static Scaling(x: number, y: number, z: number): Matrix;
  82291. /**
  82292. * Creates a scaling matrix and stores it in a given matrix
  82293. * @param x defines the scale factor on X axis
  82294. * @param y defines the scale factor on Y axis
  82295. * @param z defines the scale factor on Z axis
  82296. * @param result defines the target matrix
  82297. */
  82298. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  82299. /**
  82300. * Creates a translation matrix
  82301. * @param x defines the translation on X axis
  82302. * @param y defines the translation on Y axis
  82303. * @param z defines the translationon Z axis
  82304. * @returns the new matrix
  82305. */
  82306. static Translation(x: number, y: number, z: number): Matrix;
  82307. /**
  82308. * Creates a translation matrix and stores it in a given matrix
  82309. * @param x defines the translation on X axis
  82310. * @param y defines the translation on Y axis
  82311. * @param z defines the translationon Z axis
  82312. * @param result defines the target matrix
  82313. */
  82314. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  82315. /**
  82316. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  82317. * @param startValue defines the start value
  82318. * @param endValue defines the end value
  82319. * @param gradient defines the gradient factor
  82320. * @returns the new matrix
  82321. */
  82322. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  82323. /**
  82324. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  82325. * @param startValue defines the start value
  82326. * @param endValue defines the end value
  82327. * @param gradient defines the gradient factor
  82328. * @param result defines the Matrix object where to store data
  82329. */
  82330. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  82331. /**
  82332. * Builds a new matrix whose values are computed by:
  82333. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  82334. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  82335. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  82336. * @param startValue defines the first matrix
  82337. * @param endValue defines the second matrix
  82338. * @param gradient defines the gradient between the two matrices
  82339. * @returns the new matrix
  82340. */
  82341. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  82342. /**
  82343. * Update a matrix to values which are computed by:
  82344. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  82345. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  82346. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  82347. * @param startValue defines the first matrix
  82348. * @param endValue defines the second matrix
  82349. * @param gradient defines the gradient between the two matrices
  82350. * @param result defines the target matrix
  82351. */
  82352. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  82353. /**
  82354. * 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"
  82355. * This function works in left handed mode
  82356. * @param eye defines the final position of the entity
  82357. * @param target defines where the entity should look at
  82358. * @param up defines the up vector for the entity
  82359. * @returns the new matrix
  82360. */
  82361. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  82362. /**
  82363. * 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".
  82364. * This function works in left handed mode
  82365. * @param eye defines the final position of the entity
  82366. * @param target defines where the entity should look at
  82367. * @param up defines the up vector for the entity
  82368. * @param result defines the target matrix
  82369. */
  82370. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  82371. /**
  82372. * 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"
  82373. * This function works in right handed mode
  82374. * @param eye defines the final position of the entity
  82375. * @param target defines where the entity should look at
  82376. * @param up defines the up vector for the entity
  82377. * @returns the new matrix
  82378. */
  82379. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  82380. /**
  82381. * 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".
  82382. * This function works in right handed mode
  82383. * @param eye defines the final position of the entity
  82384. * @param target defines where the entity should look at
  82385. * @param up defines the up vector for the entity
  82386. * @param result defines the target matrix
  82387. */
  82388. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  82389. /**
  82390. * Create a left-handed orthographic projection matrix
  82391. * @param width defines the viewport width
  82392. * @param height defines the viewport height
  82393. * @param znear defines the near clip plane
  82394. * @param zfar defines the far clip plane
  82395. * @returns a new matrix as a left-handed orthographic projection matrix
  82396. */
  82397. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  82398. /**
  82399. * Store a left-handed orthographic projection to a given matrix
  82400. * @param width defines the viewport width
  82401. * @param height defines the viewport height
  82402. * @param znear defines the near clip plane
  82403. * @param zfar defines the far clip plane
  82404. * @param result defines the target matrix
  82405. */
  82406. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  82407. /**
  82408. * Create a left-handed orthographic projection matrix
  82409. * @param left defines the viewport left coordinate
  82410. * @param right defines the viewport right coordinate
  82411. * @param bottom defines the viewport bottom coordinate
  82412. * @param top defines the viewport top coordinate
  82413. * @param znear defines the near clip plane
  82414. * @param zfar defines the far clip plane
  82415. * @returns a new matrix as a left-handed orthographic projection matrix
  82416. */
  82417. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  82418. /**
  82419. * Stores a left-handed orthographic projection into a given matrix
  82420. * @param left defines the viewport left coordinate
  82421. * @param right defines the viewport right coordinate
  82422. * @param bottom defines the viewport bottom coordinate
  82423. * @param top defines the viewport top coordinate
  82424. * @param znear defines the near clip plane
  82425. * @param zfar defines the far clip plane
  82426. * @param result defines the target matrix
  82427. */
  82428. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  82429. /**
  82430. * Creates a right-handed orthographic projection matrix
  82431. * @param left defines the viewport left coordinate
  82432. * @param right defines the viewport right coordinate
  82433. * @param bottom defines the viewport bottom coordinate
  82434. * @param top defines the viewport top coordinate
  82435. * @param znear defines the near clip plane
  82436. * @param zfar defines the far clip plane
  82437. * @returns a new matrix as a right-handed orthographic projection matrix
  82438. */
  82439. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  82440. /**
  82441. * Stores a right-handed orthographic projection into a given matrix
  82442. * @param left defines the viewport left coordinate
  82443. * @param right defines the viewport right coordinate
  82444. * @param bottom defines the viewport bottom coordinate
  82445. * @param top defines the viewport top coordinate
  82446. * @param znear defines the near clip plane
  82447. * @param zfar defines the far clip plane
  82448. * @param result defines the target matrix
  82449. */
  82450. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  82451. /**
  82452. * Creates a left-handed perspective projection matrix
  82453. * @param width defines the viewport width
  82454. * @param height defines the viewport height
  82455. * @param znear defines the near clip plane
  82456. * @param zfar defines the far clip plane
  82457. * @returns a new matrix as a left-handed perspective projection matrix
  82458. */
  82459. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  82460. /**
  82461. * Creates a left-handed perspective projection matrix
  82462. * @param fov defines the horizontal field of view
  82463. * @param aspect defines the aspect ratio
  82464. * @param znear defines the near clip plane
  82465. * @param zfar defines the far clip plane
  82466. * @returns a new matrix as a left-handed perspective projection matrix
  82467. */
  82468. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  82469. /**
  82470. * Stores a left-handed perspective projection into a given matrix
  82471. * @param fov defines the horizontal field of view
  82472. * @param aspect defines the aspect ratio
  82473. * @param znear defines the near clip plane
  82474. * @param zfar defines the far clip plane
  82475. * @param result defines the target matrix
  82476. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  82477. */
  82478. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  82479. /**
  82480. * Stores a left-handed perspective projection into a given matrix with depth reversed
  82481. * @param fov defines the horizontal field of view
  82482. * @param aspect defines the aspect ratio
  82483. * @param znear defines the near clip plane
  82484. * @param zfar not used as infinity is used as far clip
  82485. * @param result defines the target matrix
  82486. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  82487. */
  82488. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  82489. /**
  82490. * Creates a right-handed perspective projection matrix
  82491. * @param fov defines the horizontal field of view
  82492. * @param aspect defines the aspect ratio
  82493. * @param znear defines the near clip plane
  82494. * @param zfar defines the far clip plane
  82495. * @returns a new matrix as a right-handed perspective projection matrix
  82496. */
  82497. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  82498. /**
  82499. * Stores a right-handed perspective projection into a given matrix
  82500. * @param fov defines the horizontal field of view
  82501. * @param aspect defines the aspect ratio
  82502. * @param znear defines the near clip plane
  82503. * @param zfar defines the far clip plane
  82504. * @param result defines the target matrix
  82505. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  82506. */
  82507. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  82508. /**
  82509. * Stores a right-handed perspective projection into a given matrix
  82510. * @param fov defines the horizontal field of view
  82511. * @param aspect defines the aspect ratio
  82512. * @param znear defines the near clip plane
  82513. * @param zfar not used as infinity is used as far clip
  82514. * @param result defines the target matrix
  82515. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  82516. */
  82517. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  82518. /**
  82519. * Stores a perspective projection for WebVR info a given matrix
  82520. * @param fov defines the field of view
  82521. * @param znear defines the near clip plane
  82522. * @param zfar defines the far clip plane
  82523. * @param result defines the target matrix
  82524. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  82525. */
  82526. static PerspectiveFovWebVRToRef(fov: {
  82527. upDegrees: number;
  82528. downDegrees: number;
  82529. leftDegrees: number;
  82530. rightDegrees: number;
  82531. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  82532. /**
  82533. * Computes a complete transformation matrix
  82534. * @param viewport defines the viewport to use
  82535. * @param world defines the world matrix
  82536. * @param view defines the view matrix
  82537. * @param projection defines the projection matrix
  82538. * @param zmin defines the near clip plane
  82539. * @param zmax defines the far clip plane
  82540. * @returns the transformation matrix
  82541. */
  82542. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  82543. /**
  82544. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  82545. * @param matrix defines the matrix to use
  82546. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  82547. */
  82548. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  82549. /**
  82550. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  82551. * @param matrix defines the matrix to use
  82552. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  82553. */
  82554. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  82555. /**
  82556. * Compute the transpose of a given matrix
  82557. * @param matrix defines the matrix to transpose
  82558. * @returns the new matrix
  82559. */
  82560. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  82561. /**
  82562. * Compute the transpose of a matrix and store it in a target matrix
  82563. * @param matrix defines the matrix to transpose
  82564. * @param result defines the target matrix
  82565. */
  82566. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  82567. /**
  82568. * Computes a reflection matrix from a plane
  82569. * @param plane defines the reflection plane
  82570. * @returns a new matrix
  82571. */
  82572. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  82573. /**
  82574. * Computes a reflection matrix from a plane
  82575. * @param plane defines the reflection plane
  82576. * @param result defines the target matrix
  82577. */
  82578. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  82579. /**
  82580. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  82581. * @param xaxis defines the value of the 1st axis
  82582. * @param yaxis defines the value of the 2nd axis
  82583. * @param zaxis defines the value of the 3rd axis
  82584. * @param result defines the target matrix
  82585. */
  82586. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  82587. /**
  82588. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  82589. * @param quat defines the quaternion to use
  82590. * @param result defines the target matrix
  82591. */
  82592. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  82593. }
  82594. /**
  82595. * @hidden
  82596. */
  82597. export class TmpVectors {
  82598. static Vector2: Vector2[];
  82599. static Vector3: Vector3[];
  82600. static Vector4: Vector4[];
  82601. static Quaternion: Quaternion[];
  82602. static Matrix: Matrix[];
  82603. }
  82604. }
  82605. declare module BABYLON {
  82606. /**
  82607. * Defines potential orientation for back face culling
  82608. */
  82609. export enum Orientation {
  82610. /**
  82611. * Clockwise
  82612. */
  82613. CW = 0,
  82614. /** Counter clockwise */
  82615. CCW = 1
  82616. }
  82617. /** Class used to represent a Bezier curve */
  82618. export class BezierCurve {
  82619. /**
  82620. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  82621. * @param t defines the time
  82622. * @param x1 defines the left coordinate on X axis
  82623. * @param y1 defines the left coordinate on Y axis
  82624. * @param x2 defines the right coordinate on X axis
  82625. * @param y2 defines the right coordinate on Y axis
  82626. * @returns the interpolated value
  82627. */
  82628. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  82629. }
  82630. /**
  82631. * Defines angle representation
  82632. */
  82633. export class Angle {
  82634. private _radians;
  82635. /**
  82636. * Creates an Angle object of "radians" radians (float).
  82637. * @param radians the angle in radians
  82638. */
  82639. constructor(radians: number);
  82640. /**
  82641. * Get value in degrees
  82642. * @returns the Angle value in degrees (float)
  82643. */
  82644. degrees(): number;
  82645. /**
  82646. * Get value in radians
  82647. * @returns the Angle value in radians (float)
  82648. */
  82649. radians(): number;
  82650. /**
  82651. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  82652. * @param a defines first vector
  82653. * @param b defines second vector
  82654. * @returns a new Angle
  82655. */
  82656. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  82657. /**
  82658. * Gets a new Angle object from the given float in radians
  82659. * @param radians defines the angle value in radians
  82660. * @returns a new Angle
  82661. */
  82662. static FromRadians(radians: number): Angle;
  82663. /**
  82664. * Gets a new Angle object from the given float in degrees
  82665. * @param degrees defines the angle value in degrees
  82666. * @returns a new Angle
  82667. */
  82668. static FromDegrees(degrees: number): Angle;
  82669. }
  82670. /**
  82671. * This represents an arc in a 2d space.
  82672. */
  82673. export class Arc2 {
  82674. /** Defines the start point of the arc */
  82675. startPoint: Vector2;
  82676. /** Defines the mid point of the arc */
  82677. midPoint: Vector2;
  82678. /** Defines the end point of the arc */
  82679. endPoint: Vector2;
  82680. /**
  82681. * Defines the center point of the arc.
  82682. */
  82683. centerPoint: Vector2;
  82684. /**
  82685. * Defines the radius of the arc.
  82686. */
  82687. radius: number;
  82688. /**
  82689. * Defines the angle of the arc (from mid point to end point).
  82690. */
  82691. angle: Angle;
  82692. /**
  82693. * Defines the start angle of the arc (from start point to middle point).
  82694. */
  82695. startAngle: Angle;
  82696. /**
  82697. * Defines the orientation of the arc (clock wise/counter clock wise).
  82698. */
  82699. orientation: Orientation;
  82700. /**
  82701. * Creates an Arc object from the three given points : start, middle and end.
  82702. * @param startPoint Defines the start point of the arc
  82703. * @param midPoint Defines the midlle point of the arc
  82704. * @param endPoint Defines the end point of the arc
  82705. */
  82706. constructor(
  82707. /** Defines the start point of the arc */
  82708. startPoint: Vector2,
  82709. /** Defines the mid point of the arc */
  82710. midPoint: Vector2,
  82711. /** Defines the end point of the arc */
  82712. endPoint: Vector2);
  82713. }
  82714. /**
  82715. * Represents a 2D path made up of multiple 2D points
  82716. */
  82717. export class Path2 {
  82718. private _points;
  82719. private _length;
  82720. /**
  82721. * If the path start and end point are the same
  82722. */
  82723. closed: boolean;
  82724. /**
  82725. * Creates a Path2 object from the starting 2D coordinates x and y.
  82726. * @param x the starting points x value
  82727. * @param y the starting points y value
  82728. */
  82729. constructor(x: number, y: number);
  82730. /**
  82731. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  82732. * @param x the added points x value
  82733. * @param y the added points y value
  82734. * @returns the updated Path2.
  82735. */
  82736. addLineTo(x: number, y: number): Path2;
  82737. /**
  82738. * 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.
  82739. * @param midX middle point x value
  82740. * @param midY middle point y value
  82741. * @param endX end point x value
  82742. * @param endY end point y value
  82743. * @param numberOfSegments (default: 36)
  82744. * @returns the updated Path2.
  82745. */
  82746. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  82747. /**
  82748. * Closes the Path2.
  82749. * @returns the Path2.
  82750. */
  82751. close(): Path2;
  82752. /**
  82753. * Gets the sum of the distance between each sequential point in the path
  82754. * @returns the Path2 total length (float).
  82755. */
  82756. length(): number;
  82757. /**
  82758. * Gets the points which construct the path
  82759. * @returns the Path2 internal array of points.
  82760. */
  82761. getPoints(): Vector2[];
  82762. /**
  82763. * Retreives the point at the distance aways from the starting point
  82764. * @param normalizedLengthPosition the length along the path to retreive the point from
  82765. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  82766. */
  82767. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  82768. /**
  82769. * Creates a new path starting from an x and y position
  82770. * @param x starting x value
  82771. * @param y starting y value
  82772. * @returns a new Path2 starting at the coordinates (x, y).
  82773. */
  82774. static StartingAt(x: number, y: number): Path2;
  82775. }
  82776. /**
  82777. * Represents a 3D path made up of multiple 3D points
  82778. */
  82779. export class Path3D {
  82780. /**
  82781. * an array of Vector3, the curve axis of the Path3D
  82782. */
  82783. path: Vector3[];
  82784. private _curve;
  82785. private _distances;
  82786. private _tangents;
  82787. private _normals;
  82788. private _binormals;
  82789. private _raw;
  82790. private _alignTangentsWithPath;
  82791. private readonly _pointAtData;
  82792. /**
  82793. * new Path3D(path, normal, raw)
  82794. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  82795. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  82796. * @param path an array of Vector3, the curve axis of the Path3D
  82797. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  82798. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  82799. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  82800. */
  82801. constructor(
  82802. /**
  82803. * an array of Vector3, the curve axis of the Path3D
  82804. */
  82805. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  82806. /**
  82807. * Returns the Path3D array of successive Vector3 designing its curve.
  82808. * @returns the Path3D array of successive Vector3 designing its curve.
  82809. */
  82810. getCurve(): Vector3[];
  82811. /**
  82812. * Returns the Path3D array of successive Vector3 designing its curve.
  82813. * @returns the Path3D array of successive Vector3 designing its curve.
  82814. */
  82815. getPoints(): Vector3[];
  82816. /**
  82817. * @returns the computed length (float) of the path.
  82818. */
  82819. length(): number;
  82820. /**
  82821. * Returns an array populated with tangent vectors on each Path3D curve point.
  82822. * @returns an array populated with tangent vectors on each Path3D curve point.
  82823. */
  82824. getTangents(): Vector3[];
  82825. /**
  82826. * Returns an array populated with normal vectors on each Path3D curve point.
  82827. * @returns an array populated with normal vectors on each Path3D curve point.
  82828. */
  82829. getNormals(): Vector3[];
  82830. /**
  82831. * Returns an array populated with binormal vectors on each Path3D curve point.
  82832. * @returns an array populated with binormal vectors on each Path3D curve point.
  82833. */
  82834. getBinormals(): Vector3[];
  82835. /**
  82836. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  82837. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  82838. */
  82839. getDistances(): number[];
  82840. /**
  82841. * Returns an interpolated point along this path
  82842. * @param position the position of the point along this path, from 0.0 to 1.0
  82843. * @returns a new Vector3 as the point
  82844. */
  82845. getPointAt(position: number): Vector3;
  82846. /**
  82847. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  82848. * @param position the position of the point along this path, from 0.0 to 1.0
  82849. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  82850. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  82851. */
  82852. getTangentAt(position: number, interpolated?: boolean): Vector3;
  82853. /**
  82854. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  82855. * @param position the position of the point along this path, from 0.0 to 1.0
  82856. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  82857. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  82858. */
  82859. getNormalAt(position: number, interpolated?: boolean): Vector3;
  82860. /**
  82861. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  82862. * @param position the position of the point along this path, from 0.0 to 1.0
  82863. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  82864. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  82865. */
  82866. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  82867. /**
  82868. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  82869. * @param position the position of the point along this path, from 0.0 to 1.0
  82870. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  82871. */
  82872. getDistanceAt(position: number): number;
  82873. /**
  82874. * Returns the array index of the previous point of an interpolated point along this path
  82875. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  82876. * @returns the array index
  82877. */
  82878. getPreviousPointIndexAt(position: number): number;
  82879. /**
  82880. * 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)
  82881. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  82882. * @returns the sub position
  82883. */
  82884. getSubPositionAt(position: number): number;
  82885. /**
  82886. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  82887. * @param target the vector of which to get the closest position to
  82888. * @returns the position of the closest virtual point on this path to the target vector
  82889. */
  82890. getClosestPositionTo(target: Vector3): number;
  82891. /**
  82892. * Returns a sub path (slice) of this path
  82893. * @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
  82894. * @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
  82895. * @returns a sub path (slice) of this path
  82896. */
  82897. slice(start?: number, end?: number): Path3D;
  82898. /**
  82899. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  82900. * @param path path which all values are copied into the curves points
  82901. * @param firstNormal which should be projected onto the curve
  82902. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  82903. * @returns the same object updated.
  82904. */
  82905. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  82906. private _compute;
  82907. private _getFirstNonNullVector;
  82908. private _getLastNonNullVector;
  82909. private _normalVector;
  82910. /**
  82911. * Updates the point at data for an interpolated point along this curve
  82912. * @param position the position of the point along this curve, from 0.0 to 1.0
  82913. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  82914. * @returns the (updated) point at data
  82915. */
  82916. private _updatePointAtData;
  82917. /**
  82918. * Updates the point at data from the specified parameters
  82919. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  82920. * @param point the interpolated point
  82921. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  82922. */
  82923. private _setPointAtData;
  82924. /**
  82925. * Updates the point at interpolation matrix for the tangents, normals and binormals
  82926. */
  82927. private _updateInterpolationMatrix;
  82928. }
  82929. /**
  82930. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  82931. * A Curve3 is designed from a series of successive Vector3.
  82932. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  82933. */
  82934. export class Curve3 {
  82935. private _points;
  82936. private _length;
  82937. /**
  82938. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  82939. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  82940. * @param v1 (Vector3) the control point
  82941. * @param v2 (Vector3) the end point of the Quadratic Bezier
  82942. * @param nbPoints (integer) the wanted number of points in the curve
  82943. * @returns the created Curve3
  82944. */
  82945. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  82946. /**
  82947. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  82948. * @param v0 (Vector3) the origin point of the Cubic Bezier
  82949. * @param v1 (Vector3) the first control point
  82950. * @param v2 (Vector3) the second control point
  82951. * @param v3 (Vector3) the end point of the Cubic Bezier
  82952. * @param nbPoints (integer) the wanted number of points in the curve
  82953. * @returns the created Curve3
  82954. */
  82955. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  82956. /**
  82957. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  82958. * @param p1 (Vector3) the origin point of the Hermite Spline
  82959. * @param t1 (Vector3) the tangent vector at the origin point
  82960. * @param p2 (Vector3) the end point of the Hermite Spline
  82961. * @param t2 (Vector3) the tangent vector at the end point
  82962. * @param nbPoints (integer) the wanted number of points in the curve
  82963. * @returns the created Curve3
  82964. */
  82965. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  82966. /**
  82967. * Returns a Curve3 object along a CatmullRom Spline curve :
  82968. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  82969. * @param nbPoints (integer) the wanted number of points between each curve control points
  82970. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  82971. * @returns the created Curve3
  82972. */
  82973. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  82974. /**
  82975. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  82976. * A Curve3 is designed from a series of successive Vector3.
  82977. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  82978. * @param points points which make up the curve
  82979. */
  82980. constructor(points: Vector3[]);
  82981. /**
  82982. * @returns the Curve3 stored array of successive Vector3
  82983. */
  82984. getPoints(): Vector3[];
  82985. /**
  82986. * @returns the computed length (float) of the curve.
  82987. */
  82988. length(): number;
  82989. /**
  82990. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  82991. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  82992. * curveA and curveB keep unchanged.
  82993. * @param curve the curve to continue from this curve
  82994. * @returns the newly constructed curve
  82995. */
  82996. continue(curve: DeepImmutable<Curve3>): Curve3;
  82997. private _computeLength;
  82998. }
  82999. }
  83000. declare module BABYLON {
  83001. /**
  83002. * This represents the main contract an easing function should follow.
  83003. * Easing functions are used throughout the animation system.
  83004. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83005. */
  83006. export interface IEasingFunction {
  83007. /**
  83008. * Given an input gradient between 0 and 1, this returns the corrseponding value
  83009. * of the easing function.
  83010. * The link below provides some of the most common examples of easing functions.
  83011. * @see https://easings.net/
  83012. * @param gradient Defines the value between 0 and 1 we want the easing value for
  83013. * @returns the corresponding value on the curve defined by the easing function
  83014. */
  83015. ease(gradient: number): number;
  83016. }
  83017. /**
  83018. * Base class used for every default easing function.
  83019. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83020. */
  83021. export class EasingFunction implements IEasingFunction {
  83022. /**
  83023. * Interpolation follows the mathematical formula associated with the easing function.
  83024. */
  83025. static readonly EASINGMODE_EASEIN: number;
  83026. /**
  83027. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  83028. */
  83029. static readonly EASINGMODE_EASEOUT: number;
  83030. /**
  83031. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  83032. */
  83033. static readonly EASINGMODE_EASEINOUT: number;
  83034. private _easingMode;
  83035. /**
  83036. * Sets the easing mode of the current function.
  83037. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  83038. */
  83039. setEasingMode(easingMode: number): void;
  83040. /**
  83041. * Gets the current easing mode.
  83042. * @returns the easing mode
  83043. */
  83044. getEasingMode(): number;
  83045. /**
  83046. * @hidden
  83047. */
  83048. easeInCore(gradient: number): number;
  83049. /**
  83050. * Given an input gradient between 0 and 1, this returns the corresponding value
  83051. * of the easing function.
  83052. * @param gradient Defines the value between 0 and 1 we want the easing value for
  83053. * @returns the corresponding value on the curve defined by the easing function
  83054. */
  83055. ease(gradient: number): number;
  83056. }
  83057. /**
  83058. * Easing function with a circle shape (see link below).
  83059. * @see https://easings.net/#easeInCirc
  83060. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83061. */
  83062. export class CircleEase extends EasingFunction implements IEasingFunction {
  83063. /** @hidden */
  83064. easeInCore(gradient: number): number;
  83065. }
  83066. /**
  83067. * Easing function with a ease back shape (see link below).
  83068. * @see https://easings.net/#easeInBack
  83069. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83070. */
  83071. export class BackEase extends EasingFunction implements IEasingFunction {
  83072. /** Defines the amplitude of the function */
  83073. amplitude: number;
  83074. /**
  83075. * Instantiates a back ease easing
  83076. * @see https://easings.net/#easeInBack
  83077. * @param amplitude Defines the amplitude of the function
  83078. */
  83079. constructor(
  83080. /** Defines the amplitude of the function */
  83081. amplitude?: number);
  83082. /** @hidden */
  83083. easeInCore(gradient: number): number;
  83084. }
  83085. /**
  83086. * Easing function with a bouncing shape (see link below).
  83087. * @see https://easings.net/#easeInBounce
  83088. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83089. */
  83090. export class BounceEase extends EasingFunction implements IEasingFunction {
  83091. /** Defines the number of bounces */
  83092. bounces: number;
  83093. /** Defines the amplitude of the bounce */
  83094. bounciness: number;
  83095. /**
  83096. * Instantiates a bounce easing
  83097. * @see https://easings.net/#easeInBounce
  83098. * @param bounces Defines the number of bounces
  83099. * @param bounciness Defines the amplitude of the bounce
  83100. */
  83101. constructor(
  83102. /** Defines the number of bounces */
  83103. bounces?: number,
  83104. /** Defines the amplitude of the bounce */
  83105. bounciness?: number);
  83106. /** @hidden */
  83107. easeInCore(gradient: number): number;
  83108. }
  83109. /**
  83110. * Easing function with a power of 3 shape (see link below).
  83111. * @see https://easings.net/#easeInCubic
  83112. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83113. */
  83114. export class CubicEase extends EasingFunction implements IEasingFunction {
  83115. /** @hidden */
  83116. easeInCore(gradient: number): number;
  83117. }
  83118. /**
  83119. * Easing function with an elastic shape (see link below).
  83120. * @see https://easings.net/#easeInElastic
  83121. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83122. */
  83123. export class ElasticEase extends EasingFunction implements IEasingFunction {
  83124. /** Defines the number of oscillations*/
  83125. oscillations: number;
  83126. /** Defines the amplitude of the oscillations*/
  83127. springiness: number;
  83128. /**
  83129. * Instantiates an elastic easing function
  83130. * @see https://easings.net/#easeInElastic
  83131. * @param oscillations Defines the number of oscillations
  83132. * @param springiness Defines the amplitude of the oscillations
  83133. */
  83134. constructor(
  83135. /** Defines the number of oscillations*/
  83136. oscillations?: number,
  83137. /** Defines the amplitude of the oscillations*/
  83138. springiness?: number);
  83139. /** @hidden */
  83140. easeInCore(gradient: number): number;
  83141. }
  83142. /**
  83143. * Easing function with an exponential shape (see link below).
  83144. * @see https://easings.net/#easeInExpo
  83145. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83146. */
  83147. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  83148. /** Defines the exponent of the function */
  83149. exponent: number;
  83150. /**
  83151. * Instantiates an exponential easing function
  83152. * @see https://easings.net/#easeInExpo
  83153. * @param exponent Defines the exponent of the function
  83154. */
  83155. constructor(
  83156. /** Defines the exponent of the function */
  83157. exponent?: number);
  83158. /** @hidden */
  83159. easeInCore(gradient: number): number;
  83160. }
  83161. /**
  83162. * Easing function with a power shape (see link below).
  83163. * @see https://easings.net/#easeInQuad
  83164. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83165. */
  83166. export class PowerEase extends EasingFunction implements IEasingFunction {
  83167. /** Defines the power of the function */
  83168. power: number;
  83169. /**
  83170. * Instantiates an power base easing function
  83171. * @see https://easings.net/#easeInQuad
  83172. * @param power Defines the power of the function
  83173. */
  83174. constructor(
  83175. /** Defines the power of the function */
  83176. power?: number);
  83177. /** @hidden */
  83178. easeInCore(gradient: number): number;
  83179. }
  83180. /**
  83181. * Easing function with a power of 2 shape (see link below).
  83182. * @see https://easings.net/#easeInQuad
  83183. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83184. */
  83185. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  83186. /** @hidden */
  83187. easeInCore(gradient: number): number;
  83188. }
  83189. /**
  83190. * Easing function with a power of 4 shape (see link below).
  83191. * @see https://easings.net/#easeInQuart
  83192. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83193. */
  83194. export class QuarticEase extends EasingFunction implements IEasingFunction {
  83195. /** @hidden */
  83196. easeInCore(gradient: number): number;
  83197. }
  83198. /**
  83199. * Easing function with a power of 5 shape (see link below).
  83200. * @see https://easings.net/#easeInQuint
  83201. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83202. */
  83203. export class QuinticEase extends EasingFunction implements IEasingFunction {
  83204. /** @hidden */
  83205. easeInCore(gradient: number): number;
  83206. }
  83207. /**
  83208. * Easing function with a sin shape (see link below).
  83209. * @see https://easings.net/#easeInSine
  83210. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83211. */
  83212. export class SineEase extends EasingFunction implements IEasingFunction {
  83213. /** @hidden */
  83214. easeInCore(gradient: number): number;
  83215. }
  83216. /**
  83217. * Easing function with a bezier shape (see link below).
  83218. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  83219. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  83220. */
  83221. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  83222. /** Defines the x component of the start tangent in the bezier curve */
  83223. x1: number;
  83224. /** Defines the y component of the start tangent in the bezier curve */
  83225. y1: number;
  83226. /** Defines the x component of the end tangent in the bezier curve */
  83227. x2: number;
  83228. /** Defines the y component of the end tangent in the bezier curve */
  83229. y2: number;
  83230. /**
  83231. * Instantiates a bezier function
  83232. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  83233. * @param x1 Defines the x component of the start tangent in the bezier curve
  83234. * @param y1 Defines the y component of the start tangent in the bezier curve
  83235. * @param x2 Defines the x component of the end tangent in the bezier curve
  83236. * @param y2 Defines the y component of the end tangent in the bezier curve
  83237. */
  83238. constructor(
  83239. /** Defines the x component of the start tangent in the bezier curve */
  83240. x1?: number,
  83241. /** Defines the y component of the start tangent in the bezier curve */
  83242. y1?: number,
  83243. /** Defines the x component of the end tangent in the bezier curve */
  83244. x2?: number,
  83245. /** Defines the y component of the end tangent in the bezier curve */
  83246. y2?: number);
  83247. /** @hidden */
  83248. easeInCore(gradient: number): number;
  83249. }
  83250. }
  83251. declare module BABYLON {
  83252. /**
  83253. * Class used to hold a RBG color
  83254. */
  83255. export class Color3 {
  83256. /**
  83257. * Defines the red component (between 0 and 1, default is 0)
  83258. */
  83259. r: number;
  83260. /**
  83261. * Defines the green component (between 0 and 1, default is 0)
  83262. */
  83263. g: number;
  83264. /**
  83265. * Defines the blue component (between 0 and 1, default is 0)
  83266. */
  83267. b: number;
  83268. /**
  83269. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  83270. * @param r defines the red component (between 0 and 1, default is 0)
  83271. * @param g defines the green component (between 0 and 1, default is 0)
  83272. * @param b defines the blue component (between 0 and 1, default is 0)
  83273. */
  83274. constructor(
  83275. /**
  83276. * Defines the red component (between 0 and 1, default is 0)
  83277. */
  83278. r?: number,
  83279. /**
  83280. * Defines the green component (between 0 and 1, default is 0)
  83281. */
  83282. g?: number,
  83283. /**
  83284. * Defines the blue component (between 0 and 1, default is 0)
  83285. */
  83286. b?: number);
  83287. /**
  83288. * Creates a string with the Color3 current values
  83289. * @returns the string representation of the Color3 object
  83290. */
  83291. toString(): string;
  83292. /**
  83293. * Returns the string "Color3"
  83294. * @returns "Color3"
  83295. */
  83296. getClassName(): string;
  83297. /**
  83298. * Compute the Color3 hash code
  83299. * @returns an unique number that can be used to hash Color3 objects
  83300. */
  83301. getHashCode(): number;
  83302. /**
  83303. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  83304. * @param array defines the array where to store the r,g,b components
  83305. * @param index defines an optional index in the target array to define where to start storing values
  83306. * @returns the current Color3 object
  83307. */
  83308. toArray(array: FloatArray, index?: number): Color3;
  83309. /**
  83310. * Returns a new Color4 object from the current Color3 and the given alpha
  83311. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  83312. * @returns a new Color4 object
  83313. */
  83314. toColor4(alpha?: number): Color4;
  83315. /**
  83316. * Returns a new array populated with 3 numeric elements : red, green and blue values
  83317. * @returns the new array
  83318. */
  83319. asArray(): number[];
  83320. /**
  83321. * Returns the luminance value
  83322. * @returns a float value
  83323. */
  83324. toLuminance(): number;
  83325. /**
  83326. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  83327. * @param otherColor defines the second operand
  83328. * @returns the new Color3 object
  83329. */
  83330. multiply(otherColor: DeepImmutable<Color3>): Color3;
  83331. /**
  83332. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  83333. * @param otherColor defines the second operand
  83334. * @param result defines the Color3 object where to store the result
  83335. * @returns the current Color3
  83336. */
  83337. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  83338. /**
  83339. * Determines equality between Color3 objects
  83340. * @param otherColor defines the second operand
  83341. * @returns true if the rgb values are equal to the given ones
  83342. */
  83343. equals(otherColor: DeepImmutable<Color3>): boolean;
  83344. /**
  83345. * Determines equality between the current Color3 object and a set of r,b,g values
  83346. * @param r defines the red component to check
  83347. * @param g defines the green component to check
  83348. * @param b defines the blue component to check
  83349. * @returns true if the rgb values are equal to the given ones
  83350. */
  83351. equalsFloats(r: number, g: number, b: number): boolean;
  83352. /**
  83353. * Multiplies in place each rgb value by scale
  83354. * @param scale defines the scaling factor
  83355. * @returns the updated Color3
  83356. */
  83357. scale(scale: number): Color3;
  83358. /**
  83359. * Multiplies the rgb values by scale and stores the result into "result"
  83360. * @param scale defines the scaling factor
  83361. * @param result defines the Color3 object where to store the result
  83362. * @returns the unmodified current Color3
  83363. */
  83364. scaleToRef(scale: number, result: Color3): Color3;
  83365. /**
  83366. * Scale the current Color3 values by a factor and add the result to a given Color3
  83367. * @param scale defines the scale factor
  83368. * @param result defines color to store the result into
  83369. * @returns the unmodified current Color3
  83370. */
  83371. scaleAndAddToRef(scale: number, result: Color3): Color3;
  83372. /**
  83373. * Clamps the rgb values by the min and max values and stores the result into "result"
  83374. * @param min defines minimum clamping value (default is 0)
  83375. * @param max defines maximum clamping value (default is 1)
  83376. * @param result defines color to store the result into
  83377. * @returns the original Color3
  83378. */
  83379. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  83380. /**
  83381. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  83382. * @param otherColor defines the second operand
  83383. * @returns the new Color3
  83384. */
  83385. add(otherColor: DeepImmutable<Color3>): Color3;
  83386. /**
  83387. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  83388. * @param otherColor defines the second operand
  83389. * @param result defines Color3 object to store the result into
  83390. * @returns the unmodified current Color3
  83391. */
  83392. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  83393. /**
  83394. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  83395. * @param otherColor defines the second operand
  83396. * @returns the new Color3
  83397. */
  83398. subtract(otherColor: DeepImmutable<Color3>): Color3;
  83399. /**
  83400. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  83401. * @param otherColor defines the second operand
  83402. * @param result defines Color3 object to store the result into
  83403. * @returns the unmodified current Color3
  83404. */
  83405. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  83406. /**
  83407. * Copy the current object
  83408. * @returns a new Color3 copied the current one
  83409. */
  83410. clone(): Color3;
  83411. /**
  83412. * Copies the rgb values from the source in the current Color3
  83413. * @param source defines the source Color3 object
  83414. * @returns the updated Color3 object
  83415. */
  83416. copyFrom(source: DeepImmutable<Color3>): Color3;
  83417. /**
  83418. * Updates the Color3 rgb values from the given floats
  83419. * @param r defines the red component to read from
  83420. * @param g defines the green component to read from
  83421. * @param b defines the blue component to read from
  83422. * @returns the current Color3 object
  83423. */
  83424. copyFromFloats(r: number, g: number, b: number): Color3;
  83425. /**
  83426. * Updates the Color3 rgb values from the given floats
  83427. * @param r defines the red component to read from
  83428. * @param g defines the green component to read from
  83429. * @param b defines the blue component to read from
  83430. * @returns the current Color3 object
  83431. */
  83432. set(r: number, g: number, b: number): Color3;
  83433. /**
  83434. * Compute the Color3 hexadecimal code as a string
  83435. * @returns a string containing the hexadecimal representation of the Color3 object
  83436. */
  83437. toHexString(): string;
  83438. /**
  83439. * Computes a new Color3 converted from the current one to linear space
  83440. * @returns a new Color3 object
  83441. */
  83442. toLinearSpace(): Color3;
  83443. /**
  83444. * Converts current color in rgb space to HSV values
  83445. * @returns a new color3 representing the HSV values
  83446. */
  83447. toHSV(): Color3;
  83448. /**
  83449. * Converts current color in rgb space to HSV values
  83450. * @param result defines the Color3 where to store the HSV values
  83451. */
  83452. toHSVToRef(result: Color3): void;
  83453. /**
  83454. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  83455. * @param convertedColor defines the Color3 object where to store the linear space version
  83456. * @returns the unmodified Color3
  83457. */
  83458. toLinearSpaceToRef(convertedColor: Color3): Color3;
  83459. /**
  83460. * Computes a new Color3 converted from the current one to gamma space
  83461. * @returns a new Color3 object
  83462. */
  83463. toGammaSpace(): Color3;
  83464. /**
  83465. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  83466. * @param convertedColor defines the Color3 object where to store the gamma space version
  83467. * @returns the unmodified Color3
  83468. */
  83469. toGammaSpaceToRef(convertedColor: Color3): Color3;
  83470. private static _BlackReadOnly;
  83471. /**
  83472. * Convert Hue, saturation and value to a Color3 (RGB)
  83473. * @param hue defines the hue
  83474. * @param saturation defines the saturation
  83475. * @param value defines the value
  83476. * @param result defines the Color3 where to store the RGB values
  83477. */
  83478. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  83479. /**
  83480. * Creates a new Color3 from the string containing valid hexadecimal values
  83481. * @param hex defines a string containing valid hexadecimal values
  83482. * @returns a new Color3 object
  83483. */
  83484. static FromHexString(hex: string): Color3;
  83485. /**
  83486. * Creates a new Color3 from the starting index of the given array
  83487. * @param array defines the source array
  83488. * @param offset defines an offset in the source array
  83489. * @returns a new Color3 object
  83490. */
  83491. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  83492. /**
  83493. * Creates a new Color3 from integer values (< 256)
  83494. * @param r defines the red component to read from (value between 0 and 255)
  83495. * @param g defines the green component to read from (value between 0 and 255)
  83496. * @param b defines the blue component to read from (value between 0 and 255)
  83497. * @returns a new Color3 object
  83498. */
  83499. static FromInts(r: number, g: number, b: number): Color3;
  83500. /**
  83501. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  83502. * @param start defines the start Color3 value
  83503. * @param end defines the end Color3 value
  83504. * @param amount defines the gradient value between start and end
  83505. * @returns a new Color3 object
  83506. */
  83507. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  83508. /**
  83509. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  83510. * @param left defines the start value
  83511. * @param right defines the end value
  83512. * @param amount defines the gradient factor
  83513. * @param result defines the Color3 object where to store the result
  83514. */
  83515. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  83516. /**
  83517. * Returns a Color3 value containing a red color
  83518. * @returns a new Color3 object
  83519. */
  83520. static Red(): Color3;
  83521. /**
  83522. * Returns a Color3 value containing a green color
  83523. * @returns a new Color3 object
  83524. */
  83525. static Green(): Color3;
  83526. /**
  83527. * Returns a Color3 value containing a blue color
  83528. * @returns a new Color3 object
  83529. */
  83530. static Blue(): Color3;
  83531. /**
  83532. * Returns a Color3 value containing a black color
  83533. * @returns a new Color3 object
  83534. */
  83535. static Black(): Color3;
  83536. /**
  83537. * Gets a Color3 value containing a black color that must not be updated
  83538. */
  83539. static get BlackReadOnly(): DeepImmutable<Color3>;
  83540. /**
  83541. * Returns a Color3 value containing a white color
  83542. * @returns a new Color3 object
  83543. */
  83544. static White(): Color3;
  83545. /**
  83546. * Returns a Color3 value containing a purple color
  83547. * @returns a new Color3 object
  83548. */
  83549. static Purple(): Color3;
  83550. /**
  83551. * Returns a Color3 value containing a magenta color
  83552. * @returns a new Color3 object
  83553. */
  83554. static Magenta(): Color3;
  83555. /**
  83556. * Returns a Color3 value containing a yellow color
  83557. * @returns a new Color3 object
  83558. */
  83559. static Yellow(): Color3;
  83560. /**
  83561. * Returns a Color3 value containing a gray color
  83562. * @returns a new Color3 object
  83563. */
  83564. static Gray(): Color3;
  83565. /**
  83566. * Returns a Color3 value containing a teal color
  83567. * @returns a new Color3 object
  83568. */
  83569. static Teal(): Color3;
  83570. /**
  83571. * Returns a Color3 value containing a random color
  83572. * @returns a new Color3 object
  83573. */
  83574. static Random(): Color3;
  83575. }
  83576. /**
  83577. * Class used to hold a RBGA color
  83578. */
  83579. export class Color4 {
  83580. /**
  83581. * Defines the red component (between 0 and 1, default is 0)
  83582. */
  83583. r: number;
  83584. /**
  83585. * Defines the green component (between 0 and 1, default is 0)
  83586. */
  83587. g: number;
  83588. /**
  83589. * Defines the blue component (between 0 and 1, default is 0)
  83590. */
  83591. b: number;
  83592. /**
  83593. * Defines the alpha component (between 0 and 1, default is 1)
  83594. */
  83595. a: number;
  83596. /**
  83597. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  83598. * @param r defines the red component (between 0 and 1, default is 0)
  83599. * @param g defines the green component (between 0 and 1, default is 0)
  83600. * @param b defines the blue component (between 0 and 1, default is 0)
  83601. * @param a defines the alpha component (between 0 and 1, default is 1)
  83602. */
  83603. constructor(
  83604. /**
  83605. * Defines the red component (between 0 and 1, default is 0)
  83606. */
  83607. r?: number,
  83608. /**
  83609. * Defines the green component (between 0 and 1, default is 0)
  83610. */
  83611. g?: number,
  83612. /**
  83613. * Defines the blue component (between 0 and 1, default is 0)
  83614. */
  83615. b?: number,
  83616. /**
  83617. * Defines the alpha component (between 0 and 1, default is 1)
  83618. */
  83619. a?: number);
  83620. /**
  83621. * Adds in place the given Color4 values to the current Color4 object
  83622. * @param right defines the second operand
  83623. * @returns the current updated Color4 object
  83624. */
  83625. addInPlace(right: DeepImmutable<Color4>): Color4;
  83626. /**
  83627. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  83628. * @returns the new array
  83629. */
  83630. asArray(): number[];
  83631. /**
  83632. * Stores from the starting index in the given array the Color4 successive values
  83633. * @param array defines the array where to store the r,g,b components
  83634. * @param index defines an optional index in the target array to define where to start storing values
  83635. * @returns the current Color4 object
  83636. */
  83637. toArray(array: number[], index?: number): Color4;
  83638. /**
  83639. * Determines equality between Color4 objects
  83640. * @param otherColor defines the second operand
  83641. * @returns true if the rgba values are equal to the given ones
  83642. */
  83643. equals(otherColor: DeepImmutable<Color4>): boolean;
  83644. /**
  83645. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  83646. * @param right defines the second operand
  83647. * @returns a new Color4 object
  83648. */
  83649. add(right: DeepImmutable<Color4>): Color4;
  83650. /**
  83651. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  83652. * @param right defines the second operand
  83653. * @returns a new Color4 object
  83654. */
  83655. subtract(right: DeepImmutable<Color4>): Color4;
  83656. /**
  83657. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  83658. * @param right defines the second operand
  83659. * @param result defines the Color4 object where to store the result
  83660. * @returns the current Color4 object
  83661. */
  83662. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  83663. /**
  83664. * Creates a new Color4 with the current Color4 values multiplied by scale
  83665. * @param scale defines the scaling factor to apply
  83666. * @returns a new Color4 object
  83667. */
  83668. scale(scale: number): Color4;
  83669. /**
  83670. * Multiplies the current Color4 values by scale and stores the result in "result"
  83671. * @param scale defines the scaling factor to apply
  83672. * @param result defines the Color4 object where to store the result
  83673. * @returns the current unmodified Color4
  83674. */
  83675. scaleToRef(scale: number, result: Color4): Color4;
  83676. /**
  83677. * Scale the current Color4 values by a factor and add the result to a given Color4
  83678. * @param scale defines the scale factor
  83679. * @param result defines the Color4 object where to store the result
  83680. * @returns the unmodified current Color4
  83681. */
  83682. scaleAndAddToRef(scale: number, result: Color4): Color4;
  83683. /**
  83684. * Clamps the rgb values by the min and max values and stores the result into "result"
  83685. * @param min defines minimum clamping value (default is 0)
  83686. * @param max defines maximum clamping value (default is 1)
  83687. * @param result defines color to store the result into.
  83688. * @returns the cuurent Color4
  83689. */
  83690. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  83691. /**
  83692. * Multipy an Color4 value by another and return a new Color4 object
  83693. * @param color defines the Color4 value to multiply by
  83694. * @returns a new Color4 object
  83695. */
  83696. multiply(color: Color4): Color4;
  83697. /**
  83698. * Multipy a Color4 value by another and push the result in a reference value
  83699. * @param color defines the Color4 value to multiply by
  83700. * @param result defines the Color4 to fill the result in
  83701. * @returns the result Color4
  83702. */
  83703. multiplyToRef(color: Color4, result: Color4): Color4;
  83704. /**
  83705. * Creates a string with the Color4 current values
  83706. * @returns the string representation of the Color4 object
  83707. */
  83708. toString(): string;
  83709. /**
  83710. * Returns the string "Color4"
  83711. * @returns "Color4"
  83712. */
  83713. getClassName(): string;
  83714. /**
  83715. * Compute the Color4 hash code
  83716. * @returns an unique number that can be used to hash Color4 objects
  83717. */
  83718. getHashCode(): number;
  83719. /**
  83720. * Creates a new Color4 copied from the current one
  83721. * @returns a new Color4 object
  83722. */
  83723. clone(): Color4;
  83724. /**
  83725. * Copies the given Color4 values into the current one
  83726. * @param source defines the source Color4 object
  83727. * @returns the current updated Color4 object
  83728. */
  83729. copyFrom(source: Color4): Color4;
  83730. /**
  83731. * Copies the given float values into the current one
  83732. * @param r defines the red component to read from
  83733. * @param g defines the green component to read from
  83734. * @param b defines the blue component to read from
  83735. * @param a defines the alpha component to read from
  83736. * @returns the current updated Color4 object
  83737. */
  83738. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  83739. /**
  83740. * Copies the given float values into the current one
  83741. * @param r defines the red component to read from
  83742. * @param g defines the green component to read from
  83743. * @param b defines the blue component to read from
  83744. * @param a defines the alpha component to read from
  83745. * @returns the current updated Color4 object
  83746. */
  83747. set(r: number, g: number, b: number, a: number): Color4;
  83748. /**
  83749. * Compute the Color4 hexadecimal code as a string
  83750. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  83751. * @returns a string containing the hexadecimal representation of the Color4 object
  83752. */
  83753. toHexString(returnAsColor3?: boolean): string;
  83754. /**
  83755. * Computes a new Color4 converted from the current one to linear space
  83756. * @returns a new Color4 object
  83757. */
  83758. toLinearSpace(): Color4;
  83759. /**
  83760. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  83761. * @param convertedColor defines the Color4 object where to store the linear space version
  83762. * @returns the unmodified Color4
  83763. */
  83764. toLinearSpaceToRef(convertedColor: Color4): Color4;
  83765. /**
  83766. * Computes a new Color4 converted from the current one to gamma space
  83767. * @returns a new Color4 object
  83768. */
  83769. toGammaSpace(): Color4;
  83770. /**
  83771. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  83772. * @param convertedColor defines the Color4 object where to store the gamma space version
  83773. * @returns the unmodified Color4
  83774. */
  83775. toGammaSpaceToRef(convertedColor: Color4): Color4;
  83776. /**
  83777. * Creates a new Color4 from the string containing valid hexadecimal values
  83778. * @param hex defines a string containing valid hexadecimal values
  83779. * @returns a new Color4 object
  83780. */
  83781. static FromHexString(hex: string): Color4;
  83782. /**
  83783. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  83784. * @param left defines the start value
  83785. * @param right defines the end value
  83786. * @param amount defines the gradient factor
  83787. * @returns a new Color4 object
  83788. */
  83789. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  83790. /**
  83791. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  83792. * @param left defines the start value
  83793. * @param right defines the end value
  83794. * @param amount defines the gradient factor
  83795. * @param result defines the Color4 object where to store data
  83796. */
  83797. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  83798. /**
  83799. * Creates a new Color4 from a Color3 and an alpha value
  83800. * @param color3 defines the source Color3 to read from
  83801. * @param alpha defines the alpha component (1.0 by default)
  83802. * @returns a new Color4 object
  83803. */
  83804. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  83805. /**
  83806. * Creates a new Color4 from the starting index element of the given array
  83807. * @param array defines the source array to read from
  83808. * @param offset defines the offset in the source array
  83809. * @returns a new Color4 object
  83810. */
  83811. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  83812. /**
  83813. * Creates a new Color3 from integer values (< 256)
  83814. * @param r defines the red component to read from (value between 0 and 255)
  83815. * @param g defines the green component to read from (value between 0 and 255)
  83816. * @param b defines the blue component to read from (value between 0 and 255)
  83817. * @param a defines the alpha component to read from (value between 0 and 255)
  83818. * @returns a new Color3 object
  83819. */
  83820. static FromInts(r: number, g: number, b: number, a: number): Color4;
  83821. /**
  83822. * Check the content of a given array and convert it to an array containing RGBA data
  83823. * If the original array was already containing count * 4 values then it is returned directly
  83824. * @param colors defines the array to check
  83825. * @param count defines the number of RGBA data to expect
  83826. * @returns an array containing count * 4 values (RGBA)
  83827. */
  83828. static CheckColors4(colors: number[], count: number): number[];
  83829. }
  83830. /**
  83831. * @hidden
  83832. */
  83833. export class TmpColors {
  83834. static Color3: Color3[];
  83835. static Color4: Color4[];
  83836. }
  83837. }
  83838. declare module BABYLON {
  83839. /**
  83840. * Defines an interface which represents an animation key frame
  83841. */
  83842. export interface IAnimationKey {
  83843. /**
  83844. * Frame of the key frame
  83845. */
  83846. frame: number;
  83847. /**
  83848. * Value at the specifies key frame
  83849. */
  83850. value: any;
  83851. /**
  83852. * The input tangent for the cubic hermite spline
  83853. */
  83854. inTangent?: any;
  83855. /**
  83856. * The output tangent for the cubic hermite spline
  83857. */
  83858. outTangent?: any;
  83859. /**
  83860. * The animation interpolation type
  83861. */
  83862. interpolation?: AnimationKeyInterpolation;
  83863. }
  83864. /**
  83865. * Enum for the animation key frame interpolation type
  83866. */
  83867. export enum AnimationKeyInterpolation {
  83868. /**
  83869. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  83870. */
  83871. STEP = 1
  83872. }
  83873. }
  83874. declare module BABYLON {
  83875. /**
  83876. * Represents the range of an animation
  83877. */
  83878. export class AnimationRange {
  83879. /**The name of the animation range**/
  83880. name: string;
  83881. /**The starting frame of the animation */
  83882. from: number;
  83883. /**The ending frame of the animation*/
  83884. to: number;
  83885. /**
  83886. * Initializes the range of an animation
  83887. * @param name The name of the animation range
  83888. * @param from The starting frame of the animation
  83889. * @param to The ending frame of the animation
  83890. */
  83891. constructor(
  83892. /**The name of the animation range**/
  83893. name: string,
  83894. /**The starting frame of the animation */
  83895. from: number,
  83896. /**The ending frame of the animation*/
  83897. to: number);
  83898. /**
  83899. * Makes a copy of the animation range
  83900. * @returns A copy of the animation range
  83901. */
  83902. clone(): AnimationRange;
  83903. }
  83904. }
  83905. declare module BABYLON {
  83906. /**
  83907. * Composed of a frame, and an action function
  83908. */
  83909. export class AnimationEvent {
  83910. /** The frame for which the event is triggered **/
  83911. frame: number;
  83912. /** The event to perform when triggered **/
  83913. action: (currentFrame: number) => void;
  83914. /** Specifies if the event should be triggered only once**/
  83915. onlyOnce?: boolean | undefined;
  83916. /**
  83917. * Specifies if the animation event is done
  83918. */
  83919. isDone: boolean;
  83920. /**
  83921. * Initializes the animation event
  83922. * @param frame The frame for which the event is triggered
  83923. * @param action The event to perform when triggered
  83924. * @param onlyOnce Specifies if the event should be triggered only once
  83925. */
  83926. constructor(
  83927. /** The frame for which the event is triggered **/
  83928. frame: number,
  83929. /** The event to perform when triggered **/
  83930. action: (currentFrame: number) => void,
  83931. /** Specifies if the event should be triggered only once**/
  83932. onlyOnce?: boolean | undefined);
  83933. /** @hidden */
  83934. _clone(): AnimationEvent;
  83935. }
  83936. }
  83937. declare module BABYLON {
  83938. /**
  83939. * Interface used to define a behavior
  83940. */
  83941. export interface Behavior<T> {
  83942. /** gets or sets behavior's name */
  83943. name: string;
  83944. /**
  83945. * Function called when the behavior needs to be initialized (after attaching it to a target)
  83946. */
  83947. init(): void;
  83948. /**
  83949. * Called when the behavior is attached to a target
  83950. * @param target defines the target where the behavior is attached to
  83951. */
  83952. attach(target: T): void;
  83953. /**
  83954. * Called when the behavior is detached from its target
  83955. */
  83956. detach(): void;
  83957. }
  83958. /**
  83959. * Interface implemented by classes supporting behaviors
  83960. */
  83961. export interface IBehaviorAware<T> {
  83962. /**
  83963. * Attach a behavior
  83964. * @param behavior defines the behavior to attach
  83965. * @returns the current host
  83966. */
  83967. addBehavior(behavior: Behavior<T>): T;
  83968. /**
  83969. * Remove a behavior from the current object
  83970. * @param behavior defines the behavior to detach
  83971. * @returns the current host
  83972. */
  83973. removeBehavior(behavior: Behavior<T>): T;
  83974. /**
  83975. * Gets a behavior using its name to search
  83976. * @param name defines the name to search
  83977. * @returns the behavior or null if not found
  83978. */
  83979. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  83980. }
  83981. }
  83982. declare module BABYLON {
  83983. /**
  83984. * Defines an array and its length.
  83985. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  83986. */
  83987. export interface ISmartArrayLike<T> {
  83988. /**
  83989. * The data of the array.
  83990. */
  83991. data: Array<T>;
  83992. /**
  83993. * The active length of the array.
  83994. */
  83995. length: number;
  83996. }
  83997. /**
  83998. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  83999. */
  84000. export class SmartArray<T> implements ISmartArrayLike<T> {
  84001. /**
  84002. * The full set of data from the array.
  84003. */
  84004. data: Array<T>;
  84005. /**
  84006. * The active length of the array.
  84007. */
  84008. length: number;
  84009. protected _id: number;
  84010. /**
  84011. * Instantiates a Smart Array.
  84012. * @param capacity defines the default capacity of the array.
  84013. */
  84014. constructor(capacity: number);
  84015. /**
  84016. * Pushes a value at the end of the active data.
  84017. * @param value defines the object to push in the array.
  84018. */
  84019. push(value: T): void;
  84020. /**
  84021. * Iterates over the active data and apply the lambda to them.
  84022. * @param func defines the action to apply on each value.
  84023. */
  84024. forEach(func: (content: T) => void): void;
  84025. /**
  84026. * Sorts the full sets of data.
  84027. * @param compareFn defines the comparison function to apply.
  84028. */
  84029. sort(compareFn: (a: T, b: T) => number): void;
  84030. /**
  84031. * Resets the active data to an empty array.
  84032. */
  84033. reset(): void;
  84034. /**
  84035. * Releases all the data from the array as well as the array.
  84036. */
  84037. dispose(): void;
  84038. /**
  84039. * Concats the active data with a given array.
  84040. * @param array defines the data to concatenate with.
  84041. */
  84042. concat(array: any): void;
  84043. /**
  84044. * Returns the position of a value in the active data.
  84045. * @param value defines the value to find the index for
  84046. * @returns the index if found in the active data otherwise -1
  84047. */
  84048. indexOf(value: T): number;
  84049. /**
  84050. * Returns whether an element is part of the active data.
  84051. * @param value defines the value to look for
  84052. * @returns true if found in the active data otherwise false
  84053. */
  84054. contains(value: T): boolean;
  84055. private static _GlobalId;
  84056. }
  84057. /**
  84058. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  84059. * The data in this array can only be present once
  84060. */
  84061. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  84062. private _duplicateId;
  84063. /**
  84064. * Pushes a value at the end of the active data.
  84065. * THIS DOES NOT PREVENT DUPPLICATE DATA
  84066. * @param value defines the object to push in the array.
  84067. */
  84068. push(value: T): void;
  84069. /**
  84070. * Pushes a value at the end of the active data.
  84071. * If the data is already present, it won t be added again
  84072. * @param value defines the object to push in the array.
  84073. * @returns true if added false if it was already present
  84074. */
  84075. pushNoDuplicate(value: T): boolean;
  84076. /**
  84077. * Resets the active data to an empty array.
  84078. */
  84079. reset(): void;
  84080. /**
  84081. * Concats the active data with a given array.
  84082. * This ensures no dupplicate will be present in the result.
  84083. * @param array defines the data to concatenate with.
  84084. */
  84085. concatWithNoDuplicate(array: any): void;
  84086. }
  84087. }
  84088. declare module BABYLON {
  84089. /**
  84090. * @ignore
  84091. * This is a list of all the different input types that are available in the application.
  84092. * Fo instance: ArcRotateCameraGamepadInput...
  84093. */
  84094. export var CameraInputTypes: {};
  84095. /**
  84096. * This is the contract to implement in order to create a new input class.
  84097. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  84098. */
  84099. export interface ICameraInput<TCamera extends Camera> {
  84100. /**
  84101. * Defines the camera the input is attached to.
  84102. */
  84103. camera: Nullable<TCamera>;
  84104. /**
  84105. * Gets the class name of the current intput.
  84106. * @returns the class name
  84107. */
  84108. getClassName(): string;
  84109. /**
  84110. * Get the friendly name associated with the input class.
  84111. * @returns the input friendly name
  84112. */
  84113. getSimpleName(): string;
  84114. /**
  84115. * Attach the input controls to a specific dom element to get the input from.
  84116. * @param element Defines the element the controls should be listened from
  84117. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  84118. */
  84119. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  84120. /**
  84121. * Detach the current controls from the specified dom element.
  84122. * @param element Defines the element to stop listening the inputs from
  84123. */
  84124. detachControl(element: Nullable<HTMLElement>): void;
  84125. /**
  84126. * Update the current camera state depending on the inputs that have been used this frame.
  84127. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  84128. */
  84129. checkInputs?: () => void;
  84130. }
  84131. /**
  84132. * Represents a map of input types to input instance or input index to input instance.
  84133. */
  84134. export interface CameraInputsMap<TCamera extends Camera> {
  84135. /**
  84136. * Accessor to the input by input type.
  84137. */
  84138. [name: string]: ICameraInput<TCamera>;
  84139. /**
  84140. * Accessor to the input by input index.
  84141. */
  84142. [idx: number]: ICameraInput<TCamera>;
  84143. }
  84144. /**
  84145. * This represents the input manager used within a camera.
  84146. * It helps dealing with all the different kind of input attached to a camera.
  84147. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  84148. */
  84149. export class CameraInputsManager<TCamera extends Camera> {
  84150. /**
  84151. * Defines the list of inputs attahed to the camera.
  84152. */
  84153. attached: CameraInputsMap<TCamera>;
  84154. /**
  84155. * Defines the dom element the camera is collecting inputs from.
  84156. * This is null if the controls have not been attached.
  84157. */
  84158. attachedElement: Nullable<HTMLElement>;
  84159. /**
  84160. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  84161. */
  84162. noPreventDefault: boolean;
  84163. /**
  84164. * Defined the camera the input manager belongs to.
  84165. */
  84166. camera: TCamera;
  84167. /**
  84168. * Update the current camera state depending on the inputs that have been used this frame.
  84169. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  84170. */
  84171. checkInputs: () => void;
  84172. /**
  84173. * Instantiate a new Camera Input Manager.
  84174. * @param camera Defines the camera the input manager blongs to
  84175. */
  84176. constructor(camera: TCamera);
  84177. /**
  84178. * Add an input method to a camera
  84179. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  84180. * @param input camera input method
  84181. */
  84182. add(input: ICameraInput<TCamera>): void;
  84183. /**
  84184. * Remove a specific input method from a camera
  84185. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  84186. * @param inputToRemove camera input method
  84187. */
  84188. remove(inputToRemove: ICameraInput<TCamera>): void;
  84189. /**
  84190. * Remove a specific input type from a camera
  84191. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  84192. * @param inputType the type of the input to remove
  84193. */
  84194. removeByType(inputType: string): void;
  84195. private _addCheckInputs;
  84196. /**
  84197. * Attach the input controls to the currently attached dom element to listen the events from.
  84198. * @param input Defines the input to attach
  84199. */
  84200. attachInput(input: ICameraInput<TCamera>): void;
  84201. /**
  84202. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  84203. * @param element Defines the dom element to collect the events from
  84204. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  84205. */
  84206. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  84207. /**
  84208. * Detach the current manager inputs controls from a specific dom element.
  84209. * @param element Defines the dom element to collect the events from
  84210. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  84211. */
  84212. detachElement(element: HTMLElement, disconnect?: boolean): void;
  84213. /**
  84214. * Rebuild the dynamic inputCheck function from the current list of
  84215. * defined inputs in the manager.
  84216. */
  84217. rebuildInputCheck(): void;
  84218. /**
  84219. * Remove all attached input methods from a camera
  84220. */
  84221. clear(): void;
  84222. /**
  84223. * Serialize the current input manager attached to a camera.
  84224. * This ensures than once parsed,
  84225. * the input associated to the camera will be identical to the current ones
  84226. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  84227. */
  84228. serialize(serializedCamera: any): void;
  84229. /**
  84230. * Parses an input manager serialized JSON to restore the previous list of inputs
  84231. * and states associated to a camera.
  84232. * @param parsedCamera Defines the JSON to parse
  84233. */
  84234. parse(parsedCamera: any): void;
  84235. }
  84236. }
  84237. declare module BABYLON {
  84238. /**
  84239. * Class used to store data that will be store in GPU memory
  84240. */
  84241. export class Buffer {
  84242. private _engine;
  84243. private _buffer;
  84244. /** @hidden */
  84245. _data: Nullable<DataArray>;
  84246. private _updatable;
  84247. private _instanced;
  84248. private _divisor;
  84249. /**
  84250. * Gets the byte stride.
  84251. */
  84252. readonly byteStride: number;
  84253. /**
  84254. * Constructor
  84255. * @param engine the engine
  84256. * @param data the data to use for this buffer
  84257. * @param updatable whether the data is updatable
  84258. * @param stride the stride (optional)
  84259. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  84260. * @param instanced whether the buffer is instanced (optional)
  84261. * @param useBytes set to true if the stride in in bytes (optional)
  84262. * @param divisor sets an optional divisor for instances (1 by default)
  84263. */
  84264. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  84265. /**
  84266. * Create a new VertexBuffer based on the current buffer
  84267. * @param kind defines the vertex buffer kind (position, normal, etc.)
  84268. * @param offset defines offset in the buffer (0 by default)
  84269. * @param size defines the size in floats of attributes (position is 3 for instance)
  84270. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  84271. * @param instanced defines if the vertex buffer contains indexed data
  84272. * @param useBytes defines if the offset and stride are in bytes *
  84273. * @param divisor sets an optional divisor for instances (1 by default)
  84274. * @returns the new vertex buffer
  84275. */
  84276. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  84277. /**
  84278. * Gets a boolean indicating if the Buffer is updatable?
  84279. * @returns true if the buffer is updatable
  84280. */
  84281. isUpdatable(): boolean;
  84282. /**
  84283. * Gets current buffer's data
  84284. * @returns a DataArray or null
  84285. */
  84286. getData(): Nullable<DataArray>;
  84287. /**
  84288. * Gets underlying native buffer
  84289. * @returns underlying native buffer
  84290. */
  84291. getBuffer(): Nullable<DataBuffer>;
  84292. /**
  84293. * Gets the stride in float32 units (i.e. byte stride / 4).
  84294. * May not be an integer if the byte stride is not divisible by 4.
  84295. * @returns the stride in float32 units
  84296. * @deprecated Please use byteStride instead.
  84297. */
  84298. getStrideSize(): number;
  84299. /**
  84300. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  84301. * @param data defines the data to store
  84302. */
  84303. create(data?: Nullable<DataArray>): void;
  84304. /** @hidden */
  84305. _rebuild(): void;
  84306. /**
  84307. * Update current buffer data
  84308. * @param data defines the data to store
  84309. */
  84310. update(data: DataArray): void;
  84311. /**
  84312. * Updates the data directly.
  84313. * @param data the new data
  84314. * @param offset the new offset
  84315. * @param vertexCount the vertex count (optional)
  84316. * @param useBytes set to true if the offset is in bytes
  84317. */
  84318. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  84319. /**
  84320. * Release all resources
  84321. */
  84322. dispose(): void;
  84323. }
  84324. /**
  84325. * Specialized buffer used to store vertex data
  84326. */
  84327. export class VertexBuffer {
  84328. /** @hidden */
  84329. _buffer: Buffer;
  84330. private _kind;
  84331. private _size;
  84332. private _ownsBuffer;
  84333. private _instanced;
  84334. private _instanceDivisor;
  84335. /**
  84336. * The byte type.
  84337. */
  84338. static readonly BYTE: number;
  84339. /**
  84340. * The unsigned byte type.
  84341. */
  84342. static readonly UNSIGNED_BYTE: number;
  84343. /**
  84344. * The short type.
  84345. */
  84346. static readonly SHORT: number;
  84347. /**
  84348. * The unsigned short type.
  84349. */
  84350. static readonly UNSIGNED_SHORT: number;
  84351. /**
  84352. * The integer type.
  84353. */
  84354. static readonly INT: number;
  84355. /**
  84356. * The unsigned integer type.
  84357. */
  84358. static readonly UNSIGNED_INT: number;
  84359. /**
  84360. * The float type.
  84361. */
  84362. static readonly FLOAT: number;
  84363. /**
  84364. * Gets or sets the instance divisor when in instanced mode
  84365. */
  84366. get instanceDivisor(): number;
  84367. set instanceDivisor(value: number);
  84368. /**
  84369. * Gets the byte stride.
  84370. */
  84371. readonly byteStride: number;
  84372. /**
  84373. * Gets the byte offset.
  84374. */
  84375. readonly byteOffset: number;
  84376. /**
  84377. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  84378. */
  84379. readonly normalized: boolean;
  84380. /**
  84381. * Gets the data type of each component in the array.
  84382. */
  84383. readonly type: number;
  84384. /**
  84385. * Constructor
  84386. * @param engine the engine
  84387. * @param data the data to use for this vertex buffer
  84388. * @param kind the vertex buffer kind
  84389. * @param updatable whether the data is updatable
  84390. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  84391. * @param stride the stride (optional)
  84392. * @param instanced whether the buffer is instanced (optional)
  84393. * @param offset the offset of the data (optional)
  84394. * @param size the number of components (optional)
  84395. * @param type the type of the component (optional)
  84396. * @param normalized whether the data contains normalized data (optional)
  84397. * @param useBytes set to true if stride and offset are in bytes (optional)
  84398. * @param divisor defines the instance divisor to use (1 by default)
  84399. */
  84400. 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);
  84401. /** @hidden */
  84402. _rebuild(): void;
  84403. /**
  84404. * Returns the kind of the VertexBuffer (string)
  84405. * @returns a string
  84406. */
  84407. getKind(): string;
  84408. /**
  84409. * Gets a boolean indicating if the VertexBuffer is updatable?
  84410. * @returns true if the buffer is updatable
  84411. */
  84412. isUpdatable(): boolean;
  84413. /**
  84414. * Gets current buffer's data
  84415. * @returns a DataArray or null
  84416. */
  84417. getData(): Nullable<DataArray>;
  84418. /**
  84419. * Gets underlying native buffer
  84420. * @returns underlying native buffer
  84421. */
  84422. getBuffer(): Nullable<DataBuffer>;
  84423. /**
  84424. * Gets the stride in float32 units (i.e. byte stride / 4).
  84425. * May not be an integer if the byte stride is not divisible by 4.
  84426. * @returns the stride in float32 units
  84427. * @deprecated Please use byteStride instead.
  84428. */
  84429. getStrideSize(): number;
  84430. /**
  84431. * Returns the offset as a multiple of the type byte length.
  84432. * @returns the offset in bytes
  84433. * @deprecated Please use byteOffset instead.
  84434. */
  84435. getOffset(): number;
  84436. /**
  84437. * Returns the number of components per vertex attribute (integer)
  84438. * @returns the size in float
  84439. */
  84440. getSize(): number;
  84441. /**
  84442. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  84443. * @returns true if this buffer is instanced
  84444. */
  84445. getIsInstanced(): boolean;
  84446. /**
  84447. * Returns the instancing divisor, zero for non-instanced (integer).
  84448. * @returns a number
  84449. */
  84450. getInstanceDivisor(): number;
  84451. /**
  84452. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  84453. * @param data defines the data to store
  84454. */
  84455. create(data?: DataArray): void;
  84456. /**
  84457. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  84458. * This function will create a new buffer if the current one is not updatable
  84459. * @param data defines the data to store
  84460. */
  84461. update(data: DataArray): void;
  84462. /**
  84463. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  84464. * Returns the directly updated WebGLBuffer.
  84465. * @param data the new data
  84466. * @param offset the new offset
  84467. * @param useBytes set to true if the offset is in bytes
  84468. */
  84469. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  84470. /**
  84471. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  84472. */
  84473. dispose(): void;
  84474. /**
  84475. * Enumerates each value of this vertex buffer as numbers.
  84476. * @param count the number of values to enumerate
  84477. * @param callback the callback function called for each value
  84478. */
  84479. forEach(count: number, callback: (value: number, index: number) => void): void;
  84480. /**
  84481. * Positions
  84482. */
  84483. static readonly PositionKind: string;
  84484. /**
  84485. * Normals
  84486. */
  84487. static readonly NormalKind: string;
  84488. /**
  84489. * Tangents
  84490. */
  84491. static readonly TangentKind: string;
  84492. /**
  84493. * Texture coordinates
  84494. */
  84495. static readonly UVKind: string;
  84496. /**
  84497. * Texture coordinates 2
  84498. */
  84499. static readonly UV2Kind: string;
  84500. /**
  84501. * Texture coordinates 3
  84502. */
  84503. static readonly UV3Kind: string;
  84504. /**
  84505. * Texture coordinates 4
  84506. */
  84507. static readonly UV4Kind: string;
  84508. /**
  84509. * Texture coordinates 5
  84510. */
  84511. static readonly UV5Kind: string;
  84512. /**
  84513. * Texture coordinates 6
  84514. */
  84515. static readonly UV6Kind: string;
  84516. /**
  84517. * Colors
  84518. */
  84519. static readonly ColorKind: string;
  84520. /**
  84521. * Matrix indices (for bones)
  84522. */
  84523. static readonly MatricesIndicesKind: string;
  84524. /**
  84525. * Matrix weights (for bones)
  84526. */
  84527. static readonly MatricesWeightsKind: string;
  84528. /**
  84529. * Additional matrix indices (for bones)
  84530. */
  84531. static readonly MatricesIndicesExtraKind: string;
  84532. /**
  84533. * Additional matrix weights (for bones)
  84534. */
  84535. static readonly MatricesWeightsExtraKind: string;
  84536. /**
  84537. * Deduces the stride given a kind.
  84538. * @param kind The kind string to deduce
  84539. * @returns The deduced stride
  84540. */
  84541. static DeduceStride(kind: string): number;
  84542. /**
  84543. * Gets the byte length of the given type.
  84544. * @param type the type
  84545. * @returns the number of bytes
  84546. */
  84547. static GetTypeByteLength(type: number): number;
  84548. /**
  84549. * Enumerates each value of the given parameters as numbers.
  84550. * @param data the data to enumerate
  84551. * @param byteOffset the byte offset of the data
  84552. * @param byteStride the byte stride of the data
  84553. * @param componentCount the number of components per element
  84554. * @param componentType the type of the component
  84555. * @param count the number of values to enumerate
  84556. * @param normalized whether the data is normalized
  84557. * @param callback the callback function called for each value
  84558. */
  84559. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  84560. private static _GetFloatValue;
  84561. }
  84562. }
  84563. declare module BABYLON {
  84564. /**
  84565. * @hidden
  84566. */
  84567. export class IntersectionInfo {
  84568. bu: Nullable<number>;
  84569. bv: Nullable<number>;
  84570. distance: number;
  84571. faceId: number;
  84572. subMeshId: number;
  84573. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  84574. }
  84575. }
  84576. declare module BABYLON {
  84577. /**
  84578. * Class used to store bounding sphere information
  84579. */
  84580. export class BoundingSphere {
  84581. /**
  84582. * Gets the center of the bounding sphere in local space
  84583. */
  84584. readonly center: Vector3;
  84585. /**
  84586. * Radius of the bounding sphere in local space
  84587. */
  84588. radius: number;
  84589. /**
  84590. * Gets the center of the bounding sphere in world space
  84591. */
  84592. readonly centerWorld: Vector3;
  84593. /**
  84594. * Radius of the bounding sphere in world space
  84595. */
  84596. radiusWorld: number;
  84597. /**
  84598. * Gets the minimum vector in local space
  84599. */
  84600. readonly minimum: Vector3;
  84601. /**
  84602. * Gets the maximum vector in local space
  84603. */
  84604. readonly maximum: Vector3;
  84605. private _worldMatrix;
  84606. private static readonly TmpVector3;
  84607. /**
  84608. * Creates a new bounding sphere
  84609. * @param min defines the minimum vector (in local space)
  84610. * @param max defines the maximum vector (in local space)
  84611. * @param worldMatrix defines the new world matrix
  84612. */
  84613. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  84614. /**
  84615. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  84616. * @param min defines the new minimum vector (in local space)
  84617. * @param max defines the new maximum vector (in local space)
  84618. * @param worldMatrix defines the new world matrix
  84619. */
  84620. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  84621. /**
  84622. * Scale the current bounding sphere by applying a scale factor
  84623. * @param factor defines the scale factor to apply
  84624. * @returns the current bounding box
  84625. */
  84626. scale(factor: number): BoundingSphere;
  84627. /**
  84628. * Gets the world matrix of the bounding box
  84629. * @returns a matrix
  84630. */
  84631. getWorldMatrix(): DeepImmutable<Matrix>;
  84632. /** @hidden */
  84633. _update(worldMatrix: DeepImmutable<Matrix>): void;
  84634. /**
  84635. * Tests if the bounding sphere is intersecting the frustum planes
  84636. * @param frustumPlanes defines the frustum planes to test
  84637. * @returns true if there is an intersection
  84638. */
  84639. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  84640. /**
  84641. * Tests if the bounding sphere center is in between the frustum planes.
  84642. * Used for optimistic fast inclusion.
  84643. * @param frustumPlanes defines the frustum planes to test
  84644. * @returns true if the sphere center is in between the frustum planes
  84645. */
  84646. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  84647. /**
  84648. * Tests if a point is inside the bounding sphere
  84649. * @param point defines the point to test
  84650. * @returns true if the point is inside the bounding sphere
  84651. */
  84652. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  84653. /**
  84654. * Checks if two sphere intersct
  84655. * @param sphere0 sphere 0
  84656. * @param sphere1 sphere 1
  84657. * @returns true if the speres intersect
  84658. */
  84659. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  84660. }
  84661. }
  84662. declare module BABYLON {
  84663. /**
  84664. * Class used to store bounding box information
  84665. */
  84666. export class BoundingBox implements ICullable {
  84667. /**
  84668. * Gets the 8 vectors representing the bounding box in local space
  84669. */
  84670. readonly vectors: Vector3[];
  84671. /**
  84672. * Gets the center of the bounding box in local space
  84673. */
  84674. readonly center: Vector3;
  84675. /**
  84676. * Gets the center of the bounding box in world space
  84677. */
  84678. readonly centerWorld: Vector3;
  84679. /**
  84680. * Gets the extend size in local space
  84681. */
  84682. readonly extendSize: Vector3;
  84683. /**
  84684. * Gets the extend size in world space
  84685. */
  84686. readonly extendSizeWorld: Vector3;
  84687. /**
  84688. * Gets the OBB (object bounding box) directions
  84689. */
  84690. readonly directions: Vector3[];
  84691. /**
  84692. * Gets the 8 vectors representing the bounding box in world space
  84693. */
  84694. readonly vectorsWorld: Vector3[];
  84695. /**
  84696. * Gets the minimum vector in world space
  84697. */
  84698. readonly minimumWorld: Vector3;
  84699. /**
  84700. * Gets the maximum vector in world space
  84701. */
  84702. readonly maximumWorld: Vector3;
  84703. /**
  84704. * Gets the minimum vector in local space
  84705. */
  84706. readonly minimum: Vector3;
  84707. /**
  84708. * Gets the maximum vector in local space
  84709. */
  84710. readonly maximum: Vector3;
  84711. private _worldMatrix;
  84712. private static readonly TmpVector3;
  84713. /**
  84714. * @hidden
  84715. */
  84716. _tag: number;
  84717. /**
  84718. * Creates a new bounding box
  84719. * @param min defines the minimum vector (in local space)
  84720. * @param max defines the maximum vector (in local space)
  84721. * @param worldMatrix defines the new world matrix
  84722. */
  84723. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  84724. /**
  84725. * Recreates the entire bounding box from scratch as if we call the constructor in place
  84726. * @param min defines the new minimum vector (in local space)
  84727. * @param max defines the new maximum vector (in local space)
  84728. * @param worldMatrix defines the new world matrix
  84729. */
  84730. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  84731. /**
  84732. * Scale the current bounding box by applying a scale factor
  84733. * @param factor defines the scale factor to apply
  84734. * @returns the current bounding box
  84735. */
  84736. scale(factor: number): BoundingBox;
  84737. /**
  84738. * Gets the world matrix of the bounding box
  84739. * @returns a matrix
  84740. */
  84741. getWorldMatrix(): DeepImmutable<Matrix>;
  84742. /** @hidden */
  84743. _update(world: DeepImmutable<Matrix>): void;
  84744. /**
  84745. * Tests if the bounding box is intersecting the frustum planes
  84746. * @param frustumPlanes defines the frustum planes to test
  84747. * @returns true if there is an intersection
  84748. */
  84749. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  84750. /**
  84751. * Tests if the bounding box is entirely inside the frustum planes
  84752. * @param frustumPlanes defines the frustum planes to test
  84753. * @returns true if there is an inclusion
  84754. */
  84755. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  84756. /**
  84757. * Tests if a point is inside the bounding box
  84758. * @param point defines the point to test
  84759. * @returns true if the point is inside the bounding box
  84760. */
  84761. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  84762. /**
  84763. * Tests if the bounding box intersects with a bounding sphere
  84764. * @param sphere defines the sphere to test
  84765. * @returns true if there is an intersection
  84766. */
  84767. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  84768. /**
  84769. * Tests if the bounding box intersects with a box defined by a min and max vectors
  84770. * @param min defines the min vector to use
  84771. * @param max defines the max vector to use
  84772. * @returns true if there is an intersection
  84773. */
  84774. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  84775. /**
  84776. * Tests if two bounding boxes are intersections
  84777. * @param box0 defines the first box to test
  84778. * @param box1 defines the second box to test
  84779. * @returns true if there is an intersection
  84780. */
  84781. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  84782. /**
  84783. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  84784. * @param minPoint defines the minimum vector of the bounding box
  84785. * @param maxPoint defines the maximum vector of the bounding box
  84786. * @param sphereCenter defines the sphere center
  84787. * @param sphereRadius defines the sphere radius
  84788. * @returns true if there is an intersection
  84789. */
  84790. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  84791. /**
  84792. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  84793. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  84794. * @param frustumPlanes defines the frustum planes to test
  84795. * @return true if there is an inclusion
  84796. */
  84797. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  84798. /**
  84799. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  84800. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  84801. * @param frustumPlanes defines the frustum planes to test
  84802. * @return true if there is an intersection
  84803. */
  84804. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  84805. }
  84806. }
  84807. declare module BABYLON {
  84808. /** @hidden */
  84809. export class Collider {
  84810. /** Define if a collision was found */
  84811. collisionFound: boolean;
  84812. /**
  84813. * Define last intersection point in local space
  84814. */
  84815. intersectionPoint: Vector3;
  84816. /**
  84817. * Define last collided mesh
  84818. */
  84819. collidedMesh: Nullable<AbstractMesh>;
  84820. private _collisionPoint;
  84821. private _planeIntersectionPoint;
  84822. private _tempVector;
  84823. private _tempVector2;
  84824. private _tempVector3;
  84825. private _tempVector4;
  84826. private _edge;
  84827. private _baseToVertex;
  84828. private _destinationPoint;
  84829. private _slidePlaneNormal;
  84830. private _displacementVector;
  84831. /** @hidden */
  84832. _radius: Vector3;
  84833. /** @hidden */
  84834. _retry: number;
  84835. private _velocity;
  84836. private _basePoint;
  84837. private _epsilon;
  84838. /** @hidden */
  84839. _velocityWorldLength: number;
  84840. /** @hidden */
  84841. _basePointWorld: Vector3;
  84842. private _velocityWorld;
  84843. private _normalizedVelocity;
  84844. /** @hidden */
  84845. _initialVelocity: Vector3;
  84846. /** @hidden */
  84847. _initialPosition: Vector3;
  84848. private _nearestDistance;
  84849. private _collisionMask;
  84850. get collisionMask(): number;
  84851. set collisionMask(mask: number);
  84852. /**
  84853. * Gets the plane normal used to compute the sliding response (in local space)
  84854. */
  84855. get slidePlaneNormal(): Vector3;
  84856. /** @hidden */
  84857. _initialize(source: Vector3, dir: Vector3, e: number): void;
  84858. /** @hidden */
  84859. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  84860. /** @hidden */
  84861. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  84862. /** @hidden */
  84863. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  84864. /** @hidden */
  84865. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  84866. /** @hidden */
  84867. _getResponse(pos: Vector3, vel: Vector3): void;
  84868. }
  84869. }
  84870. declare module BABYLON {
  84871. /**
  84872. * Interface for cullable objects
  84873. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  84874. */
  84875. export interface ICullable {
  84876. /**
  84877. * Checks if the object or part of the object is in the frustum
  84878. * @param frustumPlanes Camera near/planes
  84879. * @returns true if the object is in frustum otherwise false
  84880. */
  84881. isInFrustum(frustumPlanes: Plane[]): boolean;
  84882. /**
  84883. * Checks if a cullable object (mesh...) is in the camera frustum
  84884. * Unlike isInFrustum this cheks the full bounding box
  84885. * @param frustumPlanes Camera near/planes
  84886. * @returns true if the object is in frustum otherwise false
  84887. */
  84888. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  84889. }
  84890. /**
  84891. * Info for a bounding data of a mesh
  84892. */
  84893. export class BoundingInfo implements ICullable {
  84894. /**
  84895. * Bounding box for the mesh
  84896. */
  84897. readonly boundingBox: BoundingBox;
  84898. /**
  84899. * Bounding sphere for the mesh
  84900. */
  84901. readonly boundingSphere: BoundingSphere;
  84902. private _isLocked;
  84903. private static readonly TmpVector3;
  84904. /**
  84905. * Constructs bounding info
  84906. * @param minimum min vector of the bounding box/sphere
  84907. * @param maximum max vector of the bounding box/sphere
  84908. * @param worldMatrix defines the new world matrix
  84909. */
  84910. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  84911. /**
  84912. * Recreates the entire bounding info from scratch as if we call the constructor in place
  84913. * @param min defines the new minimum vector (in local space)
  84914. * @param max defines the new maximum vector (in local space)
  84915. * @param worldMatrix defines the new world matrix
  84916. */
  84917. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  84918. /**
  84919. * min vector of the bounding box/sphere
  84920. */
  84921. get minimum(): Vector3;
  84922. /**
  84923. * max vector of the bounding box/sphere
  84924. */
  84925. get maximum(): Vector3;
  84926. /**
  84927. * If the info is locked and won't be updated to avoid perf overhead
  84928. */
  84929. get isLocked(): boolean;
  84930. set isLocked(value: boolean);
  84931. /**
  84932. * Updates the bounding sphere and box
  84933. * @param world world matrix to be used to update
  84934. */
  84935. update(world: DeepImmutable<Matrix>): void;
  84936. /**
  84937. * Recreate the bounding info to be centered around a specific point given a specific extend.
  84938. * @param center New center of the bounding info
  84939. * @param extend New extend of the bounding info
  84940. * @returns the current bounding info
  84941. */
  84942. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  84943. /**
  84944. * Scale the current bounding info by applying a scale factor
  84945. * @param factor defines the scale factor to apply
  84946. * @returns the current bounding info
  84947. */
  84948. scale(factor: number): BoundingInfo;
  84949. /**
  84950. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  84951. * @param frustumPlanes defines the frustum to test
  84952. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  84953. * @returns true if the bounding info is in the frustum planes
  84954. */
  84955. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  84956. /**
  84957. * Gets the world distance between the min and max points of the bounding box
  84958. */
  84959. get diagonalLength(): number;
  84960. /**
  84961. * Checks if a cullable object (mesh...) is in the camera frustum
  84962. * Unlike isInFrustum this cheks the full bounding box
  84963. * @param frustumPlanes Camera near/planes
  84964. * @returns true if the object is in frustum otherwise false
  84965. */
  84966. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  84967. /** @hidden */
  84968. _checkCollision(collider: Collider): boolean;
  84969. /**
  84970. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  84971. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  84972. * @param point the point to check intersection with
  84973. * @returns if the point intersects
  84974. */
  84975. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  84976. /**
  84977. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  84978. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  84979. * @param boundingInfo the bounding info to check intersection with
  84980. * @param precise if the intersection should be done using OBB
  84981. * @returns if the bounding info intersects
  84982. */
  84983. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  84984. }
  84985. }
  84986. declare module BABYLON {
  84987. /**
  84988. * Extracts minimum and maximum values from a list of indexed positions
  84989. * @param positions defines the positions to use
  84990. * @param indices defines the indices to the positions
  84991. * @param indexStart defines the start index
  84992. * @param indexCount defines the end index
  84993. * @param bias defines bias value to add to the result
  84994. * @return minimum and maximum values
  84995. */
  84996. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  84997. minimum: Vector3;
  84998. maximum: Vector3;
  84999. };
  85000. /**
  85001. * Extracts minimum and maximum values from a list of positions
  85002. * @param positions defines the positions to use
  85003. * @param start defines the start index in the positions array
  85004. * @param count defines the number of positions to handle
  85005. * @param bias defines bias value to add to the result
  85006. * @param stride defines the stride size to use (distance between two positions in the positions array)
  85007. * @return minimum and maximum values
  85008. */
  85009. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  85010. minimum: Vector3;
  85011. maximum: Vector3;
  85012. };
  85013. }
  85014. declare module BABYLON {
  85015. /** @hidden */
  85016. export class WebGLDataBuffer extends DataBuffer {
  85017. private _buffer;
  85018. constructor(resource: WebGLBuffer);
  85019. get underlyingResource(): any;
  85020. }
  85021. }
  85022. declare module BABYLON {
  85023. /** @hidden */
  85024. export class WebGLPipelineContext implements IPipelineContext {
  85025. engine: ThinEngine;
  85026. program: Nullable<WebGLProgram>;
  85027. context?: WebGLRenderingContext;
  85028. vertexShader?: WebGLShader;
  85029. fragmentShader?: WebGLShader;
  85030. isParallelCompiled: boolean;
  85031. onCompiled?: () => void;
  85032. transformFeedback?: WebGLTransformFeedback | null;
  85033. vertexCompilationError: Nullable<string>;
  85034. fragmentCompilationError: Nullable<string>;
  85035. programLinkError: Nullable<string>;
  85036. programValidationError: Nullable<string>;
  85037. get isAsync(): boolean;
  85038. get isReady(): boolean;
  85039. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  85040. _getVertexShaderCode(): string | null;
  85041. _getFragmentShaderCode(): string | null;
  85042. }
  85043. }
  85044. declare module BABYLON {
  85045. interface ThinEngine {
  85046. /**
  85047. * Create an uniform buffer
  85048. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  85049. * @param elements defines the content of the uniform buffer
  85050. * @returns the webGL uniform buffer
  85051. */
  85052. createUniformBuffer(elements: FloatArray): DataBuffer;
  85053. /**
  85054. * Create a dynamic uniform buffer
  85055. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  85056. * @param elements defines the content of the uniform buffer
  85057. * @returns the webGL uniform buffer
  85058. */
  85059. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  85060. /**
  85061. * Update an existing uniform buffer
  85062. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  85063. * @param uniformBuffer defines the target uniform buffer
  85064. * @param elements defines the content to update
  85065. * @param offset defines the offset in the uniform buffer where update should start
  85066. * @param count defines the size of the data to update
  85067. */
  85068. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  85069. /**
  85070. * Bind an uniform buffer to the current webGL context
  85071. * @param buffer defines the buffer to bind
  85072. */
  85073. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  85074. /**
  85075. * Bind a buffer to the current webGL context at a given location
  85076. * @param buffer defines the buffer to bind
  85077. * @param location defines the index where to bind the buffer
  85078. */
  85079. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  85080. /**
  85081. * Bind a specific block at a given index in a specific shader program
  85082. * @param pipelineContext defines the pipeline context to use
  85083. * @param blockName defines the block name
  85084. * @param index defines the index where to bind the block
  85085. */
  85086. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  85087. }
  85088. }
  85089. declare module BABYLON {
  85090. /**
  85091. * Uniform buffer objects.
  85092. *
  85093. * Handles blocks of uniform on the GPU.
  85094. *
  85095. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  85096. *
  85097. * For more information, please refer to :
  85098. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  85099. */
  85100. export class UniformBuffer {
  85101. private _engine;
  85102. private _buffer;
  85103. private _data;
  85104. private _bufferData;
  85105. private _dynamic?;
  85106. private _uniformLocations;
  85107. private _uniformSizes;
  85108. private _uniformLocationPointer;
  85109. private _needSync;
  85110. private _noUBO;
  85111. private _currentEffect;
  85112. /** @hidden */
  85113. _alreadyBound: boolean;
  85114. private static _MAX_UNIFORM_SIZE;
  85115. private static _tempBuffer;
  85116. /**
  85117. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  85118. * This is dynamic to allow compat with webgl 1 and 2.
  85119. * You will need to pass the name of the uniform as well as the value.
  85120. */
  85121. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  85122. /**
  85123. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  85124. * This is dynamic to allow compat with webgl 1 and 2.
  85125. * You will need to pass the name of the uniform as well as the value.
  85126. */
  85127. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  85128. /**
  85129. * Lambda to Update a single float in a uniform buffer.
  85130. * This is dynamic to allow compat with webgl 1 and 2.
  85131. * You will need to pass the name of the uniform as well as the value.
  85132. */
  85133. updateFloat: (name: string, x: number) => void;
  85134. /**
  85135. * Lambda to Update a vec2 of float in a uniform buffer.
  85136. * This is dynamic to allow compat with webgl 1 and 2.
  85137. * You will need to pass the name of the uniform as well as the value.
  85138. */
  85139. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  85140. /**
  85141. * Lambda to Update a vec3 of float in a uniform buffer.
  85142. * This is dynamic to allow compat with webgl 1 and 2.
  85143. * You will need to pass the name of the uniform as well as the value.
  85144. */
  85145. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  85146. /**
  85147. * Lambda to Update a vec4 of float in a uniform buffer.
  85148. * This is dynamic to allow compat with webgl 1 and 2.
  85149. * You will need to pass the name of the uniform as well as the value.
  85150. */
  85151. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  85152. /**
  85153. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  85154. * This is dynamic to allow compat with webgl 1 and 2.
  85155. * You will need to pass the name of the uniform as well as the value.
  85156. */
  85157. updateMatrix: (name: string, mat: Matrix) => void;
  85158. /**
  85159. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  85160. * This is dynamic to allow compat with webgl 1 and 2.
  85161. * You will need to pass the name of the uniform as well as the value.
  85162. */
  85163. updateVector3: (name: string, vector: Vector3) => void;
  85164. /**
  85165. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  85166. * This is dynamic to allow compat with webgl 1 and 2.
  85167. * You will need to pass the name of the uniform as well as the value.
  85168. */
  85169. updateVector4: (name: string, vector: Vector4) => void;
  85170. /**
  85171. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  85172. * This is dynamic to allow compat with webgl 1 and 2.
  85173. * You will need to pass the name of the uniform as well as the value.
  85174. */
  85175. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  85176. /**
  85177. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  85178. * This is dynamic to allow compat with webgl 1 and 2.
  85179. * You will need to pass the name of the uniform as well as the value.
  85180. */
  85181. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  85182. /**
  85183. * Instantiates a new Uniform buffer objects.
  85184. *
  85185. * Handles blocks of uniform on the GPU.
  85186. *
  85187. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  85188. *
  85189. * For more information, please refer to :
  85190. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  85191. * @param engine Define the engine the buffer is associated with
  85192. * @param data Define the data contained in the buffer
  85193. * @param dynamic Define if the buffer is updatable
  85194. */
  85195. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  85196. /**
  85197. * Indicates if the buffer is using the WebGL2 UBO implementation,
  85198. * or just falling back on setUniformXXX calls.
  85199. */
  85200. get useUbo(): boolean;
  85201. /**
  85202. * Indicates if the WebGL underlying uniform buffer is in sync
  85203. * with the javascript cache data.
  85204. */
  85205. get isSync(): boolean;
  85206. /**
  85207. * Indicates if the WebGL underlying uniform buffer is dynamic.
  85208. * Also, a dynamic UniformBuffer will disable cache verification and always
  85209. * update the underlying WebGL uniform buffer to the GPU.
  85210. * @returns if Dynamic, otherwise false
  85211. */
  85212. isDynamic(): boolean;
  85213. /**
  85214. * The data cache on JS side.
  85215. * @returns the underlying data as a float array
  85216. */
  85217. getData(): Float32Array;
  85218. /**
  85219. * The underlying WebGL Uniform buffer.
  85220. * @returns the webgl buffer
  85221. */
  85222. getBuffer(): Nullable<DataBuffer>;
  85223. /**
  85224. * std140 layout specifies how to align data within an UBO structure.
  85225. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  85226. * for specs.
  85227. */
  85228. private _fillAlignment;
  85229. /**
  85230. * Adds an uniform in the buffer.
  85231. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  85232. * for the layout to be correct !
  85233. * @param name Name of the uniform, as used in the uniform block in the shader.
  85234. * @param size Data size, or data directly.
  85235. */
  85236. addUniform(name: string, size: number | number[]): void;
  85237. /**
  85238. * Adds a Matrix 4x4 to the uniform buffer.
  85239. * @param name Name of the uniform, as used in the uniform block in the shader.
  85240. * @param mat A 4x4 matrix.
  85241. */
  85242. addMatrix(name: string, mat: Matrix): void;
  85243. /**
  85244. * Adds a vec2 to the uniform buffer.
  85245. * @param name Name of the uniform, as used in the uniform block in the shader.
  85246. * @param x Define the x component value of the vec2
  85247. * @param y Define the y component value of the vec2
  85248. */
  85249. addFloat2(name: string, x: number, y: number): void;
  85250. /**
  85251. * Adds a vec3 to the uniform buffer.
  85252. * @param name Name of the uniform, as used in the uniform block in the shader.
  85253. * @param x Define the x component value of the vec3
  85254. * @param y Define the y component value of the vec3
  85255. * @param z Define the z component value of the vec3
  85256. */
  85257. addFloat3(name: string, x: number, y: number, z: number): void;
  85258. /**
  85259. * Adds a vec3 to the uniform buffer.
  85260. * @param name Name of the uniform, as used in the uniform block in the shader.
  85261. * @param color Define the vec3 from a Color
  85262. */
  85263. addColor3(name: string, color: Color3): void;
  85264. /**
  85265. * Adds a vec4 to the uniform buffer.
  85266. * @param name Name of the uniform, as used in the uniform block in the shader.
  85267. * @param color Define the rgb components from a Color
  85268. * @param alpha Define the a component of the vec4
  85269. */
  85270. addColor4(name: string, color: Color3, alpha: number): void;
  85271. /**
  85272. * Adds a vec3 to the uniform buffer.
  85273. * @param name Name of the uniform, as used in the uniform block in the shader.
  85274. * @param vector Define the vec3 components from a Vector
  85275. */
  85276. addVector3(name: string, vector: Vector3): void;
  85277. /**
  85278. * Adds a Matrix 3x3 to the uniform buffer.
  85279. * @param name Name of the uniform, as used in the uniform block in the shader.
  85280. */
  85281. addMatrix3x3(name: string): void;
  85282. /**
  85283. * Adds a Matrix 2x2 to the uniform buffer.
  85284. * @param name Name of the uniform, as used in the uniform block in the shader.
  85285. */
  85286. addMatrix2x2(name: string): void;
  85287. /**
  85288. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  85289. */
  85290. create(): void;
  85291. /** @hidden */
  85292. _rebuild(): void;
  85293. /**
  85294. * Updates the WebGL Uniform Buffer on the GPU.
  85295. * If the `dynamic` flag is set to true, no cache comparison is done.
  85296. * Otherwise, the buffer will be updated only if the cache differs.
  85297. */
  85298. update(): void;
  85299. /**
  85300. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  85301. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  85302. * @param data Define the flattened data
  85303. * @param size Define the size of the data.
  85304. */
  85305. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  85306. private _valueCache;
  85307. private _cacheMatrix;
  85308. private _updateMatrix3x3ForUniform;
  85309. private _updateMatrix3x3ForEffect;
  85310. private _updateMatrix2x2ForEffect;
  85311. private _updateMatrix2x2ForUniform;
  85312. private _updateFloatForEffect;
  85313. private _updateFloatForUniform;
  85314. private _updateFloat2ForEffect;
  85315. private _updateFloat2ForUniform;
  85316. private _updateFloat3ForEffect;
  85317. private _updateFloat3ForUniform;
  85318. private _updateFloat4ForEffect;
  85319. private _updateFloat4ForUniform;
  85320. private _updateMatrixForEffect;
  85321. private _updateMatrixForUniform;
  85322. private _updateVector3ForEffect;
  85323. private _updateVector3ForUniform;
  85324. private _updateVector4ForEffect;
  85325. private _updateVector4ForUniform;
  85326. private _updateColor3ForEffect;
  85327. private _updateColor3ForUniform;
  85328. private _updateColor4ForEffect;
  85329. private _updateColor4ForUniform;
  85330. /**
  85331. * Sets a sampler uniform on the effect.
  85332. * @param name Define the name of the sampler.
  85333. * @param texture Define the texture to set in the sampler
  85334. */
  85335. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  85336. /**
  85337. * Directly updates the value of the uniform in the cache AND on the GPU.
  85338. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  85339. * @param data Define the flattened data
  85340. */
  85341. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  85342. /**
  85343. * Binds this uniform buffer to an effect.
  85344. * @param effect Define the effect to bind the buffer to
  85345. * @param name Name of the uniform block in the shader.
  85346. */
  85347. bindToEffect(effect: Effect, name: string): void;
  85348. /**
  85349. * Disposes the uniform buffer.
  85350. */
  85351. dispose(): void;
  85352. }
  85353. }
  85354. declare module BABYLON {
  85355. /**
  85356. * Enum that determines the text-wrapping mode to use.
  85357. */
  85358. export enum InspectableType {
  85359. /**
  85360. * Checkbox for booleans
  85361. */
  85362. Checkbox = 0,
  85363. /**
  85364. * Sliders for numbers
  85365. */
  85366. Slider = 1,
  85367. /**
  85368. * Vector3
  85369. */
  85370. Vector3 = 2,
  85371. /**
  85372. * Quaternions
  85373. */
  85374. Quaternion = 3,
  85375. /**
  85376. * Color3
  85377. */
  85378. Color3 = 4,
  85379. /**
  85380. * String
  85381. */
  85382. String = 5
  85383. }
  85384. /**
  85385. * Interface used to define custom inspectable properties.
  85386. * This interface is used by the inspector to display custom property grids
  85387. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  85388. */
  85389. export interface IInspectable {
  85390. /**
  85391. * Gets the label to display
  85392. */
  85393. label: string;
  85394. /**
  85395. * Gets the name of the property to edit
  85396. */
  85397. propertyName: string;
  85398. /**
  85399. * Gets the type of the editor to use
  85400. */
  85401. type: InspectableType;
  85402. /**
  85403. * Gets the minimum value of the property when using in "slider" mode
  85404. */
  85405. min?: number;
  85406. /**
  85407. * Gets the maximum value of the property when using in "slider" mode
  85408. */
  85409. max?: number;
  85410. /**
  85411. * Gets the setp to use when using in "slider" mode
  85412. */
  85413. step?: number;
  85414. }
  85415. }
  85416. declare module BABYLON {
  85417. /**
  85418. * Class used to provide helper for timing
  85419. */
  85420. export class TimingTools {
  85421. /**
  85422. * Polyfill for setImmediate
  85423. * @param action defines the action to execute after the current execution block
  85424. */
  85425. static SetImmediate(action: () => void): void;
  85426. }
  85427. }
  85428. declare module BABYLON {
  85429. /**
  85430. * Class used to enable instatition of objects by class name
  85431. */
  85432. export class InstantiationTools {
  85433. /**
  85434. * Use this object to register external classes like custom textures or material
  85435. * to allow the laoders to instantiate them
  85436. */
  85437. static RegisteredExternalClasses: {
  85438. [key: string]: Object;
  85439. };
  85440. /**
  85441. * Tries to instantiate a new object from a given class name
  85442. * @param className defines the class name to instantiate
  85443. * @returns the new object or null if the system was not able to do the instantiation
  85444. */
  85445. static Instantiate(className: string): any;
  85446. }
  85447. }
  85448. declare module BABYLON {
  85449. /**
  85450. * Define options used to create a depth texture
  85451. */
  85452. export class DepthTextureCreationOptions {
  85453. /** Specifies whether or not a stencil should be allocated in the texture */
  85454. generateStencil?: boolean;
  85455. /** Specifies whether or not bilinear filtering is enable on the texture */
  85456. bilinearFiltering?: boolean;
  85457. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  85458. comparisonFunction?: number;
  85459. /** Specifies if the created texture is a cube texture */
  85460. isCube?: boolean;
  85461. }
  85462. }
  85463. declare module BABYLON {
  85464. interface ThinEngine {
  85465. /**
  85466. * Creates a depth stencil cube texture.
  85467. * This is only available in WebGL 2.
  85468. * @param size The size of face edge in the cube texture.
  85469. * @param options The options defining the cube texture.
  85470. * @returns The cube texture
  85471. */
  85472. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  85473. /**
  85474. * Creates a cube texture
  85475. * @param rootUrl defines the url where the files to load is located
  85476. * @param scene defines the current scene
  85477. * @param files defines the list of files to load (1 per face)
  85478. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  85479. * @param onLoad defines an optional callback raised when the texture is loaded
  85480. * @param onError defines an optional callback raised if there is an issue to load the texture
  85481. * @param format defines the format of the data
  85482. * @param forcedExtension defines the extension to use to pick the right loader
  85483. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  85484. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  85485. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  85486. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  85487. * @returns the cube texture as an InternalTexture
  85488. */
  85489. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>): InternalTexture;
  85490. /**
  85491. * Creates a cube texture
  85492. * @param rootUrl defines the url where the files to load is located
  85493. * @param scene defines the current scene
  85494. * @param files defines the list of files to load (1 per face)
  85495. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  85496. * @param onLoad defines an optional callback raised when the texture is loaded
  85497. * @param onError defines an optional callback raised if there is an issue to load the texture
  85498. * @param format defines the format of the data
  85499. * @param forcedExtension defines the extension to use to pick the right loader
  85500. * @returns the cube texture as an InternalTexture
  85501. */
  85502. 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;
  85503. /**
  85504. * Creates a cube texture
  85505. * @param rootUrl defines the url where the files to load is located
  85506. * @param scene defines the current scene
  85507. * @param files defines the list of files to load (1 per face)
  85508. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  85509. * @param onLoad defines an optional callback raised when the texture is loaded
  85510. * @param onError defines an optional callback raised if there is an issue to load the texture
  85511. * @param format defines the format of the data
  85512. * @param forcedExtension defines the extension to use to pick the right loader
  85513. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  85514. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  85515. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  85516. * @returns the cube texture as an InternalTexture
  85517. */
  85518. 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;
  85519. /** @hidden */
  85520. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  85521. /** @hidden */
  85522. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  85523. /** @hidden */
  85524. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  85525. /** @hidden */
  85526. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  85527. /**
  85528. * @hidden
  85529. */
  85530. _setCubeMapTextureParams(loadMipmap: boolean): void;
  85531. }
  85532. }
  85533. declare module BABYLON {
  85534. /**
  85535. * Class for creating a cube texture
  85536. */
  85537. export class CubeTexture extends BaseTexture {
  85538. private _delayedOnLoad;
  85539. /**
  85540. * Observable triggered once the texture has been loaded.
  85541. */
  85542. onLoadObservable: Observable<CubeTexture>;
  85543. /**
  85544. * The url of the texture
  85545. */
  85546. url: string;
  85547. /**
  85548. * Gets or sets the center of the bounding box associated with the cube texture.
  85549. * It must define where the camera used to render the texture was set
  85550. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  85551. */
  85552. boundingBoxPosition: Vector3;
  85553. private _boundingBoxSize;
  85554. /**
  85555. * Gets or sets the size of the bounding box associated with the cube texture
  85556. * When defined, the cubemap will switch to local mode
  85557. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  85558. * @example https://www.babylonjs-playground.com/#RNASML
  85559. */
  85560. set boundingBoxSize(value: Vector3);
  85561. /**
  85562. * Returns the bounding box size
  85563. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  85564. */
  85565. get boundingBoxSize(): Vector3;
  85566. protected _rotationY: number;
  85567. /**
  85568. * Sets texture matrix rotation angle around Y axis in radians.
  85569. */
  85570. set rotationY(value: number);
  85571. /**
  85572. * Gets texture matrix rotation angle around Y axis radians.
  85573. */
  85574. get rotationY(): number;
  85575. /**
  85576. * Are mip maps generated for this texture or not.
  85577. */
  85578. get noMipmap(): boolean;
  85579. private _noMipmap;
  85580. private _files;
  85581. protected _forcedExtension: Nullable<string>;
  85582. private _extensions;
  85583. private _textureMatrix;
  85584. private _format;
  85585. private _createPolynomials;
  85586. /**
  85587. * Creates a cube texture from an array of image urls
  85588. * @param files defines an array of image urls
  85589. * @param scene defines the hosting scene
  85590. * @param noMipmap specifies if mip maps are not used
  85591. * @returns a cube texture
  85592. */
  85593. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  85594. /**
  85595. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  85596. * @param url defines the url of the prefiltered texture
  85597. * @param scene defines the scene the texture is attached to
  85598. * @param forcedExtension defines the extension of the file if different from the url
  85599. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  85600. * @return the prefiltered texture
  85601. */
  85602. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  85603. /**
  85604. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  85605. * as prefiltered data.
  85606. * @param rootUrl defines the url of the texture or the root name of the six images
  85607. * @param null defines the scene or engine the texture is attached to
  85608. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  85609. * @param noMipmap defines if mipmaps should be created or not
  85610. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  85611. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  85612. * @param onError defines a callback triggered in case of error during load
  85613. * @param format defines the internal format to use for the texture once loaded
  85614. * @param prefiltered defines whether or not the texture is created from prefiltered data
  85615. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  85616. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  85617. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  85618. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  85619. * @return the cube texture
  85620. */
  85621. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  85622. /**
  85623. * Get the current class name of the texture useful for serialization or dynamic coding.
  85624. * @returns "CubeTexture"
  85625. */
  85626. getClassName(): string;
  85627. /**
  85628. * Update the url (and optional buffer) of this texture if url was null during construction.
  85629. * @param url the url of the texture
  85630. * @param forcedExtension defines the extension to use
  85631. * @param onLoad callback called when the texture is loaded (defaults to null)
  85632. * @param prefiltered Defines whether the updated texture is prefiltered or not
  85633. */
  85634. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  85635. /**
  85636. * Delays loading of the cube texture
  85637. * @param forcedExtension defines the extension to use
  85638. */
  85639. delayLoad(forcedExtension?: string): void;
  85640. /**
  85641. * Returns the reflection texture matrix
  85642. * @returns the reflection texture matrix
  85643. */
  85644. getReflectionTextureMatrix(): Matrix;
  85645. /**
  85646. * Sets the reflection texture matrix
  85647. * @param value Reflection texture matrix
  85648. */
  85649. setReflectionTextureMatrix(value: Matrix): void;
  85650. /**
  85651. * Parses text to create a cube texture
  85652. * @param parsedTexture define the serialized text to read from
  85653. * @param scene defines the hosting scene
  85654. * @param rootUrl defines the root url of the cube texture
  85655. * @returns a cube texture
  85656. */
  85657. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  85658. /**
  85659. * Makes a clone, or deep copy, of the cube texture
  85660. * @returns a new cube texture
  85661. */
  85662. clone(): CubeTexture;
  85663. }
  85664. }
  85665. declare module BABYLON {
  85666. /**
  85667. * Manages the defines for the Material
  85668. */
  85669. export class MaterialDefines {
  85670. /** @hidden */
  85671. protected _keys: string[];
  85672. private _isDirty;
  85673. /** @hidden */
  85674. _renderId: number;
  85675. /** @hidden */
  85676. _areLightsDirty: boolean;
  85677. /** @hidden */
  85678. _areLightsDisposed: boolean;
  85679. /** @hidden */
  85680. _areAttributesDirty: boolean;
  85681. /** @hidden */
  85682. _areTexturesDirty: boolean;
  85683. /** @hidden */
  85684. _areFresnelDirty: boolean;
  85685. /** @hidden */
  85686. _areMiscDirty: boolean;
  85687. /** @hidden */
  85688. _areImageProcessingDirty: boolean;
  85689. /** @hidden */
  85690. _normals: boolean;
  85691. /** @hidden */
  85692. _uvs: boolean;
  85693. /** @hidden */
  85694. _needNormals: boolean;
  85695. /** @hidden */
  85696. _needUVs: boolean;
  85697. [id: string]: any;
  85698. /**
  85699. * Specifies if the material needs to be re-calculated
  85700. */
  85701. get isDirty(): boolean;
  85702. /**
  85703. * Marks the material to indicate that it has been re-calculated
  85704. */
  85705. markAsProcessed(): void;
  85706. /**
  85707. * Marks the material to indicate that it needs to be re-calculated
  85708. */
  85709. markAsUnprocessed(): void;
  85710. /**
  85711. * Marks the material to indicate all of its defines need to be re-calculated
  85712. */
  85713. markAllAsDirty(): void;
  85714. /**
  85715. * Marks the material to indicate that image processing needs to be re-calculated
  85716. */
  85717. markAsImageProcessingDirty(): void;
  85718. /**
  85719. * Marks the material to indicate the lights need to be re-calculated
  85720. * @param disposed Defines whether the light is dirty due to dispose or not
  85721. */
  85722. markAsLightDirty(disposed?: boolean): void;
  85723. /**
  85724. * Marks the attribute state as changed
  85725. */
  85726. markAsAttributesDirty(): void;
  85727. /**
  85728. * Marks the texture state as changed
  85729. */
  85730. markAsTexturesDirty(): void;
  85731. /**
  85732. * Marks the fresnel state as changed
  85733. */
  85734. markAsFresnelDirty(): void;
  85735. /**
  85736. * Marks the misc state as changed
  85737. */
  85738. markAsMiscDirty(): void;
  85739. /**
  85740. * Rebuilds the material defines
  85741. */
  85742. rebuild(): void;
  85743. /**
  85744. * Specifies if two material defines are equal
  85745. * @param other - A material define instance to compare to
  85746. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  85747. */
  85748. isEqual(other: MaterialDefines): boolean;
  85749. /**
  85750. * Clones this instance's defines to another instance
  85751. * @param other - material defines to clone values to
  85752. */
  85753. cloneTo(other: MaterialDefines): void;
  85754. /**
  85755. * Resets the material define values
  85756. */
  85757. reset(): void;
  85758. /**
  85759. * Converts the material define values to a string
  85760. * @returns - String of material define information
  85761. */
  85762. toString(): string;
  85763. }
  85764. }
  85765. declare module BABYLON {
  85766. /**
  85767. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  85768. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  85769. * 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;
  85770. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  85771. */
  85772. export class ColorCurves {
  85773. private _dirty;
  85774. private _tempColor;
  85775. private _globalCurve;
  85776. private _highlightsCurve;
  85777. private _midtonesCurve;
  85778. private _shadowsCurve;
  85779. private _positiveCurve;
  85780. private _negativeCurve;
  85781. private _globalHue;
  85782. private _globalDensity;
  85783. private _globalSaturation;
  85784. private _globalExposure;
  85785. /**
  85786. * Gets the global Hue value.
  85787. * 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).
  85788. */
  85789. get globalHue(): number;
  85790. /**
  85791. * Sets the global Hue value.
  85792. * 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).
  85793. */
  85794. set globalHue(value: number);
  85795. /**
  85796. * Gets the global Density value.
  85797. * 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.
  85798. * Values less than zero provide a filter of opposite hue.
  85799. */
  85800. get globalDensity(): number;
  85801. /**
  85802. * Sets the global Density value.
  85803. * 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.
  85804. * Values less than zero provide a filter of opposite hue.
  85805. */
  85806. set globalDensity(value: number);
  85807. /**
  85808. * Gets the global Saturation value.
  85809. * 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.
  85810. */
  85811. get globalSaturation(): number;
  85812. /**
  85813. * Sets the global Saturation value.
  85814. * 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.
  85815. */
  85816. set globalSaturation(value: number);
  85817. /**
  85818. * Gets the global Exposure value.
  85819. * 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.
  85820. */
  85821. get globalExposure(): number;
  85822. /**
  85823. * Sets the global Exposure value.
  85824. * 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.
  85825. */
  85826. set globalExposure(value: number);
  85827. private _highlightsHue;
  85828. private _highlightsDensity;
  85829. private _highlightsSaturation;
  85830. private _highlightsExposure;
  85831. /**
  85832. * Gets the highlights Hue value.
  85833. * 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).
  85834. */
  85835. get highlightsHue(): number;
  85836. /**
  85837. * Sets the highlights Hue value.
  85838. * 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).
  85839. */
  85840. set highlightsHue(value: number);
  85841. /**
  85842. * Gets the highlights Density value.
  85843. * 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.
  85844. * Values less than zero provide a filter of opposite hue.
  85845. */
  85846. get highlightsDensity(): number;
  85847. /**
  85848. * Sets the highlights Density value.
  85849. * 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.
  85850. * Values less than zero provide a filter of opposite hue.
  85851. */
  85852. set highlightsDensity(value: number);
  85853. /**
  85854. * Gets the highlights Saturation value.
  85855. * 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.
  85856. */
  85857. get highlightsSaturation(): number;
  85858. /**
  85859. * Sets the highlights Saturation value.
  85860. * 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.
  85861. */
  85862. set highlightsSaturation(value: number);
  85863. /**
  85864. * Gets the highlights Exposure value.
  85865. * 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.
  85866. */
  85867. get highlightsExposure(): number;
  85868. /**
  85869. * Sets the highlights Exposure value.
  85870. * 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.
  85871. */
  85872. set highlightsExposure(value: number);
  85873. private _midtonesHue;
  85874. private _midtonesDensity;
  85875. private _midtonesSaturation;
  85876. private _midtonesExposure;
  85877. /**
  85878. * Gets the midtones Hue value.
  85879. * 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).
  85880. */
  85881. get midtonesHue(): number;
  85882. /**
  85883. * Sets the midtones Hue value.
  85884. * 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).
  85885. */
  85886. set midtonesHue(value: number);
  85887. /**
  85888. * Gets the midtones Density value.
  85889. * 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.
  85890. * Values less than zero provide a filter of opposite hue.
  85891. */
  85892. get midtonesDensity(): number;
  85893. /**
  85894. * Sets the midtones Density value.
  85895. * 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.
  85896. * Values less than zero provide a filter of opposite hue.
  85897. */
  85898. set midtonesDensity(value: number);
  85899. /**
  85900. * Gets the midtones Saturation value.
  85901. * 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.
  85902. */
  85903. get midtonesSaturation(): number;
  85904. /**
  85905. * Sets the midtones Saturation value.
  85906. * 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.
  85907. */
  85908. set midtonesSaturation(value: number);
  85909. /**
  85910. * Gets the midtones Exposure value.
  85911. * 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.
  85912. */
  85913. get midtonesExposure(): number;
  85914. /**
  85915. * Sets the midtones Exposure value.
  85916. * 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.
  85917. */
  85918. set midtonesExposure(value: number);
  85919. private _shadowsHue;
  85920. private _shadowsDensity;
  85921. private _shadowsSaturation;
  85922. private _shadowsExposure;
  85923. /**
  85924. * Gets the shadows Hue value.
  85925. * 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).
  85926. */
  85927. get shadowsHue(): number;
  85928. /**
  85929. * Sets the shadows Hue value.
  85930. * 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).
  85931. */
  85932. set shadowsHue(value: number);
  85933. /**
  85934. * Gets the shadows Density value.
  85935. * 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.
  85936. * Values less than zero provide a filter of opposite hue.
  85937. */
  85938. get shadowsDensity(): number;
  85939. /**
  85940. * Sets the shadows Density value.
  85941. * 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.
  85942. * Values less than zero provide a filter of opposite hue.
  85943. */
  85944. set shadowsDensity(value: number);
  85945. /**
  85946. * Gets the shadows Saturation value.
  85947. * 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.
  85948. */
  85949. get shadowsSaturation(): number;
  85950. /**
  85951. * Sets the shadows Saturation value.
  85952. * 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.
  85953. */
  85954. set shadowsSaturation(value: number);
  85955. /**
  85956. * Gets the shadows Exposure value.
  85957. * 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.
  85958. */
  85959. get shadowsExposure(): number;
  85960. /**
  85961. * Sets the shadows Exposure value.
  85962. * 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.
  85963. */
  85964. set shadowsExposure(value: number);
  85965. /**
  85966. * Returns the class name
  85967. * @returns The class name
  85968. */
  85969. getClassName(): string;
  85970. /**
  85971. * Binds the color curves to the shader.
  85972. * @param colorCurves The color curve to bind
  85973. * @param effect The effect to bind to
  85974. * @param positiveUniform The positive uniform shader parameter
  85975. * @param neutralUniform The neutral uniform shader parameter
  85976. * @param negativeUniform The negative uniform shader parameter
  85977. */
  85978. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  85979. /**
  85980. * Prepare the list of uniforms associated with the ColorCurves effects.
  85981. * @param uniformsList The list of uniforms used in the effect
  85982. */
  85983. static PrepareUniforms(uniformsList: string[]): void;
  85984. /**
  85985. * Returns color grading data based on a hue, density, saturation and exposure value.
  85986. * @param filterHue The hue of the color filter.
  85987. * @param filterDensity The density of the color filter.
  85988. * @param saturation The saturation.
  85989. * @param exposure The exposure.
  85990. * @param result The result data container.
  85991. */
  85992. private getColorGradingDataToRef;
  85993. /**
  85994. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  85995. * @param value The input slider value in range [-100,100].
  85996. * @returns Adjusted value.
  85997. */
  85998. private static applyColorGradingSliderNonlinear;
  85999. /**
  86000. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  86001. * @param hue The hue (H) input.
  86002. * @param saturation The saturation (S) input.
  86003. * @param brightness The brightness (B) input.
  86004. * @result An RGBA color represented as Vector4.
  86005. */
  86006. private static fromHSBToRef;
  86007. /**
  86008. * Returns a value clamped between min and max
  86009. * @param value The value to clamp
  86010. * @param min The minimum of value
  86011. * @param max The maximum of value
  86012. * @returns The clamped value.
  86013. */
  86014. private static clamp;
  86015. /**
  86016. * Clones the current color curve instance.
  86017. * @return The cloned curves
  86018. */
  86019. clone(): ColorCurves;
  86020. /**
  86021. * Serializes the current color curve instance to a json representation.
  86022. * @return a JSON representation
  86023. */
  86024. serialize(): any;
  86025. /**
  86026. * Parses the color curve from a json representation.
  86027. * @param source the JSON source to parse
  86028. * @return The parsed curves
  86029. */
  86030. static Parse(source: any): ColorCurves;
  86031. }
  86032. }
  86033. declare module BABYLON {
  86034. /**
  86035. * Interface to follow in your material defines to integrate easily the
  86036. * Image proccessing functions.
  86037. * @hidden
  86038. */
  86039. export interface IImageProcessingConfigurationDefines {
  86040. IMAGEPROCESSING: boolean;
  86041. VIGNETTE: boolean;
  86042. VIGNETTEBLENDMODEMULTIPLY: boolean;
  86043. VIGNETTEBLENDMODEOPAQUE: boolean;
  86044. TONEMAPPING: boolean;
  86045. TONEMAPPING_ACES: boolean;
  86046. CONTRAST: boolean;
  86047. EXPOSURE: boolean;
  86048. COLORCURVES: boolean;
  86049. COLORGRADING: boolean;
  86050. COLORGRADING3D: boolean;
  86051. SAMPLER3DGREENDEPTH: boolean;
  86052. SAMPLER3DBGRMAP: boolean;
  86053. IMAGEPROCESSINGPOSTPROCESS: boolean;
  86054. }
  86055. /**
  86056. * @hidden
  86057. */
  86058. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  86059. IMAGEPROCESSING: boolean;
  86060. VIGNETTE: boolean;
  86061. VIGNETTEBLENDMODEMULTIPLY: boolean;
  86062. VIGNETTEBLENDMODEOPAQUE: boolean;
  86063. TONEMAPPING: boolean;
  86064. TONEMAPPING_ACES: boolean;
  86065. CONTRAST: boolean;
  86066. COLORCURVES: boolean;
  86067. COLORGRADING: boolean;
  86068. COLORGRADING3D: boolean;
  86069. SAMPLER3DGREENDEPTH: boolean;
  86070. SAMPLER3DBGRMAP: boolean;
  86071. IMAGEPROCESSINGPOSTPROCESS: boolean;
  86072. EXPOSURE: boolean;
  86073. constructor();
  86074. }
  86075. /**
  86076. * This groups together the common properties used for image processing either in direct forward pass
  86077. * or through post processing effect depending on the use of the image processing pipeline in your scene
  86078. * or not.
  86079. */
  86080. export class ImageProcessingConfiguration {
  86081. /**
  86082. * Default tone mapping applied in BabylonJS.
  86083. */
  86084. static readonly TONEMAPPING_STANDARD: number;
  86085. /**
  86086. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  86087. * to other engines rendering to increase portability.
  86088. */
  86089. static readonly TONEMAPPING_ACES: number;
  86090. /**
  86091. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  86092. */
  86093. colorCurves: Nullable<ColorCurves>;
  86094. private _colorCurvesEnabled;
  86095. /**
  86096. * Gets wether the color curves effect is enabled.
  86097. */
  86098. get colorCurvesEnabled(): boolean;
  86099. /**
  86100. * Sets wether the color curves effect is enabled.
  86101. */
  86102. set colorCurvesEnabled(value: boolean);
  86103. private _colorGradingTexture;
  86104. /**
  86105. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  86106. */
  86107. get colorGradingTexture(): Nullable<BaseTexture>;
  86108. /**
  86109. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  86110. */
  86111. set colorGradingTexture(value: Nullable<BaseTexture>);
  86112. private _colorGradingEnabled;
  86113. /**
  86114. * Gets wether the color grading effect is enabled.
  86115. */
  86116. get colorGradingEnabled(): boolean;
  86117. /**
  86118. * Sets wether the color grading effect is enabled.
  86119. */
  86120. set colorGradingEnabled(value: boolean);
  86121. private _colorGradingWithGreenDepth;
  86122. /**
  86123. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  86124. */
  86125. get colorGradingWithGreenDepth(): boolean;
  86126. /**
  86127. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  86128. */
  86129. set colorGradingWithGreenDepth(value: boolean);
  86130. private _colorGradingBGR;
  86131. /**
  86132. * Gets wether the color grading texture contains BGR values.
  86133. */
  86134. get colorGradingBGR(): boolean;
  86135. /**
  86136. * Sets wether the color grading texture contains BGR values.
  86137. */
  86138. set colorGradingBGR(value: boolean);
  86139. /** @hidden */
  86140. _exposure: number;
  86141. /**
  86142. * Gets the Exposure used in the effect.
  86143. */
  86144. get exposure(): number;
  86145. /**
  86146. * Sets the Exposure used in the effect.
  86147. */
  86148. set exposure(value: number);
  86149. private _toneMappingEnabled;
  86150. /**
  86151. * Gets wether the tone mapping effect is enabled.
  86152. */
  86153. get toneMappingEnabled(): boolean;
  86154. /**
  86155. * Sets wether the tone mapping effect is enabled.
  86156. */
  86157. set toneMappingEnabled(value: boolean);
  86158. private _toneMappingType;
  86159. /**
  86160. * Gets the type of tone mapping effect.
  86161. */
  86162. get toneMappingType(): number;
  86163. /**
  86164. * Sets the type of tone mapping effect used in BabylonJS.
  86165. */
  86166. set toneMappingType(value: number);
  86167. protected _contrast: number;
  86168. /**
  86169. * Gets the contrast used in the effect.
  86170. */
  86171. get contrast(): number;
  86172. /**
  86173. * Sets the contrast used in the effect.
  86174. */
  86175. set contrast(value: number);
  86176. /**
  86177. * Vignette stretch size.
  86178. */
  86179. vignetteStretch: number;
  86180. /**
  86181. * Vignette centre X Offset.
  86182. */
  86183. vignetteCentreX: number;
  86184. /**
  86185. * Vignette centre Y Offset.
  86186. */
  86187. vignetteCentreY: number;
  86188. /**
  86189. * Vignette weight or intensity of the vignette effect.
  86190. */
  86191. vignetteWeight: number;
  86192. /**
  86193. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  86194. * if vignetteEnabled is set to true.
  86195. */
  86196. vignetteColor: Color4;
  86197. /**
  86198. * Camera field of view used by the Vignette effect.
  86199. */
  86200. vignetteCameraFov: number;
  86201. private _vignetteBlendMode;
  86202. /**
  86203. * Gets the vignette blend mode allowing different kind of effect.
  86204. */
  86205. get vignetteBlendMode(): number;
  86206. /**
  86207. * Sets the vignette blend mode allowing different kind of effect.
  86208. */
  86209. set vignetteBlendMode(value: number);
  86210. private _vignetteEnabled;
  86211. /**
  86212. * Gets wether the vignette effect is enabled.
  86213. */
  86214. get vignetteEnabled(): boolean;
  86215. /**
  86216. * Sets wether the vignette effect is enabled.
  86217. */
  86218. set vignetteEnabled(value: boolean);
  86219. private _applyByPostProcess;
  86220. /**
  86221. * Gets wether the image processing is applied through a post process or not.
  86222. */
  86223. get applyByPostProcess(): boolean;
  86224. /**
  86225. * Sets wether the image processing is applied through a post process or not.
  86226. */
  86227. set applyByPostProcess(value: boolean);
  86228. private _isEnabled;
  86229. /**
  86230. * Gets wether the image processing is enabled or not.
  86231. */
  86232. get isEnabled(): boolean;
  86233. /**
  86234. * Sets wether the image processing is enabled or not.
  86235. */
  86236. set isEnabled(value: boolean);
  86237. /**
  86238. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  86239. */
  86240. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  86241. /**
  86242. * Method called each time the image processing information changes requires to recompile the effect.
  86243. */
  86244. protected _updateParameters(): void;
  86245. /**
  86246. * Gets the current class name.
  86247. * @return "ImageProcessingConfiguration"
  86248. */
  86249. getClassName(): string;
  86250. /**
  86251. * Prepare the list of uniforms associated with the Image Processing effects.
  86252. * @param uniforms The list of uniforms used in the effect
  86253. * @param defines the list of defines currently in use
  86254. */
  86255. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  86256. /**
  86257. * Prepare the list of samplers associated with the Image Processing effects.
  86258. * @param samplersList The list of uniforms used in the effect
  86259. * @param defines the list of defines currently in use
  86260. */
  86261. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  86262. /**
  86263. * Prepare the list of defines associated to the shader.
  86264. * @param defines the list of defines to complete
  86265. * @param forPostProcess Define if we are currently in post process mode or not
  86266. */
  86267. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  86268. /**
  86269. * Returns true if all the image processing information are ready.
  86270. * @returns True if ready, otherwise, false
  86271. */
  86272. isReady(): boolean;
  86273. /**
  86274. * Binds the image processing to the shader.
  86275. * @param effect The effect to bind to
  86276. * @param overrideAspectRatio Override the aspect ratio of the effect
  86277. */
  86278. bind(effect: Effect, overrideAspectRatio?: number): void;
  86279. /**
  86280. * Clones the current image processing instance.
  86281. * @return The cloned image processing
  86282. */
  86283. clone(): ImageProcessingConfiguration;
  86284. /**
  86285. * Serializes the current image processing instance to a json representation.
  86286. * @return a JSON representation
  86287. */
  86288. serialize(): any;
  86289. /**
  86290. * Parses the image processing from a json representation.
  86291. * @param source the JSON source to parse
  86292. * @return The parsed image processing
  86293. */
  86294. static Parse(source: any): ImageProcessingConfiguration;
  86295. private static _VIGNETTEMODE_MULTIPLY;
  86296. private static _VIGNETTEMODE_OPAQUE;
  86297. /**
  86298. * Used to apply the vignette as a mix with the pixel color.
  86299. */
  86300. static get VIGNETTEMODE_MULTIPLY(): number;
  86301. /**
  86302. * Used to apply the vignette as a replacement of the pixel color.
  86303. */
  86304. static get VIGNETTEMODE_OPAQUE(): number;
  86305. }
  86306. }
  86307. declare module BABYLON {
  86308. /** @hidden */
  86309. export var postprocessVertexShader: {
  86310. name: string;
  86311. shader: string;
  86312. };
  86313. }
  86314. declare module BABYLON {
  86315. interface ThinEngine {
  86316. /**
  86317. * Creates a new render target texture
  86318. * @param size defines the size of the texture
  86319. * @param options defines the options used to create the texture
  86320. * @returns a new render target texture stored in an InternalTexture
  86321. */
  86322. createRenderTargetTexture(size: number | {
  86323. width: number;
  86324. height: number;
  86325. layers?: number;
  86326. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  86327. /**
  86328. * Creates a depth stencil texture.
  86329. * This is only available in WebGL 2 or with the depth texture extension available.
  86330. * @param size The size of face edge in the texture.
  86331. * @param options The options defining the texture.
  86332. * @returns The texture
  86333. */
  86334. createDepthStencilTexture(size: number | {
  86335. width: number;
  86336. height: number;
  86337. layers?: number;
  86338. }, options: DepthTextureCreationOptions): InternalTexture;
  86339. /** @hidden */
  86340. _createDepthStencilTexture(size: number | {
  86341. width: number;
  86342. height: number;
  86343. layers?: number;
  86344. }, options: DepthTextureCreationOptions): InternalTexture;
  86345. }
  86346. }
  86347. declare module BABYLON {
  86348. /**
  86349. * Defines the kind of connection point for node based material
  86350. */
  86351. export enum NodeMaterialBlockConnectionPointTypes {
  86352. /** Float */
  86353. Float = 1,
  86354. /** Int */
  86355. Int = 2,
  86356. /** Vector2 */
  86357. Vector2 = 4,
  86358. /** Vector3 */
  86359. Vector3 = 8,
  86360. /** Vector4 */
  86361. Vector4 = 16,
  86362. /** Color3 */
  86363. Color3 = 32,
  86364. /** Color4 */
  86365. Color4 = 64,
  86366. /** Matrix */
  86367. Matrix = 128,
  86368. /** Custom object */
  86369. Object = 256,
  86370. /** Detect type based on connection */
  86371. AutoDetect = 1024,
  86372. /** Output type that will be defined by input type */
  86373. BasedOnInput = 2048
  86374. }
  86375. }
  86376. declare module BABYLON {
  86377. /**
  86378. * Enum used to define the target of a block
  86379. */
  86380. export enum NodeMaterialBlockTargets {
  86381. /** Vertex shader */
  86382. Vertex = 1,
  86383. /** Fragment shader */
  86384. Fragment = 2,
  86385. /** Neutral */
  86386. Neutral = 4,
  86387. /** Vertex and Fragment */
  86388. VertexAndFragment = 3
  86389. }
  86390. }
  86391. declare module BABYLON {
  86392. /**
  86393. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  86394. */
  86395. export enum NodeMaterialBlockConnectionPointMode {
  86396. /** Value is an uniform */
  86397. Uniform = 0,
  86398. /** Value is a mesh attribute */
  86399. Attribute = 1,
  86400. /** Value is a varying between vertex and fragment shaders */
  86401. Varying = 2,
  86402. /** Mode is undefined */
  86403. Undefined = 3
  86404. }
  86405. }
  86406. declare module BABYLON {
  86407. /**
  86408. * Enum used to define system values e.g. values automatically provided by the system
  86409. */
  86410. export enum NodeMaterialSystemValues {
  86411. /** World */
  86412. World = 1,
  86413. /** View */
  86414. View = 2,
  86415. /** Projection */
  86416. Projection = 3,
  86417. /** ViewProjection */
  86418. ViewProjection = 4,
  86419. /** WorldView */
  86420. WorldView = 5,
  86421. /** WorldViewProjection */
  86422. WorldViewProjection = 6,
  86423. /** CameraPosition */
  86424. CameraPosition = 7,
  86425. /** Fog Color */
  86426. FogColor = 8,
  86427. /** Delta time */
  86428. DeltaTime = 9
  86429. }
  86430. }
  86431. declare module BABYLON {
  86432. /** Defines supported spaces */
  86433. export enum Space {
  86434. /** Local (object) space */
  86435. LOCAL = 0,
  86436. /** World space */
  86437. WORLD = 1,
  86438. /** Bone space */
  86439. BONE = 2
  86440. }
  86441. /** Defines the 3 main axes */
  86442. export class Axis {
  86443. /** X axis */
  86444. static X: Vector3;
  86445. /** Y axis */
  86446. static Y: Vector3;
  86447. /** Z axis */
  86448. static Z: Vector3;
  86449. }
  86450. }
  86451. declare module BABYLON {
  86452. /**
  86453. * Represents a camera frustum
  86454. */
  86455. export class Frustum {
  86456. /**
  86457. * Gets the planes representing the frustum
  86458. * @param transform matrix to be applied to the returned planes
  86459. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  86460. */
  86461. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  86462. /**
  86463. * Gets the near frustum plane transformed by the transform matrix
  86464. * @param transform transformation matrix to be applied to the resulting frustum plane
  86465. * @param frustumPlane the resuling frustum plane
  86466. */
  86467. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  86468. /**
  86469. * Gets the far frustum plane transformed by the transform matrix
  86470. * @param transform transformation matrix to be applied to the resulting frustum plane
  86471. * @param frustumPlane the resuling frustum plane
  86472. */
  86473. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  86474. /**
  86475. * Gets the left frustum plane transformed by the transform matrix
  86476. * @param transform transformation matrix to be applied to the resulting frustum plane
  86477. * @param frustumPlane the resuling frustum plane
  86478. */
  86479. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  86480. /**
  86481. * Gets the right frustum plane transformed by the transform matrix
  86482. * @param transform transformation matrix to be applied to the resulting frustum plane
  86483. * @param frustumPlane the resuling frustum plane
  86484. */
  86485. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  86486. /**
  86487. * Gets the top frustum plane transformed by the transform matrix
  86488. * @param transform transformation matrix to be applied to the resulting frustum plane
  86489. * @param frustumPlane the resuling frustum plane
  86490. */
  86491. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  86492. /**
  86493. * Gets the bottom frustum plane transformed by the transform matrix
  86494. * @param transform transformation matrix to be applied to the resulting frustum plane
  86495. * @param frustumPlane the resuling frustum plane
  86496. */
  86497. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  86498. /**
  86499. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  86500. * @param transform transformation matrix to be applied to the resulting frustum planes
  86501. * @param frustumPlanes the resuling frustum planes
  86502. */
  86503. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  86504. }
  86505. }
  86506. declare module BABYLON {
  86507. /**
  86508. * Interface for the size containing width and height
  86509. */
  86510. export interface ISize {
  86511. /**
  86512. * Width
  86513. */
  86514. width: number;
  86515. /**
  86516. * Heighht
  86517. */
  86518. height: number;
  86519. }
  86520. /**
  86521. * Size containing widht and height
  86522. */
  86523. export class Size implements ISize {
  86524. /**
  86525. * Width
  86526. */
  86527. width: number;
  86528. /**
  86529. * Height
  86530. */
  86531. height: number;
  86532. /**
  86533. * Creates a Size object from the given width and height (floats).
  86534. * @param width width of the new size
  86535. * @param height height of the new size
  86536. */
  86537. constructor(width: number, height: number);
  86538. /**
  86539. * Returns a string with the Size width and height
  86540. * @returns a string with the Size width and height
  86541. */
  86542. toString(): string;
  86543. /**
  86544. * "Size"
  86545. * @returns the string "Size"
  86546. */
  86547. getClassName(): string;
  86548. /**
  86549. * Returns the Size hash code.
  86550. * @returns a hash code for a unique width and height
  86551. */
  86552. getHashCode(): number;
  86553. /**
  86554. * Updates the current size from the given one.
  86555. * @param src the given size
  86556. */
  86557. copyFrom(src: Size): void;
  86558. /**
  86559. * Updates in place the current Size from the given floats.
  86560. * @param width width of the new size
  86561. * @param height height of the new size
  86562. * @returns the updated Size.
  86563. */
  86564. copyFromFloats(width: number, height: number): Size;
  86565. /**
  86566. * Updates in place the current Size from the given floats.
  86567. * @param width width to set
  86568. * @param height height to set
  86569. * @returns the updated Size.
  86570. */
  86571. set(width: number, height: number): Size;
  86572. /**
  86573. * Multiplies the width and height by numbers
  86574. * @param w factor to multiple the width by
  86575. * @param h factor to multiple the height by
  86576. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  86577. */
  86578. multiplyByFloats(w: number, h: number): Size;
  86579. /**
  86580. * Clones the size
  86581. * @returns a new Size copied from the given one.
  86582. */
  86583. clone(): Size;
  86584. /**
  86585. * True if the current Size and the given one width and height are strictly equal.
  86586. * @param other the other size to compare against
  86587. * @returns True if the current Size and the given one width and height are strictly equal.
  86588. */
  86589. equals(other: Size): boolean;
  86590. /**
  86591. * The surface of the Size : width * height (float).
  86592. */
  86593. get surface(): number;
  86594. /**
  86595. * Create a new size of zero
  86596. * @returns a new Size set to (0.0, 0.0)
  86597. */
  86598. static Zero(): Size;
  86599. /**
  86600. * Sums the width and height of two sizes
  86601. * @param otherSize size to add to this size
  86602. * @returns a new Size set as the addition result of the current Size and the given one.
  86603. */
  86604. add(otherSize: Size): Size;
  86605. /**
  86606. * Subtracts the width and height of two
  86607. * @param otherSize size to subtract to this size
  86608. * @returns a new Size set as the subtraction result of the given one from the current Size.
  86609. */
  86610. subtract(otherSize: Size): Size;
  86611. /**
  86612. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  86613. * @param start starting size to lerp between
  86614. * @param end end size to lerp between
  86615. * @param amount amount to lerp between the start and end values
  86616. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  86617. */
  86618. static Lerp(start: Size, end: Size, amount: number): Size;
  86619. }
  86620. }
  86621. declare module BABYLON {
  86622. /**
  86623. * Contains position and normal vectors for a vertex
  86624. */
  86625. export class PositionNormalVertex {
  86626. /** the position of the vertex (defaut: 0,0,0) */
  86627. position: Vector3;
  86628. /** the normal of the vertex (defaut: 0,1,0) */
  86629. normal: Vector3;
  86630. /**
  86631. * Creates a PositionNormalVertex
  86632. * @param position the position of the vertex (defaut: 0,0,0)
  86633. * @param normal the normal of the vertex (defaut: 0,1,0)
  86634. */
  86635. constructor(
  86636. /** the position of the vertex (defaut: 0,0,0) */
  86637. position?: Vector3,
  86638. /** the normal of the vertex (defaut: 0,1,0) */
  86639. normal?: Vector3);
  86640. /**
  86641. * Clones the PositionNormalVertex
  86642. * @returns the cloned PositionNormalVertex
  86643. */
  86644. clone(): PositionNormalVertex;
  86645. }
  86646. /**
  86647. * Contains position, normal and uv vectors for a vertex
  86648. */
  86649. export class PositionNormalTextureVertex {
  86650. /** the position of the vertex (defaut: 0,0,0) */
  86651. position: Vector3;
  86652. /** the normal of the vertex (defaut: 0,1,0) */
  86653. normal: Vector3;
  86654. /** the uv of the vertex (default: 0,0) */
  86655. uv: Vector2;
  86656. /**
  86657. * Creates a PositionNormalTextureVertex
  86658. * @param position the position of the vertex (defaut: 0,0,0)
  86659. * @param normal the normal of the vertex (defaut: 0,1,0)
  86660. * @param uv the uv of the vertex (default: 0,0)
  86661. */
  86662. constructor(
  86663. /** the position of the vertex (defaut: 0,0,0) */
  86664. position?: Vector3,
  86665. /** the normal of the vertex (defaut: 0,1,0) */
  86666. normal?: Vector3,
  86667. /** the uv of the vertex (default: 0,0) */
  86668. uv?: Vector2);
  86669. /**
  86670. * Clones the PositionNormalTextureVertex
  86671. * @returns the cloned PositionNormalTextureVertex
  86672. */
  86673. clone(): PositionNormalTextureVertex;
  86674. }
  86675. }
  86676. declare module BABYLON {
  86677. /**
  86678. * Enum defining the type of animations supported by InputBlock
  86679. */
  86680. export enum AnimatedInputBlockTypes {
  86681. /** No animation */
  86682. None = 0,
  86683. /** Time based animation. Will only work for floats */
  86684. Time = 1
  86685. }
  86686. }
  86687. declare module BABYLON {
  86688. /**
  86689. * Interface describing all the common properties and methods a shadow light needs to implement.
  86690. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  86691. * as well as binding the different shadow properties to the effects.
  86692. */
  86693. export interface IShadowLight extends Light {
  86694. /**
  86695. * The light id in the scene (used in scene.findLighById for instance)
  86696. */
  86697. id: string;
  86698. /**
  86699. * The position the shdow will be casted from.
  86700. */
  86701. position: Vector3;
  86702. /**
  86703. * In 2d mode (needCube being false), the direction used to cast the shadow.
  86704. */
  86705. direction: Vector3;
  86706. /**
  86707. * The transformed position. Position of the light in world space taking parenting in account.
  86708. */
  86709. transformedPosition: Vector3;
  86710. /**
  86711. * The transformed direction. Direction of the light in world space taking parenting in account.
  86712. */
  86713. transformedDirection: Vector3;
  86714. /**
  86715. * The friendly name of the light in the scene.
  86716. */
  86717. name: string;
  86718. /**
  86719. * Defines the shadow projection clipping minimum z value.
  86720. */
  86721. shadowMinZ: number;
  86722. /**
  86723. * Defines the shadow projection clipping maximum z value.
  86724. */
  86725. shadowMaxZ: number;
  86726. /**
  86727. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  86728. * @returns true if the information has been computed, false if it does not need to (no parenting)
  86729. */
  86730. computeTransformedInformation(): boolean;
  86731. /**
  86732. * Gets the scene the light belongs to.
  86733. * @returns The scene
  86734. */
  86735. getScene(): Scene;
  86736. /**
  86737. * Callback defining a custom Projection Matrix Builder.
  86738. * This can be used to override the default projection matrix computation.
  86739. */
  86740. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  86741. /**
  86742. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  86743. * @param matrix The materix to updated with the projection information
  86744. * @param viewMatrix The transform matrix of the light
  86745. * @param renderList The list of mesh to render in the map
  86746. * @returns The current light
  86747. */
  86748. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  86749. /**
  86750. * Gets the current depth scale used in ESM.
  86751. * @returns The scale
  86752. */
  86753. getDepthScale(): number;
  86754. /**
  86755. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  86756. * @returns true if a cube texture needs to be use
  86757. */
  86758. needCube(): boolean;
  86759. /**
  86760. * Detects if the projection matrix requires to be recomputed this frame.
  86761. * @returns true if it requires to be recomputed otherwise, false.
  86762. */
  86763. needProjectionMatrixCompute(): boolean;
  86764. /**
  86765. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  86766. */
  86767. forceProjectionMatrixCompute(): void;
  86768. /**
  86769. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  86770. * @param faceIndex The index of the face we are computed the direction to generate shadow
  86771. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  86772. */
  86773. getShadowDirection(faceIndex?: number): Vector3;
  86774. /**
  86775. * Gets the minZ used for shadow according to both the scene and the light.
  86776. * @param activeCamera The camera we are returning the min for
  86777. * @returns the depth min z
  86778. */
  86779. getDepthMinZ(activeCamera: Camera): number;
  86780. /**
  86781. * Gets the maxZ used for shadow according to both the scene and the light.
  86782. * @param activeCamera The camera we are returning the max for
  86783. * @returns the depth max z
  86784. */
  86785. getDepthMaxZ(activeCamera: Camera): number;
  86786. }
  86787. /**
  86788. * Base implementation IShadowLight
  86789. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  86790. */
  86791. export abstract class ShadowLight extends Light implements IShadowLight {
  86792. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  86793. protected _position: Vector3;
  86794. protected _setPosition(value: Vector3): void;
  86795. /**
  86796. * Sets the position the shadow will be casted from. Also use as the light position for both
  86797. * point and spot lights.
  86798. */
  86799. get position(): Vector3;
  86800. /**
  86801. * Sets the position the shadow will be casted from. Also use as the light position for both
  86802. * point and spot lights.
  86803. */
  86804. set position(value: Vector3);
  86805. protected _direction: Vector3;
  86806. protected _setDirection(value: Vector3): void;
  86807. /**
  86808. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  86809. * Also use as the light direction on spot and directional lights.
  86810. */
  86811. get direction(): Vector3;
  86812. /**
  86813. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  86814. * Also use as the light direction on spot and directional lights.
  86815. */
  86816. set direction(value: Vector3);
  86817. protected _shadowMinZ: number;
  86818. /**
  86819. * Gets the shadow projection clipping minimum z value.
  86820. */
  86821. get shadowMinZ(): number;
  86822. /**
  86823. * Sets the shadow projection clipping minimum z value.
  86824. */
  86825. set shadowMinZ(value: number);
  86826. protected _shadowMaxZ: number;
  86827. /**
  86828. * Sets the shadow projection clipping maximum z value.
  86829. */
  86830. get shadowMaxZ(): number;
  86831. /**
  86832. * Gets the shadow projection clipping maximum z value.
  86833. */
  86834. set shadowMaxZ(value: number);
  86835. /**
  86836. * Callback defining a custom Projection Matrix Builder.
  86837. * This can be used to override the default projection matrix computation.
  86838. */
  86839. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  86840. /**
  86841. * The transformed position. Position of the light in world space taking parenting in account.
  86842. */
  86843. transformedPosition: Vector3;
  86844. /**
  86845. * The transformed direction. Direction of the light in world space taking parenting in account.
  86846. */
  86847. transformedDirection: Vector3;
  86848. private _needProjectionMatrixCompute;
  86849. /**
  86850. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  86851. * @returns true if the information has been computed, false if it does not need to (no parenting)
  86852. */
  86853. computeTransformedInformation(): boolean;
  86854. /**
  86855. * Return the depth scale used for the shadow map.
  86856. * @returns the depth scale.
  86857. */
  86858. getDepthScale(): number;
  86859. /**
  86860. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  86861. * @param faceIndex The index of the face we are computed the direction to generate shadow
  86862. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  86863. */
  86864. getShadowDirection(faceIndex?: number): Vector3;
  86865. /**
  86866. * Returns the ShadowLight absolute position in the World.
  86867. * @returns the position vector in world space
  86868. */
  86869. getAbsolutePosition(): Vector3;
  86870. /**
  86871. * Sets the ShadowLight direction toward the passed target.
  86872. * @param target The point to target in local space
  86873. * @returns the updated ShadowLight direction
  86874. */
  86875. setDirectionToTarget(target: Vector3): Vector3;
  86876. /**
  86877. * Returns the light rotation in euler definition.
  86878. * @returns the x y z rotation in local space.
  86879. */
  86880. getRotation(): Vector3;
  86881. /**
  86882. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  86883. * @returns true if a cube texture needs to be use
  86884. */
  86885. needCube(): boolean;
  86886. /**
  86887. * Detects if the projection matrix requires to be recomputed this frame.
  86888. * @returns true if it requires to be recomputed otherwise, false.
  86889. */
  86890. needProjectionMatrixCompute(): boolean;
  86891. /**
  86892. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  86893. */
  86894. forceProjectionMatrixCompute(): void;
  86895. /** @hidden */
  86896. _initCache(): void;
  86897. /** @hidden */
  86898. _isSynchronized(): boolean;
  86899. /**
  86900. * Computes the world matrix of the node
  86901. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  86902. * @returns the world matrix
  86903. */
  86904. computeWorldMatrix(force?: boolean): Matrix;
  86905. /**
  86906. * Gets the minZ used for shadow according to both the scene and the light.
  86907. * @param activeCamera The camera we are returning the min for
  86908. * @returns the depth min z
  86909. */
  86910. getDepthMinZ(activeCamera: Camera): number;
  86911. /**
  86912. * Gets the maxZ used for shadow according to both the scene and the light.
  86913. * @param activeCamera The camera we are returning the max for
  86914. * @returns the depth max z
  86915. */
  86916. getDepthMaxZ(activeCamera: Camera): number;
  86917. /**
  86918. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  86919. * @param matrix The materix to updated with the projection information
  86920. * @param viewMatrix The transform matrix of the light
  86921. * @param renderList The list of mesh to render in the map
  86922. * @returns The current light
  86923. */
  86924. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  86925. }
  86926. }
  86927. declare module BABYLON {
  86928. /** @hidden */
  86929. export var packingFunctions: {
  86930. name: string;
  86931. shader: string;
  86932. };
  86933. }
  86934. declare module BABYLON {
  86935. /** @hidden */
  86936. export var bayerDitherFunctions: {
  86937. name: string;
  86938. shader: string;
  86939. };
  86940. }
  86941. declare module BABYLON {
  86942. /** @hidden */
  86943. export var shadowMapFragmentDeclaration: {
  86944. name: string;
  86945. shader: string;
  86946. };
  86947. }
  86948. declare module BABYLON {
  86949. /** @hidden */
  86950. export var clipPlaneFragmentDeclaration: {
  86951. name: string;
  86952. shader: string;
  86953. };
  86954. }
  86955. declare module BABYLON {
  86956. /** @hidden */
  86957. export var clipPlaneFragment: {
  86958. name: string;
  86959. shader: string;
  86960. };
  86961. }
  86962. declare module BABYLON {
  86963. /** @hidden */
  86964. export var shadowMapFragment: {
  86965. name: string;
  86966. shader: string;
  86967. };
  86968. }
  86969. declare module BABYLON {
  86970. /** @hidden */
  86971. export var shadowMapPixelShader: {
  86972. name: string;
  86973. shader: string;
  86974. };
  86975. }
  86976. declare module BABYLON {
  86977. /** @hidden */
  86978. export var bonesDeclaration: {
  86979. name: string;
  86980. shader: string;
  86981. };
  86982. }
  86983. declare module BABYLON {
  86984. /** @hidden */
  86985. export var morphTargetsVertexGlobalDeclaration: {
  86986. name: string;
  86987. shader: string;
  86988. };
  86989. }
  86990. declare module BABYLON {
  86991. /** @hidden */
  86992. export var morphTargetsVertexDeclaration: {
  86993. name: string;
  86994. shader: string;
  86995. };
  86996. }
  86997. declare module BABYLON {
  86998. /** @hidden */
  86999. export var instancesDeclaration: {
  87000. name: string;
  87001. shader: string;
  87002. };
  87003. }
  87004. declare module BABYLON {
  87005. /** @hidden */
  87006. export var helperFunctions: {
  87007. name: string;
  87008. shader: string;
  87009. };
  87010. }
  87011. declare module BABYLON {
  87012. /** @hidden */
  87013. export var shadowMapVertexDeclaration: {
  87014. name: string;
  87015. shader: string;
  87016. };
  87017. }
  87018. declare module BABYLON {
  87019. /** @hidden */
  87020. export var clipPlaneVertexDeclaration: {
  87021. name: string;
  87022. shader: string;
  87023. };
  87024. }
  87025. declare module BABYLON {
  87026. /** @hidden */
  87027. export var morphTargetsVertex: {
  87028. name: string;
  87029. shader: string;
  87030. };
  87031. }
  87032. declare module BABYLON {
  87033. /** @hidden */
  87034. export var instancesVertex: {
  87035. name: string;
  87036. shader: string;
  87037. };
  87038. }
  87039. declare module BABYLON {
  87040. /** @hidden */
  87041. export var bonesVertex: {
  87042. name: string;
  87043. shader: string;
  87044. };
  87045. }
  87046. declare module BABYLON {
  87047. /** @hidden */
  87048. export var shadowMapVertexNormalBias: {
  87049. name: string;
  87050. shader: string;
  87051. };
  87052. }
  87053. declare module BABYLON {
  87054. /** @hidden */
  87055. export var shadowMapVertexMetric: {
  87056. name: string;
  87057. shader: string;
  87058. };
  87059. }
  87060. declare module BABYLON {
  87061. /** @hidden */
  87062. export var clipPlaneVertex: {
  87063. name: string;
  87064. shader: string;
  87065. };
  87066. }
  87067. declare module BABYLON {
  87068. /** @hidden */
  87069. export var shadowMapVertexShader: {
  87070. name: string;
  87071. shader: string;
  87072. };
  87073. }
  87074. declare module BABYLON {
  87075. /** @hidden */
  87076. export var depthBoxBlurPixelShader: {
  87077. name: string;
  87078. shader: string;
  87079. };
  87080. }
  87081. declare module BABYLON {
  87082. /** @hidden */
  87083. export var shadowMapFragmentSoftTransparentShadow: {
  87084. name: string;
  87085. shader: string;
  87086. };
  87087. }
  87088. declare module BABYLON {
  87089. /**
  87090. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  87091. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  87092. */
  87093. export class EffectFallbacks implements IEffectFallbacks {
  87094. private _defines;
  87095. private _currentRank;
  87096. private _maxRank;
  87097. private _mesh;
  87098. /**
  87099. * Removes the fallback from the bound mesh.
  87100. */
  87101. unBindMesh(): void;
  87102. /**
  87103. * Adds a fallback on the specified property.
  87104. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  87105. * @param define The name of the define in the shader
  87106. */
  87107. addFallback(rank: number, define: string): void;
  87108. /**
  87109. * Sets the mesh to use CPU skinning when needing to fallback.
  87110. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  87111. * @param mesh The mesh to use the fallbacks.
  87112. */
  87113. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  87114. /**
  87115. * Checks to see if more fallbacks are still availible.
  87116. */
  87117. get hasMoreFallbacks(): boolean;
  87118. /**
  87119. * Removes the defines that should be removed when falling back.
  87120. * @param currentDefines defines the current define statements for the shader.
  87121. * @param effect defines the current effect we try to compile
  87122. * @returns The resulting defines with defines of the current rank removed.
  87123. */
  87124. reduce(currentDefines: string, effect: Effect): string;
  87125. }
  87126. }
  87127. declare module BABYLON {
  87128. /**
  87129. * Interface used to define Action
  87130. */
  87131. export interface IAction {
  87132. /**
  87133. * Trigger for the action
  87134. */
  87135. trigger: number;
  87136. /** Options of the trigger */
  87137. triggerOptions: any;
  87138. /**
  87139. * Gets the trigger parameters
  87140. * @returns the trigger parameters
  87141. */
  87142. getTriggerParameter(): any;
  87143. /**
  87144. * Internal only - executes current action event
  87145. * @hidden
  87146. */
  87147. _executeCurrent(evt?: ActionEvent): void;
  87148. /**
  87149. * Serialize placeholder for child classes
  87150. * @param parent of child
  87151. * @returns the serialized object
  87152. */
  87153. serialize(parent: any): any;
  87154. /**
  87155. * Internal only
  87156. * @hidden
  87157. */
  87158. _prepare(): void;
  87159. /**
  87160. * Internal only - manager for action
  87161. * @hidden
  87162. */
  87163. _actionManager: AbstractActionManager;
  87164. /**
  87165. * Adds action to chain of actions, may be a DoNothingAction
  87166. * @param action defines the next action to execute
  87167. * @returns The action passed in
  87168. * @see https://www.babylonjs-playground.com/#1T30HR#0
  87169. */
  87170. then(action: IAction): IAction;
  87171. }
  87172. /**
  87173. * The action to be carried out following a trigger
  87174. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  87175. */
  87176. export class Action implements IAction {
  87177. /** the trigger, with or without parameters, for the action */
  87178. triggerOptions: any;
  87179. /**
  87180. * Trigger for the action
  87181. */
  87182. trigger: number;
  87183. /**
  87184. * Internal only - manager for action
  87185. * @hidden
  87186. */
  87187. _actionManager: ActionManager;
  87188. private _nextActiveAction;
  87189. private _child;
  87190. private _condition?;
  87191. private _triggerParameter;
  87192. /**
  87193. * An event triggered prior to action being executed.
  87194. */
  87195. onBeforeExecuteObservable: Observable<Action>;
  87196. /**
  87197. * Creates a new Action
  87198. * @param triggerOptions the trigger, with or without parameters, for the action
  87199. * @param condition an optional determinant of action
  87200. */
  87201. constructor(
  87202. /** the trigger, with or without parameters, for the action */
  87203. triggerOptions: any, condition?: Condition);
  87204. /**
  87205. * Internal only
  87206. * @hidden
  87207. */
  87208. _prepare(): void;
  87209. /**
  87210. * Gets the trigger parameters
  87211. * @returns the trigger parameters
  87212. */
  87213. getTriggerParameter(): any;
  87214. /**
  87215. * Internal only - executes current action event
  87216. * @hidden
  87217. */
  87218. _executeCurrent(evt?: ActionEvent): void;
  87219. /**
  87220. * Execute placeholder for child classes
  87221. * @param evt optional action event
  87222. */
  87223. execute(evt?: ActionEvent): void;
  87224. /**
  87225. * Skips to next active action
  87226. */
  87227. skipToNextActiveAction(): void;
  87228. /**
  87229. * Adds action to chain of actions, may be a DoNothingAction
  87230. * @param action defines the next action to execute
  87231. * @returns The action passed in
  87232. * @see https://www.babylonjs-playground.com/#1T30HR#0
  87233. */
  87234. then(action: Action): Action;
  87235. /**
  87236. * Internal only
  87237. * @hidden
  87238. */
  87239. _getProperty(propertyPath: string): string;
  87240. /**
  87241. * Internal only
  87242. * @hidden
  87243. */
  87244. _getEffectiveTarget(target: any, propertyPath: string): any;
  87245. /**
  87246. * Serialize placeholder for child classes
  87247. * @param parent of child
  87248. * @returns the serialized object
  87249. */
  87250. serialize(parent: any): any;
  87251. /**
  87252. * Internal only called by serialize
  87253. * @hidden
  87254. */
  87255. protected _serialize(serializedAction: any, parent?: any): any;
  87256. /**
  87257. * Internal only
  87258. * @hidden
  87259. */
  87260. static _SerializeValueAsString: (value: any) => string;
  87261. /**
  87262. * Internal only
  87263. * @hidden
  87264. */
  87265. static _GetTargetProperty: (target: Node | Scene) => {
  87266. name: string;
  87267. targetType: string;
  87268. value: string;
  87269. };
  87270. }
  87271. }
  87272. declare module BABYLON {
  87273. /**
  87274. * A Condition applied to an Action
  87275. */
  87276. export class Condition {
  87277. /**
  87278. * Internal only - manager for action
  87279. * @hidden
  87280. */
  87281. _actionManager: ActionManager;
  87282. /**
  87283. * Internal only
  87284. * @hidden
  87285. */
  87286. _evaluationId: number;
  87287. /**
  87288. * Internal only
  87289. * @hidden
  87290. */
  87291. _currentResult: boolean;
  87292. /**
  87293. * Creates a new Condition
  87294. * @param actionManager the manager of the action the condition is applied to
  87295. */
  87296. constructor(actionManager: ActionManager);
  87297. /**
  87298. * Check if the current condition is valid
  87299. * @returns a boolean
  87300. */
  87301. isValid(): boolean;
  87302. /**
  87303. * Internal only
  87304. * @hidden
  87305. */
  87306. _getProperty(propertyPath: string): string;
  87307. /**
  87308. * Internal only
  87309. * @hidden
  87310. */
  87311. _getEffectiveTarget(target: any, propertyPath: string): any;
  87312. /**
  87313. * Serialize placeholder for child classes
  87314. * @returns the serialized object
  87315. */
  87316. serialize(): any;
  87317. /**
  87318. * Internal only
  87319. * @hidden
  87320. */
  87321. protected _serialize(serializedCondition: any): any;
  87322. }
  87323. /**
  87324. * Defines specific conditional operators as extensions of Condition
  87325. */
  87326. export class ValueCondition extends Condition {
  87327. /** path to specify the property of the target the conditional operator uses */
  87328. propertyPath: string;
  87329. /** the value compared by the conditional operator against the current value of the property */
  87330. value: any;
  87331. /** the conditional operator, default ValueCondition.IsEqual */
  87332. operator: number;
  87333. /**
  87334. * Internal only
  87335. * @hidden
  87336. */
  87337. private static _IsEqual;
  87338. /**
  87339. * Internal only
  87340. * @hidden
  87341. */
  87342. private static _IsDifferent;
  87343. /**
  87344. * Internal only
  87345. * @hidden
  87346. */
  87347. private static _IsGreater;
  87348. /**
  87349. * Internal only
  87350. * @hidden
  87351. */
  87352. private static _IsLesser;
  87353. /**
  87354. * returns the number for IsEqual
  87355. */
  87356. static get IsEqual(): number;
  87357. /**
  87358. * Returns the number for IsDifferent
  87359. */
  87360. static get IsDifferent(): number;
  87361. /**
  87362. * Returns the number for IsGreater
  87363. */
  87364. static get IsGreater(): number;
  87365. /**
  87366. * Returns the number for IsLesser
  87367. */
  87368. static get IsLesser(): number;
  87369. /**
  87370. * Internal only The action manager for the condition
  87371. * @hidden
  87372. */
  87373. _actionManager: ActionManager;
  87374. /**
  87375. * Internal only
  87376. * @hidden
  87377. */
  87378. private _target;
  87379. /**
  87380. * Internal only
  87381. * @hidden
  87382. */
  87383. private _effectiveTarget;
  87384. /**
  87385. * Internal only
  87386. * @hidden
  87387. */
  87388. private _property;
  87389. /**
  87390. * Creates a new ValueCondition
  87391. * @param actionManager manager for the action the condition applies to
  87392. * @param target for the action
  87393. * @param propertyPath path to specify the property of the target the conditional operator uses
  87394. * @param value the value compared by the conditional operator against the current value of the property
  87395. * @param operator the conditional operator, default ValueCondition.IsEqual
  87396. */
  87397. constructor(actionManager: ActionManager, target: any,
  87398. /** path to specify the property of the target the conditional operator uses */
  87399. propertyPath: string,
  87400. /** the value compared by the conditional operator against the current value of the property */
  87401. value: any,
  87402. /** the conditional operator, default ValueCondition.IsEqual */
  87403. operator?: number);
  87404. /**
  87405. * Compares the given value with the property value for the specified conditional operator
  87406. * @returns the result of the comparison
  87407. */
  87408. isValid(): boolean;
  87409. /**
  87410. * Serialize the ValueCondition into a JSON compatible object
  87411. * @returns serialization object
  87412. */
  87413. serialize(): any;
  87414. /**
  87415. * Gets the name of the conditional operator for the ValueCondition
  87416. * @param operator the conditional operator
  87417. * @returns the name
  87418. */
  87419. static GetOperatorName(operator: number): string;
  87420. }
  87421. /**
  87422. * Defines a predicate condition as an extension of Condition
  87423. */
  87424. export class PredicateCondition extends Condition {
  87425. /** defines the predicate function used to validate the condition */
  87426. predicate: () => boolean;
  87427. /**
  87428. * Internal only - manager for action
  87429. * @hidden
  87430. */
  87431. _actionManager: ActionManager;
  87432. /**
  87433. * Creates a new PredicateCondition
  87434. * @param actionManager manager for the action the condition applies to
  87435. * @param predicate defines the predicate function used to validate the condition
  87436. */
  87437. constructor(actionManager: ActionManager,
  87438. /** defines the predicate function used to validate the condition */
  87439. predicate: () => boolean);
  87440. /**
  87441. * @returns the validity of the predicate condition
  87442. */
  87443. isValid(): boolean;
  87444. }
  87445. /**
  87446. * Defines a state condition as an extension of Condition
  87447. */
  87448. export class StateCondition extends Condition {
  87449. /** Value to compare with target state */
  87450. value: string;
  87451. /**
  87452. * Internal only - manager for action
  87453. * @hidden
  87454. */
  87455. _actionManager: ActionManager;
  87456. /**
  87457. * Internal only
  87458. * @hidden
  87459. */
  87460. private _target;
  87461. /**
  87462. * Creates a new StateCondition
  87463. * @param actionManager manager for the action the condition applies to
  87464. * @param target of the condition
  87465. * @param value to compare with target state
  87466. */
  87467. constructor(actionManager: ActionManager, target: any,
  87468. /** Value to compare with target state */
  87469. value: string);
  87470. /**
  87471. * Gets a boolean indicating if the current condition is met
  87472. * @returns the validity of the state
  87473. */
  87474. isValid(): boolean;
  87475. /**
  87476. * Serialize the StateCondition into a JSON compatible object
  87477. * @returns serialization object
  87478. */
  87479. serialize(): any;
  87480. }
  87481. }
  87482. declare module BABYLON {
  87483. /**
  87484. * This defines an action responsible to toggle a boolean once triggered.
  87485. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87486. */
  87487. export class SwitchBooleanAction extends Action {
  87488. /**
  87489. * The path to the boolean property in the target object
  87490. */
  87491. propertyPath: string;
  87492. private _target;
  87493. private _effectiveTarget;
  87494. private _property;
  87495. /**
  87496. * Instantiate the action
  87497. * @param triggerOptions defines the trigger options
  87498. * @param target defines the object containing the boolean
  87499. * @param propertyPath defines the path to the boolean property in the target object
  87500. * @param condition defines the trigger related conditions
  87501. */
  87502. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  87503. /** @hidden */
  87504. _prepare(): void;
  87505. /**
  87506. * Execute the action toggle the boolean value.
  87507. */
  87508. execute(): void;
  87509. /**
  87510. * Serializes the actions and its related information.
  87511. * @param parent defines the object to serialize in
  87512. * @returns the serialized object
  87513. */
  87514. serialize(parent: any): any;
  87515. }
  87516. /**
  87517. * This defines an action responsible to set a the state field of the target
  87518. * to a desired value once triggered.
  87519. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87520. */
  87521. export class SetStateAction extends Action {
  87522. /**
  87523. * The value to store in the state field.
  87524. */
  87525. value: string;
  87526. private _target;
  87527. /**
  87528. * Instantiate the action
  87529. * @param triggerOptions defines the trigger options
  87530. * @param target defines the object containing the state property
  87531. * @param value defines the value to store in the state field
  87532. * @param condition defines the trigger related conditions
  87533. */
  87534. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  87535. /**
  87536. * Execute the action and store the value on the target state property.
  87537. */
  87538. execute(): void;
  87539. /**
  87540. * Serializes the actions and its related information.
  87541. * @param parent defines the object to serialize in
  87542. * @returns the serialized object
  87543. */
  87544. serialize(parent: any): any;
  87545. }
  87546. /**
  87547. * This defines an action responsible to set a property of the target
  87548. * to a desired value once triggered.
  87549. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87550. */
  87551. export class SetValueAction extends Action {
  87552. /**
  87553. * The path of the property to set in the target.
  87554. */
  87555. propertyPath: string;
  87556. /**
  87557. * The value to set in the property
  87558. */
  87559. value: any;
  87560. private _target;
  87561. private _effectiveTarget;
  87562. private _property;
  87563. /**
  87564. * Instantiate the action
  87565. * @param triggerOptions defines the trigger options
  87566. * @param target defines the object containing the property
  87567. * @param propertyPath defines the path of the property to set in the target
  87568. * @param value defines the value to set in the property
  87569. * @param condition defines the trigger related conditions
  87570. */
  87571. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  87572. /** @hidden */
  87573. _prepare(): void;
  87574. /**
  87575. * Execute the action and set the targetted property to the desired value.
  87576. */
  87577. execute(): void;
  87578. /**
  87579. * Serializes the actions and its related information.
  87580. * @param parent defines the object to serialize in
  87581. * @returns the serialized object
  87582. */
  87583. serialize(parent: any): any;
  87584. }
  87585. /**
  87586. * This defines an action responsible to increment the target value
  87587. * to a desired value once triggered.
  87588. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87589. */
  87590. export class IncrementValueAction extends Action {
  87591. /**
  87592. * The path of the property to increment in the target.
  87593. */
  87594. propertyPath: string;
  87595. /**
  87596. * The value we should increment the property by.
  87597. */
  87598. value: any;
  87599. private _target;
  87600. private _effectiveTarget;
  87601. private _property;
  87602. /**
  87603. * Instantiate the action
  87604. * @param triggerOptions defines the trigger options
  87605. * @param target defines the object containing the property
  87606. * @param propertyPath defines the path of the property to increment in the target
  87607. * @param value defines the value value we should increment the property by
  87608. * @param condition defines the trigger related conditions
  87609. */
  87610. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  87611. /** @hidden */
  87612. _prepare(): void;
  87613. /**
  87614. * Execute the action and increment the target of the value amount.
  87615. */
  87616. execute(): void;
  87617. /**
  87618. * Serializes the actions and its related information.
  87619. * @param parent defines the object to serialize in
  87620. * @returns the serialized object
  87621. */
  87622. serialize(parent: any): any;
  87623. }
  87624. /**
  87625. * This defines an action responsible to start an animation once triggered.
  87626. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87627. */
  87628. export class PlayAnimationAction extends Action {
  87629. /**
  87630. * Where the animation should start (animation frame)
  87631. */
  87632. from: number;
  87633. /**
  87634. * Where the animation should stop (animation frame)
  87635. */
  87636. to: number;
  87637. /**
  87638. * Define if the animation should loop or stop after the first play.
  87639. */
  87640. loop?: boolean;
  87641. private _target;
  87642. /**
  87643. * Instantiate the action
  87644. * @param triggerOptions defines the trigger options
  87645. * @param target defines the target animation or animation name
  87646. * @param from defines from where the animation should start (animation frame)
  87647. * @param end defines where the animation should stop (animation frame)
  87648. * @param loop defines if the animation should loop or stop after the first play
  87649. * @param condition defines the trigger related conditions
  87650. */
  87651. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  87652. /** @hidden */
  87653. _prepare(): void;
  87654. /**
  87655. * Execute the action and play the animation.
  87656. */
  87657. execute(): void;
  87658. /**
  87659. * Serializes the actions and its related information.
  87660. * @param parent defines the object to serialize in
  87661. * @returns the serialized object
  87662. */
  87663. serialize(parent: any): any;
  87664. }
  87665. /**
  87666. * This defines an action responsible to stop an animation once triggered.
  87667. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87668. */
  87669. export class StopAnimationAction extends Action {
  87670. private _target;
  87671. /**
  87672. * Instantiate the action
  87673. * @param triggerOptions defines the trigger options
  87674. * @param target defines the target animation or animation name
  87675. * @param condition defines the trigger related conditions
  87676. */
  87677. constructor(triggerOptions: any, target: any, condition?: Condition);
  87678. /** @hidden */
  87679. _prepare(): void;
  87680. /**
  87681. * Execute the action and stop the animation.
  87682. */
  87683. execute(): void;
  87684. /**
  87685. * Serializes the actions and its related information.
  87686. * @param parent defines the object to serialize in
  87687. * @returns the serialized object
  87688. */
  87689. serialize(parent: any): any;
  87690. }
  87691. /**
  87692. * This defines an action responsible that does nothing once triggered.
  87693. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87694. */
  87695. export class DoNothingAction extends Action {
  87696. /**
  87697. * Instantiate the action
  87698. * @param triggerOptions defines the trigger options
  87699. * @param condition defines the trigger related conditions
  87700. */
  87701. constructor(triggerOptions?: any, condition?: Condition);
  87702. /**
  87703. * Execute the action and do nothing.
  87704. */
  87705. execute(): void;
  87706. /**
  87707. * Serializes the actions and its related information.
  87708. * @param parent defines the object to serialize in
  87709. * @returns the serialized object
  87710. */
  87711. serialize(parent: any): any;
  87712. }
  87713. /**
  87714. * This defines an action responsible to trigger several actions once triggered.
  87715. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87716. */
  87717. export class CombineAction extends Action {
  87718. /**
  87719. * The list of aggregated animations to run.
  87720. */
  87721. children: Action[];
  87722. /**
  87723. * Instantiate the action
  87724. * @param triggerOptions defines the trigger options
  87725. * @param children defines the list of aggregated animations to run
  87726. * @param condition defines the trigger related conditions
  87727. */
  87728. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  87729. /** @hidden */
  87730. _prepare(): void;
  87731. /**
  87732. * Execute the action and executes all the aggregated actions.
  87733. */
  87734. execute(evt: ActionEvent): void;
  87735. /**
  87736. * Serializes the actions and its related information.
  87737. * @param parent defines the object to serialize in
  87738. * @returns the serialized object
  87739. */
  87740. serialize(parent: any): any;
  87741. }
  87742. /**
  87743. * This defines an action responsible to run code (external event) once triggered.
  87744. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87745. */
  87746. export class ExecuteCodeAction extends Action {
  87747. /**
  87748. * The callback function to run.
  87749. */
  87750. func: (evt: ActionEvent) => void;
  87751. /**
  87752. * Instantiate the action
  87753. * @param triggerOptions defines the trigger options
  87754. * @param func defines the callback function to run
  87755. * @param condition defines the trigger related conditions
  87756. */
  87757. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  87758. /**
  87759. * Execute the action and run the attached code.
  87760. */
  87761. execute(evt: ActionEvent): void;
  87762. }
  87763. /**
  87764. * This defines an action responsible to set the parent property of the target once triggered.
  87765. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87766. */
  87767. export class SetParentAction extends Action {
  87768. private _parent;
  87769. private _target;
  87770. /**
  87771. * Instantiate the action
  87772. * @param triggerOptions defines the trigger options
  87773. * @param target defines the target containing the parent property
  87774. * @param parent defines from where the animation should start (animation frame)
  87775. * @param condition defines the trigger related conditions
  87776. */
  87777. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  87778. /** @hidden */
  87779. _prepare(): void;
  87780. /**
  87781. * Execute the action and set the parent property.
  87782. */
  87783. execute(): void;
  87784. /**
  87785. * Serializes the actions and its related information.
  87786. * @param parent defines the object to serialize in
  87787. * @returns the serialized object
  87788. */
  87789. serialize(parent: any): any;
  87790. }
  87791. }
  87792. declare module BABYLON {
  87793. /**
  87794. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  87795. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  87796. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  87797. */
  87798. export class ActionManager extends AbstractActionManager {
  87799. /**
  87800. * Nothing
  87801. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87802. */
  87803. static readonly NothingTrigger: number;
  87804. /**
  87805. * On pick
  87806. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87807. */
  87808. static readonly OnPickTrigger: number;
  87809. /**
  87810. * On left pick
  87811. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87812. */
  87813. static readonly OnLeftPickTrigger: number;
  87814. /**
  87815. * On right pick
  87816. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87817. */
  87818. static readonly OnRightPickTrigger: number;
  87819. /**
  87820. * On center pick
  87821. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87822. */
  87823. static readonly OnCenterPickTrigger: number;
  87824. /**
  87825. * On pick down
  87826. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87827. */
  87828. static readonly OnPickDownTrigger: number;
  87829. /**
  87830. * On double pick
  87831. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87832. */
  87833. static readonly OnDoublePickTrigger: number;
  87834. /**
  87835. * On pick up
  87836. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87837. */
  87838. static readonly OnPickUpTrigger: number;
  87839. /**
  87840. * On pick out.
  87841. * This trigger will only be raised if you also declared a OnPickDown
  87842. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87843. */
  87844. static readonly OnPickOutTrigger: number;
  87845. /**
  87846. * On long press
  87847. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87848. */
  87849. static readonly OnLongPressTrigger: number;
  87850. /**
  87851. * On pointer over
  87852. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87853. */
  87854. static readonly OnPointerOverTrigger: number;
  87855. /**
  87856. * On pointer out
  87857. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87858. */
  87859. static readonly OnPointerOutTrigger: number;
  87860. /**
  87861. * On every frame
  87862. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87863. */
  87864. static readonly OnEveryFrameTrigger: number;
  87865. /**
  87866. * On intersection enter
  87867. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87868. */
  87869. static readonly OnIntersectionEnterTrigger: number;
  87870. /**
  87871. * On intersection exit
  87872. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87873. */
  87874. static readonly OnIntersectionExitTrigger: number;
  87875. /**
  87876. * On key down
  87877. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87878. */
  87879. static readonly OnKeyDownTrigger: number;
  87880. /**
  87881. * On key up
  87882. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  87883. */
  87884. static readonly OnKeyUpTrigger: number;
  87885. private _scene;
  87886. /**
  87887. * Creates a new action manager
  87888. * @param scene defines the hosting scene
  87889. */
  87890. constructor(scene: Scene);
  87891. /**
  87892. * Releases all associated resources
  87893. */
  87894. dispose(): void;
  87895. /**
  87896. * Gets hosting scene
  87897. * @returns the hosting scene
  87898. */
  87899. getScene(): Scene;
  87900. /**
  87901. * Does this action manager handles actions of any of the given triggers
  87902. * @param triggers defines the triggers to be tested
  87903. * @return a boolean indicating whether one (or more) of the triggers is handled
  87904. */
  87905. hasSpecificTriggers(triggers: number[]): boolean;
  87906. /**
  87907. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  87908. * speed.
  87909. * @param triggerA defines the trigger to be tested
  87910. * @param triggerB defines the trigger to be tested
  87911. * @return a boolean indicating whether one (or more) of the triggers is handled
  87912. */
  87913. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  87914. /**
  87915. * Does this action manager handles actions of a given trigger
  87916. * @param trigger defines the trigger to be tested
  87917. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  87918. * @return whether the trigger is handled
  87919. */
  87920. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  87921. /**
  87922. * Does this action manager has pointer triggers
  87923. */
  87924. get hasPointerTriggers(): boolean;
  87925. /**
  87926. * Does this action manager has pick triggers
  87927. */
  87928. get hasPickTriggers(): boolean;
  87929. /**
  87930. * Registers an action to this action manager
  87931. * @param action defines the action to be registered
  87932. * @return the action amended (prepared) after registration
  87933. */
  87934. registerAction(action: IAction): Nullable<IAction>;
  87935. /**
  87936. * Unregisters an action to this action manager
  87937. * @param action defines the action to be unregistered
  87938. * @return a boolean indicating whether the action has been unregistered
  87939. */
  87940. unregisterAction(action: IAction): Boolean;
  87941. /**
  87942. * Process a specific trigger
  87943. * @param trigger defines the trigger to process
  87944. * @param evt defines the event details to be processed
  87945. */
  87946. processTrigger(trigger: number, evt?: IActionEvent): void;
  87947. /** @hidden */
  87948. _getEffectiveTarget(target: any, propertyPath: string): any;
  87949. /** @hidden */
  87950. _getProperty(propertyPath: string): string;
  87951. /**
  87952. * Serialize this manager to a JSON object
  87953. * @param name defines the property name to store this manager
  87954. * @returns a JSON representation of this manager
  87955. */
  87956. serialize(name: string): any;
  87957. /**
  87958. * Creates a new ActionManager from a JSON data
  87959. * @param parsedActions defines the JSON data to read from
  87960. * @param object defines the hosting mesh
  87961. * @param scene defines the hosting scene
  87962. */
  87963. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  87964. /**
  87965. * Get a trigger name by index
  87966. * @param trigger defines the trigger index
  87967. * @returns a trigger name
  87968. */
  87969. static GetTriggerName(trigger: number): string;
  87970. }
  87971. }
  87972. declare module BABYLON {
  87973. /**
  87974. * Class used to represent a sprite
  87975. * @see http://doc.babylonjs.com/babylon101/sprites
  87976. */
  87977. export class Sprite implements IAnimatable {
  87978. /** defines the name */
  87979. name: string;
  87980. /** Gets or sets the current world position */
  87981. position: Vector3;
  87982. /** Gets or sets the main color */
  87983. color: Color4;
  87984. /** Gets or sets the width */
  87985. width: number;
  87986. /** Gets or sets the height */
  87987. height: number;
  87988. /** Gets or sets rotation angle */
  87989. angle: number;
  87990. /** Gets or sets the cell index in the sprite sheet */
  87991. cellIndex: number;
  87992. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  87993. cellRef: string;
  87994. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  87995. invertU: boolean;
  87996. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  87997. invertV: boolean;
  87998. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  87999. disposeWhenFinishedAnimating: boolean;
  88000. /** Gets the list of attached animations */
  88001. animations: Nullable<Array<Animation>>;
  88002. /** Gets or sets a boolean indicating if the sprite can be picked */
  88003. isPickable: boolean;
  88004. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  88005. useAlphaForPicking: boolean;
  88006. /** @hidden */
  88007. _xOffset: number;
  88008. /** @hidden */
  88009. _yOffset: number;
  88010. /** @hidden */
  88011. _xSize: number;
  88012. /** @hidden */
  88013. _ySize: number;
  88014. /**
  88015. * Gets or sets the associated action manager
  88016. */
  88017. actionManager: Nullable<ActionManager>;
  88018. /**
  88019. * An event triggered when the control has been disposed
  88020. */
  88021. onDisposeObservable: Observable<Sprite>;
  88022. private _animationStarted;
  88023. private _loopAnimation;
  88024. private _fromIndex;
  88025. private _toIndex;
  88026. private _delay;
  88027. private _direction;
  88028. private _manager;
  88029. private _time;
  88030. private _onAnimationEnd;
  88031. /**
  88032. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  88033. */
  88034. isVisible: boolean;
  88035. /**
  88036. * Gets or sets the sprite size
  88037. */
  88038. get size(): number;
  88039. set size(value: number);
  88040. /**
  88041. * Returns a boolean indicating if the animation is started
  88042. */
  88043. get animationStarted(): boolean;
  88044. /**
  88045. * Gets or sets the unique id of the sprite
  88046. */
  88047. uniqueId: number;
  88048. /**
  88049. * Gets the manager of this sprite
  88050. */
  88051. get manager(): ISpriteManager;
  88052. /**
  88053. * Creates a new Sprite
  88054. * @param name defines the name
  88055. * @param manager defines the manager
  88056. */
  88057. constructor(
  88058. /** defines the name */
  88059. name: string, manager: ISpriteManager);
  88060. /**
  88061. * Returns the string "Sprite"
  88062. * @returns "Sprite"
  88063. */
  88064. getClassName(): string;
  88065. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  88066. get fromIndex(): number;
  88067. set fromIndex(value: number);
  88068. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  88069. get toIndex(): number;
  88070. set toIndex(value: number);
  88071. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  88072. get loopAnimation(): boolean;
  88073. set loopAnimation(value: boolean);
  88074. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  88075. get delay(): number;
  88076. set delay(value: number);
  88077. /**
  88078. * Starts an animation
  88079. * @param from defines the initial key
  88080. * @param to defines the end key
  88081. * @param loop defines if the animation must loop
  88082. * @param delay defines the start delay (in ms)
  88083. * @param onAnimationEnd defines a callback to call when animation ends
  88084. */
  88085. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  88086. /** Stops current animation (if any) */
  88087. stopAnimation(): void;
  88088. /** @hidden */
  88089. _animate(deltaTime: number): void;
  88090. /** Release associated resources */
  88091. dispose(): void;
  88092. /**
  88093. * Serializes the sprite to a JSON object
  88094. * @returns the JSON object
  88095. */
  88096. serialize(): any;
  88097. /**
  88098. * Parses a JSON object to create a new sprite
  88099. * @param parsedSprite The JSON object to parse
  88100. * @param manager defines the hosting manager
  88101. * @returns the new sprite
  88102. */
  88103. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  88104. }
  88105. }
  88106. declare module BABYLON {
  88107. /**
  88108. * Information about the result of picking within a scene
  88109. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  88110. */
  88111. export class PickingInfo {
  88112. /** @hidden */
  88113. _pickingUnavailable: boolean;
  88114. /**
  88115. * If the pick collided with an object
  88116. */
  88117. hit: boolean;
  88118. /**
  88119. * Distance away where the pick collided
  88120. */
  88121. distance: number;
  88122. /**
  88123. * The location of pick collision
  88124. */
  88125. pickedPoint: Nullable<Vector3>;
  88126. /**
  88127. * The mesh corresponding the the pick collision
  88128. */
  88129. pickedMesh: Nullable<AbstractMesh>;
  88130. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  88131. bu: number;
  88132. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  88133. bv: number;
  88134. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  88135. faceId: number;
  88136. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  88137. subMeshFaceId: number;
  88138. /** Id of the the submesh that was picked */
  88139. subMeshId: number;
  88140. /** If a sprite was picked, this will be the sprite the pick collided with */
  88141. pickedSprite: Nullable<Sprite>;
  88142. /**
  88143. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  88144. */
  88145. originMesh: Nullable<AbstractMesh>;
  88146. /**
  88147. * The ray that was used to perform the picking.
  88148. */
  88149. ray: Nullable<Ray>;
  88150. /**
  88151. * Gets the normal correspodning to the face the pick collided with
  88152. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  88153. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  88154. * @returns The normal correspodning to the face the pick collided with
  88155. */
  88156. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  88157. /**
  88158. * Gets the texture coordinates of where the pick occured
  88159. * @returns the vector containing the coordnates of the texture
  88160. */
  88161. getTextureCoordinates(): Nullable<Vector2>;
  88162. }
  88163. }
  88164. declare module BABYLON {
  88165. /**
  88166. * Class representing a ray with position and direction
  88167. */
  88168. export class Ray {
  88169. /** origin point */
  88170. origin: Vector3;
  88171. /** direction */
  88172. direction: Vector3;
  88173. /** length of the ray */
  88174. length: number;
  88175. private static readonly TmpVector3;
  88176. private _tmpRay;
  88177. /**
  88178. * Creates a new ray
  88179. * @param origin origin point
  88180. * @param direction direction
  88181. * @param length length of the ray
  88182. */
  88183. constructor(
  88184. /** origin point */
  88185. origin: Vector3,
  88186. /** direction */
  88187. direction: Vector3,
  88188. /** length of the ray */
  88189. length?: number);
  88190. /**
  88191. * Checks if the ray intersects a box
  88192. * This does not account for the ray lenght by design to improve perfs.
  88193. * @param minimum bound of the box
  88194. * @param maximum bound of the box
  88195. * @param intersectionTreshold extra extend to be added to the box in all direction
  88196. * @returns if the box was hit
  88197. */
  88198. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  88199. /**
  88200. * Checks if the ray intersects a box
  88201. * This does not account for the ray lenght by design to improve perfs.
  88202. * @param box the bounding box to check
  88203. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  88204. * @returns if the box was hit
  88205. */
  88206. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  88207. /**
  88208. * If the ray hits a sphere
  88209. * @param sphere the bounding sphere to check
  88210. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  88211. * @returns true if it hits the sphere
  88212. */
  88213. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  88214. /**
  88215. * If the ray hits a triange
  88216. * @param vertex0 triangle vertex
  88217. * @param vertex1 triangle vertex
  88218. * @param vertex2 triangle vertex
  88219. * @returns intersection information if hit
  88220. */
  88221. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  88222. /**
  88223. * Checks if ray intersects a plane
  88224. * @param plane the plane to check
  88225. * @returns the distance away it was hit
  88226. */
  88227. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  88228. /**
  88229. * Calculate the intercept of a ray on a given axis
  88230. * @param axis to check 'x' | 'y' | 'z'
  88231. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  88232. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  88233. */
  88234. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  88235. /**
  88236. * Checks if ray intersects a mesh
  88237. * @param mesh the mesh to check
  88238. * @param fastCheck defines if the first intersection will be used (and not the closest)
  88239. * @returns picking info of the intersecton
  88240. */
  88241. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  88242. /**
  88243. * Checks if ray intersects a mesh
  88244. * @param meshes the meshes to check
  88245. * @param fastCheck defines if the first intersection will be used (and not the closest)
  88246. * @param results array to store result in
  88247. * @returns Array of picking infos
  88248. */
  88249. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  88250. private _comparePickingInfo;
  88251. private static smallnum;
  88252. private static rayl;
  88253. /**
  88254. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  88255. * @param sega the first point of the segment to test the intersection against
  88256. * @param segb the second point of the segment to test the intersection against
  88257. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  88258. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  88259. */
  88260. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  88261. /**
  88262. * Update the ray from viewport position
  88263. * @param x position
  88264. * @param y y position
  88265. * @param viewportWidth viewport width
  88266. * @param viewportHeight viewport height
  88267. * @param world world matrix
  88268. * @param view view matrix
  88269. * @param projection projection matrix
  88270. * @returns this ray updated
  88271. */
  88272. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  88273. /**
  88274. * Creates a ray with origin and direction of 0,0,0
  88275. * @returns the new ray
  88276. */
  88277. static Zero(): Ray;
  88278. /**
  88279. * Creates a new ray from screen space and viewport
  88280. * @param x position
  88281. * @param y y position
  88282. * @param viewportWidth viewport width
  88283. * @param viewportHeight viewport height
  88284. * @param world world matrix
  88285. * @param view view matrix
  88286. * @param projection projection matrix
  88287. * @returns new ray
  88288. */
  88289. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  88290. /**
  88291. * 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
  88292. * transformed to the given world matrix.
  88293. * @param origin The origin point
  88294. * @param end The end point
  88295. * @param world a matrix to transform the ray to. Default is the identity matrix.
  88296. * @returns the new ray
  88297. */
  88298. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  88299. /**
  88300. * Transforms a ray by a matrix
  88301. * @param ray ray to transform
  88302. * @param matrix matrix to apply
  88303. * @returns the resulting new ray
  88304. */
  88305. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  88306. /**
  88307. * Transforms a ray by a matrix
  88308. * @param ray ray to transform
  88309. * @param matrix matrix to apply
  88310. * @param result ray to store result in
  88311. */
  88312. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  88313. /**
  88314. * Unproject a ray from screen space to object space
  88315. * @param sourceX defines the screen space x coordinate to use
  88316. * @param sourceY defines the screen space y coordinate to use
  88317. * @param viewportWidth defines the current width of the viewport
  88318. * @param viewportHeight defines the current height of the viewport
  88319. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  88320. * @param view defines the view matrix to use
  88321. * @param projection defines the projection matrix to use
  88322. */
  88323. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  88324. }
  88325. /**
  88326. * Type used to define predicate used to select faces when a mesh intersection is detected
  88327. */
  88328. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  88329. interface Scene {
  88330. /** @hidden */
  88331. _tempPickingRay: Nullable<Ray>;
  88332. /** @hidden */
  88333. _cachedRayForTransform: Ray;
  88334. /** @hidden */
  88335. _pickWithRayInverseMatrix: Matrix;
  88336. /** @hidden */
  88337. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  88338. /** @hidden */
  88339. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  88340. }
  88341. }
  88342. declare module BABYLON {
  88343. /**
  88344. * Groups all the scene component constants in one place to ease maintenance.
  88345. * @hidden
  88346. */
  88347. export class SceneComponentConstants {
  88348. static readonly NAME_EFFECTLAYER: string;
  88349. static readonly NAME_LAYER: string;
  88350. static readonly NAME_LENSFLARESYSTEM: string;
  88351. static readonly NAME_BOUNDINGBOXRENDERER: string;
  88352. static readonly NAME_PARTICLESYSTEM: string;
  88353. static readonly NAME_GAMEPAD: string;
  88354. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  88355. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  88356. static readonly NAME_DEPTHRENDERER: string;
  88357. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  88358. static readonly NAME_SPRITE: string;
  88359. static readonly NAME_OUTLINERENDERER: string;
  88360. static readonly NAME_PROCEDURALTEXTURE: string;
  88361. static readonly NAME_SHADOWGENERATOR: string;
  88362. static readonly NAME_OCTREE: string;
  88363. static readonly NAME_PHYSICSENGINE: string;
  88364. static readonly NAME_AUDIO: string;
  88365. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  88366. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  88367. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  88368. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  88369. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  88370. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  88371. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  88372. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  88373. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  88374. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  88375. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  88376. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  88377. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  88378. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  88379. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  88380. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  88381. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  88382. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  88383. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  88384. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  88385. static readonly STEP_AFTERRENDER_AUDIO: number;
  88386. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  88387. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  88388. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  88389. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  88390. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  88391. static readonly STEP_POINTERMOVE_SPRITE: number;
  88392. static readonly STEP_POINTERDOWN_SPRITE: number;
  88393. static readonly STEP_POINTERUP_SPRITE: number;
  88394. }
  88395. /**
  88396. * This represents a scene component.
  88397. *
  88398. * This is used to decouple the dependency the scene is having on the different workloads like
  88399. * layers, post processes...
  88400. */
  88401. export interface ISceneComponent {
  88402. /**
  88403. * The name of the component. Each component must have a unique name.
  88404. */
  88405. name: string;
  88406. /**
  88407. * The scene the component belongs to.
  88408. */
  88409. scene: Scene;
  88410. /**
  88411. * Register the component to one instance of a scene.
  88412. */
  88413. register(): void;
  88414. /**
  88415. * Rebuilds the elements related to this component in case of
  88416. * context lost for instance.
  88417. */
  88418. rebuild(): void;
  88419. /**
  88420. * Disposes the component and the associated ressources.
  88421. */
  88422. dispose(): void;
  88423. }
  88424. /**
  88425. * This represents a SERIALIZABLE scene component.
  88426. *
  88427. * This extends Scene Component to add Serialization methods on top.
  88428. */
  88429. export interface ISceneSerializableComponent extends ISceneComponent {
  88430. /**
  88431. * Adds all the elements from the container to the scene
  88432. * @param container the container holding the elements
  88433. */
  88434. addFromContainer(container: AbstractScene): void;
  88435. /**
  88436. * Removes all the elements in the container from the scene
  88437. * @param container contains the elements to remove
  88438. * @param dispose if the removed element should be disposed (default: false)
  88439. */
  88440. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  88441. /**
  88442. * Serializes the component data to the specified json object
  88443. * @param serializationObject The object to serialize to
  88444. */
  88445. serialize(serializationObject: any): void;
  88446. }
  88447. /**
  88448. * Strong typing of a Mesh related stage step action
  88449. */
  88450. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  88451. /**
  88452. * Strong typing of a Evaluate Sub Mesh related stage step action
  88453. */
  88454. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  88455. /**
  88456. * Strong typing of a Active Mesh related stage step action
  88457. */
  88458. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  88459. /**
  88460. * Strong typing of a Camera related stage step action
  88461. */
  88462. export type CameraStageAction = (camera: Camera) => void;
  88463. /**
  88464. * Strong typing of a Camera Frame buffer related stage step action
  88465. */
  88466. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  88467. /**
  88468. * Strong typing of a Render Target related stage step action
  88469. */
  88470. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  88471. /**
  88472. * Strong typing of a RenderingGroup related stage step action
  88473. */
  88474. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  88475. /**
  88476. * Strong typing of a Mesh Render related stage step action
  88477. */
  88478. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  88479. /**
  88480. * Strong typing of a simple stage step action
  88481. */
  88482. export type SimpleStageAction = () => void;
  88483. /**
  88484. * Strong typing of a render target action.
  88485. */
  88486. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  88487. /**
  88488. * Strong typing of a pointer move action.
  88489. */
  88490. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  88491. /**
  88492. * Strong typing of a pointer up/down action.
  88493. */
  88494. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  88495. /**
  88496. * Representation of a stage in the scene (Basically a list of ordered steps)
  88497. * @hidden
  88498. */
  88499. export class Stage<T extends Function> extends Array<{
  88500. index: number;
  88501. component: ISceneComponent;
  88502. action: T;
  88503. }> {
  88504. /**
  88505. * Hide ctor from the rest of the world.
  88506. * @param items The items to add.
  88507. */
  88508. private constructor();
  88509. /**
  88510. * Creates a new Stage.
  88511. * @returns A new instance of a Stage
  88512. */
  88513. static Create<T extends Function>(): Stage<T>;
  88514. /**
  88515. * Registers a step in an ordered way in the targeted stage.
  88516. * @param index Defines the position to register the step in
  88517. * @param component Defines the component attached to the step
  88518. * @param action Defines the action to launch during the step
  88519. */
  88520. registerStep(index: number, component: ISceneComponent, action: T): void;
  88521. /**
  88522. * Clears all the steps from the stage.
  88523. */
  88524. clear(): void;
  88525. }
  88526. }
  88527. declare module BABYLON {
  88528. interface Scene {
  88529. /** @hidden */
  88530. _pointerOverSprite: Nullable<Sprite>;
  88531. /** @hidden */
  88532. _pickedDownSprite: Nullable<Sprite>;
  88533. /** @hidden */
  88534. _tempSpritePickingRay: Nullable<Ray>;
  88535. /**
  88536. * All of the sprite managers added to this scene
  88537. * @see http://doc.babylonjs.com/babylon101/sprites
  88538. */
  88539. spriteManagers: Array<ISpriteManager>;
  88540. /**
  88541. * An event triggered when sprites rendering is about to start
  88542. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  88543. */
  88544. onBeforeSpritesRenderingObservable: Observable<Scene>;
  88545. /**
  88546. * An event triggered when sprites rendering is done
  88547. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  88548. */
  88549. onAfterSpritesRenderingObservable: Observable<Scene>;
  88550. /** @hidden */
  88551. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  88552. /** Launch a ray to try to pick a sprite in the scene
  88553. * @param x position on screen
  88554. * @param y position on screen
  88555. * @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
  88556. * @param fastCheck defines if the first intersection will be used (and not the closest)
  88557. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  88558. * @returns a PickingInfo
  88559. */
  88560. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  88561. /** Use the given ray to pick a sprite in the scene
  88562. * @param ray The ray (in world space) to use to pick meshes
  88563. * @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
  88564. * @param fastCheck defines if the first intersection will be used (and not the closest)
  88565. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  88566. * @returns a PickingInfo
  88567. */
  88568. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  88569. /** @hidden */
  88570. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  88571. /** Launch a ray to try to pick sprites in the scene
  88572. * @param x position on screen
  88573. * @param y position on screen
  88574. * @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
  88575. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  88576. * @returns a PickingInfo array
  88577. */
  88578. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  88579. /** Use the given ray to pick sprites in the scene
  88580. * @param ray The ray (in world space) to use to pick meshes
  88581. * @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
  88582. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  88583. * @returns a PickingInfo array
  88584. */
  88585. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  88586. /**
  88587. * Force the sprite under the pointer
  88588. * @param sprite defines the sprite to use
  88589. */
  88590. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  88591. /**
  88592. * Gets the sprite under the pointer
  88593. * @returns a Sprite or null if no sprite is under the pointer
  88594. */
  88595. getPointerOverSprite(): Nullable<Sprite>;
  88596. }
  88597. /**
  88598. * Defines the sprite scene component responsible to manage sprites
  88599. * in a given scene.
  88600. */
  88601. export class SpriteSceneComponent implements ISceneComponent {
  88602. /**
  88603. * The component name helpfull to identify the component in the list of scene components.
  88604. */
  88605. readonly name: string;
  88606. /**
  88607. * The scene the component belongs to.
  88608. */
  88609. scene: Scene;
  88610. /** @hidden */
  88611. private _spritePredicate;
  88612. /**
  88613. * Creates a new instance of the component for the given scene
  88614. * @param scene Defines the scene to register the component in
  88615. */
  88616. constructor(scene: Scene);
  88617. /**
  88618. * Registers the component in a given scene
  88619. */
  88620. register(): void;
  88621. /**
  88622. * Rebuilds the elements related to this component in case of
  88623. * context lost for instance.
  88624. */
  88625. rebuild(): void;
  88626. /**
  88627. * Disposes the component and the associated ressources.
  88628. */
  88629. dispose(): void;
  88630. private _pickSpriteButKeepRay;
  88631. private _pointerMove;
  88632. private _pointerDown;
  88633. private _pointerUp;
  88634. }
  88635. }
  88636. declare module BABYLON {
  88637. /** @hidden */
  88638. export var fogFragmentDeclaration: {
  88639. name: string;
  88640. shader: string;
  88641. };
  88642. }
  88643. declare module BABYLON {
  88644. /** @hidden */
  88645. export var fogFragment: {
  88646. name: string;
  88647. shader: string;
  88648. };
  88649. }
  88650. declare module BABYLON {
  88651. /** @hidden */
  88652. export var spritesPixelShader: {
  88653. name: string;
  88654. shader: string;
  88655. };
  88656. }
  88657. declare module BABYLON {
  88658. /** @hidden */
  88659. export var fogVertexDeclaration: {
  88660. name: string;
  88661. shader: string;
  88662. };
  88663. }
  88664. declare module BABYLON {
  88665. /** @hidden */
  88666. export var spritesVertexShader: {
  88667. name: string;
  88668. shader: string;
  88669. };
  88670. }
  88671. declare module BABYLON {
  88672. /**
  88673. * Defines the minimum interface to fullfil in order to be a sprite manager.
  88674. */
  88675. export interface ISpriteManager extends IDisposable {
  88676. /**
  88677. * Gets manager's name
  88678. */
  88679. name: string;
  88680. /**
  88681. * Restricts the camera to viewing objects with the same layerMask.
  88682. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  88683. */
  88684. layerMask: number;
  88685. /**
  88686. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  88687. */
  88688. isPickable: boolean;
  88689. /**
  88690. * Gets the hosting scene
  88691. */
  88692. scene: Scene;
  88693. /**
  88694. * Specifies the rendering group id for this mesh (0 by default)
  88695. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  88696. */
  88697. renderingGroupId: number;
  88698. /**
  88699. * Defines the list of sprites managed by the manager.
  88700. */
  88701. sprites: Array<Sprite>;
  88702. /**
  88703. * Gets or sets the spritesheet texture
  88704. */
  88705. texture: Texture;
  88706. /** Defines the default width of a cell in the spritesheet */
  88707. cellWidth: number;
  88708. /** Defines the default height of a cell in the spritesheet */
  88709. cellHeight: number;
  88710. /**
  88711. * Tests the intersection of a sprite with a specific ray.
  88712. * @param ray The ray we are sending to test the collision
  88713. * @param camera The camera space we are sending rays in
  88714. * @param predicate A predicate allowing excluding sprites from the list of object to test
  88715. * @param fastCheck defines if the first intersection will be used (and not the closest)
  88716. * @returns picking info or null.
  88717. */
  88718. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  88719. /**
  88720. * Intersects the sprites with a ray
  88721. * @param ray defines the ray to intersect with
  88722. * @param camera defines the current active camera
  88723. * @param predicate defines a predicate used to select candidate sprites
  88724. * @returns null if no hit or a PickingInfo array
  88725. */
  88726. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  88727. /**
  88728. * Renders the list of sprites on screen.
  88729. */
  88730. render(): void;
  88731. }
  88732. /**
  88733. * Class used to manage multiple sprites on the same spritesheet
  88734. * @see http://doc.babylonjs.com/babylon101/sprites
  88735. */
  88736. export class SpriteManager implements ISpriteManager {
  88737. /** defines the manager's name */
  88738. name: string;
  88739. /** Define the Url to load snippets */
  88740. static SnippetUrl: string;
  88741. /** Snippet ID if the manager was created from the snippet server */
  88742. snippetId: string;
  88743. /** Gets the list of sprites */
  88744. sprites: Sprite[];
  88745. /** Gets or sets the rendering group id (0 by default) */
  88746. renderingGroupId: number;
  88747. /** Gets or sets camera layer mask */
  88748. layerMask: number;
  88749. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  88750. fogEnabled: boolean;
  88751. /** Gets or sets a boolean indicating if the sprites are pickable */
  88752. isPickable: boolean;
  88753. /** Defines the default width of a cell in the spritesheet */
  88754. cellWidth: number;
  88755. /** Defines the default height of a cell in the spritesheet */
  88756. cellHeight: number;
  88757. /** Associative array from JSON sprite data file */
  88758. private _cellData;
  88759. /** Array of sprite names from JSON sprite data file */
  88760. private _spriteMap;
  88761. /** True when packed cell data from JSON file is ready*/
  88762. private _packedAndReady;
  88763. private _textureContent;
  88764. /**
  88765. * An event triggered when the manager is disposed.
  88766. */
  88767. onDisposeObservable: Observable<SpriteManager>;
  88768. private _onDisposeObserver;
  88769. /**
  88770. * Callback called when the manager is disposed
  88771. */
  88772. set onDispose(callback: () => void);
  88773. private _capacity;
  88774. private _fromPacked;
  88775. private _spriteTexture;
  88776. private _epsilon;
  88777. private _scene;
  88778. private _vertexData;
  88779. private _buffer;
  88780. private _vertexBuffers;
  88781. private _indexBuffer;
  88782. private _effectBase;
  88783. private _effectFog;
  88784. /**
  88785. * Gets or sets the unique id of the sprite
  88786. */
  88787. uniqueId: number;
  88788. /**
  88789. * Gets the array of sprites
  88790. */
  88791. get children(): Sprite[];
  88792. /**
  88793. * Gets the hosting scene
  88794. */
  88795. get scene(): Scene;
  88796. /**
  88797. * Gets the capacity of the manager
  88798. */
  88799. get capacity(): number;
  88800. /**
  88801. * Gets or sets the spritesheet texture
  88802. */
  88803. get texture(): Texture;
  88804. set texture(value: Texture);
  88805. private _blendMode;
  88806. /**
  88807. * Blend mode use to render the particle, it can be any of
  88808. * the static Constants.ALPHA_x properties provided in this class.
  88809. * Default value is Constants.ALPHA_COMBINE
  88810. */
  88811. get blendMode(): number;
  88812. set blendMode(blendMode: number);
  88813. /** Disables writing to the depth buffer when rendering the sprites.
  88814. * It can be handy to disable depth writing when using textures without alpha channel
  88815. * and setting some specific blend modes.
  88816. */
  88817. disableDepthWrite: boolean;
  88818. /**
  88819. * Creates a new sprite manager
  88820. * @param name defines the manager's name
  88821. * @param imgUrl defines the sprite sheet url
  88822. * @param capacity defines the maximum allowed number of sprites
  88823. * @param cellSize defines the size of a sprite cell
  88824. * @param scene defines the hosting scene
  88825. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  88826. * @param samplingMode defines the smapling mode to use with spritesheet
  88827. * @param fromPacked set to false; do not alter
  88828. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  88829. */
  88830. constructor(
  88831. /** defines the manager's name */
  88832. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  88833. /**
  88834. * Returns the string "SpriteManager"
  88835. * @returns "SpriteManager"
  88836. */
  88837. getClassName(): string;
  88838. private _makePacked;
  88839. private _appendSpriteVertex;
  88840. private _checkTextureAlpha;
  88841. /**
  88842. * Intersects the sprites with a ray
  88843. * @param ray defines the ray to intersect with
  88844. * @param camera defines the current active camera
  88845. * @param predicate defines a predicate used to select candidate sprites
  88846. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  88847. * @returns null if no hit or a PickingInfo
  88848. */
  88849. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  88850. /**
  88851. * Intersects the sprites with a ray
  88852. * @param ray defines the ray to intersect with
  88853. * @param camera defines the current active camera
  88854. * @param predicate defines a predicate used to select candidate sprites
  88855. * @returns null if no hit or a PickingInfo array
  88856. */
  88857. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  88858. /**
  88859. * Render all child sprites
  88860. */
  88861. render(): void;
  88862. /**
  88863. * Release associated resources
  88864. */
  88865. dispose(): void;
  88866. /**
  88867. * Serializes the sprite manager to a JSON object
  88868. * @param serializeTexture defines if the texture must be serialized as well
  88869. * @returns the JSON object
  88870. */
  88871. serialize(serializeTexture?: boolean): any;
  88872. /**
  88873. * Parses a JSON object to create a new sprite manager.
  88874. * @param parsedManager The JSON object to parse
  88875. * @param scene The scene to create the sprite managerin
  88876. * @param rootUrl The root url to use to load external dependencies like texture
  88877. * @returns the new sprite manager
  88878. */
  88879. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  88880. /**
  88881. * Creates a sprite manager from a snippet saved in a remote file
  88882. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  88883. * @param url defines the url to load from
  88884. * @param scene defines the hosting scene
  88885. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  88886. * @returns a promise that will resolve to the new sprite manager
  88887. */
  88888. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  88889. /**
  88890. * Creates a sprite manager from a snippet saved by the sprite editor
  88891. * @param snippetId defines the snippet to load
  88892. * @param scene defines the hosting scene
  88893. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  88894. * @returns a promise that will resolve to the new sprite manager
  88895. */
  88896. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  88897. }
  88898. }
  88899. declare module BABYLON {
  88900. /** Interface used by value gradients (color, factor, ...) */
  88901. export interface IValueGradient {
  88902. /**
  88903. * Gets or sets the gradient value (between 0 and 1)
  88904. */
  88905. gradient: number;
  88906. }
  88907. /** Class used to store color4 gradient */
  88908. export class ColorGradient implements IValueGradient {
  88909. /**
  88910. * Gets or sets the gradient value (between 0 and 1)
  88911. */
  88912. gradient: number;
  88913. /**
  88914. * Gets or sets first associated color
  88915. */
  88916. color1: Color4;
  88917. /**
  88918. * Gets or sets second associated color
  88919. */
  88920. color2?: Color4 | undefined;
  88921. /**
  88922. * Creates a new color4 gradient
  88923. * @param gradient gets or sets the gradient value (between 0 and 1)
  88924. * @param color1 gets or sets first associated color
  88925. * @param color2 gets or sets first second color
  88926. */
  88927. constructor(
  88928. /**
  88929. * Gets or sets the gradient value (between 0 and 1)
  88930. */
  88931. gradient: number,
  88932. /**
  88933. * Gets or sets first associated color
  88934. */
  88935. color1: Color4,
  88936. /**
  88937. * Gets or sets second associated color
  88938. */
  88939. color2?: Color4 | undefined);
  88940. /**
  88941. * Will get a color picked randomly between color1 and color2.
  88942. * If color2 is undefined then color1 will be used
  88943. * @param result defines the target Color4 to store the result in
  88944. */
  88945. getColorToRef(result: Color4): void;
  88946. }
  88947. /** Class used to store color 3 gradient */
  88948. export class Color3Gradient implements IValueGradient {
  88949. /**
  88950. * Gets or sets the gradient value (between 0 and 1)
  88951. */
  88952. gradient: number;
  88953. /**
  88954. * Gets or sets the associated color
  88955. */
  88956. color: Color3;
  88957. /**
  88958. * Creates a new color3 gradient
  88959. * @param gradient gets or sets the gradient value (between 0 and 1)
  88960. * @param color gets or sets associated color
  88961. */
  88962. constructor(
  88963. /**
  88964. * Gets or sets the gradient value (between 0 and 1)
  88965. */
  88966. gradient: number,
  88967. /**
  88968. * Gets or sets the associated color
  88969. */
  88970. color: Color3);
  88971. }
  88972. /** Class used to store factor gradient */
  88973. export class FactorGradient implements IValueGradient {
  88974. /**
  88975. * Gets or sets the gradient value (between 0 and 1)
  88976. */
  88977. gradient: number;
  88978. /**
  88979. * Gets or sets first associated factor
  88980. */
  88981. factor1: number;
  88982. /**
  88983. * Gets or sets second associated factor
  88984. */
  88985. factor2?: number | undefined;
  88986. /**
  88987. * Creates a new factor gradient
  88988. * @param gradient gets or sets the gradient value (between 0 and 1)
  88989. * @param factor1 gets or sets first associated factor
  88990. * @param factor2 gets or sets second associated factor
  88991. */
  88992. constructor(
  88993. /**
  88994. * Gets or sets the gradient value (between 0 and 1)
  88995. */
  88996. gradient: number,
  88997. /**
  88998. * Gets or sets first associated factor
  88999. */
  89000. factor1: number,
  89001. /**
  89002. * Gets or sets second associated factor
  89003. */
  89004. factor2?: number | undefined);
  89005. /**
  89006. * Will get a number picked randomly between factor1 and factor2.
  89007. * If factor2 is undefined then factor1 will be used
  89008. * @returns the picked number
  89009. */
  89010. getFactor(): number;
  89011. }
  89012. /**
  89013. * Helper used to simplify some generic gradient tasks
  89014. */
  89015. export class GradientHelper {
  89016. /**
  89017. * Gets the current gradient from an array of IValueGradient
  89018. * @param ratio defines the current ratio to get
  89019. * @param gradients defines the array of IValueGradient
  89020. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  89021. */
  89022. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  89023. }
  89024. }
  89025. declare module BABYLON {
  89026. interface ThinEngine {
  89027. /**
  89028. * Creates a raw texture
  89029. * @param data defines the data to store in the texture
  89030. * @param width defines the width of the texture
  89031. * @param height defines the height of the texture
  89032. * @param format defines the format of the data
  89033. * @param generateMipMaps defines if the engine should generate the mip levels
  89034. * @param invertY defines if data must be stored with Y axis inverted
  89035. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  89036. * @param compression defines the compression used (null by default)
  89037. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89038. * @returns the raw texture inside an InternalTexture
  89039. */
  89040. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  89041. /**
  89042. * Update a raw texture
  89043. * @param texture defines the texture to update
  89044. * @param data defines the data to store in the texture
  89045. * @param format defines the format of the data
  89046. * @param invertY defines if data must be stored with Y axis inverted
  89047. */
  89048. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  89049. /**
  89050. * Update a raw texture
  89051. * @param texture defines the texture to update
  89052. * @param data defines the data to store in the texture
  89053. * @param format defines the format of the data
  89054. * @param invertY defines if data must be stored with Y axis inverted
  89055. * @param compression defines the compression used (null by default)
  89056. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89057. */
  89058. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  89059. /**
  89060. * Creates a new raw cube texture
  89061. * @param data defines the array of data to use to create each face
  89062. * @param size defines the size of the textures
  89063. * @param format defines the format of the data
  89064. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  89065. * @param generateMipMaps defines if the engine should generate the mip levels
  89066. * @param invertY defines if data must be stored with Y axis inverted
  89067. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  89068. * @param compression defines the compression used (null by default)
  89069. * @returns the cube texture as an InternalTexture
  89070. */
  89071. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  89072. /**
  89073. * Update a raw cube texture
  89074. * @param texture defines the texture to udpdate
  89075. * @param data defines the data to store
  89076. * @param format defines the data format
  89077. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89078. * @param invertY defines if data must be stored with Y axis inverted
  89079. */
  89080. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  89081. /**
  89082. * Update a raw cube texture
  89083. * @param texture defines the texture to udpdate
  89084. * @param data defines the data to store
  89085. * @param format defines the data format
  89086. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89087. * @param invertY defines if data must be stored with Y axis inverted
  89088. * @param compression defines the compression used (null by default)
  89089. */
  89090. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  89091. /**
  89092. * Update a raw cube texture
  89093. * @param texture defines the texture to udpdate
  89094. * @param data defines the data to store
  89095. * @param format defines the data format
  89096. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89097. * @param invertY defines if data must be stored with Y axis inverted
  89098. * @param compression defines the compression used (null by default)
  89099. * @param level defines which level of the texture to update
  89100. */
  89101. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  89102. /**
  89103. * Creates a new raw cube texture from a specified url
  89104. * @param url defines the url where the data is located
  89105. * @param scene defines the current scene
  89106. * @param size defines the size of the textures
  89107. * @param format defines the format of the data
  89108. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  89109. * @param noMipmap defines if the engine should avoid generating the mip levels
  89110. * @param callback defines a callback used to extract texture data from loaded data
  89111. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  89112. * @param onLoad defines a callback called when texture is loaded
  89113. * @param onError defines a callback called if there is an error
  89114. * @returns the cube texture as an InternalTexture
  89115. */
  89116. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  89117. /**
  89118. * Creates a new raw cube texture from a specified url
  89119. * @param url defines the url where the data is located
  89120. * @param scene defines the current scene
  89121. * @param size defines the size of the textures
  89122. * @param format defines the format of the data
  89123. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  89124. * @param noMipmap defines if the engine should avoid generating the mip levels
  89125. * @param callback defines a callback used to extract texture data from loaded data
  89126. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  89127. * @param onLoad defines a callback called when texture is loaded
  89128. * @param onError defines a callback called if there is an error
  89129. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  89130. * @param invertY defines if data must be stored with Y axis inverted
  89131. * @returns the cube texture as an InternalTexture
  89132. */
  89133. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  89134. /**
  89135. * Creates a new raw 3D texture
  89136. * @param data defines the data used to create the texture
  89137. * @param width defines the width of the texture
  89138. * @param height defines the height of the texture
  89139. * @param depth defines the depth of the texture
  89140. * @param format defines the format of the texture
  89141. * @param generateMipMaps defines if the engine must generate mip levels
  89142. * @param invertY defines if data must be stored with Y axis inverted
  89143. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  89144. * @param compression defines the compressed used (can be null)
  89145. * @param textureType defines the compressed used (can be null)
  89146. * @returns a new raw 3D texture (stored in an InternalTexture)
  89147. */
  89148. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  89149. /**
  89150. * Update a raw 3D texture
  89151. * @param texture defines the texture to update
  89152. * @param data defines the data to store
  89153. * @param format defines the data format
  89154. * @param invertY defines if data must be stored with Y axis inverted
  89155. */
  89156. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  89157. /**
  89158. * Update a raw 3D texture
  89159. * @param texture defines the texture to update
  89160. * @param data defines the data to store
  89161. * @param format defines the data format
  89162. * @param invertY defines if data must be stored with Y axis inverted
  89163. * @param compression defines the used compression (can be null)
  89164. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  89165. */
  89166. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  89167. /**
  89168. * Creates a new raw 2D array texture
  89169. * @param data defines the data used to create the texture
  89170. * @param width defines the width of the texture
  89171. * @param height defines the height of the texture
  89172. * @param depth defines the number of layers of the texture
  89173. * @param format defines the format of the texture
  89174. * @param generateMipMaps defines if the engine must generate mip levels
  89175. * @param invertY defines if data must be stored with Y axis inverted
  89176. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  89177. * @param compression defines the compressed used (can be null)
  89178. * @param textureType defines the compressed used (can be null)
  89179. * @returns a new raw 2D array texture (stored in an InternalTexture)
  89180. */
  89181. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  89182. /**
  89183. * Update a raw 2D array texture
  89184. * @param texture defines the texture to update
  89185. * @param data defines the data to store
  89186. * @param format defines the data format
  89187. * @param invertY defines if data must be stored with Y axis inverted
  89188. */
  89189. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  89190. /**
  89191. * Update a raw 2D array texture
  89192. * @param texture defines the texture to update
  89193. * @param data defines the data to store
  89194. * @param format defines the data format
  89195. * @param invertY defines if data must be stored with Y axis inverted
  89196. * @param compression defines the used compression (can be null)
  89197. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  89198. */
  89199. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  89200. }
  89201. }
  89202. declare module BABYLON {
  89203. /**
  89204. * Raw texture can help creating a texture directly from an array of data.
  89205. * This can be super useful if you either get the data from an uncompressed source or
  89206. * if you wish to create your texture pixel by pixel.
  89207. */
  89208. export class RawTexture extends Texture {
  89209. /**
  89210. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  89211. */
  89212. format: number;
  89213. /**
  89214. * Instantiates a new RawTexture.
  89215. * Raw texture can help creating a texture directly from an array of data.
  89216. * This can be super useful if you either get the data from an uncompressed source or
  89217. * if you wish to create your texture pixel by pixel.
  89218. * @param data define the array of data to use to create the texture
  89219. * @param width define the width of the texture
  89220. * @param height define the height of the texture
  89221. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  89222. * @param scene define the scene the texture belongs to
  89223. * @param generateMipMaps define whether mip maps should be generated or not
  89224. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  89225. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  89226. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  89227. */
  89228. constructor(data: ArrayBufferView, width: number, height: number,
  89229. /**
  89230. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  89231. */
  89232. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  89233. /**
  89234. * Updates the texture underlying data.
  89235. * @param data Define the new data of the texture
  89236. */
  89237. update(data: ArrayBufferView): void;
  89238. /**
  89239. * Creates a luminance texture from some data.
  89240. * @param data Define the texture data
  89241. * @param width Define the width of the texture
  89242. * @param height Define the height of the texture
  89243. * @param scene Define the scene the texture belongs to
  89244. * @param generateMipMaps Define whether or not to create mip maps for the texture
  89245. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  89246. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  89247. * @returns the luminance texture
  89248. */
  89249. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  89250. /**
  89251. * Creates a luminance alpha texture from some data.
  89252. * @param data Define the texture data
  89253. * @param width Define the width of the texture
  89254. * @param height Define the height of the texture
  89255. * @param scene Define the scene the texture belongs to
  89256. * @param generateMipMaps Define whether or not to create mip maps for the texture
  89257. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  89258. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  89259. * @returns the luminance alpha texture
  89260. */
  89261. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  89262. /**
  89263. * Creates an alpha texture from some data.
  89264. * @param data Define the texture data
  89265. * @param width Define the width of the texture
  89266. * @param height Define the height of the texture
  89267. * @param scene Define the scene the texture belongs to
  89268. * @param generateMipMaps Define whether or not to create mip maps for the texture
  89269. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  89270. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  89271. * @returns the alpha texture
  89272. */
  89273. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  89274. /**
  89275. * Creates a RGB texture from some data.
  89276. * @param data Define the texture data
  89277. * @param width Define the width of the texture
  89278. * @param height Define the height of the texture
  89279. * @param scene Define the scene the texture belongs to
  89280. * @param generateMipMaps Define whether or not to create mip maps for the texture
  89281. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  89282. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  89283. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  89284. * @returns the RGB alpha texture
  89285. */
  89286. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  89287. /**
  89288. * Creates a RGBA texture from some data.
  89289. * @param data Define the texture data
  89290. * @param width Define the width of the texture
  89291. * @param height Define the height of the texture
  89292. * @param scene Define the scene the texture belongs to
  89293. * @param generateMipMaps Define whether or not to create mip maps for the texture
  89294. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  89295. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  89296. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  89297. * @returns the RGBA texture
  89298. */
  89299. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  89300. /**
  89301. * Creates a R texture from some data.
  89302. * @param data Define the texture data
  89303. * @param width Define the width of the texture
  89304. * @param height Define the height of the texture
  89305. * @param scene Define the scene the texture belongs to
  89306. * @param generateMipMaps Define whether or not to create mip maps for the texture
  89307. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  89308. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  89309. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  89310. * @returns the R texture
  89311. */
  89312. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  89313. }
  89314. }
  89315. declare module BABYLON {
  89316. interface AbstractScene {
  89317. /**
  89318. * The list of procedural textures added to the scene
  89319. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  89320. */
  89321. proceduralTextures: Array<ProceduralTexture>;
  89322. }
  89323. /**
  89324. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  89325. * in a given scene.
  89326. */
  89327. export class ProceduralTextureSceneComponent implements ISceneComponent {
  89328. /**
  89329. * The component name helpfull to identify the component in the list of scene components.
  89330. */
  89331. readonly name: string;
  89332. /**
  89333. * The scene the component belongs to.
  89334. */
  89335. scene: Scene;
  89336. /**
  89337. * Creates a new instance of the component for the given scene
  89338. * @param scene Defines the scene to register the component in
  89339. */
  89340. constructor(scene: Scene);
  89341. /**
  89342. * Registers the component in a given scene
  89343. */
  89344. register(): void;
  89345. /**
  89346. * Rebuilds the elements related to this component in case of
  89347. * context lost for instance.
  89348. */
  89349. rebuild(): void;
  89350. /**
  89351. * Disposes the component and the associated ressources.
  89352. */
  89353. dispose(): void;
  89354. private _beforeClear;
  89355. }
  89356. }
  89357. declare module BABYLON {
  89358. interface ThinEngine {
  89359. /**
  89360. * Creates a new render target cube texture
  89361. * @param size defines the size of the texture
  89362. * @param options defines the options used to create the texture
  89363. * @returns a new render target cube texture stored in an InternalTexture
  89364. */
  89365. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  89366. }
  89367. }
  89368. declare module BABYLON {
  89369. /** @hidden */
  89370. export var proceduralVertexShader: {
  89371. name: string;
  89372. shader: string;
  89373. };
  89374. }
  89375. declare module BABYLON {
  89376. /**
  89377. * 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.
  89378. * This is the base class of any Procedural texture and contains most of the shareable code.
  89379. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  89380. */
  89381. export class ProceduralTexture extends Texture {
  89382. isCube: boolean;
  89383. /**
  89384. * Define if the texture is enabled or not (disabled texture will not render)
  89385. */
  89386. isEnabled: boolean;
  89387. /**
  89388. * Define if the texture must be cleared before rendering (default is true)
  89389. */
  89390. autoClear: boolean;
  89391. /**
  89392. * Callback called when the texture is generated
  89393. */
  89394. onGenerated: () => void;
  89395. /**
  89396. * Event raised when the texture is generated
  89397. */
  89398. onGeneratedObservable: Observable<ProceduralTexture>;
  89399. /** @hidden */
  89400. _generateMipMaps: boolean;
  89401. /** @hidden **/
  89402. _effect: Effect;
  89403. /** @hidden */
  89404. _textures: {
  89405. [key: string]: Texture;
  89406. };
  89407. /** @hidden */
  89408. protected _fallbackTexture: Nullable<Texture>;
  89409. private _size;
  89410. private _currentRefreshId;
  89411. private _frameId;
  89412. private _refreshRate;
  89413. private _vertexBuffers;
  89414. private _indexBuffer;
  89415. private _uniforms;
  89416. private _samplers;
  89417. private _fragment;
  89418. private _floats;
  89419. private _ints;
  89420. private _floatsArrays;
  89421. private _colors3;
  89422. private _colors4;
  89423. private _vectors2;
  89424. private _vectors3;
  89425. private _matrices;
  89426. private _fallbackTextureUsed;
  89427. private _fullEngine;
  89428. private _cachedDefines;
  89429. private _contentUpdateId;
  89430. private _contentData;
  89431. /**
  89432. * Instantiates a new procedural texture.
  89433. * 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.
  89434. * This is the base class of any Procedural texture and contains most of the shareable code.
  89435. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  89436. * @param name Define the name of the texture
  89437. * @param size Define the size of the texture to create
  89438. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  89439. * @param scene Define the scene the texture belongs to
  89440. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  89441. * @param generateMipMaps Define if the texture should creates mip maps or not
  89442. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  89443. */
  89444. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  89445. /**
  89446. * The effect that is created when initializing the post process.
  89447. * @returns The created effect corresponding the the postprocess.
  89448. */
  89449. getEffect(): Effect;
  89450. /**
  89451. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  89452. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  89453. */
  89454. getContent(): Nullable<ArrayBufferView>;
  89455. private _createIndexBuffer;
  89456. /** @hidden */
  89457. _rebuild(): void;
  89458. /**
  89459. * Resets the texture in order to recreate its associated resources.
  89460. * This can be called in case of context loss
  89461. */
  89462. reset(): void;
  89463. protected _getDefines(): string;
  89464. /**
  89465. * Is the texture ready to be used ? (rendered at least once)
  89466. * @returns true if ready, otherwise, false.
  89467. */
  89468. isReady(): boolean;
  89469. /**
  89470. * Resets the refresh counter of the texture and start bak from scratch.
  89471. * Could be useful to regenerate the texture if it is setup to render only once.
  89472. */
  89473. resetRefreshCounter(): void;
  89474. /**
  89475. * Set the fragment shader to use in order to render the texture.
  89476. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  89477. */
  89478. setFragment(fragment: any): void;
  89479. /**
  89480. * Define the refresh rate of the texture or the rendering frequency.
  89481. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  89482. */
  89483. get refreshRate(): number;
  89484. set refreshRate(value: number);
  89485. /** @hidden */
  89486. _shouldRender(): boolean;
  89487. /**
  89488. * Get the size the texture is rendering at.
  89489. * @returns the size (texture is always squared)
  89490. */
  89491. getRenderSize(): number;
  89492. /**
  89493. * Resize the texture to new value.
  89494. * @param size Define the new size the texture should have
  89495. * @param generateMipMaps Define whether the new texture should create mip maps
  89496. */
  89497. resize(size: number, generateMipMaps: boolean): void;
  89498. private _checkUniform;
  89499. /**
  89500. * Set a texture in the shader program used to render.
  89501. * @param name Define the name of the uniform samplers as defined in the shader
  89502. * @param texture Define the texture to bind to this sampler
  89503. * @return the texture itself allowing "fluent" like uniform updates
  89504. */
  89505. setTexture(name: string, texture: Texture): ProceduralTexture;
  89506. /**
  89507. * Set a float in the shader.
  89508. * @param name Define the name of the uniform as defined in the shader
  89509. * @param value Define the value to give to the uniform
  89510. * @return the texture itself allowing "fluent" like uniform updates
  89511. */
  89512. setFloat(name: string, value: number): ProceduralTexture;
  89513. /**
  89514. * Set a int in the shader.
  89515. * @param name Define the name of the uniform as defined in the shader
  89516. * @param value Define the value to give to the uniform
  89517. * @return the texture itself allowing "fluent" like uniform updates
  89518. */
  89519. setInt(name: string, value: number): ProceduralTexture;
  89520. /**
  89521. * Set an array of floats in the shader.
  89522. * @param name Define the name of the uniform as defined in the shader
  89523. * @param value Define the value to give to the uniform
  89524. * @return the texture itself allowing "fluent" like uniform updates
  89525. */
  89526. setFloats(name: string, value: number[]): ProceduralTexture;
  89527. /**
  89528. * Set a vec3 in the shader from a Color3.
  89529. * @param name Define the name of the uniform as defined in the shader
  89530. * @param value Define the value to give to the uniform
  89531. * @return the texture itself allowing "fluent" like uniform updates
  89532. */
  89533. setColor3(name: string, value: Color3): ProceduralTexture;
  89534. /**
  89535. * Set a vec4 in the shader from a Color4.
  89536. * @param name Define the name of the uniform as defined in the shader
  89537. * @param value Define the value to give to the uniform
  89538. * @return the texture itself allowing "fluent" like uniform updates
  89539. */
  89540. setColor4(name: string, value: Color4): ProceduralTexture;
  89541. /**
  89542. * Set a vec2 in the shader from a Vector2.
  89543. * @param name Define the name of the uniform as defined in the shader
  89544. * @param value Define the value to give to the uniform
  89545. * @return the texture itself allowing "fluent" like uniform updates
  89546. */
  89547. setVector2(name: string, value: Vector2): ProceduralTexture;
  89548. /**
  89549. * Set a vec3 in the shader from a Vector3.
  89550. * @param name Define the name of the uniform as defined in the shader
  89551. * @param value Define the value to give to the uniform
  89552. * @return the texture itself allowing "fluent" like uniform updates
  89553. */
  89554. setVector3(name: string, value: Vector3): ProceduralTexture;
  89555. /**
  89556. * Set a mat4 in the shader from a MAtrix.
  89557. * @param name Define the name of the uniform as defined in the shader
  89558. * @param value Define the value to give to the uniform
  89559. * @return the texture itself allowing "fluent" like uniform updates
  89560. */
  89561. setMatrix(name: string, value: Matrix): ProceduralTexture;
  89562. /**
  89563. * Render the texture to its associated render target.
  89564. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  89565. */
  89566. render(useCameraPostProcess?: boolean): void;
  89567. /**
  89568. * Clone the texture.
  89569. * @returns the cloned texture
  89570. */
  89571. clone(): ProceduralTexture;
  89572. /**
  89573. * Dispose the texture and release its asoociated resources.
  89574. */
  89575. dispose(): void;
  89576. }
  89577. }
  89578. declare module BABYLON {
  89579. /**
  89580. * This represents the base class for particle system in Babylon.
  89581. * 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.
  89582. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  89583. * @example https://doc.babylonjs.com/babylon101/particles
  89584. */
  89585. export class BaseParticleSystem {
  89586. /**
  89587. * Source color is added to the destination color without alpha affecting the result
  89588. */
  89589. static BLENDMODE_ONEONE: number;
  89590. /**
  89591. * Blend current color and particle color using particle’s alpha
  89592. */
  89593. static BLENDMODE_STANDARD: number;
  89594. /**
  89595. * Add current color and particle color multiplied by particle’s alpha
  89596. */
  89597. static BLENDMODE_ADD: number;
  89598. /**
  89599. * Multiply current color with particle color
  89600. */
  89601. static BLENDMODE_MULTIPLY: number;
  89602. /**
  89603. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  89604. */
  89605. static BLENDMODE_MULTIPLYADD: number;
  89606. /**
  89607. * List of animations used by the particle system.
  89608. */
  89609. animations: Animation[];
  89610. /**
  89611. * Gets or sets the unique id of the particle system
  89612. */
  89613. uniqueId: number;
  89614. /**
  89615. * The id of the Particle system.
  89616. */
  89617. id: string;
  89618. /**
  89619. * The friendly name of the Particle system.
  89620. */
  89621. name: string;
  89622. /**
  89623. * Snippet ID if the particle system was created from the snippet server
  89624. */
  89625. snippetId: string;
  89626. /**
  89627. * The rendering group used by the Particle system to chose when to render.
  89628. */
  89629. renderingGroupId: number;
  89630. /**
  89631. * The emitter represents the Mesh or position we are attaching the particle system to.
  89632. */
  89633. emitter: Nullable<AbstractMesh | Vector3>;
  89634. /**
  89635. * The maximum number of particles to emit per frame
  89636. */
  89637. emitRate: number;
  89638. /**
  89639. * If you want to launch only a few particles at once, that can be done, as well.
  89640. */
  89641. manualEmitCount: number;
  89642. /**
  89643. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  89644. */
  89645. updateSpeed: number;
  89646. /**
  89647. * The amount of time the particle system is running (depends of the overall update speed).
  89648. */
  89649. targetStopDuration: number;
  89650. /**
  89651. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  89652. */
  89653. disposeOnStop: boolean;
  89654. /**
  89655. * Minimum power of emitting particles.
  89656. */
  89657. minEmitPower: number;
  89658. /**
  89659. * Maximum power of emitting particles.
  89660. */
  89661. maxEmitPower: number;
  89662. /**
  89663. * Minimum life time of emitting particles.
  89664. */
  89665. minLifeTime: number;
  89666. /**
  89667. * Maximum life time of emitting particles.
  89668. */
  89669. maxLifeTime: number;
  89670. /**
  89671. * Minimum Size of emitting particles.
  89672. */
  89673. minSize: number;
  89674. /**
  89675. * Maximum Size of emitting particles.
  89676. */
  89677. maxSize: number;
  89678. /**
  89679. * Minimum scale of emitting particles on X axis.
  89680. */
  89681. minScaleX: number;
  89682. /**
  89683. * Maximum scale of emitting particles on X axis.
  89684. */
  89685. maxScaleX: number;
  89686. /**
  89687. * Minimum scale of emitting particles on Y axis.
  89688. */
  89689. minScaleY: number;
  89690. /**
  89691. * Maximum scale of emitting particles on Y axis.
  89692. */
  89693. maxScaleY: number;
  89694. /**
  89695. * Gets or sets the minimal initial rotation in radians.
  89696. */
  89697. minInitialRotation: number;
  89698. /**
  89699. * Gets or sets the maximal initial rotation in radians.
  89700. */
  89701. maxInitialRotation: number;
  89702. /**
  89703. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  89704. */
  89705. minAngularSpeed: number;
  89706. /**
  89707. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  89708. */
  89709. maxAngularSpeed: number;
  89710. /**
  89711. * The texture used to render each particle. (this can be a spritesheet)
  89712. */
  89713. particleTexture: Nullable<Texture>;
  89714. /**
  89715. * The layer mask we are rendering the particles through.
  89716. */
  89717. layerMask: number;
  89718. /**
  89719. * This can help using your own shader to render the particle system.
  89720. * The according effect will be created
  89721. */
  89722. customShader: any;
  89723. /**
  89724. * By default particle system starts as soon as they are created. This prevents the
  89725. * automatic start to happen and let you decide when to start emitting particles.
  89726. */
  89727. preventAutoStart: boolean;
  89728. private _noiseTexture;
  89729. /**
  89730. * Gets or sets a texture used to add random noise to particle positions
  89731. */
  89732. get noiseTexture(): Nullable<ProceduralTexture>;
  89733. set noiseTexture(value: Nullable<ProceduralTexture>);
  89734. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  89735. noiseStrength: Vector3;
  89736. /**
  89737. * Callback triggered when the particle animation is ending.
  89738. */
  89739. onAnimationEnd: Nullable<() => void>;
  89740. /**
  89741. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  89742. */
  89743. blendMode: number;
  89744. /**
  89745. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  89746. * to override the particles.
  89747. */
  89748. forceDepthWrite: boolean;
  89749. /** 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 */
  89750. preWarmCycles: number;
  89751. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  89752. preWarmStepOffset: number;
  89753. /**
  89754. * 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)
  89755. */
  89756. spriteCellChangeSpeed: number;
  89757. /**
  89758. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  89759. */
  89760. startSpriteCellID: number;
  89761. /**
  89762. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  89763. */
  89764. endSpriteCellID: number;
  89765. /**
  89766. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  89767. */
  89768. spriteCellWidth: number;
  89769. /**
  89770. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  89771. */
  89772. spriteCellHeight: number;
  89773. /**
  89774. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  89775. */
  89776. spriteRandomStartCell: boolean;
  89777. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  89778. translationPivot: Vector2;
  89779. /** @hidden */
  89780. protected _isAnimationSheetEnabled: boolean;
  89781. /**
  89782. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  89783. */
  89784. beginAnimationOnStart: boolean;
  89785. /**
  89786. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  89787. */
  89788. beginAnimationFrom: number;
  89789. /**
  89790. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  89791. */
  89792. beginAnimationTo: number;
  89793. /**
  89794. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  89795. */
  89796. beginAnimationLoop: boolean;
  89797. /**
  89798. * Gets or sets a world offset applied to all particles
  89799. */
  89800. worldOffset: Vector3;
  89801. /**
  89802. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  89803. */
  89804. get isAnimationSheetEnabled(): boolean;
  89805. set isAnimationSheetEnabled(value: boolean);
  89806. /**
  89807. * Get hosting scene
  89808. * @returns the scene
  89809. */
  89810. getScene(): Scene;
  89811. /**
  89812. * You can use gravity if you want to give an orientation to your particles.
  89813. */
  89814. gravity: Vector3;
  89815. protected _colorGradients: Nullable<Array<ColorGradient>>;
  89816. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  89817. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  89818. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  89819. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  89820. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  89821. protected _dragGradients: Nullable<Array<FactorGradient>>;
  89822. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  89823. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  89824. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  89825. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  89826. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  89827. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  89828. /**
  89829. * Defines the delay in milliseconds before starting the system (0 by default)
  89830. */
  89831. startDelay: number;
  89832. /**
  89833. * Gets the current list of drag gradients.
  89834. * You must use addDragGradient and removeDragGradient to udpate this list
  89835. * @returns the list of drag gradients
  89836. */
  89837. getDragGradients(): Nullable<Array<FactorGradient>>;
  89838. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  89839. limitVelocityDamping: number;
  89840. /**
  89841. * Gets the current list of limit velocity gradients.
  89842. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  89843. * @returns the list of limit velocity gradients
  89844. */
  89845. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  89846. /**
  89847. * Gets the current list of color gradients.
  89848. * You must use addColorGradient and removeColorGradient to udpate this list
  89849. * @returns the list of color gradients
  89850. */
  89851. getColorGradients(): Nullable<Array<ColorGradient>>;
  89852. /**
  89853. * Gets the current list of size gradients.
  89854. * You must use addSizeGradient and removeSizeGradient to udpate this list
  89855. * @returns the list of size gradients
  89856. */
  89857. getSizeGradients(): Nullable<Array<FactorGradient>>;
  89858. /**
  89859. * Gets the current list of color remap gradients.
  89860. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  89861. * @returns the list of color remap gradients
  89862. */
  89863. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  89864. /**
  89865. * Gets the current list of alpha remap gradients.
  89866. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  89867. * @returns the list of alpha remap gradients
  89868. */
  89869. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  89870. /**
  89871. * Gets the current list of life time gradients.
  89872. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  89873. * @returns the list of life time gradients
  89874. */
  89875. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  89876. /**
  89877. * Gets the current list of angular speed gradients.
  89878. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  89879. * @returns the list of angular speed gradients
  89880. */
  89881. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  89882. /**
  89883. * Gets the current list of velocity gradients.
  89884. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  89885. * @returns the list of velocity gradients
  89886. */
  89887. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  89888. /**
  89889. * Gets the current list of start size gradients.
  89890. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  89891. * @returns the list of start size gradients
  89892. */
  89893. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  89894. /**
  89895. * Gets the current list of emit rate gradients.
  89896. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  89897. * @returns the list of emit rate gradients
  89898. */
  89899. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  89900. /**
  89901. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  89902. * This only works when particleEmitterTyps is a BoxParticleEmitter
  89903. */
  89904. get direction1(): Vector3;
  89905. set direction1(value: Vector3);
  89906. /**
  89907. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  89908. * This only works when particleEmitterTyps is a BoxParticleEmitter
  89909. */
  89910. get direction2(): Vector3;
  89911. set direction2(value: Vector3);
  89912. /**
  89913. * 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.
  89914. * This only works when particleEmitterTyps is a BoxParticleEmitter
  89915. */
  89916. get minEmitBox(): Vector3;
  89917. set minEmitBox(value: Vector3);
  89918. /**
  89919. * 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.
  89920. * This only works when particleEmitterTyps is a BoxParticleEmitter
  89921. */
  89922. get maxEmitBox(): Vector3;
  89923. set maxEmitBox(value: Vector3);
  89924. /**
  89925. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  89926. */
  89927. color1: Color4;
  89928. /**
  89929. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  89930. */
  89931. color2: Color4;
  89932. /**
  89933. * Color the particle will have at the end of its lifetime
  89934. */
  89935. colorDead: Color4;
  89936. /**
  89937. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  89938. */
  89939. textureMask: Color4;
  89940. /**
  89941. * The particle emitter type defines the emitter used by the particle system.
  89942. * It can be for example box, sphere, or cone...
  89943. */
  89944. particleEmitterType: IParticleEmitterType;
  89945. /** @hidden */
  89946. _isSubEmitter: boolean;
  89947. /**
  89948. * Gets or sets the billboard mode to use when isBillboardBased = true.
  89949. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  89950. */
  89951. billboardMode: number;
  89952. protected _isBillboardBased: boolean;
  89953. /**
  89954. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  89955. */
  89956. get isBillboardBased(): boolean;
  89957. set isBillboardBased(value: boolean);
  89958. /**
  89959. * The scene the particle system belongs to.
  89960. */
  89961. protected _scene: Scene;
  89962. /**
  89963. * Local cache of defines for image processing.
  89964. */
  89965. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  89966. /**
  89967. * Default configuration related to image processing available in the standard Material.
  89968. */
  89969. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  89970. /**
  89971. * Gets the image processing configuration used either in this material.
  89972. */
  89973. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  89974. /**
  89975. * Sets the Default image processing configuration used either in the this material.
  89976. *
  89977. * If sets to null, the scene one is in use.
  89978. */
  89979. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  89980. /**
  89981. * Attaches a new image processing configuration to the Standard Material.
  89982. * @param configuration
  89983. */
  89984. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  89985. /** @hidden */
  89986. protected _reset(): void;
  89987. /** @hidden */
  89988. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  89989. /**
  89990. * Instantiates a particle system.
  89991. * 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.
  89992. * @param name The name of the particle system
  89993. */
  89994. constructor(name: string);
  89995. /**
  89996. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  89997. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  89998. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  89999. * @returns the emitter
  90000. */
  90001. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  90002. /**
  90003. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  90004. * @param radius The radius of the hemisphere to emit from
  90005. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  90006. * @returns the emitter
  90007. */
  90008. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  90009. /**
  90010. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  90011. * @param radius The radius of the sphere to emit from
  90012. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  90013. * @returns the emitter
  90014. */
  90015. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  90016. /**
  90017. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  90018. * @param radius The radius of the sphere to emit from
  90019. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  90020. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  90021. * @returns the emitter
  90022. */
  90023. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  90024. /**
  90025. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  90026. * @param radius The radius of the emission cylinder
  90027. * @param height The height of the emission cylinder
  90028. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  90029. * @param directionRandomizer How much to randomize the particle direction [0-1]
  90030. * @returns the emitter
  90031. */
  90032. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  90033. /**
  90034. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  90035. * @param radius The radius of the cylinder to emit from
  90036. * @param height The height of the emission cylinder
  90037. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  90038. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  90039. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  90040. * @returns the emitter
  90041. */
  90042. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  90043. /**
  90044. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  90045. * @param radius The radius of the cone to emit from
  90046. * @param angle The base angle of the cone
  90047. * @returns the emitter
  90048. */
  90049. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  90050. /**
  90051. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  90052. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  90053. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  90054. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  90055. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  90056. * @returns the emitter
  90057. */
  90058. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  90059. }
  90060. }
  90061. declare module BABYLON {
  90062. /**
  90063. * Type of sub emitter
  90064. */
  90065. export enum SubEmitterType {
  90066. /**
  90067. * Attached to the particle over it's lifetime
  90068. */
  90069. ATTACHED = 0,
  90070. /**
  90071. * Created when the particle dies
  90072. */
  90073. END = 1
  90074. }
  90075. /**
  90076. * Sub emitter class used to emit particles from an existing particle
  90077. */
  90078. export class SubEmitter {
  90079. /**
  90080. * the particle system to be used by the sub emitter
  90081. */
  90082. particleSystem: ParticleSystem;
  90083. /**
  90084. * Type of the submitter (Default: END)
  90085. */
  90086. type: SubEmitterType;
  90087. /**
  90088. * 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)
  90089. * Note: This only is supported when using an emitter of type Mesh
  90090. */
  90091. inheritDirection: boolean;
  90092. /**
  90093. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  90094. */
  90095. inheritedVelocityAmount: number;
  90096. /**
  90097. * Creates a sub emitter
  90098. * @param particleSystem the particle system to be used by the sub emitter
  90099. */
  90100. constructor(
  90101. /**
  90102. * the particle system to be used by the sub emitter
  90103. */
  90104. particleSystem: ParticleSystem);
  90105. /**
  90106. * Clones the sub emitter
  90107. * @returns the cloned sub emitter
  90108. */
  90109. clone(): SubEmitter;
  90110. /**
  90111. * Serialize current object to a JSON object
  90112. * @returns the serialized object
  90113. */
  90114. serialize(): any;
  90115. /** @hidden */
  90116. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  90117. /**
  90118. * Creates a new SubEmitter from a serialized JSON version
  90119. * @param serializationObject defines the JSON object to read from
  90120. * @param scene defines the hosting scene
  90121. * @param rootUrl defines the rootUrl for data loading
  90122. * @returns a new SubEmitter
  90123. */
  90124. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  90125. /** Release associated resources */
  90126. dispose(): void;
  90127. }
  90128. }
  90129. declare module BABYLON {
  90130. /** @hidden */
  90131. export var imageProcessingDeclaration: {
  90132. name: string;
  90133. shader: string;
  90134. };
  90135. }
  90136. declare module BABYLON {
  90137. /** @hidden */
  90138. export var imageProcessingFunctions: {
  90139. name: string;
  90140. shader: string;
  90141. };
  90142. }
  90143. declare module BABYLON {
  90144. /** @hidden */
  90145. export var particlesPixelShader: {
  90146. name: string;
  90147. shader: string;
  90148. };
  90149. }
  90150. declare module BABYLON {
  90151. /** @hidden */
  90152. export var particlesVertexShader: {
  90153. name: string;
  90154. shader: string;
  90155. };
  90156. }
  90157. declare module BABYLON {
  90158. /**
  90159. * This represents a particle system in Babylon.
  90160. * 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.
  90161. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  90162. * @example https://doc.babylonjs.com/babylon101/particles
  90163. */
  90164. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  90165. /**
  90166. * Billboard mode will only apply to Y axis
  90167. */
  90168. static readonly BILLBOARDMODE_Y: number;
  90169. /**
  90170. * Billboard mode will apply to all axes
  90171. */
  90172. static readonly BILLBOARDMODE_ALL: number;
  90173. /**
  90174. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  90175. */
  90176. static readonly BILLBOARDMODE_STRETCHED: number;
  90177. /**
  90178. * This function can be defined to provide custom update for active particles.
  90179. * This function will be called instead of regular update (age, position, color, etc.).
  90180. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  90181. */
  90182. updateFunction: (particles: Particle[]) => void;
  90183. private _emitterWorldMatrix;
  90184. /**
  90185. * This function can be defined to specify initial direction for every new particle.
  90186. * It by default use the emitterType defined function
  90187. */
  90188. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  90189. /**
  90190. * This function can be defined to specify initial position for every new particle.
  90191. * It by default use the emitterType defined function
  90192. */
  90193. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  90194. /**
  90195. * @hidden
  90196. */
  90197. _inheritedVelocityOffset: Vector3;
  90198. /**
  90199. * An event triggered when the system is disposed
  90200. */
  90201. onDisposeObservable: Observable<IParticleSystem>;
  90202. private _onDisposeObserver;
  90203. /**
  90204. * Sets a callback that will be triggered when the system is disposed
  90205. */
  90206. set onDispose(callback: () => void);
  90207. private _particles;
  90208. private _epsilon;
  90209. private _capacity;
  90210. private _stockParticles;
  90211. private _newPartsExcess;
  90212. private _vertexData;
  90213. private _vertexBuffer;
  90214. private _vertexBuffers;
  90215. private _spriteBuffer;
  90216. private _indexBuffer;
  90217. private _effect;
  90218. private _customEffect;
  90219. private _cachedDefines;
  90220. private _scaledColorStep;
  90221. private _colorDiff;
  90222. private _scaledDirection;
  90223. private _scaledGravity;
  90224. private _currentRenderId;
  90225. private _alive;
  90226. private _useInstancing;
  90227. private _started;
  90228. private _stopped;
  90229. private _actualFrame;
  90230. private _scaledUpdateSpeed;
  90231. private _vertexBufferSize;
  90232. /** @hidden */
  90233. _currentEmitRateGradient: Nullable<FactorGradient>;
  90234. /** @hidden */
  90235. _currentEmitRate1: number;
  90236. /** @hidden */
  90237. _currentEmitRate2: number;
  90238. /** @hidden */
  90239. _currentStartSizeGradient: Nullable<FactorGradient>;
  90240. /** @hidden */
  90241. _currentStartSize1: number;
  90242. /** @hidden */
  90243. _currentStartSize2: number;
  90244. private readonly _rawTextureWidth;
  90245. private _rampGradientsTexture;
  90246. private _useRampGradients;
  90247. /** Gets or sets a boolean indicating that ramp gradients must be used
  90248. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  90249. */
  90250. get useRampGradients(): boolean;
  90251. set useRampGradients(value: boolean);
  90252. /**
  90253. * 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.
  90254. * 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: [])
  90255. */
  90256. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  90257. private _subEmitters;
  90258. /**
  90259. * @hidden
  90260. * If the particle systems emitter should be disposed when the particle system is disposed
  90261. */
  90262. _disposeEmitterOnDispose: boolean;
  90263. /**
  90264. * The current active Sub-systems, this property is used by the root particle system only.
  90265. */
  90266. activeSubSystems: Array<ParticleSystem>;
  90267. /**
  90268. * Specifies if the particles are updated in emitter local space or world space
  90269. */
  90270. isLocal: boolean;
  90271. private _rootParticleSystem;
  90272. /**
  90273. * Gets the current list of active particles
  90274. */
  90275. get particles(): Particle[];
  90276. /**
  90277. * Gets the number of particles active at the same time.
  90278. * @returns The number of active particles.
  90279. */
  90280. getActiveCount(): number;
  90281. /**
  90282. * Returns the string "ParticleSystem"
  90283. * @returns a string containing the class name
  90284. */
  90285. getClassName(): string;
  90286. /**
  90287. * Gets a boolean indicating that the system is stopping
  90288. * @returns true if the system is currently stopping
  90289. */
  90290. isStopping(): boolean;
  90291. /**
  90292. * Gets the custom effect used to render the particles
  90293. * @param blendMode Blend mode for which the effect should be retrieved
  90294. * @returns The effect
  90295. */
  90296. getCustomEffect(blendMode?: number): Nullable<Effect>;
  90297. /**
  90298. * Sets the custom effect used to render the particles
  90299. * @param effect The effect to set
  90300. * @param blendMode Blend mode for which the effect should be set
  90301. */
  90302. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  90303. /** @hidden */
  90304. private _onBeforeDrawParticlesObservable;
  90305. /**
  90306. * Observable that will be called just before the particles are drawn
  90307. */
  90308. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  90309. /**
  90310. * Gets the name of the particle vertex shader
  90311. */
  90312. get vertexShaderName(): string;
  90313. /**
  90314. * Instantiates a particle system.
  90315. * 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.
  90316. * @param name The name of the particle system
  90317. * @param capacity The max number of particles alive at the same time
  90318. * @param scene The scene the particle system belongs to
  90319. * @param customEffect a custom effect used to change the way particles are rendered by default
  90320. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  90321. * @param epsilon Offset used to render the particles
  90322. */
  90323. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  90324. private _addFactorGradient;
  90325. private _removeFactorGradient;
  90326. /**
  90327. * Adds a new life time gradient
  90328. * @param gradient defines the gradient to use (between 0 and 1)
  90329. * @param factor defines the life time factor to affect to the specified gradient
  90330. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  90331. * @returns the current particle system
  90332. */
  90333. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  90334. /**
  90335. * Remove a specific life time gradient
  90336. * @param gradient defines the gradient to remove
  90337. * @returns the current particle system
  90338. */
  90339. removeLifeTimeGradient(gradient: number): IParticleSystem;
  90340. /**
  90341. * Adds a new size gradient
  90342. * @param gradient defines the gradient to use (between 0 and 1)
  90343. * @param factor defines the size factor to affect to the specified gradient
  90344. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  90345. * @returns the current particle system
  90346. */
  90347. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  90348. /**
  90349. * Remove a specific size gradient
  90350. * @param gradient defines the gradient to remove
  90351. * @returns the current particle system
  90352. */
  90353. removeSizeGradient(gradient: number): IParticleSystem;
  90354. /**
  90355. * Adds a new color remap gradient
  90356. * @param gradient defines the gradient to use (between 0 and 1)
  90357. * @param min defines the color remap minimal range
  90358. * @param max defines the color remap maximal range
  90359. * @returns the current particle system
  90360. */
  90361. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  90362. /**
  90363. * Remove a specific color remap gradient
  90364. * @param gradient defines the gradient to remove
  90365. * @returns the current particle system
  90366. */
  90367. removeColorRemapGradient(gradient: number): IParticleSystem;
  90368. /**
  90369. * Adds a new alpha remap gradient
  90370. * @param gradient defines the gradient to use (between 0 and 1)
  90371. * @param min defines the alpha remap minimal range
  90372. * @param max defines the alpha remap maximal range
  90373. * @returns the current particle system
  90374. */
  90375. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  90376. /**
  90377. * Remove a specific alpha remap gradient
  90378. * @param gradient defines the gradient to remove
  90379. * @returns the current particle system
  90380. */
  90381. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  90382. /**
  90383. * Adds a new angular speed gradient
  90384. * @param gradient defines the gradient to use (between 0 and 1)
  90385. * @param factor defines the angular speed to affect to the specified gradient
  90386. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  90387. * @returns the current particle system
  90388. */
  90389. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  90390. /**
  90391. * Remove a specific angular speed gradient
  90392. * @param gradient defines the gradient to remove
  90393. * @returns the current particle system
  90394. */
  90395. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  90396. /**
  90397. * Adds a new velocity gradient
  90398. * @param gradient defines the gradient to use (between 0 and 1)
  90399. * @param factor defines the velocity to affect to the specified gradient
  90400. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  90401. * @returns the current particle system
  90402. */
  90403. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  90404. /**
  90405. * Remove a specific velocity gradient
  90406. * @param gradient defines the gradient to remove
  90407. * @returns the current particle system
  90408. */
  90409. removeVelocityGradient(gradient: number): IParticleSystem;
  90410. /**
  90411. * Adds a new limit velocity gradient
  90412. * @param gradient defines the gradient to use (between 0 and 1)
  90413. * @param factor defines the limit velocity value to affect to the specified gradient
  90414. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  90415. * @returns the current particle system
  90416. */
  90417. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  90418. /**
  90419. * Remove a specific limit velocity gradient
  90420. * @param gradient defines the gradient to remove
  90421. * @returns the current particle system
  90422. */
  90423. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  90424. /**
  90425. * Adds a new drag gradient
  90426. * @param gradient defines the gradient to use (between 0 and 1)
  90427. * @param factor defines the drag value to affect to the specified gradient
  90428. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  90429. * @returns the current particle system
  90430. */
  90431. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  90432. /**
  90433. * Remove a specific drag gradient
  90434. * @param gradient defines the gradient to remove
  90435. * @returns the current particle system
  90436. */
  90437. removeDragGradient(gradient: number): IParticleSystem;
  90438. /**
  90439. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  90440. * @param gradient defines the gradient to use (between 0 and 1)
  90441. * @param factor defines the emit rate value to affect to the specified gradient
  90442. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  90443. * @returns the current particle system
  90444. */
  90445. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  90446. /**
  90447. * Remove a specific emit rate gradient
  90448. * @param gradient defines the gradient to remove
  90449. * @returns the current particle system
  90450. */
  90451. removeEmitRateGradient(gradient: number): IParticleSystem;
  90452. /**
  90453. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  90454. * @param gradient defines the gradient to use (between 0 and 1)
  90455. * @param factor defines the start size value to affect to the specified gradient
  90456. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  90457. * @returns the current particle system
  90458. */
  90459. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  90460. /**
  90461. * Remove a specific start size gradient
  90462. * @param gradient defines the gradient to remove
  90463. * @returns the current particle system
  90464. */
  90465. removeStartSizeGradient(gradient: number): IParticleSystem;
  90466. private _createRampGradientTexture;
  90467. /**
  90468. * Gets the current list of ramp gradients.
  90469. * You must use addRampGradient and removeRampGradient to udpate this list
  90470. * @returns the list of ramp gradients
  90471. */
  90472. getRampGradients(): Nullable<Array<Color3Gradient>>;
  90473. /** Force the system to rebuild all gradients that need to be resync */
  90474. forceRefreshGradients(): void;
  90475. private _syncRampGradientTexture;
  90476. /**
  90477. * Adds a new ramp gradient used to remap particle colors
  90478. * @param gradient defines the gradient to use (between 0 and 1)
  90479. * @param color defines the color to affect to the specified gradient
  90480. * @returns the current particle system
  90481. */
  90482. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  90483. /**
  90484. * Remove a specific ramp gradient
  90485. * @param gradient defines the gradient to remove
  90486. * @returns the current particle system
  90487. */
  90488. removeRampGradient(gradient: number): ParticleSystem;
  90489. /**
  90490. * Adds a new color gradient
  90491. * @param gradient defines the gradient to use (between 0 and 1)
  90492. * @param color1 defines the color to affect to the specified gradient
  90493. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  90494. * @returns this particle system
  90495. */
  90496. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  90497. /**
  90498. * Remove a specific color gradient
  90499. * @param gradient defines the gradient to remove
  90500. * @returns this particle system
  90501. */
  90502. removeColorGradient(gradient: number): IParticleSystem;
  90503. private _fetchR;
  90504. protected _reset(): void;
  90505. private _resetEffect;
  90506. private _createVertexBuffers;
  90507. private _createIndexBuffer;
  90508. /**
  90509. * Gets the maximum number of particles active at the same time.
  90510. * @returns The max number of active particles.
  90511. */
  90512. getCapacity(): number;
  90513. /**
  90514. * Gets whether there are still active particles in the system.
  90515. * @returns True if it is alive, otherwise false.
  90516. */
  90517. isAlive(): boolean;
  90518. /**
  90519. * Gets if the system has been started. (Note: this will still be true after stop is called)
  90520. * @returns True if it has been started, otherwise false.
  90521. */
  90522. isStarted(): boolean;
  90523. private _prepareSubEmitterInternalArray;
  90524. /**
  90525. * Starts the particle system and begins to emit
  90526. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  90527. */
  90528. start(delay?: number): void;
  90529. /**
  90530. * Stops the particle system.
  90531. * @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.
  90532. */
  90533. stop(stopSubEmitters?: boolean): void;
  90534. /**
  90535. * Remove all active particles
  90536. */
  90537. reset(): void;
  90538. /**
  90539. * @hidden (for internal use only)
  90540. */
  90541. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  90542. /**
  90543. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  90544. * Its lifetime will start back at 0.
  90545. */
  90546. recycleParticle: (particle: Particle) => void;
  90547. private _stopSubEmitters;
  90548. private _createParticle;
  90549. private _removeFromRoot;
  90550. private _emitFromParticle;
  90551. private _update;
  90552. /** @hidden */
  90553. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  90554. /** @hidden */
  90555. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  90556. /**
  90557. * Fill the defines array according to the current settings of the particle system
  90558. * @param defines Array to be updated
  90559. * @param blendMode blend mode to take into account when updating the array
  90560. */
  90561. fillDefines(defines: Array<string>, blendMode: number): void;
  90562. /**
  90563. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  90564. * @param uniforms Uniforms array to fill
  90565. * @param attributes Attributes array to fill
  90566. * @param samplers Samplers array to fill
  90567. */
  90568. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  90569. /** @hidden */
  90570. private _getEffect;
  90571. /**
  90572. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  90573. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  90574. */
  90575. animate(preWarmOnly?: boolean): void;
  90576. private _appendParticleVertices;
  90577. /**
  90578. * Rebuilds the particle system.
  90579. */
  90580. rebuild(): void;
  90581. /**
  90582. * Is this system ready to be used/rendered
  90583. * @return true if the system is ready
  90584. */
  90585. isReady(): boolean;
  90586. private _render;
  90587. /**
  90588. * Renders the particle system in its current state.
  90589. * @returns the current number of particles
  90590. */
  90591. render(): number;
  90592. /**
  90593. * Disposes the particle system and free the associated resources
  90594. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  90595. */
  90596. dispose(disposeTexture?: boolean): void;
  90597. /**
  90598. * Clones the particle system.
  90599. * @param name The name of the cloned object
  90600. * @param newEmitter The new emitter to use
  90601. * @returns the cloned particle system
  90602. */
  90603. clone(name: string, newEmitter: any): ParticleSystem;
  90604. /**
  90605. * Serializes the particle system to a JSON object
  90606. * @param serializeTexture defines if the texture must be serialized as well
  90607. * @returns the JSON object
  90608. */
  90609. serialize(serializeTexture?: boolean): any;
  90610. /** @hidden */
  90611. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  90612. /** @hidden */
  90613. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  90614. /**
  90615. * Parses a JSON object to create a particle system.
  90616. * @param parsedParticleSystem The JSON object to parse
  90617. * @param scene The scene to create the particle system in
  90618. * @param rootUrl The root url to use to load external dependencies like texture
  90619. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  90620. * @returns the Parsed particle system
  90621. */
  90622. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  90623. }
  90624. }
  90625. declare module BABYLON {
  90626. /**
  90627. * A particle represents one of the element emitted by a particle system.
  90628. * This is mainly define by its coordinates, direction, velocity and age.
  90629. */
  90630. export class Particle {
  90631. /**
  90632. * The particle system the particle belongs to.
  90633. */
  90634. particleSystem: ParticleSystem;
  90635. private static _Count;
  90636. /**
  90637. * Unique ID of the particle
  90638. */
  90639. id: number;
  90640. /**
  90641. * The world position of the particle in the scene.
  90642. */
  90643. position: Vector3;
  90644. /**
  90645. * The world direction of the particle in the scene.
  90646. */
  90647. direction: Vector3;
  90648. /**
  90649. * The color of the particle.
  90650. */
  90651. color: Color4;
  90652. /**
  90653. * The color change of the particle per step.
  90654. */
  90655. colorStep: Color4;
  90656. /**
  90657. * Defines how long will the life of the particle be.
  90658. */
  90659. lifeTime: number;
  90660. /**
  90661. * The current age of the particle.
  90662. */
  90663. age: number;
  90664. /**
  90665. * The current size of the particle.
  90666. */
  90667. size: number;
  90668. /**
  90669. * The current scale of the particle.
  90670. */
  90671. scale: Vector2;
  90672. /**
  90673. * The current angle of the particle.
  90674. */
  90675. angle: number;
  90676. /**
  90677. * Defines how fast is the angle changing.
  90678. */
  90679. angularSpeed: number;
  90680. /**
  90681. * Defines the cell index used by the particle to be rendered from a sprite.
  90682. */
  90683. cellIndex: number;
  90684. /**
  90685. * The information required to support color remapping
  90686. */
  90687. remapData: Vector4;
  90688. /** @hidden */
  90689. _randomCellOffset?: number;
  90690. /** @hidden */
  90691. _initialDirection: Nullable<Vector3>;
  90692. /** @hidden */
  90693. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  90694. /** @hidden */
  90695. _initialStartSpriteCellID: number;
  90696. /** @hidden */
  90697. _initialEndSpriteCellID: number;
  90698. /** @hidden */
  90699. _currentColorGradient: Nullable<ColorGradient>;
  90700. /** @hidden */
  90701. _currentColor1: Color4;
  90702. /** @hidden */
  90703. _currentColor2: Color4;
  90704. /** @hidden */
  90705. _currentSizeGradient: Nullable<FactorGradient>;
  90706. /** @hidden */
  90707. _currentSize1: number;
  90708. /** @hidden */
  90709. _currentSize2: number;
  90710. /** @hidden */
  90711. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  90712. /** @hidden */
  90713. _currentAngularSpeed1: number;
  90714. /** @hidden */
  90715. _currentAngularSpeed2: number;
  90716. /** @hidden */
  90717. _currentVelocityGradient: Nullable<FactorGradient>;
  90718. /** @hidden */
  90719. _currentVelocity1: number;
  90720. /** @hidden */
  90721. _currentVelocity2: number;
  90722. /** @hidden */
  90723. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  90724. /** @hidden */
  90725. _currentLimitVelocity1: number;
  90726. /** @hidden */
  90727. _currentLimitVelocity2: number;
  90728. /** @hidden */
  90729. _currentDragGradient: Nullable<FactorGradient>;
  90730. /** @hidden */
  90731. _currentDrag1: number;
  90732. /** @hidden */
  90733. _currentDrag2: number;
  90734. /** @hidden */
  90735. _randomNoiseCoordinates1: Vector3;
  90736. /** @hidden */
  90737. _randomNoiseCoordinates2: Vector3;
  90738. /** @hidden */
  90739. _localPosition?: Vector3;
  90740. /**
  90741. * Creates a new instance Particle
  90742. * @param particleSystem the particle system the particle belongs to
  90743. */
  90744. constructor(
  90745. /**
  90746. * The particle system the particle belongs to.
  90747. */
  90748. particleSystem: ParticleSystem);
  90749. private updateCellInfoFromSystem;
  90750. /**
  90751. * Defines how the sprite cell index is updated for the particle
  90752. */
  90753. updateCellIndex(): void;
  90754. /** @hidden */
  90755. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  90756. /** @hidden */
  90757. _inheritParticleInfoToSubEmitters(): void;
  90758. /** @hidden */
  90759. _reset(): void;
  90760. /**
  90761. * Copy the properties of particle to another one.
  90762. * @param other the particle to copy the information to.
  90763. */
  90764. copyTo(other: Particle): void;
  90765. }
  90766. }
  90767. declare module BABYLON {
  90768. /**
  90769. * Particle emitter represents a volume emitting particles.
  90770. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  90771. */
  90772. export interface IParticleEmitterType {
  90773. /**
  90774. * Called by the particle System when the direction is computed for the created particle.
  90775. * @param worldMatrix is the world matrix of the particle system
  90776. * @param directionToUpdate is the direction vector to update with the result
  90777. * @param particle is the particle we are computed the direction for
  90778. * @param isLocal defines if the direction should be set in local space
  90779. */
  90780. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  90781. /**
  90782. * Called by the particle System when the position is computed for the created particle.
  90783. * @param worldMatrix is the world matrix of the particle system
  90784. * @param positionToUpdate is the position vector to update with the result
  90785. * @param particle is the particle we are computed the position for
  90786. * @param isLocal defines if the position should be set in local space
  90787. */
  90788. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  90789. /**
  90790. * Clones the current emitter and returns a copy of it
  90791. * @returns the new emitter
  90792. */
  90793. clone(): IParticleEmitterType;
  90794. /**
  90795. * Called by the GPUParticleSystem to setup the update shader
  90796. * @param effect defines the update shader
  90797. */
  90798. applyToShader(effect: Effect): void;
  90799. /**
  90800. * Returns a string to use to update the GPU particles update shader
  90801. * @returns the effect defines string
  90802. */
  90803. getEffectDefines(): string;
  90804. /**
  90805. * Returns a string representing the class name
  90806. * @returns a string containing the class name
  90807. */
  90808. getClassName(): string;
  90809. /**
  90810. * Serializes the particle system to a JSON object.
  90811. * @returns the JSON object
  90812. */
  90813. serialize(): any;
  90814. /**
  90815. * Parse properties from a JSON object
  90816. * @param serializationObject defines the JSON object
  90817. * @param scene defines the hosting scene
  90818. */
  90819. parse(serializationObject: any, scene: Scene): void;
  90820. }
  90821. }
  90822. declare module BABYLON {
  90823. /**
  90824. * Particle emitter emitting particles from the inside of a box.
  90825. * It emits the particles randomly between 2 given directions.
  90826. */
  90827. export class BoxParticleEmitter implements IParticleEmitterType {
  90828. /**
  90829. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  90830. */
  90831. direction1: Vector3;
  90832. /**
  90833. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  90834. */
  90835. direction2: Vector3;
  90836. /**
  90837. * 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.
  90838. */
  90839. minEmitBox: Vector3;
  90840. /**
  90841. * 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.
  90842. */
  90843. maxEmitBox: Vector3;
  90844. /**
  90845. * Creates a new instance BoxParticleEmitter
  90846. */
  90847. constructor();
  90848. /**
  90849. * Called by the particle System when the direction is computed for the created particle.
  90850. * @param worldMatrix is the world matrix of the particle system
  90851. * @param directionToUpdate is the direction vector to update with the result
  90852. * @param particle is the particle we are computed the direction for
  90853. * @param isLocal defines if the direction should be set in local space
  90854. */
  90855. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  90856. /**
  90857. * Called by the particle System when the position is computed for the created particle.
  90858. * @param worldMatrix is the world matrix of the particle system
  90859. * @param positionToUpdate is the position vector to update with the result
  90860. * @param particle is the particle we are computed the position for
  90861. * @param isLocal defines if the position should be set in local space
  90862. */
  90863. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  90864. /**
  90865. * Clones the current emitter and returns a copy of it
  90866. * @returns the new emitter
  90867. */
  90868. clone(): BoxParticleEmitter;
  90869. /**
  90870. * Called by the GPUParticleSystem to setup the update shader
  90871. * @param effect defines the update shader
  90872. */
  90873. applyToShader(effect: Effect): void;
  90874. /**
  90875. * Returns a string to use to update the GPU particles update shader
  90876. * @returns a string containng the defines string
  90877. */
  90878. getEffectDefines(): string;
  90879. /**
  90880. * Returns the string "BoxParticleEmitter"
  90881. * @returns a string containing the class name
  90882. */
  90883. getClassName(): string;
  90884. /**
  90885. * Serializes the particle system to a JSON object.
  90886. * @returns the JSON object
  90887. */
  90888. serialize(): any;
  90889. /**
  90890. * Parse properties from a JSON object
  90891. * @param serializationObject defines the JSON object
  90892. */
  90893. parse(serializationObject: any): void;
  90894. }
  90895. }
  90896. declare module BABYLON {
  90897. /**
  90898. * Particle emitter emitting particles from the inside of a cone.
  90899. * It emits the particles alongside the cone volume from the base to the particle.
  90900. * The emission direction might be randomized.
  90901. */
  90902. export class ConeParticleEmitter implements IParticleEmitterType {
  90903. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  90904. directionRandomizer: number;
  90905. private _radius;
  90906. private _angle;
  90907. private _height;
  90908. /**
  90909. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  90910. */
  90911. radiusRange: number;
  90912. /**
  90913. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  90914. */
  90915. heightRange: number;
  90916. /**
  90917. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  90918. */
  90919. emitFromSpawnPointOnly: boolean;
  90920. /**
  90921. * Gets or sets the radius of the emission cone
  90922. */
  90923. get radius(): number;
  90924. set radius(value: number);
  90925. /**
  90926. * Gets or sets the angle of the emission cone
  90927. */
  90928. get angle(): number;
  90929. set angle(value: number);
  90930. private _buildHeight;
  90931. /**
  90932. * Creates a new instance ConeParticleEmitter
  90933. * @param radius the radius of the emission cone (1 by default)
  90934. * @param angle the cone base angle (PI by default)
  90935. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  90936. */
  90937. constructor(radius?: number, angle?: number,
  90938. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  90939. directionRandomizer?: number);
  90940. /**
  90941. * Called by the particle System when the direction is computed for the created particle.
  90942. * @param worldMatrix is the world matrix of the particle system
  90943. * @param directionToUpdate is the direction vector to update with the result
  90944. * @param particle is the particle we are computed the direction for
  90945. * @param isLocal defines if the direction should be set in local space
  90946. */
  90947. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  90948. /**
  90949. * Called by the particle System when the position is computed for the created particle.
  90950. * @param worldMatrix is the world matrix of the particle system
  90951. * @param positionToUpdate is the position vector to update with the result
  90952. * @param particle is the particle we are computed the position for
  90953. * @param isLocal defines if the position should be set in local space
  90954. */
  90955. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  90956. /**
  90957. * Clones the current emitter and returns a copy of it
  90958. * @returns the new emitter
  90959. */
  90960. clone(): ConeParticleEmitter;
  90961. /**
  90962. * Called by the GPUParticleSystem to setup the update shader
  90963. * @param effect defines the update shader
  90964. */
  90965. applyToShader(effect: Effect): void;
  90966. /**
  90967. * Returns a string to use to update the GPU particles update shader
  90968. * @returns a string containng the defines string
  90969. */
  90970. getEffectDefines(): string;
  90971. /**
  90972. * Returns the string "ConeParticleEmitter"
  90973. * @returns a string containing the class name
  90974. */
  90975. getClassName(): string;
  90976. /**
  90977. * Serializes the particle system to a JSON object.
  90978. * @returns the JSON object
  90979. */
  90980. serialize(): any;
  90981. /**
  90982. * Parse properties from a JSON object
  90983. * @param serializationObject defines the JSON object
  90984. */
  90985. parse(serializationObject: any): void;
  90986. }
  90987. }
  90988. declare module BABYLON {
  90989. /**
  90990. * Particle emitter emitting particles from the inside of a cylinder.
  90991. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  90992. */
  90993. export class CylinderParticleEmitter implements IParticleEmitterType {
  90994. /**
  90995. * The radius of the emission cylinder.
  90996. */
  90997. radius: number;
  90998. /**
  90999. * The height of the emission cylinder.
  91000. */
  91001. height: number;
  91002. /**
  91003. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91004. */
  91005. radiusRange: number;
  91006. /**
  91007. * How much to randomize the particle direction [0-1].
  91008. */
  91009. directionRandomizer: number;
  91010. /**
  91011. * Creates a new instance CylinderParticleEmitter
  91012. * @param radius the radius of the emission cylinder (1 by default)
  91013. * @param height the height of the emission cylinder (1 by default)
  91014. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91015. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  91016. */
  91017. constructor(
  91018. /**
  91019. * The radius of the emission cylinder.
  91020. */
  91021. radius?: number,
  91022. /**
  91023. * The height of the emission cylinder.
  91024. */
  91025. height?: number,
  91026. /**
  91027. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91028. */
  91029. radiusRange?: number,
  91030. /**
  91031. * How much to randomize the particle direction [0-1].
  91032. */
  91033. directionRandomizer?: number);
  91034. /**
  91035. * Called by the particle System when the direction is computed for the created particle.
  91036. * @param worldMatrix is the world matrix of the particle system
  91037. * @param directionToUpdate is the direction vector to update with the result
  91038. * @param particle is the particle we are computed the direction for
  91039. * @param isLocal defines if the direction should be set in local space
  91040. */
  91041. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91042. /**
  91043. * Called by the particle System when the position is computed for the created particle.
  91044. * @param worldMatrix is the world matrix of the particle system
  91045. * @param positionToUpdate is the position vector to update with the result
  91046. * @param particle is the particle we are computed the position for
  91047. * @param isLocal defines if the position should be set in local space
  91048. */
  91049. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91050. /**
  91051. * Clones the current emitter and returns a copy of it
  91052. * @returns the new emitter
  91053. */
  91054. clone(): CylinderParticleEmitter;
  91055. /**
  91056. * Called by the GPUParticleSystem to setup the update shader
  91057. * @param effect defines the update shader
  91058. */
  91059. applyToShader(effect: Effect): void;
  91060. /**
  91061. * Returns a string to use to update the GPU particles update shader
  91062. * @returns a string containng the defines string
  91063. */
  91064. getEffectDefines(): string;
  91065. /**
  91066. * Returns the string "CylinderParticleEmitter"
  91067. * @returns a string containing the class name
  91068. */
  91069. getClassName(): string;
  91070. /**
  91071. * Serializes the particle system to a JSON object.
  91072. * @returns the JSON object
  91073. */
  91074. serialize(): any;
  91075. /**
  91076. * Parse properties from a JSON object
  91077. * @param serializationObject defines the JSON object
  91078. */
  91079. parse(serializationObject: any): void;
  91080. }
  91081. /**
  91082. * Particle emitter emitting particles from the inside of a cylinder.
  91083. * It emits the particles randomly between two vectors.
  91084. */
  91085. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  91086. /**
  91087. * The min limit of the emission direction.
  91088. */
  91089. direction1: Vector3;
  91090. /**
  91091. * The max limit of the emission direction.
  91092. */
  91093. direction2: Vector3;
  91094. /**
  91095. * Creates a new instance CylinderDirectedParticleEmitter
  91096. * @param radius the radius of the emission cylinder (1 by default)
  91097. * @param height the height of the emission cylinder (1 by default)
  91098. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91099. * @param direction1 the min limit of the emission direction (up vector by default)
  91100. * @param direction2 the max limit of the emission direction (up vector by default)
  91101. */
  91102. constructor(radius?: number, height?: number, radiusRange?: number,
  91103. /**
  91104. * The min limit of the emission direction.
  91105. */
  91106. direction1?: Vector3,
  91107. /**
  91108. * The max limit of the emission direction.
  91109. */
  91110. direction2?: Vector3);
  91111. /**
  91112. * Called by the particle System when the direction is computed for the created particle.
  91113. * @param worldMatrix is the world matrix of the particle system
  91114. * @param directionToUpdate is the direction vector to update with the result
  91115. * @param particle is the particle we are computed the direction for
  91116. */
  91117. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  91118. /**
  91119. * Clones the current emitter and returns a copy of it
  91120. * @returns the new emitter
  91121. */
  91122. clone(): CylinderDirectedParticleEmitter;
  91123. /**
  91124. * Called by the GPUParticleSystem to setup the update shader
  91125. * @param effect defines the update shader
  91126. */
  91127. applyToShader(effect: Effect): void;
  91128. /**
  91129. * Returns a string to use to update the GPU particles update shader
  91130. * @returns a string containng the defines string
  91131. */
  91132. getEffectDefines(): string;
  91133. /**
  91134. * Returns the string "CylinderDirectedParticleEmitter"
  91135. * @returns a string containing the class name
  91136. */
  91137. getClassName(): string;
  91138. /**
  91139. * Serializes the particle system to a JSON object.
  91140. * @returns the JSON object
  91141. */
  91142. serialize(): any;
  91143. /**
  91144. * Parse properties from a JSON object
  91145. * @param serializationObject defines the JSON object
  91146. */
  91147. parse(serializationObject: any): void;
  91148. }
  91149. }
  91150. declare module BABYLON {
  91151. /**
  91152. * Particle emitter emitting particles from the inside of a hemisphere.
  91153. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  91154. */
  91155. export class HemisphericParticleEmitter implements IParticleEmitterType {
  91156. /**
  91157. * The radius of the emission hemisphere.
  91158. */
  91159. radius: number;
  91160. /**
  91161. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91162. */
  91163. radiusRange: number;
  91164. /**
  91165. * How much to randomize the particle direction [0-1].
  91166. */
  91167. directionRandomizer: number;
  91168. /**
  91169. * Creates a new instance HemisphericParticleEmitter
  91170. * @param radius the radius of the emission hemisphere (1 by default)
  91171. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91172. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  91173. */
  91174. constructor(
  91175. /**
  91176. * The radius of the emission hemisphere.
  91177. */
  91178. radius?: number,
  91179. /**
  91180. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91181. */
  91182. radiusRange?: number,
  91183. /**
  91184. * How much to randomize the particle direction [0-1].
  91185. */
  91186. directionRandomizer?: number);
  91187. /**
  91188. * Called by the particle System when the direction is computed for the created particle.
  91189. * @param worldMatrix is the world matrix of the particle system
  91190. * @param directionToUpdate is the direction vector to update with the result
  91191. * @param particle is the particle we are computed the direction for
  91192. * @param isLocal defines if the direction should be set in local space
  91193. */
  91194. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91195. /**
  91196. * Called by the particle System when the position is computed for the created particle.
  91197. * @param worldMatrix is the world matrix of the particle system
  91198. * @param positionToUpdate is the position vector to update with the result
  91199. * @param particle is the particle we are computed the position for
  91200. * @param isLocal defines if the position should be set in local space
  91201. */
  91202. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91203. /**
  91204. * Clones the current emitter and returns a copy of it
  91205. * @returns the new emitter
  91206. */
  91207. clone(): HemisphericParticleEmitter;
  91208. /**
  91209. * Called by the GPUParticleSystem to setup the update shader
  91210. * @param effect defines the update shader
  91211. */
  91212. applyToShader(effect: Effect): void;
  91213. /**
  91214. * Returns a string to use to update the GPU particles update shader
  91215. * @returns a string containng the defines string
  91216. */
  91217. getEffectDefines(): string;
  91218. /**
  91219. * Returns the string "HemisphericParticleEmitter"
  91220. * @returns a string containing the class name
  91221. */
  91222. getClassName(): string;
  91223. /**
  91224. * Serializes the particle system to a JSON object.
  91225. * @returns the JSON object
  91226. */
  91227. serialize(): any;
  91228. /**
  91229. * Parse properties from a JSON object
  91230. * @param serializationObject defines the JSON object
  91231. */
  91232. parse(serializationObject: any): void;
  91233. }
  91234. }
  91235. declare module BABYLON {
  91236. /**
  91237. * Particle emitter emitting particles from a point.
  91238. * It emits the particles randomly between 2 given directions.
  91239. */
  91240. export class PointParticleEmitter implements IParticleEmitterType {
  91241. /**
  91242. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91243. */
  91244. direction1: Vector3;
  91245. /**
  91246. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91247. */
  91248. direction2: Vector3;
  91249. /**
  91250. * Creates a new instance PointParticleEmitter
  91251. */
  91252. constructor();
  91253. /**
  91254. * Called by the particle System when the direction is computed for the created particle.
  91255. * @param worldMatrix is the world matrix of the particle system
  91256. * @param directionToUpdate is the direction vector to update with the result
  91257. * @param particle is the particle we are computed the direction for
  91258. * @param isLocal defines if the direction should be set in local space
  91259. */
  91260. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91261. /**
  91262. * Called by the particle System when the position is computed for the created particle.
  91263. * @param worldMatrix is the world matrix of the particle system
  91264. * @param positionToUpdate is the position vector to update with the result
  91265. * @param particle is the particle we are computed the position for
  91266. * @param isLocal defines if the position should be set in local space
  91267. */
  91268. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91269. /**
  91270. * Clones the current emitter and returns a copy of it
  91271. * @returns the new emitter
  91272. */
  91273. clone(): PointParticleEmitter;
  91274. /**
  91275. * Called by the GPUParticleSystem to setup the update shader
  91276. * @param effect defines the update shader
  91277. */
  91278. applyToShader(effect: Effect): void;
  91279. /**
  91280. * Returns a string to use to update the GPU particles update shader
  91281. * @returns a string containng the defines string
  91282. */
  91283. getEffectDefines(): string;
  91284. /**
  91285. * Returns the string "PointParticleEmitter"
  91286. * @returns a string containing the class name
  91287. */
  91288. getClassName(): string;
  91289. /**
  91290. * Serializes the particle system to a JSON object.
  91291. * @returns the JSON object
  91292. */
  91293. serialize(): any;
  91294. /**
  91295. * Parse properties from a JSON object
  91296. * @param serializationObject defines the JSON object
  91297. */
  91298. parse(serializationObject: any): void;
  91299. }
  91300. }
  91301. declare module BABYLON {
  91302. /**
  91303. * Particle emitter emitting particles from the inside of a sphere.
  91304. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  91305. */
  91306. export class SphereParticleEmitter implements IParticleEmitterType {
  91307. /**
  91308. * The radius of the emission sphere.
  91309. */
  91310. radius: number;
  91311. /**
  91312. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91313. */
  91314. radiusRange: number;
  91315. /**
  91316. * How much to randomize the particle direction [0-1].
  91317. */
  91318. directionRandomizer: number;
  91319. /**
  91320. * Creates a new instance SphereParticleEmitter
  91321. * @param radius the radius of the emission sphere (1 by default)
  91322. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91323. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  91324. */
  91325. constructor(
  91326. /**
  91327. * The radius of the emission sphere.
  91328. */
  91329. radius?: number,
  91330. /**
  91331. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91332. */
  91333. radiusRange?: number,
  91334. /**
  91335. * How much to randomize the particle direction [0-1].
  91336. */
  91337. directionRandomizer?: number);
  91338. /**
  91339. * Called by the particle System when the direction is computed for the created particle.
  91340. * @param worldMatrix is the world matrix of the particle system
  91341. * @param directionToUpdate is the direction vector to update with the result
  91342. * @param particle is the particle we are computed the direction for
  91343. * @param isLocal defines if the direction should be set in local space
  91344. */
  91345. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91346. /**
  91347. * Called by the particle System when the position is computed for the created particle.
  91348. * @param worldMatrix is the world matrix of the particle system
  91349. * @param positionToUpdate is the position vector to update with the result
  91350. * @param particle is the particle we are computed the position for
  91351. * @param isLocal defines if the position should be set in local space
  91352. */
  91353. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91354. /**
  91355. * Clones the current emitter and returns a copy of it
  91356. * @returns the new emitter
  91357. */
  91358. clone(): SphereParticleEmitter;
  91359. /**
  91360. * Called by the GPUParticleSystem to setup the update shader
  91361. * @param effect defines the update shader
  91362. */
  91363. applyToShader(effect: Effect): void;
  91364. /**
  91365. * Returns a string to use to update the GPU particles update shader
  91366. * @returns a string containng the defines string
  91367. */
  91368. getEffectDefines(): string;
  91369. /**
  91370. * Returns the string "SphereParticleEmitter"
  91371. * @returns a string containing the class name
  91372. */
  91373. getClassName(): string;
  91374. /**
  91375. * Serializes the particle system to a JSON object.
  91376. * @returns the JSON object
  91377. */
  91378. serialize(): any;
  91379. /**
  91380. * Parse properties from a JSON object
  91381. * @param serializationObject defines the JSON object
  91382. */
  91383. parse(serializationObject: any): void;
  91384. }
  91385. /**
  91386. * Particle emitter emitting particles from the inside of a sphere.
  91387. * It emits the particles randomly between two vectors.
  91388. */
  91389. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  91390. /**
  91391. * The min limit of the emission direction.
  91392. */
  91393. direction1: Vector3;
  91394. /**
  91395. * The max limit of the emission direction.
  91396. */
  91397. direction2: Vector3;
  91398. /**
  91399. * Creates a new instance SphereDirectedParticleEmitter
  91400. * @param radius the radius of the emission sphere (1 by default)
  91401. * @param direction1 the min limit of the emission direction (up vector by default)
  91402. * @param direction2 the max limit of the emission direction (up vector by default)
  91403. */
  91404. constructor(radius?: number,
  91405. /**
  91406. * The min limit of the emission direction.
  91407. */
  91408. direction1?: Vector3,
  91409. /**
  91410. * The max limit of the emission direction.
  91411. */
  91412. direction2?: Vector3);
  91413. /**
  91414. * Called by the particle System when the direction is computed for the created particle.
  91415. * @param worldMatrix is the world matrix of the particle system
  91416. * @param directionToUpdate is the direction vector to update with the result
  91417. * @param particle is the particle we are computed the direction for
  91418. */
  91419. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  91420. /**
  91421. * Clones the current emitter and returns a copy of it
  91422. * @returns the new emitter
  91423. */
  91424. clone(): SphereDirectedParticleEmitter;
  91425. /**
  91426. * Called by the GPUParticleSystem to setup the update shader
  91427. * @param effect defines the update shader
  91428. */
  91429. applyToShader(effect: Effect): void;
  91430. /**
  91431. * Returns a string to use to update the GPU particles update shader
  91432. * @returns a string containng the defines string
  91433. */
  91434. getEffectDefines(): string;
  91435. /**
  91436. * Returns the string "SphereDirectedParticleEmitter"
  91437. * @returns a string containing the class name
  91438. */
  91439. getClassName(): string;
  91440. /**
  91441. * Serializes the particle system to a JSON object.
  91442. * @returns the JSON object
  91443. */
  91444. serialize(): any;
  91445. /**
  91446. * Parse properties from a JSON object
  91447. * @param serializationObject defines the JSON object
  91448. */
  91449. parse(serializationObject: any): void;
  91450. }
  91451. }
  91452. declare module BABYLON {
  91453. /**
  91454. * Particle emitter emitting particles from a custom list of positions.
  91455. */
  91456. export class CustomParticleEmitter implements IParticleEmitterType {
  91457. /**
  91458. * Gets or sets the position generator that will create the inital position of each particle.
  91459. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  91460. */
  91461. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  91462. /**
  91463. * Gets or sets the destination generator that will create the final destination of each particle.
  91464. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  91465. */
  91466. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  91467. /**
  91468. * Creates a new instance CustomParticleEmitter
  91469. */
  91470. constructor();
  91471. /**
  91472. * Called by the particle System when the direction is computed for the created particle.
  91473. * @param worldMatrix is the world matrix of the particle system
  91474. * @param directionToUpdate is the direction vector to update with the result
  91475. * @param particle is the particle we are computed the direction for
  91476. * @param isLocal defines if the direction should be set in local space
  91477. */
  91478. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91479. /**
  91480. * Called by the particle System when the position is computed for the created particle.
  91481. * @param worldMatrix is the world matrix of the particle system
  91482. * @param positionToUpdate is the position vector to update with the result
  91483. * @param particle is the particle we are computed the position for
  91484. * @param isLocal defines if the position should be set in local space
  91485. */
  91486. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91487. /**
  91488. * Clones the current emitter and returns a copy of it
  91489. * @returns the new emitter
  91490. */
  91491. clone(): CustomParticleEmitter;
  91492. /**
  91493. * Called by the GPUParticleSystem to setup the update shader
  91494. * @param effect defines the update shader
  91495. */
  91496. applyToShader(effect: Effect): void;
  91497. /**
  91498. * Returns a string to use to update the GPU particles update shader
  91499. * @returns a string containng the defines string
  91500. */
  91501. getEffectDefines(): string;
  91502. /**
  91503. * Returns the string "PointParticleEmitter"
  91504. * @returns a string containing the class name
  91505. */
  91506. getClassName(): string;
  91507. /**
  91508. * Serializes the particle system to a JSON object.
  91509. * @returns the JSON object
  91510. */
  91511. serialize(): any;
  91512. /**
  91513. * Parse properties from a JSON object
  91514. * @param serializationObject defines the JSON object
  91515. */
  91516. parse(serializationObject: any): void;
  91517. }
  91518. }
  91519. declare module BABYLON {
  91520. /**
  91521. * Particle emitter emitting particles from the inside of a box.
  91522. * It emits the particles randomly between 2 given directions.
  91523. */
  91524. export class MeshParticleEmitter implements IParticleEmitterType {
  91525. private _indices;
  91526. private _positions;
  91527. private _normals;
  91528. private _storedNormal;
  91529. private _mesh;
  91530. /**
  91531. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91532. */
  91533. direction1: Vector3;
  91534. /**
  91535. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91536. */
  91537. direction2: Vector3;
  91538. /**
  91539. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  91540. */
  91541. useMeshNormalsForDirection: boolean;
  91542. /** Defines the mesh to use as source */
  91543. get mesh(): Nullable<AbstractMesh>;
  91544. set mesh(value: Nullable<AbstractMesh>);
  91545. /**
  91546. * Creates a new instance MeshParticleEmitter
  91547. * @param mesh defines the mesh to use as source
  91548. */
  91549. constructor(mesh?: Nullable<AbstractMesh>);
  91550. /**
  91551. * Called by the particle System when the direction is computed for the created particle.
  91552. * @param worldMatrix is the world matrix of the particle system
  91553. * @param directionToUpdate is the direction vector to update with the result
  91554. * @param particle is the particle we are computed the direction for
  91555. * @param isLocal defines if the direction should be set in local space
  91556. */
  91557. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91558. /**
  91559. * Called by the particle System when the position is computed for the created particle.
  91560. * @param worldMatrix is the world matrix of the particle system
  91561. * @param positionToUpdate is the position vector to update with the result
  91562. * @param particle is the particle we are computed the position for
  91563. * @param isLocal defines if the position should be set in local space
  91564. */
  91565. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91566. /**
  91567. * Clones the current emitter and returns a copy of it
  91568. * @returns the new emitter
  91569. */
  91570. clone(): MeshParticleEmitter;
  91571. /**
  91572. * Called by the GPUParticleSystem to setup the update shader
  91573. * @param effect defines the update shader
  91574. */
  91575. applyToShader(effect: Effect): void;
  91576. /**
  91577. * Returns a string to use to update the GPU particles update shader
  91578. * @returns a string containng the defines string
  91579. */
  91580. getEffectDefines(): string;
  91581. /**
  91582. * Returns the string "BoxParticleEmitter"
  91583. * @returns a string containing the class name
  91584. */
  91585. getClassName(): string;
  91586. /**
  91587. * Serializes the particle system to a JSON object.
  91588. * @returns the JSON object
  91589. */
  91590. serialize(): any;
  91591. /**
  91592. * Parse properties from a JSON object
  91593. * @param serializationObject defines the JSON object
  91594. * @param scene defines the hosting scene
  91595. */
  91596. parse(serializationObject: any, scene: Scene): void;
  91597. }
  91598. }
  91599. declare module BABYLON {
  91600. /**
  91601. * Interface representing a particle system in Babylon.js.
  91602. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  91603. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  91604. */
  91605. export interface IParticleSystem {
  91606. /**
  91607. * List of animations used by the particle system.
  91608. */
  91609. animations: Animation[];
  91610. /**
  91611. * The id of the Particle system.
  91612. */
  91613. id: string;
  91614. /**
  91615. * The name of the Particle system.
  91616. */
  91617. name: string;
  91618. /**
  91619. * The emitter represents the Mesh or position we are attaching the particle system to.
  91620. */
  91621. emitter: Nullable<AbstractMesh | Vector3>;
  91622. /**
  91623. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  91624. */
  91625. isBillboardBased: boolean;
  91626. /**
  91627. * The rendering group used by the Particle system to chose when to render.
  91628. */
  91629. renderingGroupId: number;
  91630. /**
  91631. * The layer mask we are rendering the particles through.
  91632. */
  91633. layerMask: number;
  91634. /**
  91635. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91636. */
  91637. updateSpeed: number;
  91638. /**
  91639. * The amount of time the particle system is running (depends of the overall update speed).
  91640. */
  91641. targetStopDuration: number;
  91642. /**
  91643. * The texture used to render each particle. (this can be a spritesheet)
  91644. */
  91645. particleTexture: Nullable<Texture>;
  91646. /**
  91647. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  91648. */
  91649. blendMode: number;
  91650. /**
  91651. * Minimum life time of emitting particles.
  91652. */
  91653. minLifeTime: number;
  91654. /**
  91655. * Maximum life time of emitting particles.
  91656. */
  91657. maxLifeTime: number;
  91658. /**
  91659. * Minimum Size of emitting particles.
  91660. */
  91661. minSize: number;
  91662. /**
  91663. * Maximum Size of emitting particles.
  91664. */
  91665. maxSize: number;
  91666. /**
  91667. * Minimum scale of emitting particles on X axis.
  91668. */
  91669. minScaleX: number;
  91670. /**
  91671. * Maximum scale of emitting particles on X axis.
  91672. */
  91673. maxScaleX: number;
  91674. /**
  91675. * Minimum scale of emitting particles on Y axis.
  91676. */
  91677. minScaleY: number;
  91678. /**
  91679. * Maximum scale of emitting particles on Y axis.
  91680. */
  91681. maxScaleY: number;
  91682. /**
  91683. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  91684. */
  91685. color1: Color4;
  91686. /**
  91687. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  91688. */
  91689. color2: Color4;
  91690. /**
  91691. * Color the particle will have at the end of its lifetime.
  91692. */
  91693. colorDead: Color4;
  91694. /**
  91695. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  91696. */
  91697. emitRate: number;
  91698. /**
  91699. * You can use gravity if you want to give an orientation to your particles.
  91700. */
  91701. gravity: Vector3;
  91702. /**
  91703. * Minimum power of emitting particles.
  91704. */
  91705. minEmitPower: number;
  91706. /**
  91707. * Maximum power of emitting particles.
  91708. */
  91709. maxEmitPower: number;
  91710. /**
  91711. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91712. */
  91713. minAngularSpeed: number;
  91714. /**
  91715. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91716. */
  91717. maxAngularSpeed: number;
  91718. /**
  91719. * Gets or sets the minimal initial rotation in radians.
  91720. */
  91721. minInitialRotation: number;
  91722. /**
  91723. * Gets or sets the maximal initial rotation in radians.
  91724. */
  91725. maxInitialRotation: number;
  91726. /**
  91727. * The particle emitter type defines the emitter used by the particle system.
  91728. * It can be for example box, sphere, or cone...
  91729. */
  91730. particleEmitterType: Nullable<IParticleEmitterType>;
  91731. /**
  91732. * Defines the delay in milliseconds before starting the system (0 by default)
  91733. */
  91734. startDelay: number;
  91735. /**
  91736. * 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
  91737. */
  91738. preWarmCycles: number;
  91739. /**
  91740. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  91741. */
  91742. preWarmStepOffset: number;
  91743. /**
  91744. * 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)
  91745. */
  91746. spriteCellChangeSpeed: number;
  91747. /**
  91748. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91749. */
  91750. startSpriteCellID: number;
  91751. /**
  91752. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91753. */
  91754. endSpriteCellID: number;
  91755. /**
  91756. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91757. */
  91758. spriteCellWidth: number;
  91759. /**
  91760. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91761. */
  91762. spriteCellHeight: number;
  91763. /**
  91764. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91765. */
  91766. spriteRandomStartCell: boolean;
  91767. /**
  91768. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  91769. */
  91770. isAnimationSheetEnabled: boolean;
  91771. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91772. translationPivot: Vector2;
  91773. /**
  91774. * Gets or sets a texture used to add random noise to particle positions
  91775. */
  91776. noiseTexture: Nullable<BaseTexture>;
  91777. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91778. noiseStrength: Vector3;
  91779. /**
  91780. * Gets or sets the billboard mode to use when isBillboardBased = true.
  91781. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  91782. */
  91783. billboardMode: number;
  91784. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91785. limitVelocityDamping: number;
  91786. /**
  91787. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91788. */
  91789. beginAnimationOnStart: boolean;
  91790. /**
  91791. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91792. */
  91793. beginAnimationFrom: number;
  91794. /**
  91795. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91796. */
  91797. beginAnimationTo: number;
  91798. /**
  91799. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91800. */
  91801. beginAnimationLoop: boolean;
  91802. /**
  91803. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91804. */
  91805. disposeOnStop: boolean;
  91806. /**
  91807. * Specifies if the particles are updated in emitter local space or world space
  91808. */
  91809. isLocal: boolean;
  91810. /** Snippet ID if the particle system was created from the snippet server */
  91811. snippetId: string;
  91812. /**
  91813. * Gets the maximum number of particles active at the same time.
  91814. * @returns The max number of active particles.
  91815. */
  91816. getCapacity(): number;
  91817. /**
  91818. * Gets the number of particles active at the same time.
  91819. * @returns The number of active particles.
  91820. */
  91821. getActiveCount(): number;
  91822. /**
  91823. * Gets if the system has been started. (Note: this will still be true after stop is called)
  91824. * @returns True if it has been started, otherwise false.
  91825. */
  91826. isStarted(): boolean;
  91827. /**
  91828. * Animates the particle system for this frame.
  91829. */
  91830. animate(): void;
  91831. /**
  91832. * Renders the particle system in its current state.
  91833. * @returns the current number of particles
  91834. */
  91835. render(): number;
  91836. /**
  91837. * Dispose the particle system and frees its associated resources.
  91838. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  91839. */
  91840. dispose(disposeTexture?: boolean): void;
  91841. /**
  91842. * An event triggered when the system is disposed
  91843. */
  91844. onDisposeObservable: Observable<IParticleSystem>;
  91845. /**
  91846. * Clones the particle system.
  91847. * @param name The name of the cloned object
  91848. * @param newEmitter The new emitter to use
  91849. * @returns the cloned particle system
  91850. */
  91851. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  91852. /**
  91853. * Serializes the particle system to a JSON object
  91854. * @param serializeTexture defines if the texture must be serialized as well
  91855. * @returns the JSON object
  91856. */
  91857. serialize(serializeTexture: boolean): any;
  91858. /**
  91859. * Rebuild the particle system
  91860. */
  91861. rebuild(): void;
  91862. /** Force the system to rebuild all gradients that need to be resync */
  91863. forceRefreshGradients(): void;
  91864. /**
  91865. * Starts the particle system and begins to emit
  91866. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  91867. */
  91868. start(delay?: number): void;
  91869. /**
  91870. * Stops the particle system.
  91871. */
  91872. stop(): void;
  91873. /**
  91874. * Remove all active particles
  91875. */
  91876. reset(): void;
  91877. /**
  91878. * Gets a boolean indicating that the system is stopping
  91879. * @returns true if the system is currently stopping
  91880. */
  91881. isStopping(): boolean;
  91882. /**
  91883. * Is this system ready to be used/rendered
  91884. * @return true if the system is ready
  91885. */
  91886. isReady(): boolean;
  91887. /**
  91888. * Returns the string "ParticleSystem"
  91889. * @returns a string containing the class name
  91890. */
  91891. getClassName(): string;
  91892. /**
  91893. * Gets the custom effect used to render the particles
  91894. * @param blendMode Blend mode for which the effect should be retrieved
  91895. * @returns The effect
  91896. */
  91897. getCustomEffect(blendMode: number): Nullable<Effect>;
  91898. /**
  91899. * Sets the custom effect used to render the particles
  91900. * @param effect The effect to set
  91901. * @param blendMode Blend mode for which the effect should be set
  91902. */
  91903. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  91904. /**
  91905. * Fill the defines array according to the current settings of the particle system
  91906. * @param defines Array to be updated
  91907. * @param blendMode blend mode to take into account when updating the array
  91908. */
  91909. fillDefines(defines: Array<string>, blendMode: number): void;
  91910. /**
  91911. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  91912. * @param uniforms Uniforms array to fill
  91913. * @param attributes Attributes array to fill
  91914. * @param samplers Samplers array to fill
  91915. */
  91916. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  91917. /**
  91918. * Observable that will be called just before the particles are drawn
  91919. */
  91920. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  91921. /**
  91922. * Gets the name of the particle vertex shader
  91923. */
  91924. vertexShaderName: string;
  91925. /**
  91926. * Adds a new color gradient
  91927. * @param gradient defines the gradient to use (between 0 and 1)
  91928. * @param color1 defines the color to affect to the specified gradient
  91929. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  91930. * @returns the current particle system
  91931. */
  91932. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  91933. /**
  91934. * Remove a specific color gradient
  91935. * @param gradient defines the gradient to remove
  91936. * @returns the current particle system
  91937. */
  91938. removeColorGradient(gradient: number): IParticleSystem;
  91939. /**
  91940. * Adds a new size gradient
  91941. * @param gradient defines the gradient to use (between 0 and 1)
  91942. * @param factor defines the size factor to affect to the specified gradient
  91943. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91944. * @returns the current particle system
  91945. */
  91946. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91947. /**
  91948. * Remove a specific size gradient
  91949. * @param gradient defines the gradient to remove
  91950. * @returns the current particle system
  91951. */
  91952. removeSizeGradient(gradient: number): IParticleSystem;
  91953. /**
  91954. * Gets the current list of color gradients.
  91955. * You must use addColorGradient and removeColorGradient to udpate this list
  91956. * @returns the list of color gradients
  91957. */
  91958. getColorGradients(): Nullable<Array<ColorGradient>>;
  91959. /**
  91960. * Gets the current list of size gradients.
  91961. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91962. * @returns the list of size gradients
  91963. */
  91964. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91965. /**
  91966. * Gets the current list of angular speed gradients.
  91967. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91968. * @returns the list of angular speed gradients
  91969. */
  91970. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91971. /**
  91972. * Adds a new angular speed gradient
  91973. * @param gradient defines the gradient to use (between 0 and 1)
  91974. * @param factor defines the angular speed to affect to the specified gradient
  91975. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91976. * @returns the current particle system
  91977. */
  91978. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91979. /**
  91980. * Remove a specific angular speed gradient
  91981. * @param gradient defines the gradient to remove
  91982. * @returns the current particle system
  91983. */
  91984. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  91985. /**
  91986. * Gets the current list of velocity gradients.
  91987. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91988. * @returns the list of velocity gradients
  91989. */
  91990. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91991. /**
  91992. * Adds a new velocity gradient
  91993. * @param gradient defines the gradient to use (between 0 and 1)
  91994. * @param factor defines the velocity to affect to the specified gradient
  91995. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91996. * @returns the current particle system
  91997. */
  91998. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91999. /**
  92000. * Remove a specific velocity gradient
  92001. * @param gradient defines the gradient to remove
  92002. * @returns the current particle system
  92003. */
  92004. removeVelocityGradient(gradient: number): IParticleSystem;
  92005. /**
  92006. * Gets the current list of limit velocity gradients.
  92007. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  92008. * @returns the list of limit velocity gradients
  92009. */
  92010. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  92011. /**
  92012. * Adds a new limit velocity gradient
  92013. * @param gradient defines the gradient to use (between 0 and 1)
  92014. * @param factor defines the limit velocity to affect to the specified gradient
  92015. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92016. * @returns the current particle system
  92017. */
  92018. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92019. /**
  92020. * Remove a specific limit velocity gradient
  92021. * @param gradient defines the gradient to remove
  92022. * @returns the current particle system
  92023. */
  92024. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92025. /**
  92026. * Adds a new drag gradient
  92027. * @param gradient defines the gradient to use (between 0 and 1)
  92028. * @param factor defines the drag to affect to the specified gradient
  92029. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92030. * @returns the current particle system
  92031. */
  92032. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92033. /**
  92034. * Remove a specific drag gradient
  92035. * @param gradient defines the gradient to remove
  92036. * @returns the current particle system
  92037. */
  92038. removeDragGradient(gradient: number): IParticleSystem;
  92039. /**
  92040. * Gets the current list of drag gradients.
  92041. * You must use addDragGradient and removeDragGradient to udpate this list
  92042. * @returns the list of drag gradients
  92043. */
  92044. getDragGradients(): Nullable<Array<FactorGradient>>;
  92045. /**
  92046. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92047. * @param gradient defines the gradient to use (between 0 and 1)
  92048. * @param factor defines the emit rate to affect to the specified gradient
  92049. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92050. * @returns the current particle system
  92051. */
  92052. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92053. /**
  92054. * Remove a specific emit rate gradient
  92055. * @param gradient defines the gradient to remove
  92056. * @returns the current particle system
  92057. */
  92058. removeEmitRateGradient(gradient: number): IParticleSystem;
  92059. /**
  92060. * Gets the current list of emit rate gradients.
  92061. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  92062. * @returns the list of emit rate gradients
  92063. */
  92064. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  92065. /**
  92066. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92067. * @param gradient defines the gradient to use (between 0 and 1)
  92068. * @param factor defines the start size to affect to the specified gradient
  92069. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92070. * @returns the current particle system
  92071. */
  92072. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92073. /**
  92074. * Remove a specific start size gradient
  92075. * @param gradient defines the gradient to remove
  92076. * @returns the current particle system
  92077. */
  92078. removeStartSizeGradient(gradient: number): IParticleSystem;
  92079. /**
  92080. * Gets the current list of start size gradients.
  92081. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  92082. * @returns the list of start size gradients
  92083. */
  92084. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  92085. /**
  92086. * Adds a new life time gradient
  92087. * @param gradient defines the gradient to use (between 0 and 1)
  92088. * @param factor defines the life time factor to affect to the specified gradient
  92089. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92090. * @returns the current particle system
  92091. */
  92092. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92093. /**
  92094. * Remove a specific life time gradient
  92095. * @param gradient defines the gradient to remove
  92096. * @returns the current particle system
  92097. */
  92098. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92099. /**
  92100. * Gets the current list of life time gradients.
  92101. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  92102. * @returns the list of life time gradients
  92103. */
  92104. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  92105. /**
  92106. * Gets the current list of color gradients.
  92107. * You must use addColorGradient and removeColorGradient to udpate this list
  92108. * @returns the list of color gradients
  92109. */
  92110. getColorGradients(): Nullable<Array<ColorGradient>>;
  92111. /**
  92112. * Adds a new ramp gradient used to remap particle colors
  92113. * @param gradient defines the gradient to use (between 0 and 1)
  92114. * @param color defines the color to affect to the specified gradient
  92115. * @returns the current particle system
  92116. */
  92117. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  92118. /**
  92119. * Gets the current list of ramp gradients.
  92120. * You must use addRampGradient and removeRampGradient to udpate this list
  92121. * @returns the list of ramp gradients
  92122. */
  92123. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92124. /** Gets or sets a boolean indicating that ramp gradients must be used
  92125. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92126. */
  92127. useRampGradients: boolean;
  92128. /**
  92129. * Adds a new color remap gradient
  92130. * @param gradient defines the gradient to use (between 0 and 1)
  92131. * @param min defines the color remap minimal range
  92132. * @param max defines the color remap maximal range
  92133. * @returns the current particle system
  92134. */
  92135. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92136. /**
  92137. * Gets the current list of color remap gradients.
  92138. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  92139. * @returns the list of color remap gradients
  92140. */
  92141. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  92142. /**
  92143. * Adds a new alpha remap gradient
  92144. * @param gradient defines the gradient to use (between 0 and 1)
  92145. * @param min defines the alpha remap minimal range
  92146. * @param max defines the alpha remap maximal range
  92147. * @returns the current particle system
  92148. */
  92149. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92150. /**
  92151. * Gets the current list of alpha remap gradients.
  92152. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  92153. * @returns the list of alpha remap gradients
  92154. */
  92155. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  92156. /**
  92157. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  92158. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92159. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92160. * @returns the emitter
  92161. */
  92162. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  92163. /**
  92164. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  92165. * @param radius The radius of the hemisphere to emit from
  92166. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92167. * @returns the emitter
  92168. */
  92169. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  92170. /**
  92171. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  92172. * @param radius The radius of the sphere to emit from
  92173. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92174. * @returns the emitter
  92175. */
  92176. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  92177. /**
  92178. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  92179. * @param radius The radius of the sphere to emit from
  92180. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  92181. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  92182. * @returns the emitter
  92183. */
  92184. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  92185. /**
  92186. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  92187. * @param radius The radius of the emission cylinder
  92188. * @param height The height of the emission cylinder
  92189. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  92190. * @param directionRandomizer How much to randomize the particle direction [0-1]
  92191. * @returns the emitter
  92192. */
  92193. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  92194. /**
  92195. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  92196. * @param radius The radius of the cylinder to emit from
  92197. * @param height The height of the emission cylinder
  92198. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92199. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  92200. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  92201. * @returns the emitter
  92202. */
  92203. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  92204. /**
  92205. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  92206. * @param radius The radius of the cone to emit from
  92207. * @param angle The base angle of the cone
  92208. * @returns the emitter
  92209. */
  92210. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  92211. /**
  92212. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  92213. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92214. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92215. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92216. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92217. * @returns the emitter
  92218. */
  92219. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  92220. /**
  92221. * Get hosting scene
  92222. * @returns the scene
  92223. */
  92224. getScene(): Scene;
  92225. }
  92226. }
  92227. declare module BABYLON {
  92228. /**
  92229. * 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.
  92230. * @see https://doc.babylonjs.com/how_to/transformnode
  92231. */
  92232. export class TransformNode extends Node {
  92233. /**
  92234. * Object will not rotate to face the camera
  92235. */
  92236. static BILLBOARDMODE_NONE: number;
  92237. /**
  92238. * Object will rotate to face the camera but only on the x axis
  92239. */
  92240. static BILLBOARDMODE_X: number;
  92241. /**
  92242. * Object will rotate to face the camera but only on the y axis
  92243. */
  92244. static BILLBOARDMODE_Y: number;
  92245. /**
  92246. * Object will rotate to face the camera but only on the z axis
  92247. */
  92248. static BILLBOARDMODE_Z: number;
  92249. /**
  92250. * Object will rotate to face the camera
  92251. */
  92252. static BILLBOARDMODE_ALL: number;
  92253. /**
  92254. * Object will rotate to face the camera's position instead of orientation
  92255. */
  92256. static BILLBOARDMODE_USE_POSITION: number;
  92257. private static _TmpRotation;
  92258. private static _TmpScaling;
  92259. private static _TmpTranslation;
  92260. private _forward;
  92261. private _forwardInverted;
  92262. private _up;
  92263. private _right;
  92264. private _rightInverted;
  92265. private _position;
  92266. private _rotation;
  92267. private _rotationQuaternion;
  92268. protected _scaling: Vector3;
  92269. protected _isDirty: boolean;
  92270. private _transformToBoneReferal;
  92271. private _isAbsoluteSynced;
  92272. private _billboardMode;
  92273. /**
  92274. * Gets or sets the billboard mode. Default is 0.
  92275. *
  92276. * | Value | Type | Description |
  92277. * | --- | --- | --- |
  92278. * | 0 | BILLBOARDMODE_NONE | |
  92279. * | 1 | BILLBOARDMODE_X | |
  92280. * | 2 | BILLBOARDMODE_Y | |
  92281. * | 4 | BILLBOARDMODE_Z | |
  92282. * | 7 | BILLBOARDMODE_ALL | |
  92283. *
  92284. */
  92285. get billboardMode(): number;
  92286. set billboardMode(value: number);
  92287. private _preserveParentRotationForBillboard;
  92288. /**
  92289. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  92290. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  92291. */
  92292. get preserveParentRotationForBillboard(): boolean;
  92293. set preserveParentRotationForBillboard(value: boolean);
  92294. /**
  92295. * 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
  92296. */
  92297. scalingDeterminant: number;
  92298. private _infiniteDistance;
  92299. /**
  92300. * Gets or sets the distance of the object to max, often used by skybox
  92301. */
  92302. get infiniteDistance(): boolean;
  92303. set infiniteDistance(value: boolean);
  92304. /**
  92305. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  92306. * By default the system will update normals to compensate
  92307. */
  92308. ignoreNonUniformScaling: boolean;
  92309. /**
  92310. * 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
  92311. */
  92312. reIntegrateRotationIntoRotationQuaternion: boolean;
  92313. /** @hidden */
  92314. _poseMatrix: Nullable<Matrix>;
  92315. /** @hidden */
  92316. _localMatrix: Matrix;
  92317. private _usePivotMatrix;
  92318. private _absolutePosition;
  92319. private _absoluteScaling;
  92320. private _absoluteRotationQuaternion;
  92321. private _pivotMatrix;
  92322. private _pivotMatrixInverse;
  92323. protected _postMultiplyPivotMatrix: boolean;
  92324. protected _isWorldMatrixFrozen: boolean;
  92325. /** @hidden */
  92326. _indexInSceneTransformNodesArray: number;
  92327. /**
  92328. * An event triggered after the world matrix is updated
  92329. */
  92330. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  92331. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  92332. /**
  92333. * Gets a string identifying the name of the class
  92334. * @returns "TransformNode" string
  92335. */
  92336. getClassName(): string;
  92337. /**
  92338. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  92339. */
  92340. get position(): Vector3;
  92341. set position(newPosition: Vector3);
  92342. /**
  92343. * 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)).
  92344. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  92345. */
  92346. get rotation(): Vector3;
  92347. set rotation(newRotation: Vector3);
  92348. /**
  92349. * 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)).
  92350. */
  92351. get scaling(): Vector3;
  92352. set scaling(newScaling: Vector3);
  92353. /**
  92354. * 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).
  92355. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  92356. */
  92357. get rotationQuaternion(): Nullable<Quaternion>;
  92358. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  92359. /**
  92360. * The forward direction of that transform in world space.
  92361. */
  92362. get forward(): Vector3;
  92363. /**
  92364. * The up direction of that transform in world space.
  92365. */
  92366. get up(): Vector3;
  92367. /**
  92368. * The right direction of that transform in world space.
  92369. */
  92370. get right(): Vector3;
  92371. /**
  92372. * Copies the parameter passed Matrix into the mesh Pose matrix.
  92373. * @param matrix the matrix to copy the pose from
  92374. * @returns this TransformNode.
  92375. */
  92376. updatePoseMatrix(matrix: Matrix): TransformNode;
  92377. /**
  92378. * Returns the mesh Pose matrix.
  92379. * @returns the pose matrix
  92380. */
  92381. getPoseMatrix(): Matrix;
  92382. /** @hidden */
  92383. _isSynchronized(): boolean;
  92384. /** @hidden */
  92385. _initCache(): void;
  92386. /**
  92387. * Flag the transform node as dirty (Forcing it to update everything)
  92388. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  92389. * @returns this transform node
  92390. */
  92391. markAsDirty(property: string): TransformNode;
  92392. /**
  92393. * Returns the current mesh absolute position.
  92394. * Returns a Vector3.
  92395. */
  92396. get absolutePosition(): Vector3;
  92397. /**
  92398. * Returns the current mesh absolute scaling.
  92399. * Returns a Vector3.
  92400. */
  92401. get absoluteScaling(): Vector3;
  92402. /**
  92403. * Returns the current mesh absolute rotation.
  92404. * Returns a Quaternion.
  92405. */
  92406. get absoluteRotationQuaternion(): Quaternion;
  92407. /**
  92408. * Sets a new matrix to apply before all other transformation
  92409. * @param matrix defines the transform matrix
  92410. * @returns the current TransformNode
  92411. */
  92412. setPreTransformMatrix(matrix: Matrix): TransformNode;
  92413. /**
  92414. * Sets a new pivot matrix to the current node
  92415. * @param matrix defines the new pivot matrix to use
  92416. * @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
  92417. * @returns the current TransformNode
  92418. */
  92419. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  92420. /**
  92421. * Returns the mesh pivot matrix.
  92422. * Default : Identity.
  92423. * @returns the matrix
  92424. */
  92425. getPivotMatrix(): Matrix;
  92426. /**
  92427. * Instantiate (when possible) or clone that node with its hierarchy
  92428. * @param newParent defines the new parent to use for the instance (or clone)
  92429. * @param options defines options to configure how copy is done
  92430. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  92431. * @returns an instance (or a clone) of the current node with its hiearchy
  92432. */
  92433. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  92434. doNotInstantiate: boolean;
  92435. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  92436. /**
  92437. * Prevents the World matrix to be computed any longer
  92438. * @param newWorldMatrix defines an optional matrix to use as world matrix
  92439. * @returns the TransformNode.
  92440. */
  92441. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  92442. /**
  92443. * Allows back the World matrix computation.
  92444. * @returns the TransformNode.
  92445. */
  92446. unfreezeWorldMatrix(): this;
  92447. /**
  92448. * True if the World matrix has been frozen.
  92449. */
  92450. get isWorldMatrixFrozen(): boolean;
  92451. /**
  92452. * Retuns the mesh absolute position in the World.
  92453. * @returns a Vector3.
  92454. */
  92455. getAbsolutePosition(): Vector3;
  92456. /**
  92457. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  92458. * @param absolutePosition the absolute position to set
  92459. * @returns the TransformNode.
  92460. */
  92461. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  92462. /**
  92463. * Sets the mesh position in its local space.
  92464. * @param vector3 the position to set in localspace
  92465. * @returns the TransformNode.
  92466. */
  92467. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  92468. /**
  92469. * Returns the mesh position in the local space from the current World matrix values.
  92470. * @returns a new Vector3.
  92471. */
  92472. getPositionExpressedInLocalSpace(): Vector3;
  92473. /**
  92474. * Translates the mesh along the passed Vector3 in its local space.
  92475. * @param vector3 the distance to translate in localspace
  92476. * @returns the TransformNode.
  92477. */
  92478. locallyTranslate(vector3: Vector3): TransformNode;
  92479. private static _lookAtVectorCache;
  92480. /**
  92481. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  92482. * @param targetPoint the position (must be in same space as current mesh) to look at
  92483. * @param yawCor optional yaw (y-axis) correction in radians
  92484. * @param pitchCor optional pitch (x-axis) correction in radians
  92485. * @param rollCor optional roll (z-axis) correction in radians
  92486. * @param space the choosen space of the target
  92487. * @returns the TransformNode.
  92488. */
  92489. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  92490. /**
  92491. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  92492. * This Vector3 is expressed in the World space.
  92493. * @param localAxis axis to rotate
  92494. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  92495. */
  92496. getDirection(localAxis: Vector3): Vector3;
  92497. /**
  92498. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  92499. * localAxis is expressed in the mesh local space.
  92500. * result is computed in the Wordl space from the mesh World matrix.
  92501. * @param localAxis axis to rotate
  92502. * @param result the resulting transformnode
  92503. * @returns this TransformNode.
  92504. */
  92505. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  92506. /**
  92507. * Sets this transform node rotation to the given local axis.
  92508. * @param localAxis the axis in local space
  92509. * @param yawCor optional yaw (y-axis) correction in radians
  92510. * @param pitchCor optional pitch (x-axis) correction in radians
  92511. * @param rollCor optional roll (z-axis) correction in radians
  92512. * @returns this TransformNode
  92513. */
  92514. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  92515. /**
  92516. * Sets a new pivot point to the current node
  92517. * @param point defines the new pivot point to use
  92518. * @param space defines if the point is in world or local space (local by default)
  92519. * @returns the current TransformNode
  92520. */
  92521. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  92522. /**
  92523. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  92524. * @returns the pivot point
  92525. */
  92526. getPivotPoint(): Vector3;
  92527. /**
  92528. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  92529. * @param result the vector3 to store the result
  92530. * @returns this TransformNode.
  92531. */
  92532. getPivotPointToRef(result: Vector3): TransformNode;
  92533. /**
  92534. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  92535. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  92536. */
  92537. getAbsolutePivotPoint(): Vector3;
  92538. /**
  92539. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  92540. * @param result vector3 to store the result
  92541. * @returns this TransformNode.
  92542. */
  92543. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  92544. /**
  92545. * Defines the passed node as the parent of the current node.
  92546. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  92547. * @see https://doc.babylonjs.com/how_to/parenting
  92548. * @param node the node ot set as the parent
  92549. * @returns this TransformNode.
  92550. */
  92551. setParent(node: Nullable<Node>): TransformNode;
  92552. private _nonUniformScaling;
  92553. /**
  92554. * True if the scaling property of this object is non uniform eg. (1,2,1)
  92555. */
  92556. get nonUniformScaling(): boolean;
  92557. /** @hidden */
  92558. _updateNonUniformScalingState(value: boolean): boolean;
  92559. /**
  92560. * Attach the current TransformNode to another TransformNode associated with a bone
  92561. * @param bone Bone affecting the TransformNode
  92562. * @param affectedTransformNode TransformNode associated with the bone
  92563. * @returns this object
  92564. */
  92565. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  92566. /**
  92567. * Detach the transform node if its associated with a bone
  92568. * @returns this object
  92569. */
  92570. detachFromBone(): TransformNode;
  92571. private static _rotationAxisCache;
  92572. /**
  92573. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  92574. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  92575. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  92576. * The passed axis is also normalized.
  92577. * @param axis the axis to rotate around
  92578. * @param amount the amount to rotate in radians
  92579. * @param space Space to rotate in (Default: local)
  92580. * @returns the TransformNode.
  92581. */
  92582. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  92583. /**
  92584. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  92585. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  92586. * The passed axis is also normalized. .
  92587. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  92588. * @param point the point to rotate around
  92589. * @param axis the axis to rotate around
  92590. * @param amount the amount to rotate in radians
  92591. * @returns the TransformNode
  92592. */
  92593. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  92594. /**
  92595. * Translates the mesh along the axis vector for the passed distance in the given space.
  92596. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  92597. * @param axis the axis to translate in
  92598. * @param distance the distance to translate
  92599. * @param space Space to rotate in (Default: local)
  92600. * @returns the TransformNode.
  92601. */
  92602. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  92603. /**
  92604. * Adds a rotation step to the mesh current rotation.
  92605. * x, y, z are Euler angles expressed in radians.
  92606. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  92607. * This means this rotation is made in the mesh local space only.
  92608. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  92609. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  92610. * ```javascript
  92611. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  92612. * ```
  92613. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  92614. * 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.
  92615. * @param x Rotation to add
  92616. * @param y Rotation to add
  92617. * @param z Rotation to add
  92618. * @returns the TransformNode.
  92619. */
  92620. addRotation(x: number, y: number, z: number): TransformNode;
  92621. /**
  92622. * @hidden
  92623. */
  92624. protected _getEffectiveParent(): Nullable<Node>;
  92625. /**
  92626. * Computes the world matrix of the node
  92627. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  92628. * @returns the world matrix
  92629. */
  92630. computeWorldMatrix(force?: boolean): Matrix;
  92631. /**
  92632. * Resets this nodeTransform's local matrix to Matrix.Identity().
  92633. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  92634. */
  92635. resetLocalMatrix(independentOfChildren?: boolean): void;
  92636. protected _afterComputeWorldMatrix(): void;
  92637. /**
  92638. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  92639. * @param func callback function to add
  92640. *
  92641. * @returns the TransformNode.
  92642. */
  92643. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  92644. /**
  92645. * Removes a registered callback function.
  92646. * @param func callback function to remove
  92647. * @returns the TransformNode.
  92648. */
  92649. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  92650. /**
  92651. * Gets the position of the current mesh in camera space
  92652. * @param camera defines the camera to use
  92653. * @returns a position
  92654. */
  92655. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  92656. /**
  92657. * Returns the distance from the mesh to the active camera
  92658. * @param camera defines the camera to use
  92659. * @returns the distance
  92660. */
  92661. getDistanceToCamera(camera?: Nullable<Camera>): number;
  92662. /**
  92663. * Clone the current transform node
  92664. * @param name Name of the new clone
  92665. * @param newParent New parent for the clone
  92666. * @param doNotCloneChildren Do not clone children hierarchy
  92667. * @returns the new transform node
  92668. */
  92669. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  92670. /**
  92671. * Serializes the objects information.
  92672. * @param currentSerializationObject defines the object to serialize in
  92673. * @returns the serialized object
  92674. */
  92675. serialize(currentSerializationObject?: any): any;
  92676. /**
  92677. * Returns a new TransformNode object parsed from the source provided.
  92678. * @param parsedTransformNode is the source.
  92679. * @param scene the scne the object belongs to
  92680. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  92681. * @returns a new TransformNode object parsed from the source provided.
  92682. */
  92683. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  92684. /**
  92685. * Get all child-transformNodes of this node
  92686. * @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
  92687. * @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
  92688. * @returns an array of TransformNode
  92689. */
  92690. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  92691. /**
  92692. * Releases resources associated with this transform node.
  92693. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  92694. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  92695. */
  92696. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  92697. /**
  92698. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  92699. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  92700. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  92701. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  92702. * @returns the current mesh
  92703. */
  92704. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  92705. private _syncAbsoluteScalingAndRotation;
  92706. }
  92707. }
  92708. declare module BABYLON {
  92709. /**
  92710. * Class used to override all child animations of a given target
  92711. */
  92712. export class AnimationPropertiesOverride {
  92713. /**
  92714. * Gets or sets a value indicating if animation blending must be used
  92715. */
  92716. enableBlending: boolean;
  92717. /**
  92718. * Gets or sets the blending speed to use when enableBlending is true
  92719. */
  92720. blendingSpeed: number;
  92721. /**
  92722. * Gets or sets the default loop mode to use
  92723. */
  92724. loopMode: number;
  92725. }
  92726. }
  92727. declare module BABYLON {
  92728. /**
  92729. * Class used to store bone information
  92730. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  92731. */
  92732. export class Bone extends Node {
  92733. /**
  92734. * defines the bone name
  92735. */
  92736. name: string;
  92737. private static _tmpVecs;
  92738. private static _tmpQuat;
  92739. private static _tmpMats;
  92740. /**
  92741. * Gets the list of child bones
  92742. */
  92743. children: Bone[];
  92744. /** Gets the animations associated with this bone */
  92745. animations: Animation[];
  92746. /**
  92747. * Gets or sets bone length
  92748. */
  92749. length: number;
  92750. /**
  92751. * @hidden Internal only
  92752. * Set this value to map this bone to a different index in the transform matrices
  92753. * Set this value to -1 to exclude the bone from the transform matrices
  92754. */
  92755. _index: Nullable<number>;
  92756. private _skeleton;
  92757. private _localMatrix;
  92758. private _restPose;
  92759. private _baseMatrix;
  92760. private _absoluteTransform;
  92761. private _invertedAbsoluteTransform;
  92762. private _parent;
  92763. private _scalingDeterminant;
  92764. private _worldTransform;
  92765. private _localScaling;
  92766. private _localRotation;
  92767. private _localPosition;
  92768. private _needToDecompose;
  92769. private _needToCompose;
  92770. /** @hidden */
  92771. _linkedTransformNode: Nullable<TransformNode>;
  92772. /** @hidden */
  92773. _waitingTransformNodeId: Nullable<string>;
  92774. /** @hidden */
  92775. get _matrix(): Matrix;
  92776. /** @hidden */
  92777. set _matrix(value: Matrix);
  92778. /**
  92779. * Create a new bone
  92780. * @param name defines the bone name
  92781. * @param skeleton defines the parent skeleton
  92782. * @param parentBone defines the parent (can be null if the bone is the root)
  92783. * @param localMatrix defines the local matrix
  92784. * @param restPose defines the rest pose matrix
  92785. * @param baseMatrix defines the base matrix
  92786. * @param index defines index of the bone in the hiearchy
  92787. */
  92788. constructor(
  92789. /**
  92790. * defines the bone name
  92791. */
  92792. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  92793. /**
  92794. * Gets the current object class name.
  92795. * @return the class name
  92796. */
  92797. getClassName(): string;
  92798. /**
  92799. * Gets the parent skeleton
  92800. * @returns a skeleton
  92801. */
  92802. getSkeleton(): Skeleton;
  92803. /**
  92804. * Gets parent bone
  92805. * @returns a bone or null if the bone is the root of the bone hierarchy
  92806. */
  92807. getParent(): Nullable<Bone>;
  92808. /**
  92809. * Returns an array containing the root bones
  92810. * @returns an array containing the root bones
  92811. */
  92812. getChildren(): Array<Bone>;
  92813. /**
  92814. * Gets the node index in matrix array generated for rendering
  92815. * @returns the node index
  92816. */
  92817. getIndex(): number;
  92818. /**
  92819. * Sets the parent bone
  92820. * @param parent defines the parent (can be null if the bone is the root)
  92821. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  92822. */
  92823. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  92824. /**
  92825. * Gets the local matrix
  92826. * @returns a matrix
  92827. */
  92828. getLocalMatrix(): Matrix;
  92829. /**
  92830. * Gets the base matrix (initial matrix which remains unchanged)
  92831. * @returns a matrix
  92832. */
  92833. getBaseMatrix(): Matrix;
  92834. /**
  92835. * Gets the rest pose matrix
  92836. * @returns a matrix
  92837. */
  92838. getRestPose(): Matrix;
  92839. /**
  92840. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  92841. */
  92842. getWorldMatrix(): Matrix;
  92843. /**
  92844. * Sets the local matrix to rest pose matrix
  92845. */
  92846. returnToRest(): void;
  92847. /**
  92848. * Gets the inverse of the absolute transform matrix.
  92849. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  92850. * @returns a matrix
  92851. */
  92852. getInvertedAbsoluteTransform(): Matrix;
  92853. /**
  92854. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  92855. * @returns a matrix
  92856. */
  92857. getAbsoluteTransform(): Matrix;
  92858. /**
  92859. * Links with the given transform node.
  92860. * The local matrix of this bone is copied from the transform node every frame.
  92861. * @param transformNode defines the transform node to link to
  92862. */
  92863. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  92864. /**
  92865. * Gets the node used to drive the bone's transformation
  92866. * @returns a transform node or null
  92867. */
  92868. getTransformNode(): Nullable<TransformNode>;
  92869. /** Gets or sets current position (in local space) */
  92870. get position(): Vector3;
  92871. set position(newPosition: Vector3);
  92872. /** Gets or sets current rotation (in local space) */
  92873. get rotation(): Vector3;
  92874. set rotation(newRotation: Vector3);
  92875. /** Gets or sets current rotation quaternion (in local space) */
  92876. get rotationQuaternion(): Quaternion;
  92877. set rotationQuaternion(newRotation: Quaternion);
  92878. /** Gets or sets current scaling (in local space) */
  92879. get scaling(): Vector3;
  92880. set scaling(newScaling: Vector3);
  92881. /**
  92882. * Gets the animation properties override
  92883. */
  92884. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  92885. private _decompose;
  92886. private _compose;
  92887. /**
  92888. * Update the base and local matrices
  92889. * @param matrix defines the new base or local matrix
  92890. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  92891. * @param updateLocalMatrix defines if the local matrix should be updated
  92892. */
  92893. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  92894. /** @hidden */
  92895. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  92896. /**
  92897. * Flag the bone as dirty (Forcing it to update everything)
  92898. */
  92899. markAsDirty(): void;
  92900. /** @hidden */
  92901. _markAsDirtyAndCompose(): void;
  92902. private _markAsDirtyAndDecompose;
  92903. /**
  92904. * Translate the bone in local or world space
  92905. * @param vec The amount to translate the bone
  92906. * @param space The space that the translation is in
  92907. * @param mesh The mesh that this bone is attached to. This is only used in world space
  92908. */
  92909. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  92910. /**
  92911. * Set the postion of the bone in local or world space
  92912. * @param position The position to set the bone
  92913. * @param space The space that the position is in
  92914. * @param mesh The mesh that this bone is attached to. This is only used in world space
  92915. */
  92916. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  92917. /**
  92918. * Set the absolute position of the bone (world space)
  92919. * @param position The position to set the bone
  92920. * @param mesh The mesh that this bone is attached to
  92921. */
  92922. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  92923. /**
  92924. * Scale the bone on the x, y and z axes (in local space)
  92925. * @param x The amount to scale the bone on the x axis
  92926. * @param y The amount to scale the bone on the y axis
  92927. * @param z The amount to scale the bone on the z axis
  92928. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  92929. */
  92930. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  92931. /**
  92932. * Set the bone scaling in local space
  92933. * @param scale defines the scaling vector
  92934. */
  92935. setScale(scale: Vector3): void;
  92936. /**
  92937. * Gets the current scaling in local space
  92938. * @returns the current scaling vector
  92939. */
  92940. getScale(): Vector3;
  92941. /**
  92942. * Gets the current scaling in local space and stores it in a target vector
  92943. * @param result defines the target vector
  92944. */
  92945. getScaleToRef(result: Vector3): void;
  92946. /**
  92947. * Set the yaw, pitch, and roll of the bone in local or world space
  92948. * @param yaw The rotation of the bone on the y axis
  92949. * @param pitch The rotation of the bone on the x axis
  92950. * @param roll The rotation of the bone on the z axis
  92951. * @param space The space that the axes of rotation are in
  92952. * @param mesh The mesh that this bone is attached to. This is only used in world space
  92953. */
  92954. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  92955. /**
  92956. * Add a rotation to the bone on an axis in local or world space
  92957. * @param axis The axis to rotate the bone on
  92958. * @param amount The amount to rotate the bone
  92959. * @param space The space that the axis is in
  92960. * @param mesh The mesh that this bone is attached to. This is only used in world space
  92961. */
  92962. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  92963. /**
  92964. * Set the rotation of the bone to a particular axis angle in local or world space
  92965. * @param axis The axis to rotate the bone on
  92966. * @param angle The angle that the bone should be rotated to
  92967. * @param space The space that the axis is in
  92968. * @param mesh The mesh that this bone is attached to. This is only used in world space
  92969. */
  92970. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  92971. /**
  92972. * Set the euler rotation of the bone in local of world space
  92973. * @param rotation The euler rotation that the bone should be set to
  92974. * @param space The space that the rotation is in
  92975. * @param mesh The mesh that this bone is attached to. This is only used in world space
  92976. */
  92977. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  92978. /**
  92979. * Set the quaternion rotation of the bone in local of world space
  92980. * @param quat The quaternion rotation that the bone should be set to
  92981. * @param space The space that the rotation is in
  92982. * @param mesh The mesh that this bone is attached to. This is only used in world space
  92983. */
  92984. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  92985. /**
  92986. * Set the rotation matrix of the bone in local of world space
  92987. * @param rotMat The rotation matrix that the bone should be set to
  92988. * @param space The space that the rotation is in
  92989. * @param mesh The mesh that this bone is attached to. This is only used in world space
  92990. */
  92991. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  92992. private _rotateWithMatrix;
  92993. private _getNegativeRotationToRef;
  92994. /**
  92995. * Get the position of the bone in local or world space
  92996. * @param space The space that the returned position is in
  92997. * @param mesh The mesh that this bone is attached to. This is only used in world space
  92998. * @returns The position of the bone
  92999. */
  93000. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  93001. /**
  93002. * Copy the position of the bone to a vector3 in local or world space
  93003. * @param space The space that the returned position is in
  93004. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93005. * @param result The vector3 to copy the position to
  93006. */
  93007. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  93008. /**
  93009. * Get the absolute position of the bone (world space)
  93010. * @param mesh The mesh that this bone is attached to
  93011. * @returns The absolute position of the bone
  93012. */
  93013. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  93014. /**
  93015. * Copy the absolute position of the bone (world space) to the result param
  93016. * @param mesh The mesh that this bone is attached to
  93017. * @param result The vector3 to copy the absolute position to
  93018. */
  93019. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  93020. /**
  93021. * Compute the absolute transforms of this bone and its children
  93022. */
  93023. computeAbsoluteTransforms(): void;
  93024. /**
  93025. * Get the world direction from an axis that is in the local space of the bone
  93026. * @param localAxis The local direction that is used to compute the world direction
  93027. * @param mesh The mesh that this bone is attached to
  93028. * @returns The world direction
  93029. */
  93030. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  93031. /**
  93032. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  93033. * @param localAxis The local direction that is used to compute the world direction
  93034. * @param mesh The mesh that this bone is attached to
  93035. * @param result The vector3 that the world direction will be copied to
  93036. */
  93037. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  93038. /**
  93039. * Get the euler rotation of the bone in local or world space
  93040. * @param space The space that the rotation should be in
  93041. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93042. * @returns The euler rotation
  93043. */
  93044. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  93045. /**
  93046. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  93047. * @param space The space that the rotation should be in
  93048. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93049. * @param result The vector3 that the rotation should be copied to
  93050. */
  93051. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  93052. /**
  93053. * Get the quaternion rotation of the bone in either local or world space
  93054. * @param space The space that the rotation should be in
  93055. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93056. * @returns The quaternion rotation
  93057. */
  93058. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  93059. /**
  93060. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  93061. * @param space The space that the rotation should be in
  93062. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93063. * @param result The quaternion that the rotation should be copied to
  93064. */
  93065. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  93066. /**
  93067. * Get the rotation matrix of the bone in local or world space
  93068. * @param space The space that the rotation should be in
  93069. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93070. * @returns The rotation matrix
  93071. */
  93072. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  93073. /**
  93074. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  93075. * @param space The space that the rotation should be in
  93076. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93077. * @param result The quaternion that the rotation should be copied to
  93078. */
  93079. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  93080. /**
  93081. * Get the world position of a point that is in the local space of the bone
  93082. * @param position The local position
  93083. * @param mesh The mesh that this bone is attached to
  93084. * @returns The world position
  93085. */
  93086. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  93087. /**
  93088. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  93089. * @param position The local position
  93090. * @param mesh The mesh that this bone is attached to
  93091. * @param result The vector3 that the world position should be copied to
  93092. */
  93093. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  93094. /**
  93095. * Get the local position of a point that is in world space
  93096. * @param position The world position
  93097. * @param mesh The mesh that this bone is attached to
  93098. * @returns The local position
  93099. */
  93100. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  93101. /**
  93102. * Get the local position of a point that is in world space and copy it to the result param
  93103. * @param position The world position
  93104. * @param mesh The mesh that this bone is attached to
  93105. * @param result The vector3 that the local position should be copied to
  93106. */
  93107. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  93108. }
  93109. }
  93110. declare module BABYLON {
  93111. /**
  93112. * Defines a runtime animation
  93113. */
  93114. export class RuntimeAnimation {
  93115. private _events;
  93116. /**
  93117. * The current frame of the runtime animation
  93118. */
  93119. private _currentFrame;
  93120. /**
  93121. * The animation used by the runtime animation
  93122. */
  93123. private _animation;
  93124. /**
  93125. * The target of the runtime animation
  93126. */
  93127. private _target;
  93128. /**
  93129. * The initiating animatable
  93130. */
  93131. private _host;
  93132. /**
  93133. * The original value of the runtime animation
  93134. */
  93135. private _originalValue;
  93136. /**
  93137. * The original blend value of the runtime animation
  93138. */
  93139. private _originalBlendValue;
  93140. /**
  93141. * The offsets cache of the runtime animation
  93142. */
  93143. private _offsetsCache;
  93144. /**
  93145. * The high limits cache of the runtime animation
  93146. */
  93147. private _highLimitsCache;
  93148. /**
  93149. * Specifies if the runtime animation has been stopped
  93150. */
  93151. private _stopped;
  93152. /**
  93153. * The blending factor of the runtime animation
  93154. */
  93155. private _blendingFactor;
  93156. /**
  93157. * The BabylonJS scene
  93158. */
  93159. private _scene;
  93160. /**
  93161. * The current value of the runtime animation
  93162. */
  93163. private _currentValue;
  93164. /** @hidden */
  93165. _animationState: _IAnimationState;
  93166. /**
  93167. * The active target of the runtime animation
  93168. */
  93169. private _activeTargets;
  93170. private _currentActiveTarget;
  93171. private _directTarget;
  93172. /**
  93173. * The target path of the runtime animation
  93174. */
  93175. private _targetPath;
  93176. /**
  93177. * The weight of the runtime animation
  93178. */
  93179. private _weight;
  93180. /**
  93181. * The ratio offset of the runtime animation
  93182. */
  93183. private _ratioOffset;
  93184. /**
  93185. * The previous delay of the runtime animation
  93186. */
  93187. private _previousDelay;
  93188. /**
  93189. * The previous ratio of the runtime animation
  93190. */
  93191. private _previousRatio;
  93192. private _enableBlending;
  93193. private _keys;
  93194. private _minFrame;
  93195. private _maxFrame;
  93196. private _minValue;
  93197. private _maxValue;
  93198. private _targetIsArray;
  93199. /**
  93200. * Gets the current frame of the runtime animation
  93201. */
  93202. get currentFrame(): number;
  93203. /**
  93204. * Gets the weight of the runtime animation
  93205. */
  93206. get weight(): number;
  93207. /**
  93208. * Gets the current value of the runtime animation
  93209. */
  93210. get currentValue(): any;
  93211. /**
  93212. * Gets the target path of the runtime animation
  93213. */
  93214. get targetPath(): string;
  93215. /**
  93216. * Gets the actual target of the runtime animation
  93217. */
  93218. get target(): any;
  93219. /**
  93220. * Gets the additive state of the runtime animation
  93221. */
  93222. get isAdditive(): boolean;
  93223. /** @hidden */
  93224. _onLoop: () => void;
  93225. /**
  93226. * Create a new RuntimeAnimation object
  93227. * @param target defines the target of the animation
  93228. * @param animation defines the source animation object
  93229. * @param scene defines the hosting scene
  93230. * @param host defines the initiating Animatable
  93231. */
  93232. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  93233. private _preparePath;
  93234. /**
  93235. * Gets the animation from the runtime animation
  93236. */
  93237. get animation(): Animation;
  93238. /**
  93239. * Resets the runtime animation to the beginning
  93240. * @param restoreOriginal defines whether to restore the target property to the original value
  93241. */
  93242. reset(restoreOriginal?: boolean): void;
  93243. /**
  93244. * Specifies if the runtime animation is stopped
  93245. * @returns Boolean specifying if the runtime animation is stopped
  93246. */
  93247. isStopped(): boolean;
  93248. /**
  93249. * Disposes of the runtime animation
  93250. */
  93251. dispose(): void;
  93252. /**
  93253. * Apply the interpolated value to the target
  93254. * @param currentValue defines the value computed by the animation
  93255. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  93256. */
  93257. setValue(currentValue: any, weight: number): void;
  93258. private _getOriginalValues;
  93259. private _setValue;
  93260. /**
  93261. * Gets the loop pmode of the runtime animation
  93262. * @returns Loop Mode
  93263. */
  93264. private _getCorrectLoopMode;
  93265. /**
  93266. * Move the current animation to a given frame
  93267. * @param frame defines the frame to move to
  93268. */
  93269. goToFrame(frame: number): void;
  93270. /**
  93271. * @hidden Internal use only
  93272. */
  93273. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  93274. /**
  93275. * Execute the current animation
  93276. * @param delay defines the delay to add to the current frame
  93277. * @param from defines the lower bound of the animation range
  93278. * @param to defines the upper bound of the animation range
  93279. * @param loop defines if the current animation must loop
  93280. * @param speedRatio defines the current speed ratio
  93281. * @param weight defines the weight of the animation (default is -1 so no weight)
  93282. * @param onLoop optional callback called when animation loops
  93283. * @returns a boolean indicating if the animation is running
  93284. */
  93285. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  93286. }
  93287. }
  93288. declare module BABYLON {
  93289. /**
  93290. * Class used to store an actual running animation
  93291. */
  93292. export class Animatable {
  93293. /** defines the target object */
  93294. target: any;
  93295. /** defines the starting frame number (default is 0) */
  93296. fromFrame: number;
  93297. /** defines the ending frame number (default is 100) */
  93298. toFrame: number;
  93299. /** defines if the animation must loop (default is false) */
  93300. loopAnimation: boolean;
  93301. /** defines a callback to call when animation ends if it is not looping */
  93302. onAnimationEnd?: (() => void) | null | undefined;
  93303. /** defines a callback to call when animation loops */
  93304. onAnimationLoop?: (() => void) | null | undefined;
  93305. /** defines whether the animation should be evaluated additively */
  93306. isAdditive: boolean;
  93307. private _localDelayOffset;
  93308. private _pausedDelay;
  93309. private _runtimeAnimations;
  93310. private _paused;
  93311. private _scene;
  93312. private _speedRatio;
  93313. private _weight;
  93314. private _syncRoot;
  93315. /**
  93316. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  93317. * This will only apply for non looping animation (default is true)
  93318. */
  93319. disposeOnEnd: boolean;
  93320. /**
  93321. * Gets a boolean indicating if the animation has started
  93322. */
  93323. animationStarted: boolean;
  93324. /**
  93325. * Observer raised when the animation ends
  93326. */
  93327. onAnimationEndObservable: Observable<Animatable>;
  93328. /**
  93329. * Observer raised when the animation loops
  93330. */
  93331. onAnimationLoopObservable: Observable<Animatable>;
  93332. /**
  93333. * Gets the root Animatable used to synchronize and normalize animations
  93334. */
  93335. get syncRoot(): Nullable<Animatable>;
  93336. /**
  93337. * Gets the current frame of the first RuntimeAnimation
  93338. * Used to synchronize Animatables
  93339. */
  93340. get masterFrame(): number;
  93341. /**
  93342. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  93343. */
  93344. get weight(): number;
  93345. set weight(value: number);
  93346. /**
  93347. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  93348. */
  93349. get speedRatio(): number;
  93350. set speedRatio(value: number);
  93351. /**
  93352. * Creates a new Animatable
  93353. * @param scene defines the hosting scene
  93354. * @param target defines the target object
  93355. * @param fromFrame defines the starting frame number (default is 0)
  93356. * @param toFrame defines the ending frame number (default is 100)
  93357. * @param loopAnimation defines if the animation must loop (default is false)
  93358. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  93359. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  93360. * @param animations defines a group of animation to add to the new Animatable
  93361. * @param onAnimationLoop defines a callback to call when animation loops
  93362. * @param isAdditive defines whether the animation should be evaluated additively
  93363. */
  93364. constructor(scene: Scene,
  93365. /** defines the target object */
  93366. target: any,
  93367. /** defines the starting frame number (default is 0) */
  93368. fromFrame?: number,
  93369. /** defines the ending frame number (default is 100) */
  93370. toFrame?: number,
  93371. /** defines if the animation must loop (default is false) */
  93372. loopAnimation?: boolean, speedRatio?: number,
  93373. /** defines a callback to call when animation ends if it is not looping */
  93374. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  93375. /** defines a callback to call when animation loops */
  93376. onAnimationLoop?: (() => void) | null | undefined,
  93377. /** defines whether the animation should be evaluated additively */
  93378. isAdditive?: boolean);
  93379. /**
  93380. * Synchronize and normalize current Animatable with a source Animatable
  93381. * This is useful when using animation weights and when animations are not of the same length
  93382. * @param root defines the root Animatable to synchronize with
  93383. * @returns the current Animatable
  93384. */
  93385. syncWith(root: Animatable): Animatable;
  93386. /**
  93387. * Gets the list of runtime animations
  93388. * @returns an array of RuntimeAnimation
  93389. */
  93390. getAnimations(): RuntimeAnimation[];
  93391. /**
  93392. * Adds more animations to the current animatable
  93393. * @param target defines the target of the animations
  93394. * @param animations defines the new animations to add
  93395. */
  93396. appendAnimations(target: any, animations: Animation[]): void;
  93397. /**
  93398. * Gets the source animation for a specific property
  93399. * @param property defines the propertyu to look for
  93400. * @returns null or the source animation for the given property
  93401. */
  93402. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  93403. /**
  93404. * Gets the runtime animation for a specific property
  93405. * @param property defines the propertyu to look for
  93406. * @returns null or the runtime animation for the given property
  93407. */
  93408. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  93409. /**
  93410. * Resets the animatable to its original state
  93411. */
  93412. reset(): void;
  93413. /**
  93414. * Allows the animatable to blend with current running animations
  93415. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  93416. * @param blendingSpeed defines the blending speed to use
  93417. */
  93418. enableBlending(blendingSpeed: number): void;
  93419. /**
  93420. * Disable animation blending
  93421. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  93422. */
  93423. disableBlending(): void;
  93424. /**
  93425. * Jump directly to a given frame
  93426. * @param frame defines the frame to jump to
  93427. */
  93428. goToFrame(frame: number): void;
  93429. /**
  93430. * Pause the animation
  93431. */
  93432. pause(): void;
  93433. /**
  93434. * Restart the animation
  93435. */
  93436. restart(): void;
  93437. private _raiseOnAnimationEnd;
  93438. /**
  93439. * Stop and delete the current animation
  93440. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  93441. * @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)
  93442. */
  93443. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  93444. /**
  93445. * Wait asynchronously for the animation to end
  93446. * @returns a promise which will be fullfilled when the animation ends
  93447. */
  93448. waitAsync(): Promise<Animatable>;
  93449. /** @hidden */
  93450. _animate(delay: number): boolean;
  93451. }
  93452. interface Scene {
  93453. /** @hidden */
  93454. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  93455. /** @hidden */
  93456. _processLateAnimationBindingsForMatrices(holder: {
  93457. totalWeight: number;
  93458. totalAdditiveWeight: number;
  93459. animations: RuntimeAnimation[];
  93460. additiveAnimations: RuntimeAnimation[];
  93461. originalValue: Matrix;
  93462. }): any;
  93463. /** @hidden */
  93464. _processLateAnimationBindingsForQuaternions(holder: {
  93465. totalWeight: number;
  93466. totalAdditiveWeight: number;
  93467. animations: RuntimeAnimation[];
  93468. additiveAnimations: RuntimeAnimation[];
  93469. originalValue: Quaternion;
  93470. }, refQuaternion: Quaternion): Quaternion;
  93471. /** @hidden */
  93472. _processLateAnimationBindings(): void;
  93473. /**
  93474. * Will start the animation sequence of a given target
  93475. * @param target defines the target
  93476. * @param from defines from which frame should animation start
  93477. * @param to defines until which frame should animation run.
  93478. * @param weight defines the weight to apply to the animation (1.0 by default)
  93479. * @param loop defines if the animation loops
  93480. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  93481. * @param onAnimationEnd defines the function to be executed when the animation ends
  93482. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  93483. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  93484. * @param onAnimationLoop defines the callback to call when an animation loops
  93485. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  93486. * @returns the animatable object created for this animation
  93487. */
  93488. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  93489. /**
  93490. * Will start the animation sequence of a given target
  93491. * @param target defines the target
  93492. * @param from defines from which frame should animation start
  93493. * @param to defines until which frame should animation run.
  93494. * @param loop defines if the animation loops
  93495. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  93496. * @param onAnimationEnd defines the function to be executed when the animation ends
  93497. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  93498. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  93499. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  93500. * @param onAnimationLoop defines the callback to call when an animation loops
  93501. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  93502. * @returns the animatable object created for this animation
  93503. */
  93504. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  93505. /**
  93506. * Will start the animation sequence of a given target and its hierarchy
  93507. * @param target defines the target
  93508. * @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.
  93509. * @param from defines from which frame should animation start
  93510. * @param to defines until which frame should animation run.
  93511. * @param loop defines if the animation loops
  93512. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  93513. * @param onAnimationEnd defines the function to be executed when the animation ends
  93514. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  93515. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  93516. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  93517. * @param onAnimationLoop defines the callback to call when an animation loops
  93518. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  93519. * @returns the list of created animatables
  93520. */
  93521. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  93522. /**
  93523. * Begin a new animation on a given node
  93524. * @param target defines the target where the animation will take place
  93525. * @param animations defines the list of animations to start
  93526. * @param from defines the initial value
  93527. * @param to defines the final value
  93528. * @param loop defines if you want animation to loop (off by default)
  93529. * @param speedRatio defines the speed ratio to apply to all animations
  93530. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  93531. * @param onAnimationLoop defines the callback to call when an animation loops
  93532. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  93533. * @returns the list of created animatables
  93534. */
  93535. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  93536. /**
  93537. * Begin a new animation on a given node and its hierarchy
  93538. * @param target defines the root node where the animation will take place
  93539. * @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.
  93540. * @param animations defines the list of animations to start
  93541. * @param from defines the initial value
  93542. * @param to defines the final value
  93543. * @param loop defines if you want animation to loop (off by default)
  93544. * @param speedRatio defines the speed ratio to apply to all animations
  93545. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  93546. * @param onAnimationLoop defines the callback to call when an animation loops
  93547. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  93548. * @returns the list of animatables created for all nodes
  93549. */
  93550. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  93551. /**
  93552. * Gets the animatable associated with a specific target
  93553. * @param target defines the target of the animatable
  93554. * @returns the required animatable if found
  93555. */
  93556. getAnimatableByTarget(target: any): Nullable<Animatable>;
  93557. /**
  93558. * Gets all animatables associated with a given target
  93559. * @param target defines the target to look animatables for
  93560. * @returns an array of Animatables
  93561. */
  93562. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  93563. /**
  93564. * Stops and removes all animations that have been applied to the scene
  93565. */
  93566. stopAllAnimations(): void;
  93567. /**
  93568. * Gets the current delta time used by animation engine
  93569. */
  93570. deltaTime: number;
  93571. }
  93572. interface Bone {
  93573. /**
  93574. * Copy an animation range from another bone
  93575. * @param source defines the source bone
  93576. * @param rangeName defines the range name to copy
  93577. * @param frameOffset defines the frame offset
  93578. * @param rescaleAsRequired defines if rescaling must be applied if required
  93579. * @param skelDimensionsRatio defines the scaling ratio
  93580. * @returns true if operation was successful
  93581. */
  93582. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  93583. }
  93584. }
  93585. declare module BABYLON {
  93586. /**
  93587. * Class used to handle skinning animations
  93588. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  93589. */
  93590. export class Skeleton implements IAnimatable {
  93591. /** defines the skeleton name */
  93592. name: string;
  93593. /** defines the skeleton Id */
  93594. id: string;
  93595. /**
  93596. * Defines the list of child bones
  93597. */
  93598. bones: Bone[];
  93599. /**
  93600. * Defines an estimate of the dimension of the skeleton at rest
  93601. */
  93602. dimensionsAtRest: Vector3;
  93603. /**
  93604. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  93605. */
  93606. needInitialSkinMatrix: boolean;
  93607. /**
  93608. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  93609. */
  93610. overrideMesh: Nullable<AbstractMesh>;
  93611. /**
  93612. * Gets the list of animations attached to this skeleton
  93613. */
  93614. animations: Array<Animation>;
  93615. private _scene;
  93616. private _isDirty;
  93617. private _transformMatrices;
  93618. private _transformMatrixTexture;
  93619. private _meshesWithPoseMatrix;
  93620. private _animatables;
  93621. private _identity;
  93622. private _synchronizedWithMesh;
  93623. private _ranges;
  93624. private _lastAbsoluteTransformsUpdateId;
  93625. private _canUseTextureForBones;
  93626. private _uniqueId;
  93627. /** @hidden */
  93628. _numBonesWithLinkedTransformNode: number;
  93629. /** @hidden */
  93630. _hasWaitingData: Nullable<boolean>;
  93631. /**
  93632. * Specifies if the skeleton should be serialized
  93633. */
  93634. doNotSerialize: boolean;
  93635. private _useTextureToStoreBoneMatrices;
  93636. /**
  93637. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  93638. * Please note that this option is not available if the hardware does not support it
  93639. */
  93640. get useTextureToStoreBoneMatrices(): boolean;
  93641. set useTextureToStoreBoneMatrices(value: boolean);
  93642. private _animationPropertiesOverride;
  93643. /**
  93644. * Gets or sets the animation properties override
  93645. */
  93646. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  93647. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  93648. /**
  93649. * List of inspectable custom properties (used by the Inspector)
  93650. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  93651. */
  93652. inspectableCustomProperties: IInspectable[];
  93653. /**
  93654. * An observable triggered before computing the skeleton's matrices
  93655. */
  93656. onBeforeComputeObservable: Observable<Skeleton>;
  93657. /**
  93658. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  93659. */
  93660. get isUsingTextureForMatrices(): boolean;
  93661. /**
  93662. * Gets the unique ID of this skeleton
  93663. */
  93664. get uniqueId(): number;
  93665. /**
  93666. * Creates a new skeleton
  93667. * @param name defines the skeleton name
  93668. * @param id defines the skeleton Id
  93669. * @param scene defines the hosting scene
  93670. */
  93671. constructor(
  93672. /** defines the skeleton name */
  93673. name: string,
  93674. /** defines the skeleton Id */
  93675. id: string, scene: Scene);
  93676. /**
  93677. * Gets the current object class name.
  93678. * @return the class name
  93679. */
  93680. getClassName(): string;
  93681. /**
  93682. * Returns an array containing the root bones
  93683. * @returns an array containing the root bones
  93684. */
  93685. getChildren(): Array<Bone>;
  93686. /**
  93687. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  93688. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  93689. * @returns a Float32Array containing matrices data
  93690. */
  93691. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  93692. /**
  93693. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  93694. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  93695. * @returns a raw texture containing the data
  93696. */
  93697. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  93698. /**
  93699. * Gets the current hosting scene
  93700. * @returns a scene object
  93701. */
  93702. getScene(): Scene;
  93703. /**
  93704. * Gets a string representing the current skeleton data
  93705. * @param fullDetails defines a boolean indicating if we want a verbose version
  93706. * @returns a string representing the current skeleton data
  93707. */
  93708. toString(fullDetails?: boolean): string;
  93709. /**
  93710. * Get bone's index searching by name
  93711. * @param name defines bone's name to search for
  93712. * @return the indice of the bone. Returns -1 if not found
  93713. */
  93714. getBoneIndexByName(name: string): number;
  93715. /**
  93716. * Creater a new animation range
  93717. * @param name defines the name of the range
  93718. * @param from defines the start key
  93719. * @param to defines the end key
  93720. */
  93721. createAnimationRange(name: string, from: number, to: number): void;
  93722. /**
  93723. * Delete a specific animation range
  93724. * @param name defines the name of the range
  93725. * @param deleteFrames defines if frames must be removed as well
  93726. */
  93727. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  93728. /**
  93729. * Gets a specific animation range
  93730. * @param name defines the name of the range to look for
  93731. * @returns the requested animation range or null if not found
  93732. */
  93733. getAnimationRange(name: string): Nullable<AnimationRange>;
  93734. /**
  93735. * Gets the list of all animation ranges defined on this skeleton
  93736. * @returns an array
  93737. */
  93738. getAnimationRanges(): Nullable<AnimationRange>[];
  93739. /**
  93740. * Copy animation range from a source skeleton.
  93741. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  93742. * @param source defines the source skeleton
  93743. * @param name defines the name of the range to copy
  93744. * @param rescaleAsRequired defines if rescaling must be applied if required
  93745. * @returns true if operation was successful
  93746. */
  93747. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  93748. /**
  93749. * Forces the skeleton to go to rest pose
  93750. */
  93751. returnToRest(): void;
  93752. private _getHighestAnimationFrame;
  93753. /**
  93754. * Begin a specific animation range
  93755. * @param name defines the name of the range to start
  93756. * @param loop defines if looping must be turned on (false by default)
  93757. * @param speedRatio defines the speed ratio to apply (1 by default)
  93758. * @param onAnimationEnd defines a callback which will be called when animation will end
  93759. * @returns a new animatable
  93760. */
  93761. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  93762. /**
  93763. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  93764. * @param skeleton defines the Skeleton containing the animation range to convert
  93765. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  93766. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  93767. * @returns the original skeleton
  93768. */
  93769. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  93770. /** @hidden */
  93771. _markAsDirty(): void;
  93772. /** @hidden */
  93773. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  93774. /** @hidden */
  93775. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  93776. private _computeTransformMatrices;
  93777. /**
  93778. * Build all resources required to render a skeleton
  93779. */
  93780. prepare(): void;
  93781. /**
  93782. * Gets the list of animatables currently running for this skeleton
  93783. * @returns an array of animatables
  93784. */
  93785. getAnimatables(): IAnimatable[];
  93786. /**
  93787. * Clone the current skeleton
  93788. * @param name defines the name of the new skeleton
  93789. * @param id defines the id of the new skeleton
  93790. * @returns the new skeleton
  93791. */
  93792. clone(name: string, id?: string): Skeleton;
  93793. /**
  93794. * Enable animation blending for this skeleton
  93795. * @param blendingSpeed defines the blending speed to apply
  93796. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  93797. */
  93798. enableBlending(blendingSpeed?: number): void;
  93799. /**
  93800. * Releases all resources associated with the current skeleton
  93801. */
  93802. dispose(): void;
  93803. /**
  93804. * Serialize the skeleton in a JSON object
  93805. * @returns a JSON object
  93806. */
  93807. serialize(): any;
  93808. /**
  93809. * Creates a new skeleton from serialized data
  93810. * @param parsedSkeleton defines the serialized data
  93811. * @param scene defines the hosting scene
  93812. * @returns a new skeleton
  93813. */
  93814. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  93815. /**
  93816. * Compute all node absolute transforms
  93817. * @param forceUpdate defines if computation must be done even if cache is up to date
  93818. */
  93819. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  93820. /**
  93821. * Gets the root pose matrix
  93822. * @returns a matrix
  93823. */
  93824. getPoseMatrix(): Nullable<Matrix>;
  93825. /**
  93826. * Sorts bones per internal index
  93827. */
  93828. sortBones(): void;
  93829. private _sortBones;
  93830. }
  93831. }
  93832. declare module BABYLON {
  93833. /**
  93834. * Creates an instance based on a source mesh.
  93835. */
  93836. export class InstancedMesh extends AbstractMesh {
  93837. private _sourceMesh;
  93838. private _currentLOD;
  93839. /** @hidden */
  93840. _indexInSourceMeshInstanceArray: number;
  93841. constructor(name: string, source: Mesh);
  93842. /**
  93843. * Returns the string "InstancedMesh".
  93844. */
  93845. getClassName(): string;
  93846. /** Gets the list of lights affecting that mesh */
  93847. get lightSources(): Light[];
  93848. _resyncLightSources(): void;
  93849. _resyncLightSource(light: Light): void;
  93850. _removeLightSource(light: Light, dispose: boolean): void;
  93851. /**
  93852. * If the source mesh receives shadows
  93853. */
  93854. get receiveShadows(): boolean;
  93855. /**
  93856. * The material of the source mesh
  93857. */
  93858. get material(): Nullable<Material>;
  93859. /**
  93860. * Visibility of the source mesh
  93861. */
  93862. get visibility(): number;
  93863. /**
  93864. * Skeleton of the source mesh
  93865. */
  93866. get skeleton(): Nullable<Skeleton>;
  93867. /**
  93868. * Rendering ground id of the source mesh
  93869. */
  93870. get renderingGroupId(): number;
  93871. set renderingGroupId(value: number);
  93872. /**
  93873. * Returns the total number of vertices (integer).
  93874. */
  93875. getTotalVertices(): number;
  93876. /**
  93877. * Returns a positive integer : the total number of indices in this mesh geometry.
  93878. * @returns the numner of indices or zero if the mesh has no geometry.
  93879. */
  93880. getTotalIndices(): number;
  93881. /**
  93882. * The source mesh of the instance
  93883. */
  93884. get sourceMesh(): Mesh;
  93885. /**
  93886. * Creates a new InstancedMesh object from the mesh model.
  93887. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  93888. * @param name defines the name of the new instance
  93889. * @returns a new InstancedMesh
  93890. */
  93891. createInstance(name: string): InstancedMesh;
  93892. /**
  93893. * Is this node ready to be used/rendered
  93894. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  93895. * @return {boolean} is it ready
  93896. */
  93897. isReady(completeCheck?: boolean): boolean;
  93898. /**
  93899. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  93900. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  93901. * @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.
  93902. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  93903. */
  93904. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  93905. /**
  93906. * Sets the vertex data of the mesh geometry for the requested `kind`.
  93907. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  93908. * The `data` are either a numeric array either a Float32Array.
  93909. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  93910. * 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).
  93911. * Note that a new underlying VertexBuffer object is created each call.
  93912. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  93913. *
  93914. * Possible `kind` values :
  93915. * - VertexBuffer.PositionKind
  93916. * - VertexBuffer.UVKind
  93917. * - VertexBuffer.UV2Kind
  93918. * - VertexBuffer.UV3Kind
  93919. * - VertexBuffer.UV4Kind
  93920. * - VertexBuffer.UV5Kind
  93921. * - VertexBuffer.UV6Kind
  93922. * - VertexBuffer.ColorKind
  93923. * - VertexBuffer.MatricesIndicesKind
  93924. * - VertexBuffer.MatricesIndicesExtraKind
  93925. * - VertexBuffer.MatricesWeightsKind
  93926. * - VertexBuffer.MatricesWeightsExtraKind
  93927. *
  93928. * Returns the Mesh.
  93929. */
  93930. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  93931. /**
  93932. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  93933. * If the mesh has no geometry, it is simply returned as it is.
  93934. * The `data` are either a numeric array either a Float32Array.
  93935. * No new underlying VertexBuffer object is created.
  93936. * 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.
  93937. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  93938. *
  93939. * Possible `kind` values :
  93940. * - VertexBuffer.PositionKind
  93941. * - VertexBuffer.UVKind
  93942. * - VertexBuffer.UV2Kind
  93943. * - VertexBuffer.UV3Kind
  93944. * - VertexBuffer.UV4Kind
  93945. * - VertexBuffer.UV5Kind
  93946. * - VertexBuffer.UV6Kind
  93947. * - VertexBuffer.ColorKind
  93948. * - VertexBuffer.MatricesIndicesKind
  93949. * - VertexBuffer.MatricesIndicesExtraKind
  93950. * - VertexBuffer.MatricesWeightsKind
  93951. * - VertexBuffer.MatricesWeightsExtraKind
  93952. *
  93953. * Returns the Mesh.
  93954. */
  93955. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  93956. /**
  93957. * Sets the mesh indices.
  93958. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  93959. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  93960. * This method creates a new index buffer each call.
  93961. * Returns the Mesh.
  93962. */
  93963. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  93964. /**
  93965. * Boolean : True if the mesh owns the requested kind of data.
  93966. */
  93967. isVerticesDataPresent(kind: string): boolean;
  93968. /**
  93969. * Returns an array of indices (IndicesArray).
  93970. */
  93971. getIndices(): Nullable<IndicesArray>;
  93972. get _positions(): Nullable<Vector3[]>;
  93973. /**
  93974. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  93975. * This means the mesh underlying bounding box and sphere are recomputed.
  93976. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  93977. * @returns the current mesh
  93978. */
  93979. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  93980. /** @hidden */
  93981. _preActivate(): InstancedMesh;
  93982. /** @hidden */
  93983. _activate(renderId: number, intermediateRendering: boolean): boolean;
  93984. /** @hidden */
  93985. _postActivate(): void;
  93986. getWorldMatrix(): Matrix;
  93987. get isAnInstance(): boolean;
  93988. /**
  93989. * Returns the current associated LOD AbstractMesh.
  93990. */
  93991. getLOD(camera: Camera): AbstractMesh;
  93992. /** @hidden */
  93993. _preActivateForIntermediateRendering(renderId: number): Mesh;
  93994. /** @hidden */
  93995. _syncSubMeshes(): InstancedMesh;
  93996. /** @hidden */
  93997. _generatePointsArray(): boolean;
  93998. /**
  93999. * Creates a new InstancedMesh from the current mesh.
  94000. * - name (string) : the cloned mesh name
  94001. * - newParent (optional Node) : the optional Node to parent the clone to.
  94002. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  94003. *
  94004. * Returns the clone.
  94005. */
  94006. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  94007. /**
  94008. * Disposes the InstancedMesh.
  94009. * Returns nothing.
  94010. */
  94011. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94012. }
  94013. interface Mesh {
  94014. /**
  94015. * Register a custom buffer that will be instanced
  94016. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  94017. * @param kind defines the buffer kind
  94018. * @param stride defines the stride in floats
  94019. */
  94020. registerInstancedBuffer(kind: string, stride: number): void;
  94021. /**
  94022. * true to use the edge renderer for all instances of this mesh
  94023. */
  94024. edgesShareWithInstances: boolean;
  94025. /** @hidden */
  94026. _userInstancedBuffersStorage: {
  94027. data: {
  94028. [key: string]: Float32Array;
  94029. };
  94030. sizes: {
  94031. [key: string]: number;
  94032. };
  94033. vertexBuffers: {
  94034. [key: string]: Nullable<VertexBuffer>;
  94035. };
  94036. strides: {
  94037. [key: string]: number;
  94038. };
  94039. };
  94040. }
  94041. interface AbstractMesh {
  94042. /**
  94043. * Object used to store instanced buffers defined by user
  94044. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  94045. */
  94046. instancedBuffers: {
  94047. [key: string]: any;
  94048. };
  94049. }
  94050. }
  94051. declare module BABYLON {
  94052. /**
  94053. * Defines the options associated with the creation of a shader material.
  94054. */
  94055. export interface IShaderMaterialOptions {
  94056. /**
  94057. * Does the material work in alpha blend mode
  94058. */
  94059. needAlphaBlending: boolean;
  94060. /**
  94061. * Does the material work in alpha test mode
  94062. */
  94063. needAlphaTesting: boolean;
  94064. /**
  94065. * The list of attribute names used in the shader
  94066. */
  94067. attributes: string[];
  94068. /**
  94069. * The list of unifrom names used in the shader
  94070. */
  94071. uniforms: string[];
  94072. /**
  94073. * The list of UBO names used in the shader
  94074. */
  94075. uniformBuffers: string[];
  94076. /**
  94077. * The list of sampler names used in the shader
  94078. */
  94079. samplers: string[];
  94080. /**
  94081. * The list of defines used in the shader
  94082. */
  94083. defines: string[];
  94084. }
  94085. /**
  94086. * 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.
  94087. *
  94088. * This returned material effects how the mesh will look based on the code in the shaders.
  94089. *
  94090. * @see http://doc.babylonjs.com/how_to/shader_material
  94091. */
  94092. export class ShaderMaterial extends Material {
  94093. private _shaderPath;
  94094. private _options;
  94095. private _textures;
  94096. private _textureArrays;
  94097. private _floats;
  94098. private _ints;
  94099. private _floatsArrays;
  94100. private _colors3;
  94101. private _colors3Arrays;
  94102. private _colors4;
  94103. private _colors4Arrays;
  94104. private _vectors2;
  94105. private _vectors3;
  94106. private _vectors4;
  94107. private _matrices;
  94108. private _matrixArrays;
  94109. private _matrices3x3;
  94110. private _matrices2x2;
  94111. private _vectors2Arrays;
  94112. private _vectors3Arrays;
  94113. private _vectors4Arrays;
  94114. private _cachedWorldViewMatrix;
  94115. private _cachedWorldViewProjectionMatrix;
  94116. private _renderId;
  94117. private _multiview;
  94118. private _cachedDefines;
  94119. /** Define the Url to load snippets */
  94120. static SnippetUrl: string;
  94121. /** Snippet ID if the material was created from the snippet server */
  94122. snippetId: string;
  94123. /**
  94124. * Instantiate a new shader material.
  94125. * 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.
  94126. * This returned material effects how the mesh will look based on the code in the shaders.
  94127. * @see http://doc.babylonjs.com/how_to/shader_material
  94128. * @param name Define the name of the material in the scene
  94129. * @param scene Define the scene the material belongs to
  94130. * @param shaderPath Defines the route to the shader code in one of three ways:
  94131. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  94132. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  94133. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  94134. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  94135. * @param options Define the options used to create the shader
  94136. */
  94137. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  94138. /**
  94139. * Gets the shader path used to define the shader code
  94140. * It can be modified to trigger a new compilation
  94141. */
  94142. get shaderPath(): any;
  94143. /**
  94144. * Sets the shader path used to define the shader code
  94145. * It can be modified to trigger a new compilation
  94146. */
  94147. set shaderPath(shaderPath: any);
  94148. /**
  94149. * Gets the options used to compile the shader.
  94150. * They can be modified to trigger a new compilation
  94151. */
  94152. get options(): IShaderMaterialOptions;
  94153. /**
  94154. * Gets the current class name of the material e.g. "ShaderMaterial"
  94155. * Mainly use in serialization.
  94156. * @returns the class name
  94157. */
  94158. getClassName(): string;
  94159. /**
  94160. * Specifies if the material will require alpha blending
  94161. * @returns a boolean specifying if alpha blending is needed
  94162. */
  94163. needAlphaBlending(): boolean;
  94164. /**
  94165. * Specifies if this material should be rendered in alpha test mode
  94166. * @returns a boolean specifying if an alpha test is needed.
  94167. */
  94168. needAlphaTesting(): boolean;
  94169. private _checkUniform;
  94170. /**
  94171. * Set a texture in the shader.
  94172. * @param name Define the name of the uniform samplers as defined in the shader
  94173. * @param texture Define the texture to bind to this sampler
  94174. * @return the material itself allowing "fluent" like uniform updates
  94175. */
  94176. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  94177. /**
  94178. * Set a texture array in the shader.
  94179. * @param name Define the name of the uniform sampler array as defined in the shader
  94180. * @param textures Define the list of textures to bind to this sampler
  94181. * @return the material itself allowing "fluent" like uniform updates
  94182. */
  94183. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  94184. /**
  94185. * Set a float in the shader.
  94186. * @param name Define the name of the uniform as defined in the shader
  94187. * @param value Define the value to give to the uniform
  94188. * @return the material itself allowing "fluent" like uniform updates
  94189. */
  94190. setFloat(name: string, value: number): ShaderMaterial;
  94191. /**
  94192. * Set a int in the shader.
  94193. * @param name Define the name of the uniform as defined in the shader
  94194. * @param value Define the value to give to the uniform
  94195. * @return the material itself allowing "fluent" like uniform updates
  94196. */
  94197. setInt(name: string, value: number): ShaderMaterial;
  94198. /**
  94199. * Set an array of floats in the shader.
  94200. * @param name Define the name of the uniform as defined in the shader
  94201. * @param value Define the value to give to the uniform
  94202. * @return the material itself allowing "fluent" like uniform updates
  94203. */
  94204. setFloats(name: string, value: number[]): ShaderMaterial;
  94205. /**
  94206. * Set a vec3 in the shader from a Color3.
  94207. * @param name Define the name of the uniform as defined in the shader
  94208. * @param value Define the value to give to the uniform
  94209. * @return the material itself allowing "fluent" like uniform updates
  94210. */
  94211. setColor3(name: string, value: Color3): ShaderMaterial;
  94212. /**
  94213. * Set a vec3 array in the shader from a Color3 array.
  94214. * @param name Define the name of the uniform as defined in the shader
  94215. * @param value Define the value to give to the uniform
  94216. * @return the material itself allowing "fluent" like uniform updates
  94217. */
  94218. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  94219. /**
  94220. * Set a vec4 in the shader from a Color4.
  94221. * @param name Define the name of the uniform as defined in the shader
  94222. * @param value Define the value to give to the uniform
  94223. * @return the material itself allowing "fluent" like uniform updates
  94224. */
  94225. setColor4(name: string, value: Color4): ShaderMaterial;
  94226. /**
  94227. * Set a vec4 array in the shader from a Color4 array.
  94228. * @param name Define the name of the uniform as defined in the shader
  94229. * @param value Define the value to give to the uniform
  94230. * @return the material itself allowing "fluent" like uniform updates
  94231. */
  94232. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  94233. /**
  94234. * Set a vec2 in the shader from a Vector2.
  94235. * @param name Define the name of the uniform as defined in the shader
  94236. * @param value Define the value to give to the uniform
  94237. * @return the material itself allowing "fluent" like uniform updates
  94238. */
  94239. setVector2(name: string, value: Vector2): ShaderMaterial;
  94240. /**
  94241. * Set a vec3 in the shader from a Vector3.
  94242. * @param name Define the name of the uniform as defined in the shader
  94243. * @param value Define the value to give to the uniform
  94244. * @return the material itself allowing "fluent" like uniform updates
  94245. */
  94246. setVector3(name: string, value: Vector3): ShaderMaterial;
  94247. /**
  94248. * Set a vec4 in the shader from a Vector4.
  94249. * @param name Define the name of the uniform as defined in the shader
  94250. * @param value Define the value to give to the uniform
  94251. * @return the material itself allowing "fluent" like uniform updates
  94252. */
  94253. setVector4(name: string, value: Vector4): ShaderMaterial;
  94254. /**
  94255. * Set a mat4 in the shader from a Matrix.
  94256. * @param name Define the name of the uniform as defined in the shader
  94257. * @param value Define the value to give to the uniform
  94258. * @return the material itself allowing "fluent" like uniform updates
  94259. */
  94260. setMatrix(name: string, value: Matrix): ShaderMaterial;
  94261. /**
  94262. * Set a float32Array in the shader from a matrix array.
  94263. * @param name Define the name of the uniform as defined in the shader
  94264. * @param value Define the value to give to the uniform
  94265. * @return the material itself allowing "fluent" like uniform updates
  94266. */
  94267. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  94268. /**
  94269. * Set a mat3 in the shader from a Float32Array.
  94270. * @param name Define the name of the uniform as defined in the shader
  94271. * @param value Define the value to give to the uniform
  94272. * @return the material itself allowing "fluent" like uniform updates
  94273. */
  94274. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  94275. /**
  94276. * Set a mat2 in the shader from a Float32Array.
  94277. * @param name Define the name of the uniform as defined in the shader
  94278. * @param value Define the value to give to the uniform
  94279. * @return the material itself allowing "fluent" like uniform updates
  94280. */
  94281. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  94282. /**
  94283. * Set a vec2 array in the shader from a number array.
  94284. * @param name Define the name of the uniform as defined in the shader
  94285. * @param value Define the value to give to the uniform
  94286. * @return the material itself allowing "fluent" like uniform updates
  94287. */
  94288. setArray2(name: string, value: number[]): ShaderMaterial;
  94289. /**
  94290. * Set a vec3 array in the shader from a number array.
  94291. * @param name Define the name of the uniform as defined in the shader
  94292. * @param value Define the value to give to the uniform
  94293. * @return the material itself allowing "fluent" like uniform updates
  94294. */
  94295. setArray3(name: string, value: number[]): ShaderMaterial;
  94296. /**
  94297. * Set a vec4 array in the shader from a number array.
  94298. * @param name Define the name of the uniform as defined in the shader
  94299. * @param value Define the value to give to the uniform
  94300. * @return the material itself allowing "fluent" like uniform updates
  94301. */
  94302. setArray4(name: string, value: number[]): ShaderMaterial;
  94303. private _checkCache;
  94304. /**
  94305. * Specifies that the submesh is ready to be used
  94306. * @param mesh defines the mesh to check
  94307. * @param subMesh defines which submesh to check
  94308. * @param useInstances specifies that instances should be used
  94309. * @returns a boolean indicating that the submesh is ready or not
  94310. */
  94311. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  94312. /**
  94313. * Checks if the material is ready to render the requested mesh
  94314. * @param mesh Define the mesh to render
  94315. * @param useInstances Define whether or not the material is used with instances
  94316. * @returns true if ready, otherwise false
  94317. */
  94318. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  94319. /**
  94320. * Binds the world matrix to the material
  94321. * @param world defines the world transformation matrix
  94322. * @param effectOverride - If provided, use this effect instead of internal effect
  94323. */
  94324. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  94325. /**
  94326. * Binds the submesh to this material by preparing the effect and shader to draw
  94327. * @param world defines the world transformation matrix
  94328. * @param mesh defines the mesh containing the submesh
  94329. * @param subMesh defines the submesh to bind the material to
  94330. */
  94331. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  94332. /**
  94333. * Binds the material to the mesh
  94334. * @param world defines the world transformation matrix
  94335. * @param mesh defines the mesh to bind the material to
  94336. * @param effectOverride - If provided, use this effect instead of internal effect
  94337. */
  94338. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  94339. protected _afterBind(mesh?: Mesh): void;
  94340. /**
  94341. * Gets the active textures from the material
  94342. * @returns an array of textures
  94343. */
  94344. getActiveTextures(): BaseTexture[];
  94345. /**
  94346. * Specifies if the material uses a texture
  94347. * @param texture defines the texture to check against the material
  94348. * @returns a boolean specifying if the material uses the texture
  94349. */
  94350. hasTexture(texture: BaseTexture): boolean;
  94351. /**
  94352. * Makes a duplicate of the material, and gives it a new name
  94353. * @param name defines the new name for the duplicated material
  94354. * @returns the cloned material
  94355. */
  94356. clone(name: string): ShaderMaterial;
  94357. /**
  94358. * Disposes the material
  94359. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  94360. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  94361. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  94362. */
  94363. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  94364. /**
  94365. * Serializes this material in a JSON representation
  94366. * @returns the serialized material object
  94367. */
  94368. serialize(): any;
  94369. /**
  94370. * Creates a shader material from parsed shader material data
  94371. * @param source defines the JSON represnetation of the material
  94372. * @param scene defines the hosting scene
  94373. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  94374. * @returns a new material
  94375. */
  94376. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  94377. /**
  94378. * Creates a new ShaderMaterial from a snippet saved in a remote file
  94379. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  94380. * @param url defines the url to load from
  94381. * @param scene defines the hosting scene
  94382. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  94383. * @returns a promise that will resolve to the new ShaderMaterial
  94384. */
  94385. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  94386. /**
  94387. * Creates a ShaderMaterial from a snippet saved by the Inspector
  94388. * @param snippetId defines the snippet to load
  94389. * @param scene defines the hosting scene
  94390. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  94391. * @returns a promise that will resolve to the new ShaderMaterial
  94392. */
  94393. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  94394. }
  94395. }
  94396. declare module BABYLON {
  94397. /** @hidden */
  94398. export var colorPixelShader: {
  94399. name: string;
  94400. shader: string;
  94401. };
  94402. }
  94403. declare module BABYLON {
  94404. /** @hidden */
  94405. export var colorVertexShader: {
  94406. name: string;
  94407. shader: string;
  94408. };
  94409. }
  94410. declare module BABYLON {
  94411. /**
  94412. * Line mesh
  94413. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  94414. */
  94415. export class LinesMesh extends Mesh {
  94416. /**
  94417. * If vertex color should be applied to the mesh
  94418. */
  94419. readonly useVertexColor?: boolean | undefined;
  94420. /**
  94421. * If vertex alpha should be applied to the mesh
  94422. */
  94423. readonly useVertexAlpha?: boolean | undefined;
  94424. /**
  94425. * Color of the line (Default: White)
  94426. */
  94427. color: Color3;
  94428. /**
  94429. * Alpha of the line (Default: 1)
  94430. */
  94431. alpha: number;
  94432. /**
  94433. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  94434. * This margin is expressed in world space coordinates, so its value may vary.
  94435. * Default value is 0.1
  94436. */
  94437. intersectionThreshold: number;
  94438. private _colorShader;
  94439. private color4;
  94440. /**
  94441. * Creates a new LinesMesh
  94442. * @param name defines the name
  94443. * @param scene defines the hosting scene
  94444. * @param parent defines the parent mesh if any
  94445. * @param source defines the optional source LinesMesh used to clone data from
  94446. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  94447. * When false, achieved by calling a clone(), also passing False.
  94448. * This will make creation of children, recursive.
  94449. * @param useVertexColor defines if this LinesMesh supports vertex color
  94450. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  94451. */
  94452. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  94453. /**
  94454. * If vertex color should be applied to the mesh
  94455. */
  94456. useVertexColor?: boolean | undefined,
  94457. /**
  94458. * If vertex alpha should be applied to the mesh
  94459. */
  94460. useVertexAlpha?: boolean | undefined);
  94461. private _addClipPlaneDefine;
  94462. private _removeClipPlaneDefine;
  94463. isReady(): boolean;
  94464. /**
  94465. * Returns the string "LineMesh"
  94466. */
  94467. getClassName(): string;
  94468. /**
  94469. * @hidden
  94470. */
  94471. get material(): Material;
  94472. /**
  94473. * @hidden
  94474. */
  94475. set material(value: Material);
  94476. /**
  94477. * @hidden
  94478. */
  94479. get checkCollisions(): boolean;
  94480. /** @hidden */
  94481. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  94482. /** @hidden */
  94483. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  94484. /**
  94485. * Disposes of the line mesh
  94486. * @param doNotRecurse If children should be disposed
  94487. */
  94488. dispose(doNotRecurse?: boolean): void;
  94489. /**
  94490. * Returns a new LineMesh object cloned from the current one.
  94491. */
  94492. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  94493. /**
  94494. * Creates a new InstancedLinesMesh object from the mesh model.
  94495. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  94496. * @param name defines the name of the new instance
  94497. * @returns a new InstancedLinesMesh
  94498. */
  94499. createInstance(name: string): InstancedLinesMesh;
  94500. }
  94501. /**
  94502. * Creates an instance based on a source LinesMesh
  94503. */
  94504. export class InstancedLinesMesh extends InstancedMesh {
  94505. /**
  94506. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  94507. * This margin is expressed in world space coordinates, so its value may vary.
  94508. * Initilized with the intersectionThreshold value of the source LinesMesh
  94509. */
  94510. intersectionThreshold: number;
  94511. constructor(name: string, source: LinesMesh);
  94512. /**
  94513. * Returns the string "InstancedLinesMesh".
  94514. */
  94515. getClassName(): string;
  94516. }
  94517. }
  94518. declare module BABYLON {
  94519. /** @hidden */
  94520. export var linePixelShader: {
  94521. name: string;
  94522. shader: string;
  94523. };
  94524. }
  94525. declare module BABYLON {
  94526. /** @hidden */
  94527. export var lineVertexShader: {
  94528. name: string;
  94529. shader: string;
  94530. };
  94531. }
  94532. declare module BABYLON {
  94533. interface Scene {
  94534. /** @hidden */
  94535. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  94536. }
  94537. interface AbstractMesh {
  94538. /**
  94539. * Gets the edgesRenderer associated with the mesh
  94540. */
  94541. edgesRenderer: Nullable<EdgesRenderer>;
  94542. }
  94543. interface LinesMesh {
  94544. /**
  94545. * Enables the edge rendering mode on the mesh.
  94546. * This mode makes the mesh edges visible
  94547. * @param epsilon defines the maximal distance between two angles to detect a face
  94548. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  94549. * @returns the currentAbstractMesh
  94550. * @see https://www.babylonjs-playground.com/#19O9TU#0
  94551. */
  94552. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  94553. }
  94554. interface InstancedLinesMesh {
  94555. /**
  94556. * Enables the edge rendering mode on the mesh.
  94557. * This mode makes the mesh edges visible
  94558. * @param epsilon defines the maximal distance between two angles to detect a face
  94559. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  94560. * @returns the current InstancedLinesMesh
  94561. * @see https://www.babylonjs-playground.com/#19O9TU#0
  94562. */
  94563. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  94564. }
  94565. /**
  94566. * Defines the minimum contract an Edges renderer should follow.
  94567. */
  94568. export interface IEdgesRenderer extends IDisposable {
  94569. /**
  94570. * Gets or sets a boolean indicating if the edgesRenderer is active
  94571. */
  94572. isEnabled: boolean;
  94573. /**
  94574. * Renders the edges of the attached mesh,
  94575. */
  94576. render(): void;
  94577. /**
  94578. * Checks wether or not the edges renderer is ready to render.
  94579. * @return true if ready, otherwise false.
  94580. */
  94581. isReady(): boolean;
  94582. /**
  94583. * List of instances to render in case the source mesh has instances
  94584. */
  94585. customInstances: SmartArray<Matrix>;
  94586. }
  94587. /**
  94588. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  94589. */
  94590. export class EdgesRenderer implements IEdgesRenderer {
  94591. /**
  94592. * Define the size of the edges with an orthographic camera
  94593. */
  94594. edgesWidthScalerForOrthographic: number;
  94595. /**
  94596. * Define the size of the edges with a perspective camera
  94597. */
  94598. edgesWidthScalerForPerspective: number;
  94599. protected _source: AbstractMesh;
  94600. protected _linesPositions: number[];
  94601. protected _linesNormals: number[];
  94602. protected _linesIndices: number[];
  94603. protected _epsilon: number;
  94604. protected _indicesCount: number;
  94605. protected _lineShader: ShaderMaterial;
  94606. protected _ib: DataBuffer;
  94607. protected _buffers: {
  94608. [key: string]: Nullable<VertexBuffer>;
  94609. };
  94610. protected _buffersForInstances: {
  94611. [key: string]: Nullable<VertexBuffer>;
  94612. };
  94613. protected _checkVerticesInsteadOfIndices: boolean;
  94614. private _meshRebuildObserver;
  94615. private _meshDisposeObserver;
  94616. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  94617. isEnabled: boolean;
  94618. /**
  94619. * List of instances to render in case the source mesh has instances
  94620. */
  94621. customInstances: SmartArray<Matrix>;
  94622. private static GetShader;
  94623. /**
  94624. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  94625. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  94626. * @param source Mesh used to create edges
  94627. * @param epsilon sum of angles in adjacency to check for edge
  94628. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  94629. * @param generateEdgesLines - should generate Lines or only prepare resources.
  94630. */
  94631. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  94632. protected _prepareRessources(): void;
  94633. /** @hidden */
  94634. _rebuild(): void;
  94635. /**
  94636. * Releases the required resources for the edges renderer
  94637. */
  94638. dispose(): void;
  94639. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  94640. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  94641. /**
  94642. * Checks if the pair of p0 and p1 is en edge
  94643. * @param faceIndex
  94644. * @param edge
  94645. * @param faceNormals
  94646. * @param p0
  94647. * @param p1
  94648. * @private
  94649. */
  94650. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  94651. /**
  94652. * push line into the position, normal and index buffer
  94653. * @protected
  94654. */
  94655. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  94656. /**
  94657. * Generates lines edges from adjacencjes
  94658. * @private
  94659. */
  94660. _generateEdgesLines(): void;
  94661. /**
  94662. * Checks wether or not the edges renderer is ready to render.
  94663. * @return true if ready, otherwise false.
  94664. */
  94665. isReady(): boolean;
  94666. /**
  94667. * Renders the edges of the attached mesh,
  94668. */
  94669. render(): void;
  94670. }
  94671. /**
  94672. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  94673. */
  94674. export class LineEdgesRenderer extends EdgesRenderer {
  94675. /**
  94676. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  94677. * @param source LineMesh used to generate edges
  94678. * @param epsilon not important (specified angle for edge detection)
  94679. * @param checkVerticesInsteadOfIndices not important for LineMesh
  94680. */
  94681. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  94682. /**
  94683. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  94684. */
  94685. _generateEdgesLines(): void;
  94686. }
  94687. }
  94688. declare module BABYLON {
  94689. /**
  94690. * This represents the object necessary to create a rendering group.
  94691. * This is exclusively used and created by the rendering manager.
  94692. * To modify the behavior, you use the available helpers in your scene or meshes.
  94693. * @hidden
  94694. */
  94695. export class RenderingGroup {
  94696. index: number;
  94697. private static _zeroVector;
  94698. private _scene;
  94699. private _opaqueSubMeshes;
  94700. private _transparentSubMeshes;
  94701. private _alphaTestSubMeshes;
  94702. private _depthOnlySubMeshes;
  94703. private _particleSystems;
  94704. private _spriteManagers;
  94705. private _opaqueSortCompareFn;
  94706. private _alphaTestSortCompareFn;
  94707. private _transparentSortCompareFn;
  94708. private _renderOpaque;
  94709. private _renderAlphaTest;
  94710. private _renderTransparent;
  94711. /** @hidden */
  94712. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  94713. onBeforeTransparentRendering: () => void;
  94714. /**
  94715. * Set the opaque sort comparison function.
  94716. * If null the sub meshes will be render in the order they were created
  94717. */
  94718. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  94719. /**
  94720. * Set the alpha test sort comparison function.
  94721. * If null the sub meshes will be render in the order they were created
  94722. */
  94723. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  94724. /**
  94725. * Set the transparent sort comparison function.
  94726. * If null the sub meshes will be render in the order they were created
  94727. */
  94728. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  94729. /**
  94730. * Creates a new rendering group.
  94731. * @param index The rendering group index
  94732. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  94733. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  94734. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  94735. */
  94736. 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>);
  94737. /**
  94738. * Render all the sub meshes contained in the group.
  94739. * @param customRenderFunction Used to override the default render behaviour of the group.
  94740. * @returns true if rendered some submeshes.
  94741. */
  94742. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  94743. /**
  94744. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  94745. * @param subMeshes The submeshes to render
  94746. */
  94747. private renderOpaqueSorted;
  94748. /**
  94749. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  94750. * @param subMeshes The submeshes to render
  94751. */
  94752. private renderAlphaTestSorted;
  94753. /**
  94754. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  94755. * @param subMeshes The submeshes to render
  94756. */
  94757. private renderTransparentSorted;
  94758. /**
  94759. * Renders the submeshes in a specified order.
  94760. * @param subMeshes The submeshes to sort before render
  94761. * @param sortCompareFn The comparison function use to sort
  94762. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  94763. * @param transparent Specifies to activate blending if true
  94764. */
  94765. private static renderSorted;
  94766. /**
  94767. * Renders the submeshes in the order they were dispatched (no sort applied).
  94768. * @param subMeshes The submeshes to render
  94769. */
  94770. private static renderUnsorted;
  94771. /**
  94772. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  94773. * are rendered back to front if in the same alpha index.
  94774. *
  94775. * @param a The first submesh
  94776. * @param b The second submesh
  94777. * @returns The result of the comparison
  94778. */
  94779. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  94780. /**
  94781. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  94782. * are rendered back to front.
  94783. *
  94784. * @param a The first submesh
  94785. * @param b The second submesh
  94786. * @returns The result of the comparison
  94787. */
  94788. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  94789. /**
  94790. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  94791. * are rendered front to back (prevent overdraw).
  94792. *
  94793. * @param a The first submesh
  94794. * @param b The second submesh
  94795. * @returns The result of the comparison
  94796. */
  94797. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  94798. /**
  94799. * Resets the different lists of submeshes to prepare a new frame.
  94800. */
  94801. prepare(): void;
  94802. dispose(): void;
  94803. /**
  94804. * Inserts the submesh in its correct queue depending on its material.
  94805. * @param subMesh The submesh to dispatch
  94806. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  94807. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  94808. */
  94809. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  94810. dispatchSprites(spriteManager: ISpriteManager): void;
  94811. dispatchParticles(particleSystem: IParticleSystem): void;
  94812. private _renderParticles;
  94813. private _renderSprites;
  94814. }
  94815. }
  94816. declare module BABYLON {
  94817. /**
  94818. * Interface describing the different options available in the rendering manager
  94819. * regarding Auto Clear between groups.
  94820. */
  94821. export interface IRenderingManagerAutoClearSetup {
  94822. /**
  94823. * Defines whether or not autoclear is enable.
  94824. */
  94825. autoClear: boolean;
  94826. /**
  94827. * Defines whether or not to autoclear the depth buffer.
  94828. */
  94829. depth: boolean;
  94830. /**
  94831. * Defines whether or not to autoclear the stencil buffer.
  94832. */
  94833. stencil: boolean;
  94834. }
  94835. /**
  94836. * This class is used by the onRenderingGroupObservable
  94837. */
  94838. export class RenderingGroupInfo {
  94839. /**
  94840. * The Scene that being rendered
  94841. */
  94842. scene: Scene;
  94843. /**
  94844. * The camera currently used for the rendering pass
  94845. */
  94846. camera: Nullable<Camera>;
  94847. /**
  94848. * The ID of the renderingGroup being processed
  94849. */
  94850. renderingGroupId: number;
  94851. }
  94852. /**
  94853. * This is the manager responsible of all the rendering for meshes sprites and particles.
  94854. * It is enable to manage the different groups as well as the different necessary sort functions.
  94855. * This should not be used directly aside of the few static configurations
  94856. */
  94857. export class RenderingManager {
  94858. /**
  94859. * The max id used for rendering groups (not included)
  94860. */
  94861. static MAX_RENDERINGGROUPS: number;
  94862. /**
  94863. * The min id used for rendering groups (included)
  94864. */
  94865. static MIN_RENDERINGGROUPS: number;
  94866. /**
  94867. * Used to globally prevent autoclearing scenes.
  94868. */
  94869. static AUTOCLEAR: boolean;
  94870. /**
  94871. * @hidden
  94872. */
  94873. _useSceneAutoClearSetup: boolean;
  94874. private _scene;
  94875. private _renderingGroups;
  94876. private _depthStencilBufferAlreadyCleaned;
  94877. private _autoClearDepthStencil;
  94878. private _customOpaqueSortCompareFn;
  94879. private _customAlphaTestSortCompareFn;
  94880. private _customTransparentSortCompareFn;
  94881. private _renderingGroupInfo;
  94882. /**
  94883. * Instantiates a new rendering group for a particular scene
  94884. * @param scene Defines the scene the groups belongs to
  94885. */
  94886. constructor(scene: Scene);
  94887. private _clearDepthStencilBuffer;
  94888. /**
  94889. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  94890. * @hidden
  94891. */
  94892. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  94893. /**
  94894. * Resets the different information of the group to prepare a new frame
  94895. * @hidden
  94896. */
  94897. reset(): void;
  94898. /**
  94899. * Dispose and release the group and its associated resources.
  94900. * @hidden
  94901. */
  94902. dispose(): void;
  94903. /**
  94904. * Clear the info related to rendering groups preventing retention points during dispose.
  94905. */
  94906. freeRenderingGroups(): void;
  94907. private _prepareRenderingGroup;
  94908. /**
  94909. * Add a sprite manager to the rendering manager in order to render it this frame.
  94910. * @param spriteManager Define the sprite manager to render
  94911. */
  94912. dispatchSprites(spriteManager: ISpriteManager): void;
  94913. /**
  94914. * Add a particle system to the rendering manager in order to render it this frame.
  94915. * @param particleSystem Define the particle system to render
  94916. */
  94917. dispatchParticles(particleSystem: IParticleSystem): void;
  94918. /**
  94919. * Add a submesh to the manager in order to render it this frame
  94920. * @param subMesh The submesh to dispatch
  94921. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  94922. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  94923. */
  94924. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  94925. /**
  94926. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  94927. * This allowed control for front to back rendering or reversly depending of the special needs.
  94928. *
  94929. * @param renderingGroupId The rendering group id corresponding to its index
  94930. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  94931. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  94932. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  94933. */
  94934. 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;
  94935. /**
  94936. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  94937. *
  94938. * @param renderingGroupId The rendering group id corresponding to its index
  94939. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  94940. * @param depth Automatically clears depth between groups if true and autoClear is true.
  94941. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  94942. */
  94943. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  94944. /**
  94945. * Gets the current auto clear configuration for one rendering group of the rendering
  94946. * manager.
  94947. * @param index the rendering group index to get the information for
  94948. * @returns The auto clear setup for the requested rendering group
  94949. */
  94950. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  94951. }
  94952. }
  94953. declare module BABYLON {
  94954. /**
  94955. * Defines the options associated with the creation of a custom shader for a shadow generator.
  94956. */
  94957. export interface ICustomShaderOptions {
  94958. /**
  94959. * Gets or sets the custom shader name to use
  94960. */
  94961. shaderName: string;
  94962. /**
  94963. * The list of attribute names used in the shader
  94964. */
  94965. attributes?: string[];
  94966. /**
  94967. * The list of unifrom names used in the shader
  94968. */
  94969. uniforms?: string[];
  94970. /**
  94971. * The list of sampler names used in the shader
  94972. */
  94973. samplers?: string[];
  94974. /**
  94975. * The list of defines used in the shader
  94976. */
  94977. defines?: string[];
  94978. }
  94979. /**
  94980. * Interface to implement to create a shadow generator compatible with BJS.
  94981. */
  94982. export interface IShadowGenerator {
  94983. /**
  94984. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  94985. * @returns The render target texture if present otherwise, null
  94986. */
  94987. getShadowMap(): Nullable<RenderTargetTexture>;
  94988. /**
  94989. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  94990. * @param subMesh The submesh we want to render in the shadow map
  94991. * @param useInstances Defines wether will draw in the map using instances
  94992. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  94993. * @returns true if ready otherwise, false
  94994. */
  94995. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  94996. /**
  94997. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  94998. * @param defines Defines of the material we want to update
  94999. * @param lightIndex Index of the light in the enabled light list of the material
  95000. */
  95001. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  95002. /**
  95003. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  95004. * defined in the generator but impacting the effect).
  95005. * It implies the unifroms available on the materials are the standard BJS ones.
  95006. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  95007. * @param effect The effect we are binfing the information for
  95008. */
  95009. bindShadowLight(lightIndex: string, effect: Effect): void;
  95010. /**
  95011. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  95012. * (eq to shadow prjection matrix * light transform matrix)
  95013. * @returns The transform matrix used to create the shadow map
  95014. */
  95015. getTransformMatrix(): Matrix;
  95016. /**
  95017. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  95018. * Cube and 2D textures for instance.
  95019. */
  95020. recreateShadowMap(): void;
  95021. /**
  95022. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  95023. * @param onCompiled Callback triggered at the and of the effects compilation
  95024. * @param options Sets of optional options forcing the compilation with different modes
  95025. */
  95026. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  95027. useInstances: boolean;
  95028. }>): void;
  95029. /**
  95030. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  95031. * @param options Sets of optional options forcing the compilation with different modes
  95032. * @returns A promise that resolves when the compilation completes
  95033. */
  95034. forceCompilationAsync(options?: Partial<{
  95035. useInstances: boolean;
  95036. }>): Promise<void>;
  95037. /**
  95038. * Serializes the shadow generator setup to a json object.
  95039. * @returns The serialized JSON object
  95040. */
  95041. serialize(): any;
  95042. /**
  95043. * Disposes the Shadow map and related Textures and effects.
  95044. */
  95045. dispose(): void;
  95046. }
  95047. /**
  95048. * Default implementation IShadowGenerator.
  95049. * This is the main object responsible of generating shadows in the framework.
  95050. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  95051. */
  95052. export class ShadowGenerator implements IShadowGenerator {
  95053. /**
  95054. * Name of the shadow generator class
  95055. */
  95056. static CLASSNAME: string;
  95057. /**
  95058. * Shadow generator mode None: no filtering applied.
  95059. */
  95060. static readonly FILTER_NONE: number;
  95061. /**
  95062. * Shadow generator mode ESM: Exponential Shadow Mapping.
  95063. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  95064. */
  95065. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  95066. /**
  95067. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  95068. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  95069. */
  95070. static readonly FILTER_POISSONSAMPLING: number;
  95071. /**
  95072. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  95073. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  95074. */
  95075. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  95076. /**
  95077. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  95078. * edge artifacts on steep falloff.
  95079. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  95080. */
  95081. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  95082. /**
  95083. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  95084. * edge artifacts on steep falloff.
  95085. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  95086. */
  95087. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  95088. /**
  95089. * Shadow generator mode PCF: Percentage Closer Filtering
  95090. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  95091. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  95092. */
  95093. static readonly FILTER_PCF: number;
  95094. /**
  95095. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  95096. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  95097. * Contact Hardening
  95098. */
  95099. static readonly FILTER_PCSS: number;
  95100. /**
  95101. * Reserved for PCF and PCSS
  95102. * Highest Quality.
  95103. *
  95104. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  95105. *
  95106. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  95107. */
  95108. static readonly QUALITY_HIGH: number;
  95109. /**
  95110. * Reserved for PCF and PCSS
  95111. * Good tradeoff for quality/perf cross devices
  95112. *
  95113. * Execute PCF on a 3*3 kernel.
  95114. *
  95115. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  95116. */
  95117. static readonly QUALITY_MEDIUM: number;
  95118. /**
  95119. * Reserved for PCF and PCSS
  95120. * The lowest quality but the fastest.
  95121. *
  95122. * Execute PCF on a 1*1 kernel.
  95123. *
  95124. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  95125. */
  95126. static readonly QUALITY_LOW: number;
  95127. /** Gets or sets the custom shader name to use */
  95128. customShaderOptions: ICustomShaderOptions;
  95129. /**
  95130. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  95131. */
  95132. onBeforeShadowMapRenderObservable: Observable<Effect>;
  95133. /**
  95134. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  95135. */
  95136. onAfterShadowMapRenderObservable: Observable<Effect>;
  95137. /**
  95138. * Observable triggered before a mesh is rendered in the shadow map.
  95139. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  95140. */
  95141. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  95142. /**
  95143. * Observable triggered after a mesh is rendered in the shadow map.
  95144. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  95145. */
  95146. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  95147. protected _bias: number;
  95148. /**
  95149. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  95150. */
  95151. get bias(): number;
  95152. /**
  95153. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  95154. */
  95155. set bias(bias: number);
  95156. protected _normalBias: number;
  95157. /**
  95158. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  95159. */
  95160. get normalBias(): number;
  95161. /**
  95162. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  95163. */
  95164. set normalBias(normalBias: number);
  95165. protected _blurBoxOffset: number;
  95166. /**
  95167. * Gets the blur box offset: offset applied during the blur pass.
  95168. * Only useful if useKernelBlur = false
  95169. */
  95170. get blurBoxOffset(): number;
  95171. /**
  95172. * Sets the blur box offset: offset applied during the blur pass.
  95173. * Only useful if useKernelBlur = false
  95174. */
  95175. set blurBoxOffset(value: number);
  95176. protected _blurScale: number;
  95177. /**
  95178. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  95179. * 2 means half of the size.
  95180. */
  95181. get blurScale(): number;
  95182. /**
  95183. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  95184. * 2 means half of the size.
  95185. */
  95186. set blurScale(value: number);
  95187. protected _blurKernel: number;
  95188. /**
  95189. * Gets the blur kernel: kernel size of the blur pass.
  95190. * Only useful if useKernelBlur = true
  95191. */
  95192. get blurKernel(): number;
  95193. /**
  95194. * Sets the blur kernel: kernel size of the blur pass.
  95195. * Only useful if useKernelBlur = true
  95196. */
  95197. set blurKernel(value: number);
  95198. protected _useKernelBlur: boolean;
  95199. /**
  95200. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  95201. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  95202. */
  95203. get useKernelBlur(): boolean;
  95204. /**
  95205. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  95206. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  95207. */
  95208. set useKernelBlur(value: boolean);
  95209. protected _depthScale: number;
  95210. /**
  95211. * Gets the depth scale used in ESM mode.
  95212. */
  95213. get depthScale(): number;
  95214. /**
  95215. * Sets the depth scale used in ESM mode.
  95216. * This can override the scale stored on the light.
  95217. */
  95218. set depthScale(value: number);
  95219. protected _validateFilter(filter: number): number;
  95220. protected _filter: number;
  95221. /**
  95222. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  95223. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  95224. */
  95225. get filter(): number;
  95226. /**
  95227. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  95228. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  95229. */
  95230. set filter(value: number);
  95231. /**
  95232. * Gets if the current filter is set to Poisson Sampling.
  95233. */
  95234. get usePoissonSampling(): boolean;
  95235. /**
  95236. * Sets the current filter to Poisson Sampling.
  95237. */
  95238. set usePoissonSampling(value: boolean);
  95239. /**
  95240. * Gets if the current filter is set to ESM.
  95241. */
  95242. get useExponentialShadowMap(): boolean;
  95243. /**
  95244. * Sets the current filter is to ESM.
  95245. */
  95246. set useExponentialShadowMap(value: boolean);
  95247. /**
  95248. * Gets if the current filter is set to filtered ESM.
  95249. */
  95250. get useBlurExponentialShadowMap(): boolean;
  95251. /**
  95252. * Gets if the current filter is set to filtered ESM.
  95253. */
  95254. set useBlurExponentialShadowMap(value: boolean);
  95255. /**
  95256. * Gets if the current filter is set to "close ESM" (using the inverse of the
  95257. * exponential to prevent steep falloff artifacts).
  95258. */
  95259. get useCloseExponentialShadowMap(): boolean;
  95260. /**
  95261. * Sets the current filter to "close ESM" (using the inverse of the
  95262. * exponential to prevent steep falloff artifacts).
  95263. */
  95264. set useCloseExponentialShadowMap(value: boolean);
  95265. /**
  95266. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  95267. * exponential to prevent steep falloff artifacts).
  95268. */
  95269. get useBlurCloseExponentialShadowMap(): boolean;
  95270. /**
  95271. * Sets the current filter to filtered "close ESM" (using the inverse of the
  95272. * exponential to prevent steep falloff artifacts).
  95273. */
  95274. set useBlurCloseExponentialShadowMap(value: boolean);
  95275. /**
  95276. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  95277. */
  95278. get usePercentageCloserFiltering(): boolean;
  95279. /**
  95280. * Sets the current filter to "PCF" (percentage closer filtering).
  95281. */
  95282. set usePercentageCloserFiltering(value: boolean);
  95283. protected _filteringQuality: number;
  95284. /**
  95285. * Gets the PCF or PCSS Quality.
  95286. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  95287. */
  95288. get filteringQuality(): number;
  95289. /**
  95290. * Sets the PCF or PCSS Quality.
  95291. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  95292. */
  95293. set filteringQuality(filteringQuality: number);
  95294. /**
  95295. * Gets if the current filter is set to "PCSS" (contact hardening).
  95296. */
  95297. get useContactHardeningShadow(): boolean;
  95298. /**
  95299. * Sets the current filter to "PCSS" (contact hardening).
  95300. */
  95301. set useContactHardeningShadow(value: boolean);
  95302. protected _contactHardeningLightSizeUVRatio: number;
  95303. /**
  95304. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  95305. * Using a ratio helps keeping shape stability independently of the map size.
  95306. *
  95307. * It does not account for the light projection as it was having too much
  95308. * instability during the light setup or during light position changes.
  95309. *
  95310. * Only valid if useContactHardeningShadow is true.
  95311. */
  95312. get contactHardeningLightSizeUVRatio(): number;
  95313. /**
  95314. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  95315. * Using a ratio helps keeping shape stability independently of the map size.
  95316. *
  95317. * It does not account for the light projection as it was having too much
  95318. * instability during the light setup or during light position changes.
  95319. *
  95320. * Only valid if useContactHardeningShadow is true.
  95321. */
  95322. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  95323. protected _darkness: number;
  95324. /** Gets or sets the actual darkness of a shadow */
  95325. get darkness(): number;
  95326. set darkness(value: number);
  95327. /**
  95328. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  95329. * 0 means strongest and 1 would means no shadow.
  95330. * @returns the darkness.
  95331. */
  95332. getDarkness(): number;
  95333. /**
  95334. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  95335. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  95336. * @returns the shadow generator allowing fluent coding.
  95337. */
  95338. setDarkness(darkness: number): ShadowGenerator;
  95339. protected _transparencyShadow: boolean;
  95340. /** Gets or sets the ability to have transparent shadow */
  95341. get transparencyShadow(): boolean;
  95342. set transparencyShadow(value: boolean);
  95343. /**
  95344. * Sets the ability to have transparent shadow (boolean).
  95345. * @param transparent True if transparent else False
  95346. * @returns the shadow generator allowing fluent coding
  95347. */
  95348. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  95349. /**
  95350. * Enables or disables shadows with varying strength based on the transparency
  95351. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  95352. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  95353. * mesh.visibility * alphaTexture.a
  95354. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  95355. */
  95356. enableSoftTransparentShadow: boolean;
  95357. protected _shadowMap: Nullable<RenderTargetTexture>;
  95358. protected _shadowMap2: Nullable<RenderTargetTexture>;
  95359. /**
  95360. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  95361. * @returns The render target texture if present otherwise, null
  95362. */
  95363. getShadowMap(): Nullable<RenderTargetTexture>;
  95364. /**
  95365. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  95366. * @returns The render target texture if the shadow map is present otherwise, null
  95367. */
  95368. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  95369. /**
  95370. * Gets the class name of that object
  95371. * @returns "ShadowGenerator"
  95372. */
  95373. getClassName(): string;
  95374. /**
  95375. * Helper function to add a mesh and its descendants to the list of shadow casters.
  95376. * @param mesh Mesh to add
  95377. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  95378. * @returns the Shadow Generator itself
  95379. */
  95380. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  95381. /**
  95382. * Helper function to remove a mesh and its descendants from the list of shadow casters
  95383. * @param mesh Mesh to remove
  95384. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  95385. * @returns the Shadow Generator itself
  95386. */
  95387. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  95388. /**
  95389. * Controls the extent to which the shadows fade out at the edge of the frustum
  95390. */
  95391. frustumEdgeFalloff: number;
  95392. protected _light: IShadowLight;
  95393. /**
  95394. * Returns the associated light object.
  95395. * @returns the light generating the shadow
  95396. */
  95397. getLight(): IShadowLight;
  95398. /**
  95399. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  95400. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  95401. * It might on the other hand introduce peter panning.
  95402. */
  95403. forceBackFacesOnly: boolean;
  95404. protected _scene: Scene;
  95405. protected _lightDirection: Vector3;
  95406. protected _effect: Effect;
  95407. protected _viewMatrix: Matrix;
  95408. protected _projectionMatrix: Matrix;
  95409. protected _transformMatrix: Matrix;
  95410. protected _cachedPosition: Vector3;
  95411. protected _cachedDirection: Vector3;
  95412. protected _cachedDefines: string;
  95413. protected _currentRenderID: number;
  95414. protected _boxBlurPostprocess: Nullable<PostProcess>;
  95415. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  95416. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  95417. protected _blurPostProcesses: PostProcess[];
  95418. protected _mapSize: number;
  95419. protected _currentFaceIndex: number;
  95420. protected _currentFaceIndexCache: number;
  95421. protected _textureType: number;
  95422. protected _defaultTextureMatrix: Matrix;
  95423. protected _storedUniqueId: Nullable<number>;
  95424. /** @hidden */
  95425. static _SceneComponentInitialization: (scene: Scene) => void;
  95426. /**
  95427. * Creates a ShadowGenerator object.
  95428. * A ShadowGenerator is the required tool to use the shadows.
  95429. * Each light casting shadows needs to use its own ShadowGenerator.
  95430. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  95431. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  95432. * @param light The light object generating the shadows.
  95433. * @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.
  95434. */
  95435. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  95436. protected _initializeGenerator(): void;
  95437. protected _createTargetRenderTexture(): void;
  95438. protected _initializeShadowMap(): void;
  95439. protected _initializeBlurRTTAndPostProcesses(): void;
  95440. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  95441. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  95442. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  95443. protected _applyFilterValues(): void;
  95444. /**
  95445. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  95446. * @param onCompiled Callback triggered at the and of the effects compilation
  95447. * @param options Sets of optional options forcing the compilation with different modes
  95448. */
  95449. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  95450. useInstances: boolean;
  95451. }>): void;
  95452. /**
  95453. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  95454. * @param options Sets of optional options forcing the compilation with different modes
  95455. * @returns A promise that resolves when the compilation completes
  95456. */
  95457. forceCompilationAsync(options?: Partial<{
  95458. useInstances: boolean;
  95459. }>): Promise<void>;
  95460. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  95461. private _prepareShadowDefines;
  95462. /**
  95463. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  95464. * @param subMesh The submesh we want to render in the shadow map
  95465. * @param useInstances Defines wether will draw in the map using instances
  95466. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  95467. * @returns true if ready otherwise, false
  95468. */
  95469. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  95470. /**
  95471. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  95472. * @param defines Defines of the material we want to update
  95473. * @param lightIndex Index of the light in the enabled light list of the material
  95474. */
  95475. prepareDefines(defines: any, lightIndex: number): void;
  95476. /**
  95477. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  95478. * defined in the generator but impacting the effect).
  95479. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  95480. * @param effect The effect we are binfing the information for
  95481. */
  95482. bindShadowLight(lightIndex: string, effect: Effect): void;
  95483. /**
  95484. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  95485. * (eq to shadow prjection matrix * light transform matrix)
  95486. * @returns The transform matrix used to create the shadow map
  95487. */
  95488. getTransformMatrix(): Matrix;
  95489. /**
  95490. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  95491. * Cube and 2D textures for instance.
  95492. */
  95493. recreateShadowMap(): void;
  95494. protected _disposeBlurPostProcesses(): void;
  95495. protected _disposeRTTandPostProcesses(): void;
  95496. /**
  95497. * Disposes the ShadowGenerator.
  95498. * Returns nothing.
  95499. */
  95500. dispose(): void;
  95501. /**
  95502. * Serializes the shadow generator setup to a json object.
  95503. * @returns The serialized JSON object
  95504. */
  95505. serialize(): any;
  95506. /**
  95507. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  95508. * @param parsedShadowGenerator The JSON object to parse
  95509. * @param scene The scene to create the shadow map for
  95510. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  95511. * @returns The parsed shadow generator
  95512. */
  95513. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  95514. }
  95515. }
  95516. declare module BABYLON {
  95517. /**
  95518. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  95519. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  95520. * 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.
  95521. */
  95522. export abstract class Light extends Node {
  95523. /**
  95524. * Falloff Default: light is falling off following the material specification:
  95525. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  95526. */
  95527. static readonly FALLOFF_DEFAULT: number;
  95528. /**
  95529. * Falloff Physical: light is falling off following the inverse squared distance law.
  95530. */
  95531. static readonly FALLOFF_PHYSICAL: number;
  95532. /**
  95533. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  95534. * to enhance interoperability with other engines.
  95535. */
  95536. static readonly FALLOFF_GLTF: number;
  95537. /**
  95538. * Falloff Standard: light is falling off like in the standard material
  95539. * to enhance interoperability with other materials.
  95540. */
  95541. static readonly FALLOFF_STANDARD: number;
  95542. /**
  95543. * If every light affecting the material is in this lightmapMode,
  95544. * material.lightmapTexture adds or multiplies
  95545. * (depends on material.useLightmapAsShadowmap)
  95546. * after every other light calculations.
  95547. */
  95548. static readonly LIGHTMAP_DEFAULT: number;
  95549. /**
  95550. * material.lightmapTexture as only diffuse lighting from this light
  95551. * adds only specular lighting from this light
  95552. * adds dynamic shadows
  95553. */
  95554. static readonly LIGHTMAP_SPECULAR: number;
  95555. /**
  95556. * material.lightmapTexture as only lighting
  95557. * no light calculation from this light
  95558. * only adds dynamic shadows from this light
  95559. */
  95560. static readonly LIGHTMAP_SHADOWSONLY: number;
  95561. /**
  95562. * Each light type uses the default quantity according to its type:
  95563. * point/spot lights use luminous intensity
  95564. * directional lights use illuminance
  95565. */
  95566. static readonly INTENSITYMODE_AUTOMATIC: number;
  95567. /**
  95568. * lumen (lm)
  95569. */
  95570. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  95571. /**
  95572. * candela (lm/sr)
  95573. */
  95574. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  95575. /**
  95576. * lux (lm/m^2)
  95577. */
  95578. static readonly INTENSITYMODE_ILLUMINANCE: number;
  95579. /**
  95580. * nit (cd/m^2)
  95581. */
  95582. static readonly INTENSITYMODE_LUMINANCE: number;
  95583. /**
  95584. * Light type const id of the point light.
  95585. */
  95586. static readonly LIGHTTYPEID_POINTLIGHT: number;
  95587. /**
  95588. * Light type const id of the directional light.
  95589. */
  95590. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  95591. /**
  95592. * Light type const id of the spot light.
  95593. */
  95594. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  95595. /**
  95596. * Light type const id of the hemispheric light.
  95597. */
  95598. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  95599. /**
  95600. * Diffuse gives the basic color to an object.
  95601. */
  95602. diffuse: Color3;
  95603. /**
  95604. * Specular produces a highlight color on an object.
  95605. * Note: This is note affecting PBR materials.
  95606. */
  95607. specular: Color3;
  95608. /**
  95609. * Defines the falloff type for this light. This lets overrriding how punctual light are
  95610. * falling off base on range or angle.
  95611. * This can be set to any values in Light.FALLOFF_x.
  95612. *
  95613. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  95614. * other types of materials.
  95615. */
  95616. falloffType: number;
  95617. /**
  95618. * Strength of the light.
  95619. * Note: By default it is define in the framework own unit.
  95620. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  95621. */
  95622. intensity: number;
  95623. private _range;
  95624. protected _inverseSquaredRange: number;
  95625. /**
  95626. * Defines how far from the source the light is impacting in scene units.
  95627. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  95628. */
  95629. get range(): number;
  95630. /**
  95631. * Defines how far from the source the light is impacting in scene units.
  95632. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  95633. */
  95634. set range(value: number);
  95635. /**
  95636. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  95637. * of light.
  95638. */
  95639. private _photometricScale;
  95640. private _intensityMode;
  95641. /**
  95642. * Gets the photometric scale used to interpret the intensity.
  95643. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  95644. */
  95645. get intensityMode(): number;
  95646. /**
  95647. * Sets the photometric scale used to interpret the intensity.
  95648. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  95649. */
  95650. set intensityMode(value: number);
  95651. private _radius;
  95652. /**
  95653. * Gets the light radius used by PBR Materials to simulate soft area lights.
  95654. */
  95655. get radius(): number;
  95656. /**
  95657. * sets the light radius used by PBR Materials to simulate soft area lights.
  95658. */
  95659. set radius(value: number);
  95660. private _renderPriority;
  95661. /**
  95662. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  95663. * exceeding the number allowed of the materials.
  95664. */
  95665. renderPriority: number;
  95666. private _shadowEnabled;
  95667. /**
  95668. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  95669. * the current shadow generator.
  95670. */
  95671. get shadowEnabled(): boolean;
  95672. /**
  95673. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  95674. * the current shadow generator.
  95675. */
  95676. set shadowEnabled(value: boolean);
  95677. private _includedOnlyMeshes;
  95678. /**
  95679. * Gets the only meshes impacted by this light.
  95680. */
  95681. get includedOnlyMeshes(): AbstractMesh[];
  95682. /**
  95683. * Sets the only meshes impacted by this light.
  95684. */
  95685. set includedOnlyMeshes(value: AbstractMesh[]);
  95686. private _excludedMeshes;
  95687. /**
  95688. * Gets the meshes not impacted by this light.
  95689. */
  95690. get excludedMeshes(): AbstractMesh[];
  95691. /**
  95692. * Sets the meshes not impacted by this light.
  95693. */
  95694. set excludedMeshes(value: AbstractMesh[]);
  95695. private _excludeWithLayerMask;
  95696. /**
  95697. * Gets the layer id use to find what meshes are not impacted by the light.
  95698. * Inactive if 0
  95699. */
  95700. get excludeWithLayerMask(): number;
  95701. /**
  95702. * Sets the layer id use to find what meshes are not impacted by the light.
  95703. * Inactive if 0
  95704. */
  95705. set excludeWithLayerMask(value: number);
  95706. private _includeOnlyWithLayerMask;
  95707. /**
  95708. * Gets the layer id use to find what meshes are impacted by the light.
  95709. * Inactive if 0
  95710. */
  95711. get includeOnlyWithLayerMask(): number;
  95712. /**
  95713. * Sets the layer id use to find what meshes are impacted by the light.
  95714. * Inactive if 0
  95715. */
  95716. set includeOnlyWithLayerMask(value: number);
  95717. private _lightmapMode;
  95718. /**
  95719. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  95720. */
  95721. get lightmapMode(): number;
  95722. /**
  95723. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  95724. */
  95725. set lightmapMode(value: number);
  95726. /**
  95727. * Shadow generator associted to the light.
  95728. * @hidden Internal use only.
  95729. */
  95730. _shadowGenerator: Nullable<IShadowGenerator>;
  95731. /**
  95732. * @hidden Internal use only.
  95733. */
  95734. _excludedMeshesIds: string[];
  95735. /**
  95736. * @hidden Internal use only.
  95737. */
  95738. _includedOnlyMeshesIds: string[];
  95739. /**
  95740. * The current light unifom buffer.
  95741. * @hidden Internal use only.
  95742. */
  95743. _uniformBuffer: UniformBuffer;
  95744. /** @hidden */
  95745. _renderId: number;
  95746. /**
  95747. * Creates a Light object in the scene.
  95748. * Documentation : https://doc.babylonjs.com/babylon101/lights
  95749. * @param name The firendly name of the light
  95750. * @param scene The scene the light belongs too
  95751. */
  95752. constructor(name: string, scene: Scene);
  95753. protected abstract _buildUniformLayout(): void;
  95754. /**
  95755. * Sets the passed Effect "effect" with the Light information.
  95756. * @param effect The effect to update
  95757. * @param lightIndex The index of the light in the effect to update
  95758. * @returns The light
  95759. */
  95760. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  95761. /**
  95762. * Sets the passed Effect "effect" with the Light textures.
  95763. * @param effect The effect to update
  95764. * @param lightIndex The index of the light in the effect to update
  95765. * @returns The light
  95766. */
  95767. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  95768. /**
  95769. * Binds the lights information from the scene to the effect for the given mesh.
  95770. * @param lightIndex Light index
  95771. * @param scene The scene where the light belongs to
  95772. * @param effect The effect we are binding the data to
  95773. * @param useSpecular Defines if specular is supported
  95774. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  95775. */
  95776. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  95777. /**
  95778. * Sets the passed Effect "effect" with the Light information.
  95779. * @param effect The effect to update
  95780. * @param lightDataUniformName The uniform used to store light data (position or direction)
  95781. * @returns The light
  95782. */
  95783. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  95784. /**
  95785. * Returns the string "Light".
  95786. * @returns the class name
  95787. */
  95788. getClassName(): string;
  95789. /** @hidden */
  95790. readonly _isLight: boolean;
  95791. /**
  95792. * Converts the light information to a readable string for debug purpose.
  95793. * @param fullDetails Supports for multiple levels of logging within scene loading
  95794. * @returns the human readable light info
  95795. */
  95796. toString(fullDetails?: boolean): string;
  95797. /** @hidden */
  95798. protected _syncParentEnabledState(): void;
  95799. /**
  95800. * Set the enabled state of this node.
  95801. * @param value - the new enabled state
  95802. */
  95803. setEnabled(value: boolean): void;
  95804. /**
  95805. * Returns the Light associated shadow generator if any.
  95806. * @return the associated shadow generator.
  95807. */
  95808. getShadowGenerator(): Nullable<IShadowGenerator>;
  95809. /**
  95810. * Returns a Vector3, the absolute light position in the World.
  95811. * @returns the world space position of the light
  95812. */
  95813. getAbsolutePosition(): Vector3;
  95814. /**
  95815. * Specifies if the light will affect the passed mesh.
  95816. * @param mesh The mesh to test against the light
  95817. * @return true the mesh is affected otherwise, false.
  95818. */
  95819. canAffectMesh(mesh: AbstractMesh): boolean;
  95820. /**
  95821. * Sort function to order lights for rendering.
  95822. * @param a First Light object to compare to second.
  95823. * @param b Second Light object to compare first.
  95824. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  95825. */
  95826. static CompareLightsPriority(a: Light, b: Light): number;
  95827. /**
  95828. * Releases resources associated with this node.
  95829. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  95830. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  95831. */
  95832. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95833. /**
  95834. * Returns the light type ID (integer).
  95835. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  95836. */
  95837. getTypeID(): number;
  95838. /**
  95839. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  95840. * @returns the scaled intensity in intensity mode unit
  95841. */
  95842. getScaledIntensity(): number;
  95843. /**
  95844. * Returns a new Light object, named "name", from the current one.
  95845. * @param name The name of the cloned light
  95846. * @param newParent The parent of this light, if it has one
  95847. * @returns the new created light
  95848. */
  95849. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  95850. /**
  95851. * Serializes the current light into a Serialization object.
  95852. * @returns the serialized object.
  95853. */
  95854. serialize(): any;
  95855. /**
  95856. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  95857. * This new light is named "name" and added to the passed scene.
  95858. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  95859. * @param name The friendly name of the light
  95860. * @param scene The scene the new light will belong to
  95861. * @returns the constructor function
  95862. */
  95863. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  95864. /**
  95865. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  95866. * @param parsedLight The JSON representation of the light
  95867. * @param scene The scene to create the parsed light in
  95868. * @returns the created light after parsing
  95869. */
  95870. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  95871. private _hookArrayForExcluded;
  95872. private _hookArrayForIncludedOnly;
  95873. private _resyncMeshes;
  95874. /**
  95875. * Forces the meshes to update their light related information in their rendering used effects
  95876. * @hidden Internal Use Only
  95877. */
  95878. _markMeshesAsLightDirty(): void;
  95879. /**
  95880. * Recomputes the cached photometric scale if needed.
  95881. */
  95882. private _computePhotometricScale;
  95883. /**
  95884. * Returns the Photometric Scale according to the light type and intensity mode.
  95885. */
  95886. private _getPhotometricScale;
  95887. /**
  95888. * Reorder the light in the scene according to their defined priority.
  95889. * @hidden Internal Use Only
  95890. */
  95891. _reorderLightsInScene(): void;
  95892. /**
  95893. * Prepares the list of defines specific to the light type.
  95894. * @param defines the list of defines
  95895. * @param lightIndex defines the index of the light for the effect
  95896. */
  95897. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  95898. }
  95899. }
  95900. declare module BABYLON {
  95901. /**
  95902. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  95903. * This is the base of the follow, arc rotate cameras and Free camera
  95904. * @see http://doc.babylonjs.com/features/cameras
  95905. */
  95906. export class TargetCamera extends Camera {
  95907. private static _RigCamTransformMatrix;
  95908. private static _TargetTransformMatrix;
  95909. private static _TargetFocalPoint;
  95910. private _tmpUpVector;
  95911. private _tmpTargetVector;
  95912. /**
  95913. * Define the current direction the camera is moving to
  95914. */
  95915. cameraDirection: Vector3;
  95916. /**
  95917. * Define the current rotation the camera is rotating to
  95918. */
  95919. cameraRotation: Vector2;
  95920. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  95921. ignoreParentScaling: boolean;
  95922. /**
  95923. * When set, the up vector of the camera will be updated by the rotation of the camera
  95924. */
  95925. updateUpVectorFromRotation: boolean;
  95926. private _tmpQuaternion;
  95927. /**
  95928. * Define the current rotation of the camera
  95929. */
  95930. rotation: Vector3;
  95931. /**
  95932. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  95933. */
  95934. rotationQuaternion: Quaternion;
  95935. /**
  95936. * Define the current speed of the camera
  95937. */
  95938. speed: number;
  95939. /**
  95940. * Add constraint to the camera to prevent it to move freely in all directions and
  95941. * around all axis.
  95942. */
  95943. noRotationConstraint: boolean;
  95944. /**
  95945. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  95946. * panning
  95947. */
  95948. invertRotation: boolean;
  95949. /**
  95950. * Speed multiplier for inverse camera panning
  95951. */
  95952. inverseRotationSpeed: number;
  95953. /**
  95954. * Define the current target of the camera as an object or a position.
  95955. */
  95956. lockedTarget: any;
  95957. /** @hidden */
  95958. _currentTarget: Vector3;
  95959. /** @hidden */
  95960. _initialFocalDistance: number;
  95961. /** @hidden */
  95962. _viewMatrix: Matrix;
  95963. /** @hidden */
  95964. _camMatrix: Matrix;
  95965. /** @hidden */
  95966. _cameraTransformMatrix: Matrix;
  95967. /** @hidden */
  95968. _cameraRotationMatrix: Matrix;
  95969. /** @hidden */
  95970. _referencePoint: Vector3;
  95971. /** @hidden */
  95972. _transformedReferencePoint: Vector3;
  95973. /** @hidden */
  95974. _reset: () => void;
  95975. private _defaultUp;
  95976. /**
  95977. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  95978. * This is the base of the follow, arc rotate cameras and Free camera
  95979. * @see http://doc.babylonjs.com/features/cameras
  95980. * @param name Defines the name of the camera in the scene
  95981. * @param position Defines the start position of the camera in the scene
  95982. * @param scene Defines the scene the camera belongs to
  95983. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  95984. */
  95985. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  95986. /**
  95987. * Gets the position in front of the camera at a given distance.
  95988. * @param distance The distance from the camera we want the position to be
  95989. * @returns the position
  95990. */
  95991. getFrontPosition(distance: number): Vector3;
  95992. /** @hidden */
  95993. _getLockedTargetPosition(): Nullable<Vector3>;
  95994. private _storedPosition;
  95995. private _storedRotation;
  95996. private _storedRotationQuaternion;
  95997. /**
  95998. * Store current camera state of the camera (fov, position, rotation, etc..)
  95999. * @returns the camera
  96000. */
  96001. storeState(): Camera;
  96002. /**
  96003. * Restored camera state. You must call storeState() first
  96004. * @returns whether it was successful or not
  96005. * @hidden
  96006. */
  96007. _restoreStateValues(): boolean;
  96008. /** @hidden */
  96009. _initCache(): void;
  96010. /** @hidden */
  96011. _updateCache(ignoreParentClass?: boolean): void;
  96012. /** @hidden */
  96013. _isSynchronizedViewMatrix(): boolean;
  96014. /** @hidden */
  96015. _computeLocalCameraSpeed(): number;
  96016. /**
  96017. * Defines the target the camera should look at.
  96018. * @param target Defines the new target as a Vector or a mesh
  96019. */
  96020. setTarget(target: Vector3): void;
  96021. /**
  96022. * Return the current target position of the camera. This value is expressed in local space.
  96023. * @returns the target position
  96024. */
  96025. getTarget(): Vector3;
  96026. /** @hidden */
  96027. _decideIfNeedsToMove(): boolean;
  96028. /** @hidden */
  96029. _updatePosition(): void;
  96030. /** @hidden */
  96031. _checkInputs(): void;
  96032. protected _updateCameraRotationMatrix(): void;
  96033. /**
  96034. * 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)
  96035. * @returns the current camera
  96036. */
  96037. private _rotateUpVectorWithCameraRotationMatrix;
  96038. private _cachedRotationZ;
  96039. private _cachedQuaternionRotationZ;
  96040. /** @hidden */
  96041. _getViewMatrix(): Matrix;
  96042. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  96043. /**
  96044. * @hidden
  96045. */
  96046. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  96047. /**
  96048. * @hidden
  96049. */
  96050. _updateRigCameras(): void;
  96051. private _getRigCamPositionAndTarget;
  96052. /**
  96053. * Gets the current object class name.
  96054. * @return the class name
  96055. */
  96056. getClassName(): string;
  96057. }
  96058. }
  96059. declare module BABYLON {
  96060. /**
  96061. * Gather the list of keyboard event types as constants.
  96062. */
  96063. export class KeyboardEventTypes {
  96064. /**
  96065. * The keydown event is fired when a key becomes active (pressed).
  96066. */
  96067. static readonly KEYDOWN: number;
  96068. /**
  96069. * The keyup event is fired when a key has been released.
  96070. */
  96071. static readonly KEYUP: number;
  96072. }
  96073. /**
  96074. * This class is used to store keyboard related info for the onKeyboardObservable event.
  96075. */
  96076. export class KeyboardInfo {
  96077. /**
  96078. * Defines the type of event (KeyboardEventTypes)
  96079. */
  96080. type: number;
  96081. /**
  96082. * Defines the related dom event
  96083. */
  96084. event: KeyboardEvent;
  96085. /**
  96086. * Instantiates a new keyboard info.
  96087. * This class is used to store keyboard related info for the onKeyboardObservable event.
  96088. * @param type Defines the type of event (KeyboardEventTypes)
  96089. * @param event Defines the related dom event
  96090. */
  96091. constructor(
  96092. /**
  96093. * Defines the type of event (KeyboardEventTypes)
  96094. */
  96095. type: number,
  96096. /**
  96097. * Defines the related dom event
  96098. */
  96099. event: KeyboardEvent);
  96100. }
  96101. /**
  96102. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  96103. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  96104. */
  96105. export class KeyboardInfoPre extends KeyboardInfo {
  96106. /**
  96107. * Defines the type of event (KeyboardEventTypes)
  96108. */
  96109. type: number;
  96110. /**
  96111. * Defines the related dom event
  96112. */
  96113. event: KeyboardEvent;
  96114. /**
  96115. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  96116. */
  96117. skipOnPointerObservable: boolean;
  96118. /**
  96119. * Instantiates a new keyboard pre info.
  96120. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  96121. * @param type Defines the type of event (KeyboardEventTypes)
  96122. * @param event Defines the related dom event
  96123. */
  96124. constructor(
  96125. /**
  96126. * Defines the type of event (KeyboardEventTypes)
  96127. */
  96128. type: number,
  96129. /**
  96130. * Defines the related dom event
  96131. */
  96132. event: KeyboardEvent);
  96133. }
  96134. }
  96135. declare module BABYLON {
  96136. /**
  96137. * Manage the keyboard inputs to control the movement of a free camera.
  96138. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  96139. */
  96140. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  96141. /**
  96142. * Defines the camera the input is attached to.
  96143. */
  96144. camera: FreeCamera;
  96145. /**
  96146. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  96147. */
  96148. keysUp: number[];
  96149. /**
  96150. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  96151. */
  96152. keysUpward: number[];
  96153. /**
  96154. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  96155. */
  96156. keysDown: number[];
  96157. /**
  96158. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  96159. */
  96160. keysDownward: number[];
  96161. /**
  96162. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  96163. */
  96164. keysLeft: number[];
  96165. /**
  96166. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  96167. */
  96168. keysRight: number[];
  96169. private _keys;
  96170. private _onCanvasBlurObserver;
  96171. private _onKeyboardObserver;
  96172. private _engine;
  96173. private _scene;
  96174. /**
  96175. * Attach the input controls to a specific dom element to get the input from.
  96176. * @param element Defines the element the controls should be listened from
  96177. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  96178. */
  96179. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  96180. /**
  96181. * Detach the current controls from the specified dom element.
  96182. * @param element Defines the element to stop listening the inputs from
  96183. */
  96184. detachControl(element: Nullable<HTMLElement>): void;
  96185. /**
  96186. * Update the current camera state depending on the inputs that have been used this frame.
  96187. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  96188. */
  96189. checkInputs(): void;
  96190. /**
  96191. * Gets the class name of the current intput.
  96192. * @returns the class name
  96193. */
  96194. getClassName(): string;
  96195. /** @hidden */
  96196. _onLostFocus(): void;
  96197. /**
  96198. * Get the friendly name associated with the input class.
  96199. * @returns the input friendly name
  96200. */
  96201. getSimpleName(): string;
  96202. }
  96203. }
  96204. declare module BABYLON {
  96205. /**
  96206. * Gather the list of pointer event types as constants.
  96207. */
  96208. export class PointerEventTypes {
  96209. /**
  96210. * 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.
  96211. */
  96212. static readonly POINTERDOWN: number;
  96213. /**
  96214. * The pointerup event is fired when a pointer is no longer active.
  96215. */
  96216. static readonly POINTERUP: number;
  96217. /**
  96218. * The pointermove event is fired when a pointer changes coordinates.
  96219. */
  96220. static readonly POINTERMOVE: number;
  96221. /**
  96222. * The pointerwheel event is fired when a mouse wheel has been rotated.
  96223. */
  96224. static readonly POINTERWHEEL: number;
  96225. /**
  96226. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  96227. */
  96228. static readonly POINTERPICK: number;
  96229. /**
  96230. * The pointertap event is fired when a the object has been touched and released without drag.
  96231. */
  96232. static readonly POINTERTAP: number;
  96233. /**
  96234. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  96235. */
  96236. static readonly POINTERDOUBLETAP: number;
  96237. }
  96238. /**
  96239. * Base class of pointer info types.
  96240. */
  96241. export class PointerInfoBase {
  96242. /**
  96243. * Defines the type of event (PointerEventTypes)
  96244. */
  96245. type: number;
  96246. /**
  96247. * Defines the related dom event
  96248. */
  96249. event: PointerEvent | MouseWheelEvent;
  96250. /**
  96251. * Instantiates the base class of pointers info.
  96252. * @param type Defines the type of event (PointerEventTypes)
  96253. * @param event Defines the related dom event
  96254. */
  96255. constructor(
  96256. /**
  96257. * Defines the type of event (PointerEventTypes)
  96258. */
  96259. type: number,
  96260. /**
  96261. * Defines the related dom event
  96262. */
  96263. event: PointerEvent | MouseWheelEvent);
  96264. }
  96265. /**
  96266. * This class is used to store pointer related info for the onPrePointerObservable event.
  96267. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  96268. */
  96269. export class PointerInfoPre extends PointerInfoBase {
  96270. /**
  96271. * Ray from a pointer if availible (eg. 6dof controller)
  96272. */
  96273. ray: Nullable<Ray>;
  96274. /**
  96275. * Defines the local position of the pointer on the canvas.
  96276. */
  96277. localPosition: Vector2;
  96278. /**
  96279. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  96280. */
  96281. skipOnPointerObservable: boolean;
  96282. /**
  96283. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  96284. * @param type Defines the type of event (PointerEventTypes)
  96285. * @param event Defines the related dom event
  96286. * @param localX Defines the local x coordinates of the pointer when the event occured
  96287. * @param localY Defines the local y coordinates of the pointer when the event occured
  96288. */
  96289. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  96290. }
  96291. /**
  96292. * This type contains all the data related to a pointer event in Babylon.js.
  96293. * 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.
  96294. */
  96295. export class PointerInfo extends PointerInfoBase {
  96296. /**
  96297. * Defines the picking info associated to the info (if any)\
  96298. */
  96299. pickInfo: Nullable<PickingInfo>;
  96300. /**
  96301. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  96302. * @param type Defines the type of event (PointerEventTypes)
  96303. * @param event Defines the related dom event
  96304. * @param pickInfo Defines the picking info associated to the info (if any)\
  96305. */
  96306. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  96307. /**
  96308. * Defines the picking info associated to the info (if any)\
  96309. */
  96310. pickInfo: Nullable<PickingInfo>);
  96311. }
  96312. /**
  96313. * Data relating to a touch event on the screen.
  96314. */
  96315. export interface PointerTouch {
  96316. /**
  96317. * X coordinate of touch.
  96318. */
  96319. x: number;
  96320. /**
  96321. * Y coordinate of touch.
  96322. */
  96323. y: number;
  96324. /**
  96325. * Id of touch. Unique for each finger.
  96326. */
  96327. pointerId: number;
  96328. /**
  96329. * Event type passed from DOM.
  96330. */
  96331. type: any;
  96332. }
  96333. }
  96334. declare module BABYLON {
  96335. /**
  96336. * Manage the mouse inputs to control the movement of a free camera.
  96337. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  96338. */
  96339. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  96340. /**
  96341. * Define if touch is enabled in the mouse input
  96342. */
  96343. touchEnabled: boolean;
  96344. /**
  96345. * Defines the camera the input is attached to.
  96346. */
  96347. camera: FreeCamera;
  96348. /**
  96349. * Defines the buttons associated with the input to handle camera move.
  96350. */
  96351. buttons: number[];
  96352. /**
  96353. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  96354. */
  96355. angularSensibility: number;
  96356. private _pointerInput;
  96357. private _onMouseMove;
  96358. private _observer;
  96359. private previousPosition;
  96360. /**
  96361. * Observable for when a pointer move event occurs containing the move offset
  96362. */
  96363. onPointerMovedObservable: Observable<{
  96364. offsetX: number;
  96365. offsetY: number;
  96366. }>;
  96367. /**
  96368. * @hidden
  96369. * If the camera should be rotated automatically based on pointer movement
  96370. */
  96371. _allowCameraRotation: boolean;
  96372. /**
  96373. * Manage the mouse inputs to control the movement of a free camera.
  96374. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  96375. * @param touchEnabled Defines if touch is enabled or not
  96376. */
  96377. constructor(
  96378. /**
  96379. * Define if touch is enabled in the mouse input
  96380. */
  96381. touchEnabled?: boolean);
  96382. /**
  96383. * Attach the input controls to a specific dom element to get the input from.
  96384. * @param element Defines the element the controls should be listened from
  96385. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  96386. */
  96387. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  96388. /**
  96389. * Called on JS contextmenu event.
  96390. * Override this method to provide functionality.
  96391. */
  96392. protected onContextMenu(evt: PointerEvent): void;
  96393. /**
  96394. * Detach the current controls from the specified dom element.
  96395. * @param element Defines the element to stop listening the inputs from
  96396. */
  96397. detachControl(element: Nullable<HTMLElement>): void;
  96398. /**
  96399. * Gets the class name of the current intput.
  96400. * @returns the class name
  96401. */
  96402. getClassName(): string;
  96403. /**
  96404. * Get the friendly name associated with the input class.
  96405. * @returns the input friendly name
  96406. */
  96407. getSimpleName(): string;
  96408. }
  96409. }
  96410. declare module BABYLON {
  96411. /**
  96412. * Manage the touch inputs to control the movement of a free camera.
  96413. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  96414. */
  96415. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  96416. /**
  96417. * Defines the camera the input is attached to.
  96418. */
  96419. camera: FreeCamera;
  96420. /**
  96421. * Defines the touch sensibility for rotation.
  96422. * The higher the faster.
  96423. */
  96424. touchAngularSensibility: number;
  96425. /**
  96426. * Defines the touch sensibility for move.
  96427. * The higher the faster.
  96428. */
  96429. touchMoveSensibility: number;
  96430. private _offsetX;
  96431. private _offsetY;
  96432. private _pointerPressed;
  96433. private _pointerInput;
  96434. private _observer;
  96435. private _onLostFocus;
  96436. /**
  96437. * Attach the input controls to a specific dom element to get the input from.
  96438. * @param element Defines the element the controls should be listened from
  96439. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  96440. */
  96441. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  96442. /**
  96443. * Detach the current controls from the specified dom element.
  96444. * @param element Defines the element to stop listening the inputs from
  96445. */
  96446. detachControl(element: Nullable<HTMLElement>): void;
  96447. /**
  96448. * Update the current camera state depending on the inputs that have been used this frame.
  96449. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  96450. */
  96451. checkInputs(): void;
  96452. /**
  96453. * Gets the class name of the current intput.
  96454. * @returns the class name
  96455. */
  96456. getClassName(): string;
  96457. /**
  96458. * Get the friendly name associated with the input class.
  96459. * @returns the input friendly name
  96460. */
  96461. getSimpleName(): string;
  96462. }
  96463. }
  96464. declare module BABYLON {
  96465. /**
  96466. * Default Inputs manager for the FreeCamera.
  96467. * It groups all the default supported inputs for ease of use.
  96468. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  96469. */
  96470. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  96471. /**
  96472. * @hidden
  96473. */
  96474. _mouseInput: Nullable<FreeCameraMouseInput>;
  96475. /**
  96476. * Instantiates a new FreeCameraInputsManager.
  96477. * @param camera Defines the camera the inputs belong to
  96478. */
  96479. constructor(camera: FreeCamera);
  96480. /**
  96481. * Add keyboard input support to the input manager.
  96482. * @returns the current input manager
  96483. */
  96484. addKeyboard(): FreeCameraInputsManager;
  96485. /**
  96486. * Add mouse input support to the input manager.
  96487. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  96488. * @returns the current input manager
  96489. */
  96490. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  96491. /**
  96492. * Removes the mouse input support from the manager
  96493. * @returns the current input manager
  96494. */
  96495. removeMouse(): FreeCameraInputsManager;
  96496. /**
  96497. * Add touch input support to the input manager.
  96498. * @returns the current input manager
  96499. */
  96500. addTouch(): FreeCameraInputsManager;
  96501. /**
  96502. * Remove all attached input methods from a camera
  96503. */
  96504. clear(): void;
  96505. }
  96506. }
  96507. declare module BABYLON {
  96508. /**
  96509. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  96510. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  96511. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  96512. */
  96513. export class FreeCamera extends TargetCamera {
  96514. /**
  96515. * Define the collision ellipsoid of the camera.
  96516. * This is helpful to simulate a camera body like the player body around the camera
  96517. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  96518. */
  96519. ellipsoid: Vector3;
  96520. /**
  96521. * Define an offset for the position of the ellipsoid around the camera.
  96522. * This can be helpful to determine the center of the body near the gravity center of the body
  96523. * instead of its head.
  96524. */
  96525. ellipsoidOffset: Vector3;
  96526. /**
  96527. * Enable or disable collisions of the camera with the rest of the scene objects.
  96528. */
  96529. checkCollisions: boolean;
  96530. /**
  96531. * Enable or disable gravity on the camera.
  96532. */
  96533. applyGravity: boolean;
  96534. /**
  96535. * Define the input manager associated to the camera.
  96536. */
  96537. inputs: FreeCameraInputsManager;
  96538. /**
  96539. * Gets the input sensibility for a mouse input. (default is 2000.0)
  96540. * Higher values reduce sensitivity.
  96541. */
  96542. get angularSensibility(): number;
  96543. /**
  96544. * Sets the input sensibility for a mouse input. (default is 2000.0)
  96545. * Higher values reduce sensitivity.
  96546. */
  96547. set angularSensibility(value: number);
  96548. /**
  96549. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  96550. */
  96551. get keysUp(): number[];
  96552. set keysUp(value: number[]);
  96553. /**
  96554. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  96555. */
  96556. get keysUpward(): number[];
  96557. set keysUpward(value: number[]);
  96558. /**
  96559. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  96560. */
  96561. get keysDown(): number[];
  96562. set keysDown(value: number[]);
  96563. /**
  96564. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  96565. */
  96566. get keysDownward(): number[];
  96567. set keysDownward(value: number[]);
  96568. /**
  96569. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  96570. */
  96571. get keysLeft(): number[];
  96572. set keysLeft(value: number[]);
  96573. /**
  96574. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  96575. */
  96576. get keysRight(): number[];
  96577. set keysRight(value: number[]);
  96578. /**
  96579. * Event raised when the camera collide with a mesh in the scene.
  96580. */
  96581. onCollide: (collidedMesh: AbstractMesh) => void;
  96582. private _collider;
  96583. private _needMoveForGravity;
  96584. private _oldPosition;
  96585. private _diffPosition;
  96586. private _newPosition;
  96587. /** @hidden */
  96588. _localDirection: Vector3;
  96589. /** @hidden */
  96590. _transformedDirection: Vector3;
  96591. /**
  96592. * Instantiates a Free Camera.
  96593. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  96594. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  96595. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  96596. * @param name Define the name of the camera in the scene
  96597. * @param position Define the start position of the camera in the scene
  96598. * @param scene Define the scene the camera belongs to
  96599. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  96600. */
  96601. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  96602. /**
  96603. * Attached controls to the current camera.
  96604. * @param element Defines the element the controls should be listened from
  96605. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  96606. */
  96607. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  96608. /**
  96609. * Detach the current controls from the camera.
  96610. * The camera will stop reacting to inputs.
  96611. * @param element Defines the element to stop listening the inputs from
  96612. */
  96613. detachControl(element: HTMLElement): void;
  96614. private _collisionMask;
  96615. /**
  96616. * Define a collision mask to limit the list of object the camera can collide with
  96617. */
  96618. get collisionMask(): number;
  96619. set collisionMask(mask: number);
  96620. /** @hidden */
  96621. _collideWithWorld(displacement: Vector3): void;
  96622. private _onCollisionPositionChange;
  96623. /** @hidden */
  96624. _checkInputs(): void;
  96625. /** @hidden */
  96626. _decideIfNeedsToMove(): boolean;
  96627. /** @hidden */
  96628. _updatePosition(): void;
  96629. /**
  96630. * Destroy the camera and release the current resources hold by it.
  96631. */
  96632. dispose(): void;
  96633. /**
  96634. * Gets the current object class name.
  96635. * @return the class name
  96636. */
  96637. getClassName(): string;
  96638. }
  96639. }
  96640. declare module BABYLON {
  96641. /**
  96642. * Represents a gamepad control stick position
  96643. */
  96644. export class StickValues {
  96645. /**
  96646. * The x component of the control stick
  96647. */
  96648. x: number;
  96649. /**
  96650. * The y component of the control stick
  96651. */
  96652. y: number;
  96653. /**
  96654. * Initializes the gamepad x and y control stick values
  96655. * @param x The x component of the gamepad control stick value
  96656. * @param y The y component of the gamepad control stick value
  96657. */
  96658. constructor(
  96659. /**
  96660. * The x component of the control stick
  96661. */
  96662. x: number,
  96663. /**
  96664. * The y component of the control stick
  96665. */
  96666. y: number);
  96667. }
  96668. /**
  96669. * An interface which manages callbacks for gamepad button changes
  96670. */
  96671. export interface GamepadButtonChanges {
  96672. /**
  96673. * Called when a gamepad has been changed
  96674. */
  96675. changed: boolean;
  96676. /**
  96677. * Called when a gamepad press event has been triggered
  96678. */
  96679. pressChanged: boolean;
  96680. /**
  96681. * Called when a touch event has been triggered
  96682. */
  96683. touchChanged: boolean;
  96684. /**
  96685. * Called when a value has changed
  96686. */
  96687. valueChanged: boolean;
  96688. }
  96689. /**
  96690. * Represents a gamepad
  96691. */
  96692. export class Gamepad {
  96693. /**
  96694. * The id of the gamepad
  96695. */
  96696. id: string;
  96697. /**
  96698. * The index of the gamepad
  96699. */
  96700. index: number;
  96701. /**
  96702. * The browser gamepad
  96703. */
  96704. browserGamepad: any;
  96705. /**
  96706. * Specifies what type of gamepad this represents
  96707. */
  96708. type: number;
  96709. private _leftStick;
  96710. private _rightStick;
  96711. /** @hidden */
  96712. _isConnected: boolean;
  96713. private _leftStickAxisX;
  96714. private _leftStickAxisY;
  96715. private _rightStickAxisX;
  96716. private _rightStickAxisY;
  96717. /**
  96718. * Triggered when the left control stick has been changed
  96719. */
  96720. private _onleftstickchanged;
  96721. /**
  96722. * Triggered when the right control stick has been changed
  96723. */
  96724. private _onrightstickchanged;
  96725. /**
  96726. * Represents a gamepad controller
  96727. */
  96728. static GAMEPAD: number;
  96729. /**
  96730. * Represents a generic controller
  96731. */
  96732. static GENERIC: number;
  96733. /**
  96734. * Represents an XBox controller
  96735. */
  96736. static XBOX: number;
  96737. /**
  96738. * Represents a pose-enabled controller
  96739. */
  96740. static POSE_ENABLED: number;
  96741. /**
  96742. * Represents an Dual Shock controller
  96743. */
  96744. static DUALSHOCK: number;
  96745. /**
  96746. * Specifies whether the left control stick should be Y-inverted
  96747. */
  96748. protected _invertLeftStickY: boolean;
  96749. /**
  96750. * Specifies if the gamepad has been connected
  96751. */
  96752. get isConnected(): boolean;
  96753. /**
  96754. * Initializes the gamepad
  96755. * @param id The id of the gamepad
  96756. * @param index The index of the gamepad
  96757. * @param browserGamepad The browser gamepad
  96758. * @param leftStickX The x component of the left joystick
  96759. * @param leftStickY The y component of the left joystick
  96760. * @param rightStickX The x component of the right joystick
  96761. * @param rightStickY The y component of the right joystick
  96762. */
  96763. constructor(
  96764. /**
  96765. * The id of the gamepad
  96766. */
  96767. id: string,
  96768. /**
  96769. * The index of the gamepad
  96770. */
  96771. index: number,
  96772. /**
  96773. * The browser gamepad
  96774. */
  96775. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  96776. /**
  96777. * Callback triggered when the left joystick has changed
  96778. * @param callback
  96779. */
  96780. onleftstickchanged(callback: (values: StickValues) => void): void;
  96781. /**
  96782. * Callback triggered when the right joystick has changed
  96783. * @param callback
  96784. */
  96785. onrightstickchanged(callback: (values: StickValues) => void): void;
  96786. /**
  96787. * Gets the left joystick
  96788. */
  96789. get leftStick(): StickValues;
  96790. /**
  96791. * Sets the left joystick values
  96792. */
  96793. set leftStick(newValues: StickValues);
  96794. /**
  96795. * Gets the right joystick
  96796. */
  96797. get rightStick(): StickValues;
  96798. /**
  96799. * Sets the right joystick value
  96800. */
  96801. set rightStick(newValues: StickValues);
  96802. /**
  96803. * Updates the gamepad joystick positions
  96804. */
  96805. update(): void;
  96806. /**
  96807. * Disposes the gamepad
  96808. */
  96809. dispose(): void;
  96810. }
  96811. /**
  96812. * Represents a generic gamepad
  96813. */
  96814. export class GenericPad extends Gamepad {
  96815. private _buttons;
  96816. private _onbuttondown;
  96817. private _onbuttonup;
  96818. /**
  96819. * Observable triggered when a button has been pressed
  96820. */
  96821. onButtonDownObservable: Observable<number>;
  96822. /**
  96823. * Observable triggered when a button has been released
  96824. */
  96825. onButtonUpObservable: Observable<number>;
  96826. /**
  96827. * Callback triggered when a button has been pressed
  96828. * @param callback Called when a button has been pressed
  96829. */
  96830. onbuttondown(callback: (buttonPressed: number) => void): void;
  96831. /**
  96832. * Callback triggered when a button has been released
  96833. * @param callback Called when a button has been released
  96834. */
  96835. onbuttonup(callback: (buttonReleased: number) => void): void;
  96836. /**
  96837. * Initializes the generic gamepad
  96838. * @param id The id of the generic gamepad
  96839. * @param index The index of the generic gamepad
  96840. * @param browserGamepad The browser gamepad
  96841. */
  96842. constructor(id: string, index: number, browserGamepad: any);
  96843. private _setButtonValue;
  96844. /**
  96845. * Updates the generic gamepad
  96846. */
  96847. update(): void;
  96848. /**
  96849. * Disposes the generic gamepad
  96850. */
  96851. dispose(): void;
  96852. }
  96853. }
  96854. declare module BABYLON {
  96855. /**
  96856. * Defines the types of pose enabled controllers that are supported
  96857. */
  96858. export enum PoseEnabledControllerType {
  96859. /**
  96860. * HTC Vive
  96861. */
  96862. VIVE = 0,
  96863. /**
  96864. * Oculus Rift
  96865. */
  96866. OCULUS = 1,
  96867. /**
  96868. * Windows mixed reality
  96869. */
  96870. WINDOWS = 2,
  96871. /**
  96872. * Samsung gear VR
  96873. */
  96874. GEAR_VR = 3,
  96875. /**
  96876. * Google Daydream
  96877. */
  96878. DAYDREAM = 4,
  96879. /**
  96880. * Generic
  96881. */
  96882. GENERIC = 5
  96883. }
  96884. /**
  96885. * Defines the MutableGamepadButton interface for the state of a gamepad button
  96886. */
  96887. export interface MutableGamepadButton {
  96888. /**
  96889. * Value of the button/trigger
  96890. */
  96891. value: number;
  96892. /**
  96893. * If the button/trigger is currently touched
  96894. */
  96895. touched: boolean;
  96896. /**
  96897. * If the button/trigger is currently pressed
  96898. */
  96899. pressed: boolean;
  96900. }
  96901. /**
  96902. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  96903. * @hidden
  96904. */
  96905. export interface ExtendedGamepadButton extends GamepadButton {
  96906. /**
  96907. * If the button/trigger is currently pressed
  96908. */
  96909. readonly pressed: boolean;
  96910. /**
  96911. * If the button/trigger is currently touched
  96912. */
  96913. readonly touched: boolean;
  96914. /**
  96915. * Value of the button/trigger
  96916. */
  96917. readonly value: number;
  96918. }
  96919. /** @hidden */
  96920. export interface _GamePadFactory {
  96921. /**
  96922. * Returns whether or not the current gamepad can be created for this type of controller.
  96923. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  96924. * @returns true if it can be created, otherwise false
  96925. */
  96926. canCreate(gamepadInfo: any): boolean;
  96927. /**
  96928. * Creates a new instance of the Gamepad.
  96929. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  96930. * @returns the new gamepad instance
  96931. */
  96932. create(gamepadInfo: any): Gamepad;
  96933. }
  96934. /**
  96935. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  96936. */
  96937. export class PoseEnabledControllerHelper {
  96938. /** @hidden */
  96939. static _ControllerFactories: _GamePadFactory[];
  96940. /** @hidden */
  96941. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  96942. /**
  96943. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  96944. * @param vrGamepad the gamepad to initialized
  96945. * @returns a vr controller of the type the gamepad identified as
  96946. */
  96947. static InitiateController(vrGamepad: any): Gamepad;
  96948. }
  96949. /**
  96950. * Defines the PoseEnabledController object that contains state of a vr capable controller
  96951. */
  96952. export class PoseEnabledController extends Gamepad implements PoseControlled {
  96953. /**
  96954. * If the controller is used in a webXR session
  96955. */
  96956. isXR: boolean;
  96957. private _deviceRoomPosition;
  96958. private _deviceRoomRotationQuaternion;
  96959. /**
  96960. * The device position in babylon space
  96961. */
  96962. devicePosition: Vector3;
  96963. /**
  96964. * The device rotation in babylon space
  96965. */
  96966. deviceRotationQuaternion: Quaternion;
  96967. /**
  96968. * The scale factor of the device in babylon space
  96969. */
  96970. deviceScaleFactor: number;
  96971. /**
  96972. * (Likely devicePosition should be used instead) The device position in its room space
  96973. */
  96974. position: Vector3;
  96975. /**
  96976. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  96977. */
  96978. rotationQuaternion: Quaternion;
  96979. /**
  96980. * The type of controller (Eg. Windows mixed reality)
  96981. */
  96982. controllerType: PoseEnabledControllerType;
  96983. protected _calculatedPosition: Vector3;
  96984. private _calculatedRotation;
  96985. /**
  96986. * The raw pose from the device
  96987. */
  96988. rawPose: DevicePose;
  96989. private _trackPosition;
  96990. private _maxRotationDistFromHeadset;
  96991. private _draggedRoomRotation;
  96992. /**
  96993. * @hidden
  96994. */
  96995. _disableTrackPosition(fixedPosition: Vector3): void;
  96996. /**
  96997. * Internal, the mesh attached to the controller
  96998. * @hidden
  96999. */
  97000. _mesh: Nullable<AbstractMesh>;
  97001. private _poseControlledCamera;
  97002. private _leftHandSystemQuaternion;
  97003. /**
  97004. * Internal, matrix used to convert room space to babylon space
  97005. * @hidden
  97006. */
  97007. _deviceToWorld: Matrix;
  97008. /**
  97009. * Node to be used when casting a ray from the controller
  97010. * @hidden
  97011. */
  97012. _pointingPoseNode: Nullable<TransformNode>;
  97013. /**
  97014. * Name of the child mesh that can be used to cast a ray from the controller
  97015. */
  97016. static readonly POINTING_POSE: string;
  97017. /**
  97018. * Creates a new PoseEnabledController from a gamepad
  97019. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  97020. */
  97021. constructor(browserGamepad: any);
  97022. private _workingMatrix;
  97023. /**
  97024. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  97025. */
  97026. update(): void;
  97027. /**
  97028. * Updates only the pose device and mesh without doing any button event checking
  97029. */
  97030. protected _updatePoseAndMesh(): void;
  97031. /**
  97032. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  97033. * @param poseData raw pose fromthe device
  97034. */
  97035. updateFromDevice(poseData: DevicePose): void;
  97036. /**
  97037. * @hidden
  97038. */
  97039. _meshAttachedObservable: Observable<AbstractMesh>;
  97040. /**
  97041. * Attaches a mesh to the controller
  97042. * @param mesh the mesh to be attached
  97043. */
  97044. attachToMesh(mesh: AbstractMesh): void;
  97045. /**
  97046. * Attaches the controllers mesh to a camera
  97047. * @param camera the camera the mesh should be attached to
  97048. */
  97049. attachToPoseControlledCamera(camera: TargetCamera): void;
  97050. /**
  97051. * Disposes of the controller
  97052. */
  97053. dispose(): void;
  97054. /**
  97055. * The mesh that is attached to the controller
  97056. */
  97057. get mesh(): Nullable<AbstractMesh>;
  97058. /**
  97059. * Gets the ray of the controller in the direction the controller is pointing
  97060. * @param length the length the resulting ray should be
  97061. * @returns a ray in the direction the controller is pointing
  97062. */
  97063. getForwardRay(length?: number): Ray;
  97064. }
  97065. }
  97066. declare module BABYLON {
  97067. /**
  97068. * Defines the WebVRController object that represents controllers tracked in 3D space
  97069. */
  97070. export abstract class WebVRController extends PoseEnabledController {
  97071. /**
  97072. * Internal, the default controller model for the controller
  97073. */
  97074. protected _defaultModel: Nullable<AbstractMesh>;
  97075. /**
  97076. * Fired when the trigger state has changed
  97077. */
  97078. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  97079. /**
  97080. * Fired when the main button state has changed
  97081. */
  97082. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  97083. /**
  97084. * Fired when the secondary button state has changed
  97085. */
  97086. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  97087. /**
  97088. * Fired when the pad state has changed
  97089. */
  97090. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  97091. /**
  97092. * Fired when controllers stick values have changed
  97093. */
  97094. onPadValuesChangedObservable: Observable<StickValues>;
  97095. /**
  97096. * Array of button availible on the controller
  97097. */
  97098. protected _buttons: Array<MutableGamepadButton>;
  97099. private _onButtonStateChange;
  97100. /**
  97101. * Fired when a controller button's state has changed
  97102. * @param callback the callback containing the button that was modified
  97103. */
  97104. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  97105. /**
  97106. * X and Y axis corresponding to the controllers joystick
  97107. */
  97108. pad: StickValues;
  97109. /**
  97110. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  97111. */
  97112. hand: string;
  97113. /**
  97114. * The default controller model for the controller
  97115. */
  97116. get defaultModel(): Nullable<AbstractMesh>;
  97117. /**
  97118. * Creates a new WebVRController from a gamepad
  97119. * @param vrGamepad the gamepad that the WebVRController should be created from
  97120. */
  97121. constructor(vrGamepad: any);
  97122. /**
  97123. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  97124. */
  97125. update(): void;
  97126. /**
  97127. * Function to be called when a button is modified
  97128. */
  97129. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  97130. /**
  97131. * Loads a mesh and attaches it to the controller
  97132. * @param scene the scene the mesh should be added to
  97133. * @param meshLoaded callback for when the mesh has been loaded
  97134. */
  97135. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  97136. private _setButtonValue;
  97137. private _changes;
  97138. private _checkChanges;
  97139. /**
  97140. * Disposes of th webVRCOntroller
  97141. */
  97142. dispose(): void;
  97143. }
  97144. }
  97145. declare module BABYLON {
  97146. /**
  97147. * The HemisphericLight simulates the ambient environment light,
  97148. * so the passed direction is the light reflection direction, not the incoming direction.
  97149. */
  97150. export class HemisphericLight extends Light {
  97151. /**
  97152. * The groundColor is the light in the opposite direction to the one specified during creation.
  97153. * 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.
  97154. */
  97155. groundColor: Color3;
  97156. /**
  97157. * The light reflection direction, not the incoming direction.
  97158. */
  97159. direction: Vector3;
  97160. /**
  97161. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  97162. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  97163. * The HemisphericLight can't cast shadows.
  97164. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97165. * @param name The friendly name of the light
  97166. * @param direction The direction of the light reflection
  97167. * @param scene The scene the light belongs to
  97168. */
  97169. constructor(name: string, direction: Vector3, scene: Scene);
  97170. protected _buildUniformLayout(): void;
  97171. /**
  97172. * Returns the string "HemisphericLight".
  97173. * @return The class name
  97174. */
  97175. getClassName(): string;
  97176. /**
  97177. * Sets the HemisphericLight direction towards the passed target (Vector3).
  97178. * Returns the updated direction.
  97179. * @param target The target the direction should point to
  97180. * @return The computed direction
  97181. */
  97182. setDirectionToTarget(target: Vector3): Vector3;
  97183. /**
  97184. * Returns the shadow generator associated to the light.
  97185. * @returns Always null for hemispheric lights because it does not support shadows.
  97186. */
  97187. getShadowGenerator(): Nullable<IShadowGenerator>;
  97188. /**
  97189. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  97190. * @param effect The effect to update
  97191. * @param lightIndex The index of the light in the effect to update
  97192. * @returns The hemispheric light
  97193. */
  97194. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  97195. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  97196. /**
  97197. * Computes the world matrix of the node
  97198. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  97199. * @param useWasUpdatedFlag defines a reserved property
  97200. * @returns the world matrix
  97201. */
  97202. computeWorldMatrix(): Matrix;
  97203. /**
  97204. * Returns the integer 3.
  97205. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  97206. */
  97207. getTypeID(): number;
  97208. /**
  97209. * Prepares the list of defines specific to the light type.
  97210. * @param defines the list of defines
  97211. * @param lightIndex defines the index of the light for the effect
  97212. */
  97213. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  97214. }
  97215. }
  97216. declare module BABYLON {
  97217. /** @hidden */
  97218. export var vrMultiviewToSingleviewPixelShader: {
  97219. name: string;
  97220. shader: string;
  97221. };
  97222. }
  97223. declare module BABYLON {
  97224. /**
  97225. * Renders to multiple views with a single draw call
  97226. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  97227. */
  97228. export class MultiviewRenderTarget extends RenderTargetTexture {
  97229. /**
  97230. * Creates a multiview render target
  97231. * @param scene scene used with the render target
  97232. * @param size the size of the render target (used for each view)
  97233. */
  97234. constructor(scene: Scene, size?: number | {
  97235. width: number;
  97236. height: number;
  97237. } | {
  97238. ratio: number;
  97239. });
  97240. /**
  97241. * @hidden
  97242. * @param faceIndex the face index, if its a cube texture
  97243. */
  97244. _bindFrameBuffer(faceIndex?: number): void;
  97245. /**
  97246. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  97247. * @returns the view count
  97248. */
  97249. getViewCount(): number;
  97250. }
  97251. }
  97252. declare module BABYLON {
  97253. interface Engine {
  97254. /**
  97255. * Creates a new multiview render target
  97256. * @param width defines the width of the texture
  97257. * @param height defines the height of the texture
  97258. * @returns the created multiview texture
  97259. */
  97260. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  97261. /**
  97262. * Binds a multiview framebuffer to be drawn to
  97263. * @param multiviewTexture texture to bind
  97264. */
  97265. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  97266. }
  97267. interface Camera {
  97268. /**
  97269. * @hidden
  97270. * 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)
  97271. */
  97272. _useMultiviewToSingleView: boolean;
  97273. /**
  97274. * @hidden
  97275. * 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)
  97276. */
  97277. _multiviewTexture: Nullable<RenderTargetTexture>;
  97278. /**
  97279. * @hidden
  97280. * ensures the multiview texture of the camera exists and has the specified width/height
  97281. * @param width height to set on the multiview texture
  97282. * @param height width to set on the multiview texture
  97283. */
  97284. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  97285. }
  97286. interface Scene {
  97287. /** @hidden */
  97288. _transformMatrixR: Matrix;
  97289. /** @hidden */
  97290. _multiviewSceneUbo: Nullable<UniformBuffer>;
  97291. /** @hidden */
  97292. _createMultiviewUbo(): void;
  97293. /** @hidden */
  97294. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  97295. /** @hidden */
  97296. _renderMultiviewToSingleView(camera: Camera): void;
  97297. }
  97298. }
  97299. declare module BABYLON {
  97300. /**
  97301. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  97302. * This will not be used for webXR as it supports displaying texture arrays directly
  97303. */
  97304. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  97305. /**
  97306. * Initializes a VRMultiviewToSingleview
  97307. * @param name name of the post process
  97308. * @param camera camera to be applied to
  97309. * @param scaleFactor scaling factor to the size of the output texture
  97310. */
  97311. constructor(name: string, camera: Camera, scaleFactor: number);
  97312. }
  97313. }
  97314. declare module BABYLON {
  97315. /**
  97316. * Interface used to define additional presentation attributes
  97317. */
  97318. export interface IVRPresentationAttributes {
  97319. /**
  97320. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  97321. */
  97322. highRefreshRate: boolean;
  97323. /**
  97324. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  97325. */
  97326. foveationLevel: number;
  97327. }
  97328. interface Engine {
  97329. /** @hidden */
  97330. _vrDisplay: any;
  97331. /** @hidden */
  97332. _vrSupported: boolean;
  97333. /** @hidden */
  97334. _oldSize: Size;
  97335. /** @hidden */
  97336. _oldHardwareScaleFactor: number;
  97337. /** @hidden */
  97338. _vrExclusivePointerMode: boolean;
  97339. /** @hidden */
  97340. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  97341. /** @hidden */
  97342. _onVRDisplayPointerRestricted: () => void;
  97343. /** @hidden */
  97344. _onVRDisplayPointerUnrestricted: () => void;
  97345. /** @hidden */
  97346. _onVrDisplayConnect: Nullable<(display: any) => void>;
  97347. /** @hidden */
  97348. _onVrDisplayDisconnect: Nullable<() => void>;
  97349. /** @hidden */
  97350. _onVrDisplayPresentChange: Nullable<() => void>;
  97351. /**
  97352. * Observable signaled when VR display mode changes
  97353. */
  97354. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  97355. /**
  97356. * Observable signaled when VR request present is complete
  97357. */
  97358. onVRRequestPresentComplete: Observable<boolean>;
  97359. /**
  97360. * Observable signaled when VR request present starts
  97361. */
  97362. onVRRequestPresentStart: Observable<Engine>;
  97363. /**
  97364. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  97365. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  97366. */
  97367. isInVRExclusivePointerMode: boolean;
  97368. /**
  97369. * Gets a boolean indicating if a webVR device was detected
  97370. * @returns true if a webVR device was detected
  97371. */
  97372. isVRDevicePresent(): boolean;
  97373. /**
  97374. * Gets the current webVR device
  97375. * @returns the current webVR device (or null)
  97376. */
  97377. getVRDevice(): any;
  97378. /**
  97379. * Initializes a webVR display and starts listening to display change events
  97380. * The onVRDisplayChangedObservable will be notified upon these changes
  97381. * @returns A promise containing a VRDisplay and if vr is supported
  97382. */
  97383. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  97384. /** @hidden */
  97385. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  97386. /**
  97387. * Gets or sets the presentation attributes used to configure VR rendering
  97388. */
  97389. vrPresentationAttributes?: IVRPresentationAttributes;
  97390. /**
  97391. * Call this function to switch to webVR mode
  97392. * Will do nothing if webVR is not supported or if there is no webVR device
  97393. * @param options the webvr options provided to the camera. mainly used for multiview
  97394. * @see http://doc.babylonjs.com/how_to/webvr_camera
  97395. */
  97396. enableVR(options: WebVROptions): void;
  97397. /** @hidden */
  97398. _onVRFullScreenTriggered(): void;
  97399. }
  97400. }
  97401. declare module BABYLON {
  97402. /**
  97403. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  97404. * IMPORTANT!! The data is right-hand data.
  97405. * @export
  97406. * @interface DevicePose
  97407. */
  97408. export interface DevicePose {
  97409. /**
  97410. * The position of the device, values in array are [x,y,z].
  97411. */
  97412. readonly position: Nullable<Float32Array>;
  97413. /**
  97414. * The linearVelocity of the device, values in array are [x,y,z].
  97415. */
  97416. readonly linearVelocity: Nullable<Float32Array>;
  97417. /**
  97418. * The linearAcceleration of the device, values in array are [x,y,z].
  97419. */
  97420. readonly linearAcceleration: Nullable<Float32Array>;
  97421. /**
  97422. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  97423. */
  97424. readonly orientation: Nullable<Float32Array>;
  97425. /**
  97426. * The angularVelocity of the device, values in array are [x,y,z].
  97427. */
  97428. readonly angularVelocity: Nullable<Float32Array>;
  97429. /**
  97430. * The angularAcceleration of the device, values in array are [x,y,z].
  97431. */
  97432. readonly angularAcceleration: Nullable<Float32Array>;
  97433. }
  97434. /**
  97435. * Interface representing a pose controlled object in Babylon.
  97436. * A pose controlled object has both regular pose values as well as pose values
  97437. * from an external device such as a VR head mounted display
  97438. */
  97439. export interface PoseControlled {
  97440. /**
  97441. * The position of the object in babylon space.
  97442. */
  97443. position: Vector3;
  97444. /**
  97445. * The rotation quaternion of the object in babylon space.
  97446. */
  97447. rotationQuaternion: Quaternion;
  97448. /**
  97449. * The position of the device in babylon space.
  97450. */
  97451. devicePosition?: Vector3;
  97452. /**
  97453. * The rotation quaternion of the device in babylon space.
  97454. */
  97455. deviceRotationQuaternion: Quaternion;
  97456. /**
  97457. * The raw pose coming from the device.
  97458. */
  97459. rawPose: Nullable<DevicePose>;
  97460. /**
  97461. * The scale of the device to be used when translating from device space to babylon space.
  97462. */
  97463. deviceScaleFactor: number;
  97464. /**
  97465. * Updates the poseControlled values based on the input device pose.
  97466. * @param poseData the pose data to update the object with
  97467. */
  97468. updateFromDevice(poseData: DevicePose): void;
  97469. }
  97470. /**
  97471. * Set of options to customize the webVRCamera
  97472. */
  97473. export interface WebVROptions {
  97474. /**
  97475. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  97476. */
  97477. trackPosition?: boolean;
  97478. /**
  97479. * Sets the scale of the vrDevice in babylon space. (default: 1)
  97480. */
  97481. positionScale?: number;
  97482. /**
  97483. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  97484. */
  97485. displayName?: string;
  97486. /**
  97487. * Should the native controller meshes be initialized. (default: true)
  97488. */
  97489. controllerMeshes?: boolean;
  97490. /**
  97491. * Creating a default HemiLight only on controllers. (default: true)
  97492. */
  97493. defaultLightingOnControllers?: boolean;
  97494. /**
  97495. * If you don't want to use the default VR button of the helper. (default: false)
  97496. */
  97497. useCustomVRButton?: boolean;
  97498. /**
  97499. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  97500. */
  97501. customVRButton?: HTMLButtonElement;
  97502. /**
  97503. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  97504. */
  97505. rayLength?: number;
  97506. /**
  97507. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  97508. */
  97509. defaultHeight?: number;
  97510. /**
  97511. * If multiview should be used if availible (default: false)
  97512. */
  97513. useMultiview?: boolean;
  97514. }
  97515. /**
  97516. * This represents a WebVR camera.
  97517. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  97518. * @example http://doc.babylonjs.com/how_to/webvr_camera
  97519. */
  97520. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  97521. private webVROptions;
  97522. /**
  97523. * @hidden
  97524. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  97525. */
  97526. _vrDevice: any;
  97527. /**
  97528. * The rawPose of the vrDevice.
  97529. */
  97530. rawPose: Nullable<DevicePose>;
  97531. private _onVREnabled;
  97532. private _specsVersion;
  97533. private _attached;
  97534. private _frameData;
  97535. protected _descendants: Array<Node>;
  97536. private _deviceRoomPosition;
  97537. /** @hidden */
  97538. _deviceRoomRotationQuaternion: Quaternion;
  97539. private _standingMatrix;
  97540. /**
  97541. * Represents device position in babylon space.
  97542. */
  97543. devicePosition: Vector3;
  97544. /**
  97545. * Represents device rotation in babylon space.
  97546. */
  97547. deviceRotationQuaternion: Quaternion;
  97548. /**
  97549. * The scale of the device to be used when translating from device space to babylon space.
  97550. */
  97551. deviceScaleFactor: number;
  97552. private _deviceToWorld;
  97553. private _worldToDevice;
  97554. /**
  97555. * References to the webVR controllers for the vrDevice.
  97556. */
  97557. controllers: Array<WebVRController>;
  97558. /**
  97559. * Emits an event when a controller is attached.
  97560. */
  97561. onControllersAttachedObservable: Observable<WebVRController[]>;
  97562. /**
  97563. * Emits an event when a controller's mesh has been loaded;
  97564. */
  97565. onControllerMeshLoadedObservable: Observable<WebVRController>;
  97566. /**
  97567. * Emits an event when the HMD's pose has been updated.
  97568. */
  97569. onPoseUpdatedFromDeviceObservable: Observable<any>;
  97570. private _poseSet;
  97571. /**
  97572. * If the rig cameras be used as parent instead of this camera.
  97573. */
  97574. rigParenting: boolean;
  97575. private _lightOnControllers;
  97576. private _defaultHeight?;
  97577. /**
  97578. * Instantiates a WebVRFreeCamera.
  97579. * @param name The name of the WebVRFreeCamera
  97580. * @param position The starting anchor position for the camera
  97581. * @param scene The scene the camera belongs to
  97582. * @param webVROptions a set of customizable options for the webVRCamera
  97583. */
  97584. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  97585. /**
  97586. * Gets the device distance from the ground in meters.
  97587. * @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.
  97588. */
  97589. deviceDistanceToRoomGround(): number;
  97590. /**
  97591. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  97592. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  97593. */
  97594. useStandingMatrix(callback?: (bool: boolean) => void): void;
  97595. /**
  97596. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  97597. * @returns A promise with a boolean set to if the standing matrix is supported.
  97598. */
  97599. useStandingMatrixAsync(): Promise<boolean>;
  97600. /**
  97601. * Disposes the camera
  97602. */
  97603. dispose(): void;
  97604. /**
  97605. * Gets a vrController by name.
  97606. * @param name The name of the controller to retreive
  97607. * @returns the controller matching the name specified or null if not found
  97608. */
  97609. getControllerByName(name: string): Nullable<WebVRController>;
  97610. private _leftController;
  97611. /**
  97612. * The controller corresponding to the users left hand.
  97613. */
  97614. get leftController(): Nullable<WebVRController>;
  97615. private _rightController;
  97616. /**
  97617. * The controller corresponding to the users right hand.
  97618. */
  97619. get rightController(): Nullable<WebVRController>;
  97620. /**
  97621. * Casts a ray forward from the vrCamera's gaze.
  97622. * @param length Length of the ray (default: 100)
  97623. * @returns the ray corresponding to the gaze
  97624. */
  97625. getForwardRay(length?: number): Ray;
  97626. /**
  97627. * @hidden
  97628. * Updates the camera based on device's frame data
  97629. */
  97630. _checkInputs(): void;
  97631. /**
  97632. * Updates the poseControlled values based on the input device pose.
  97633. * @param poseData Pose coming from the device
  97634. */
  97635. updateFromDevice(poseData: DevicePose): void;
  97636. private _htmlElementAttached;
  97637. private _detachIfAttached;
  97638. /**
  97639. * WebVR's attach control will start broadcasting frames to the device.
  97640. * Note that in certain browsers (chrome for example) this function must be called
  97641. * within a user-interaction callback. Example:
  97642. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  97643. *
  97644. * @param element html element to attach the vrDevice to
  97645. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  97646. */
  97647. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  97648. /**
  97649. * Detaches the camera from the html element and disables VR
  97650. *
  97651. * @param element html element to detach from
  97652. */
  97653. detachControl(element: HTMLElement): void;
  97654. /**
  97655. * @returns the name of this class
  97656. */
  97657. getClassName(): string;
  97658. /**
  97659. * Calls resetPose on the vrDisplay
  97660. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  97661. */
  97662. resetToCurrentRotation(): void;
  97663. /**
  97664. * @hidden
  97665. * Updates the rig cameras (left and right eye)
  97666. */
  97667. _updateRigCameras(): void;
  97668. private _workingVector;
  97669. private _oneVector;
  97670. private _workingMatrix;
  97671. private updateCacheCalled;
  97672. private _correctPositionIfNotTrackPosition;
  97673. /**
  97674. * @hidden
  97675. * Updates the cached values of the camera
  97676. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  97677. */
  97678. _updateCache(ignoreParentClass?: boolean): void;
  97679. /**
  97680. * @hidden
  97681. * Get current device position in babylon world
  97682. */
  97683. _computeDevicePosition(): void;
  97684. /**
  97685. * Updates the current device position and rotation in the babylon world
  97686. */
  97687. update(): void;
  97688. /**
  97689. * @hidden
  97690. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  97691. * @returns an identity matrix
  97692. */
  97693. _getViewMatrix(): Matrix;
  97694. private _tmpMatrix;
  97695. /**
  97696. * This function is called by the two RIG cameras.
  97697. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  97698. * @hidden
  97699. */
  97700. _getWebVRViewMatrix(): Matrix;
  97701. /** @hidden */
  97702. _getWebVRProjectionMatrix(): Matrix;
  97703. private _onGamepadConnectedObserver;
  97704. private _onGamepadDisconnectedObserver;
  97705. private _updateCacheWhenTrackingDisabledObserver;
  97706. /**
  97707. * Initializes the controllers and their meshes
  97708. */
  97709. initControllers(): void;
  97710. }
  97711. }
  97712. declare module BABYLON {
  97713. /**
  97714. * "Static Class" containing the most commonly used helper while dealing with material for
  97715. * rendering purpose.
  97716. *
  97717. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  97718. *
  97719. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  97720. */
  97721. export class MaterialHelper {
  97722. /**
  97723. * Bind the current view position to an effect.
  97724. * @param effect The effect to be bound
  97725. * @param scene The scene the eyes position is used from
  97726. * @param variableName name of the shader variable that will hold the eye position
  97727. */
  97728. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  97729. /**
  97730. * Helps preparing the defines values about the UVs in used in the effect.
  97731. * UVs are shared as much as we can accross channels in the shaders.
  97732. * @param texture The texture we are preparing the UVs for
  97733. * @param defines The defines to update
  97734. * @param key The channel key "diffuse", "specular"... used in the shader
  97735. */
  97736. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  97737. /**
  97738. * Binds a texture matrix value to its corrsponding uniform
  97739. * @param texture The texture to bind the matrix for
  97740. * @param uniformBuffer The uniform buffer receivin the data
  97741. * @param key The channel key "diffuse", "specular"... used in the shader
  97742. */
  97743. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  97744. /**
  97745. * Gets the current status of the fog (should it be enabled?)
  97746. * @param mesh defines the mesh to evaluate for fog support
  97747. * @param scene defines the hosting scene
  97748. * @returns true if fog must be enabled
  97749. */
  97750. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  97751. /**
  97752. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  97753. * @param mesh defines the current mesh
  97754. * @param scene defines the current scene
  97755. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  97756. * @param pointsCloud defines if point cloud rendering has to be turned on
  97757. * @param fogEnabled defines if fog has to be turned on
  97758. * @param alphaTest defines if alpha testing has to be turned on
  97759. * @param defines defines the current list of defines
  97760. */
  97761. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  97762. /**
  97763. * Helper used to prepare the list of defines associated with frame values for shader compilation
  97764. * @param scene defines the current scene
  97765. * @param engine defines the current engine
  97766. * @param defines specifies the list of active defines
  97767. * @param useInstances defines if instances have to be turned on
  97768. * @param useClipPlane defines if clip plane have to be turned on
  97769. * @param useInstances defines if instances have to be turned on
  97770. * @param useThinInstances defines if thin instances have to be turned on
  97771. */
  97772. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  97773. /**
  97774. * Prepares the defines for bones
  97775. * @param mesh The mesh containing the geometry data we will draw
  97776. * @param defines The defines to update
  97777. */
  97778. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  97779. /**
  97780. * Prepares the defines for morph targets
  97781. * @param mesh The mesh containing the geometry data we will draw
  97782. * @param defines The defines to update
  97783. */
  97784. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  97785. /**
  97786. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  97787. * @param mesh The mesh containing the geometry data we will draw
  97788. * @param defines The defines to update
  97789. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  97790. * @param useBones Precise whether bones should be used or not (override mesh info)
  97791. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  97792. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  97793. * @returns false if defines are considered not dirty and have not been checked
  97794. */
  97795. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  97796. /**
  97797. * Prepares the defines related to multiview
  97798. * @param scene The scene we are intending to draw
  97799. * @param defines The defines to update
  97800. */
  97801. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  97802. /**
  97803. * Prepares the defines related to the light information passed in parameter
  97804. * @param scene The scene we are intending to draw
  97805. * @param mesh The mesh the effect is compiling for
  97806. * @param light The light the effect is compiling for
  97807. * @param lightIndex The index of the light
  97808. * @param defines The defines to update
  97809. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  97810. * @param state Defines the current state regarding what is needed (normals, etc...)
  97811. */
  97812. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  97813. needNormals: boolean;
  97814. needRebuild: boolean;
  97815. shadowEnabled: boolean;
  97816. specularEnabled: boolean;
  97817. lightmapMode: boolean;
  97818. }): void;
  97819. /**
  97820. * Prepares the defines related to the light information passed in parameter
  97821. * @param scene The scene we are intending to draw
  97822. * @param mesh The mesh the effect is compiling for
  97823. * @param defines The defines to update
  97824. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  97825. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  97826. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  97827. * @returns true if normals will be required for the rest of the effect
  97828. */
  97829. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  97830. /**
  97831. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  97832. * @param lightIndex defines the light index
  97833. * @param uniformsList The uniform list
  97834. * @param samplersList The sampler list
  97835. * @param projectedLightTexture defines if projected texture must be used
  97836. * @param uniformBuffersList defines an optional list of uniform buffers
  97837. */
  97838. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  97839. /**
  97840. * Prepares the uniforms and samplers list to be used in the effect
  97841. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  97842. * @param samplersList The sampler list
  97843. * @param defines The defines helping in the list generation
  97844. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  97845. */
  97846. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  97847. /**
  97848. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  97849. * @param defines The defines to update while falling back
  97850. * @param fallbacks The authorized effect fallbacks
  97851. * @param maxSimultaneousLights The maximum number of lights allowed
  97852. * @param rank the current rank of the Effect
  97853. * @returns The newly affected rank
  97854. */
  97855. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  97856. private static _TmpMorphInfluencers;
  97857. /**
  97858. * Prepares the list of attributes required for morph targets according to the effect defines.
  97859. * @param attribs The current list of supported attribs
  97860. * @param mesh The mesh to prepare the morph targets attributes for
  97861. * @param influencers The number of influencers
  97862. */
  97863. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  97864. /**
  97865. * Prepares the list of attributes required for morph targets according to the effect defines.
  97866. * @param attribs The current list of supported attribs
  97867. * @param mesh The mesh to prepare the morph targets attributes for
  97868. * @param defines The current Defines of the effect
  97869. */
  97870. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  97871. /**
  97872. * Prepares the list of attributes required for bones according to the effect defines.
  97873. * @param attribs The current list of supported attribs
  97874. * @param mesh The mesh to prepare the bones attributes for
  97875. * @param defines The current Defines of the effect
  97876. * @param fallbacks The current efffect fallback strategy
  97877. */
  97878. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  97879. /**
  97880. * Check and prepare the list of attributes required for instances according to the effect defines.
  97881. * @param attribs The current list of supported attribs
  97882. * @param defines The current MaterialDefines of the effect
  97883. */
  97884. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  97885. /**
  97886. * Add the list of attributes required for instances to the attribs array.
  97887. * @param attribs The current list of supported attribs
  97888. */
  97889. static PushAttributesForInstances(attribs: string[]): void;
  97890. /**
  97891. * Binds the light information to the effect.
  97892. * @param light The light containing the generator
  97893. * @param effect The effect we are binding the data to
  97894. * @param lightIndex The light index in the effect used to render
  97895. */
  97896. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  97897. /**
  97898. * Binds the lights information from the scene to the effect for the given mesh.
  97899. * @param light Light to bind
  97900. * @param lightIndex Light index
  97901. * @param scene The scene where the light belongs to
  97902. * @param effect The effect we are binding the data to
  97903. * @param useSpecular Defines if specular is supported
  97904. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97905. */
  97906. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97907. /**
  97908. * Binds the lights information from the scene to the effect for the given mesh.
  97909. * @param scene The scene the lights belongs to
  97910. * @param mesh The mesh we are binding the information to render
  97911. * @param effect The effect we are binding the data to
  97912. * @param defines The generated defines for the effect
  97913. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  97914. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97915. */
  97916. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  97917. private static _tempFogColor;
  97918. /**
  97919. * Binds the fog information from the scene to the effect for the given mesh.
  97920. * @param scene The scene the lights belongs to
  97921. * @param mesh The mesh we are binding the information to render
  97922. * @param effect The effect we are binding the data to
  97923. * @param linearSpace Defines if the fog effect is applied in linear space
  97924. */
  97925. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  97926. /**
  97927. * Binds the bones information from the mesh to the effect.
  97928. * @param mesh The mesh we are binding the information to render
  97929. * @param effect The effect we are binding the data to
  97930. */
  97931. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  97932. /**
  97933. * Binds the morph targets information from the mesh to the effect.
  97934. * @param abstractMesh The mesh we are binding the information to render
  97935. * @param effect The effect we are binding the data to
  97936. */
  97937. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  97938. /**
  97939. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  97940. * @param defines The generated defines used in the effect
  97941. * @param effect The effect we are binding the data to
  97942. * @param scene The scene we are willing to render with logarithmic scale for
  97943. */
  97944. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  97945. /**
  97946. * Binds the clip plane information from the scene to the effect.
  97947. * @param scene The scene the clip plane information are extracted from
  97948. * @param effect The effect we are binding the data to
  97949. */
  97950. static BindClipPlane(effect: Effect, scene: Scene): void;
  97951. }
  97952. }
  97953. declare module BABYLON {
  97954. /**
  97955. * Block used to expose an input value
  97956. */
  97957. export class InputBlock extends NodeMaterialBlock {
  97958. private _mode;
  97959. private _associatedVariableName;
  97960. private _storedValue;
  97961. private _valueCallback;
  97962. private _type;
  97963. private _animationType;
  97964. /** Gets or set a value used to limit the range of float values */
  97965. min: number;
  97966. /** Gets or set a value used to limit the range of float values */
  97967. max: number;
  97968. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  97969. isBoolean: boolean;
  97970. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  97971. matrixMode: number;
  97972. /** @hidden */
  97973. _systemValue: Nullable<NodeMaterialSystemValues>;
  97974. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  97975. visibleInInspector: boolean;
  97976. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  97977. isConstant: boolean;
  97978. /** Gets or sets the group to use to display this block in the Inspector */
  97979. groupInInspector: string;
  97980. /** Gets an observable raised when the value is changed */
  97981. onValueChangedObservable: Observable<InputBlock>;
  97982. /**
  97983. * Gets or sets the connection point type (default is float)
  97984. */
  97985. get type(): NodeMaterialBlockConnectionPointTypes;
  97986. /**
  97987. * Creates a new InputBlock
  97988. * @param name defines the block name
  97989. * @param target defines the target of that block (Vertex by default)
  97990. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  97991. */
  97992. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  97993. /**
  97994. * Gets the output component
  97995. */
  97996. get output(): NodeMaterialConnectionPoint;
  97997. /**
  97998. * Set the source of this connection point to a vertex attribute
  97999. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  98000. * @returns the current connection point
  98001. */
  98002. setAsAttribute(attributeName?: string): InputBlock;
  98003. /**
  98004. * Set the source of this connection point to a system value
  98005. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  98006. * @returns the current connection point
  98007. */
  98008. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  98009. /**
  98010. * Gets or sets the value of that point.
  98011. * Please note that this value will be ignored if valueCallback is defined
  98012. */
  98013. get value(): any;
  98014. set value(value: any);
  98015. /**
  98016. * Gets or sets a callback used to get the value of that point.
  98017. * Please note that setting this value will force the connection point to ignore the value property
  98018. */
  98019. get valueCallback(): () => any;
  98020. set valueCallback(value: () => any);
  98021. /**
  98022. * Gets or sets the associated variable name in the shader
  98023. */
  98024. get associatedVariableName(): string;
  98025. set associatedVariableName(value: string);
  98026. /** Gets or sets the type of animation applied to the input */
  98027. get animationType(): AnimatedInputBlockTypes;
  98028. set animationType(value: AnimatedInputBlockTypes);
  98029. /**
  98030. * Gets a boolean indicating that this connection point not defined yet
  98031. */
  98032. get isUndefined(): boolean;
  98033. /**
  98034. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  98035. * In this case the connection point name must be the name of the uniform to use.
  98036. * Can only be set on inputs
  98037. */
  98038. get isUniform(): boolean;
  98039. set isUniform(value: boolean);
  98040. /**
  98041. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  98042. * In this case the connection point name must be the name of the attribute to use
  98043. * Can only be set on inputs
  98044. */
  98045. get isAttribute(): boolean;
  98046. set isAttribute(value: boolean);
  98047. /**
  98048. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  98049. * Can only be set on exit points
  98050. */
  98051. get isVarying(): boolean;
  98052. set isVarying(value: boolean);
  98053. /**
  98054. * Gets a boolean indicating that the current connection point is a system value
  98055. */
  98056. get isSystemValue(): boolean;
  98057. /**
  98058. * Gets or sets the current well known value or null if not defined as a system value
  98059. */
  98060. get systemValue(): Nullable<NodeMaterialSystemValues>;
  98061. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  98062. /**
  98063. * Gets the current class name
  98064. * @returns the class name
  98065. */
  98066. getClassName(): string;
  98067. /**
  98068. * Animate the input if animationType !== None
  98069. * @param scene defines the rendering scene
  98070. */
  98071. animate(scene: Scene): void;
  98072. private _emitDefine;
  98073. initialize(state: NodeMaterialBuildState): void;
  98074. /**
  98075. * Set the input block to its default value (based on its type)
  98076. */
  98077. setDefaultValue(): void;
  98078. private _emitConstant;
  98079. /** @hidden */
  98080. get _noContextSwitch(): boolean;
  98081. private _emit;
  98082. /** @hidden */
  98083. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  98084. /** @hidden */
  98085. _transmit(effect: Effect, scene: Scene): void;
  98086. protected _buildBlock(state: NodeMaterialBuildState): void;
  98087. protected _dumpPropertiesCode(): string;
  98088. dispose(): void;
  98089. serialize(): any;
  98090. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  98091. }
  98092. }
  98093. declare module BABYLON {
  98094. /**
  98095. * Enum used to define the compatibility state between two connection points
  98096. */
  98097. export enum NodeMaterialConnectionPointCompatibilityStates {
  98098. /** Points are compatibles */
  98099. Compatible = 0,
  98100. /** Points are incompatible because of their types */
  98101. TypeIncompatible = 1,
  98102. /** Points are incompatible because of their targets (vertex vs fragment) */
  98103. TargetIncompatible = 2
  98104. }
  98105. /**
  98106. * Defines the direction of a connection point
  98107. */
  98108. export enum NodeMaterialConnectionPointDirection {
  98109. /** Input */
  98110. Input = 0,
  98111. /** Output */
  98112. Output = 1
  98113. }
  98114. /**
  98115. * Defines a connection point for a block
  98116. */
  98117. export class NodeMaterialConnectionPoint {
  98118. /** @hidden */
  98119. _ownerBlock: NodeMaterialBlock;
  98120. /** @hidden */
  98121. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  98122. private _endpoints;
  98123. private _associatedVariableName;
  98124. private _direction;
  98125. /** @hidden */
  98126. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  98127. /** @hidden */
  98128. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  98129. private _type;
  98130. /** @hidden */
  98131. _enforceAssociatedVariableName: boolean;
  98132. /** Gets the direction of the point */
  98133. get direction(): NodeMaterialConnectionPointDirection;
  98134. /** Indicates that this connection point needs dual validation before being connected to another point */
  98135. needDualDirectionValidation: boolean;
  98136. /**
  98137. * Gets or sets the additional types supported by this connection point
  98138. */
  98139. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  98140. /**
  98141. * Gets or sets the additional types excluded by this connection point
  98142. */
  98143. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  98144. /**
  98145. * Observable triggered when this point is connected
  98146. */
  98147. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  98148. /**
  98149. * Gets or sets the associated variable name in the shader
  98150. */
  98151. get associatedVariableName(): string;
  98152. set associatedVariableName(value: string);
  98153. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  98154. get innerType(): NodeMaterialBlockConnectionPointTypes;
  98155. /**
  98156. * Gets or sets the connection point type (default is float)
  98157. */
  98158. get type(): NodeMaterialBlockConnectionPointTypes;
  98159. set type(value: NodeMaterialBlockConnectionPointTypes);
  98160. /**
  98161. * Gets or sets the connection point name
  98162. */
  98163. name: string;
  98164. /**
  98165. * Gets or sets the connection point name
  98166. */
  98167. displayName: string;
  98168. /**
  98169. * Gets or sets a boolean indicating that this connection point can be omitted
  98170. */
  98171. isOptional: boolean;
  98172. /**
  98173. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  98174. */
  98175. isExposedOnFrame: boolean;
  98176. /**
  98177. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  98178. */
  98179. define: string;
  98180. /** @hidden */
  98181. _prioritizeVertex: boolean;
  98182. private _target;
  98183. /** Gets or sets the target of that connection point */
  98184. get target(): NodeMaterialBlockTargets;
  98185. set target(value: NodeMaterialBlockTargets);
  98186. /**
  98187. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  98188. */
  98189. get isConnected(): boolean;
  98190. /**
  98191. * Gets a boolean indicating that the current point is connected to an input block
  98192. */
  98193. get isConnectedToInputBlock(): boolean;
  98194. /**
  98195. * Gets a the connected input block (if any)
  98196. */
  98197. get connectInputBlock(): Nullable<InputBlock>;
  98198. /** Get the other side of the connection (if any) */
  98199. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  98200. /** Get the block that owns this connection point */
  98201. get ownerBlock(): NodeMaterialBlock;
  98202. /** Get the block connected on the other side of this connection (if any) */
  98203. get sourceBlock(): Nullable<NodeMaterialBlock>;
  98204. /** Get the block connected on the endpoints of this connection (if any) */
  98205. get connectedBlocks(): Array<NodeMaterialBlock>;
  98206. /** Gets the list of connected endpoints */
  98207. get endpoints(): NodeMaterialConnectionPoint[];
  98208. /** Gets a boolean indicating if that output point is connected to at least one input */
  98209. get hasEndpoints(): boolean;
  98210. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  98211. get isConnectedInVertexShader(): boolean;
  98212. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  98213. get isConnectedInFragmentShader(): boolean;
  98214. /**
  98215. * Creates a block suitable to be used as an input for this input point.
  98216. * If null is returned, a block based on the point type will be created.
  98217. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  98218. */
  98219. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  98220. /**
  98221. * Creates a new connection point
  98222. * @param name defines the connection point name
  98223. * @param ownerBlock defines the block hosting this connection point
  98224. * @param direction defines the direction of the connection point
  98225. */
  98226. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  98227. /**
  98228. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  98229. * @returns the class name
  98230. */
  98231. getClassName(): string;
  98232. /**
  98233. * Gets a boolean indicating if the current point can be connected to another point
  98234. * @param connectionPoint defines the other connection point
  98235. * @returns a boolean
  98236. */
  98237. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  98238. /**
  98239. * Gets a number indicating if the current point can be connected to another point
  98240. * @param connectionPoint defines the other connection point
  98241. * @returns a number defining the compatibility state
  98242. */
  98243. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  98244. /**
  98245. * Connect this point to another connection point
  98246. * @param connectionPoint defines the other connection point
  98247. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  98248. * @returns the current connection point
  98249. */
  98250. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  98251. /**
  98252. * Disconnect this point from one of his endpoint
  98253. * @param endpoint defines the other connection point
  98254. * @returns the current connection point
  98255. */
  98256. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  98257. /**
  98258. * Serializes this point in a JSON representation
  98259. * @param isInput defines if the connection point is an input (default is true)
  98260. * @returns the serialized point object
  98261. */
  98262. serialize(isInput?: boolean): any;
  98263. /**
  98264. * Release resources
  98265. */
  98266. dispose(): void;
  98267. }
  98268. }
  98269. declare module BABYLON {
  98270. /**
  98271. * Enum used to define the material modes
  98272. */
  98273. export enum NodeMaterialModes {
  98274. /** Regular material */
  98275. Material = 0,
  98276. /** For post process */
  98277. PostProcess = 1,
  98278. /** For particle system */
  98279. Particle = 2
  98280. }
  98281. }
  98282. declare module BABYLON {
  98283. /**
  98284. * Block used to read a texture from a sampler
  98285. */
  98286. export class TextureBlock extends NodeMaterialBlock {
  98287. private _defineName;
  98288. private _linearDefineName;
  98289. private _gammaDefineName;
  98290. private _tempTextureRead;
  98291. private _samplerName;
  98292. private _transformedUVName;
  98293. private _textureTransformName;
  98294. private _textureInfoName;
  98295. private _mainUVName;
  98296. private _mainUVDefineName;
  98297. private _fragmentOnly;
  98298. /**
  98299. * Gets or sets the texture associated with the node
  98300. */
  98301. texture: Nullable<Texture>;
  98302. /**
  98303. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  98304. */
  98305. convertToGammaSpace: boolean;
  98306. /**
  98307. * Gets or sets a boolean indicating if content needs to be converted to linear space
  98308. */
  98309. convertToLinearSpace: boolean;
  98310. /**
  98311. * Create a new TextureBlock
  98312. * @param name defines the block name
  98313. */
  98314. constructor(name: string, fragmentOnly?: boolean);
  98315. /**
  98316. * Gets the current class name
  98317. * @returns the class name
  98318. */
  98319. getClassName(): string;
  98320. /**
  98321. * Gets the uv input component
  98322. */
  98323. get uv(): NodeMaterialConnectionPoint;
  98324. /**
  98325. * Gets the rgba output component
  98326. */
  98327. get rgba(): NodeMaterialConnectionPoint;
  98328. /**
  98329. * Gets the rgb output component
  98330. */
  98331. get rgb(): NodeMaterialConnectionPoint;
  98332. /**
  98333. * Gets the r output component
  98334. */
  98335. get r(): NodeMaterialConnectionPoint;
  98336. /**
  98337. * Gets the g output component
  98338. */
  98339. get g(): NodeMaterialConnectionPoint;
  98340. /**
  98341. * Gets the b output component
  98342. */
  98343. get b(): NodeMaterialConnectionPoint;
  98344. /**
  98345. * Gets the a output component
  98346. */
  98347. get a(): NodeMaterialConnectionPoint;
  98348. get target(): NodeMaterialBlockTargets;
  98349. autoConfigure(material: NodeMaterial): void;
  98350. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  98351. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  98352. isReady(): boolean;
  98353. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  98354. private get _isMixed();
  98355. private _injectVertexCode;
  98356. private _writeTextureRead;
  98357. private _writeOutput;
  98358. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  98359. protected _dumpPropertiesCode(): string;
  98360. serialize(): any;
  98361. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  98362. }
  98363. }
  98364. declare module BABYLON {
  98365. /** @hidden */
  98366. export var reflectionFunction: {
  98367. name: string;
  98368. shader: string;
  98369. };
  98370. }
  98371. declare module BABYLON {
  98372. /**
  98373. * Base block used to read a reflection texture from a sampler
  98374. */
  98375. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  98376. /** @hidden */
  98377. _define3DName: string;
  98378. /** @hidden */
  98379. _defineCubicName: string;
  98380. /** @hidden */
  98381. _defineExplicitName: string;
  98382. /** @hidden */
  98383. _defineProjectionName: string;
  98384. /** @hidden */
  98385. _defineLocalCubicName: string;
  98386. /** @hidden */
  98387. _defineSphericalName: string;
  98388. /** @hidden */
  98389. _definePlanarName: string;
  98390. /** @hidden */
  98391. _defineEquirectangularName: string;
  98392. /** @hidden */
  98393. _defineMirroredEquirectangularFixedName: string;
  98394. /** @hidden */
  98395. _defineEquirectangularFixedName: string;
  98396. /** @hidden */
  98397. _defineSkyboxName: string;
  98398. /** @hidden */
  98399. _defineOppositeZ: string;
  98400. /** @hidden */
  98401. _cubeSamplerName: string;
  98402. /** @hidden */
  98403. _2DSamplerName: string;
  98404. protected _positionUVWName: string;
  98405. protected _directionWName: string;
  98406. protected _reflectionVectorName: string;
  98407. /** @hidden */
  98408. _reflectionCoordsName: string;
  98409. /** @hidden */
  98410. _reflectionMatrixName: string;
  98411. protected _reflectionColorName: string;
  98412. /**
  98413. * Gets or sets the texture associated with the node
  98414. */
  98415. texture: Nullable<BaseTexture>;
  98416. /**
  98417. * Create a new ReflectionTextureBaseBlock
  98418. * @param name defines the block name
  98419. */
  98420. constructor(name: string);
  98421. /**
  98422. * Gets the current class name
  98423. * @returns the class name
  98424. */
  98425. getClassName(): string;
  98426. /**
  98427. * Gets the world position input component
  98428. */
  98429. abstract get position(): NodeMaterialConnectionPoint;
  98430. /**
  98431. * Gets the world position input component
  98432. */
  98433. abstract get worldPosition(): NodeMaterialConnectionPoint;
  98434. /**
  98435. * Gets the world normal input component
  98436. */
  98437. abstract get worldNormal(): NodeMaterialConnectionPoint;
  98438. /**
  98439. * Gets the world input component
  98440. */
  98441. abstract get world(): NodeMaterialConnectionPoint;
  98442. /**
  98443. * Gets the camera (or eye) position component
  98444. */
  98445. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  98446. /**
  98447. * Gets the view input component
  98448. */
  98449. abstract get view(): NodeMaterialConnectionPoint;
  98450. protected _getTexture(): Nullable<BaseTexture>;
  98451. autoConfigure(material: NodeMaterial): void;
  98452. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  98453. isReady(): boolean;
  98454. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  98455. /**
  98456. * Gets the code to inject in the vertex shader
  98457. * @param state current state of the node material building
  98458. * @returns the shader code
  98459. */
  98460. handleVertexSide(state: NodeMaterialBuildState): string;
  98461. /**
  98462. * Handles the inits for the fragment code path
  98463. * @param state node material build state
  98464. */
  98465. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  98466. /**
  98467. * Generates the reflection coords code for the fragment code path
  98468. * @param worldNormalVarName name of the world normal variable
  98469. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  98470. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  98471. * @returns the shader code
  98472. */
  98473. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  98474. /**
  98475. * Generates the reflection color code for the fragment code path
  98476. * @param lodVarName name of the lod variable
  98477. * @param swizzleLookupTexture swizzle to use for the final color variable
  98478. * @returns the shader code
  98479. */
  98480. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  98481. /**
  98482. * Generates the code corresponding to the connected output points
  98483. * @param state node material build state
  98484. * @param varName name of the variable to output
  98485. * @returns the shader code
  98486. */
  98487. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  98488. protected _buildBlock(state: NodeMaterialBuildState): this;
  98489. protected _dumpPropertiesCode(): string;
  98490. serialize(): any;
  98491. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  98492. }
  98493. }
  98494. declare module BABYLON {
  98495. /**
  98496. * Defines a connection point to be used for points with a custom object type
  98497. */
  98498. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  98499. private _blockType;
  98500. private _blockName;
  98501. private _nameForCheking?;
  98502. /**
  98503. * Creates a new connection point
  98504. * @param name defines the connection point name
  98505. * @param ownerBlock defines the block hosting this connection point
  98506. * @param direction defines the direction of the connection point
  98507. */
  98508. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  98509. /**
  98510. * Gets a number indicating if the current point can be connected to another point
  98511. * @param connectionPoint defines the other connection point
  98512. * @returns a number defining the compatibility state
  98513. */
  98514. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  98515. /**
  98516. * Creates a block suitable to be used as an input for this input point.
  98517. * If null is returned, a block based on the point type will be created.
  98518. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  98519. */
  98520. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  98521. }
  98522. }
  98523. declare module BABYLON {
  98524. /**
  98525. * Enum defining the type of properties that can be edited in the property pages in the NME
  98526. */
  98527. export enum PropertyTypeForEdition {
  98528. /** property is a boolean */
  98529. Boolean = 0,
  98530. /** property is a float */
  98531. Float = 1,
  98532. /** property is a Vector2 */
  98533. Vector2 = 2,
  98534. /** property is a list of values */
  98535. List = 3
  98536. }
  98537. /**
  98538. * Interface that defines an option in a variable of type list
  98539. */
  98540. export interface IEditablePropertyListOption {
  98541. /** label of the option */
  98542. "label": string;
  98543. /** value of the option */
  98544. "value": number;
  98545. }
  98546. /**
  98547. * Interface that defines the options available for an editable property
  98548. */
  98549. export interface IEditablePropertyOption {
  98550. /** min value */
  98551. "min"?: number;
  98552. /** max value */
  98553. "max"?: number;
  98554. /** notifiers: indicates which actions to take when the property is changed */
  98555. "notifiers"?: {
  98556. /** the material should be rebuilt */
  98557. "rebuild"?: boolean;
  98558. /** the preview should be updated */
  98559. "update"?: boolean;
  98560. };
  98561. /** list of the options for a variable of type list */
  98562. "options"?: IEditablePropertyListOption[];
  98563. }
  98564. /**
  98565. * Interface that describes an editable property
  98566. */
  98567. export interface IPropertyDescriptionForEdition {
  98568. /** name of the property */
  98569. "propertyName": string;
  98570. /** display name of the property */
  98571. "displayName": string;
  98572. /** type of the property */
  98573. "type": PropertyTypeForEdition;
  98574. /** group of the property - all properties with the same group value will be displayed in a specific section */
  98575. "groupName": string;
  98576. /** options for the property */
  98577. "options": IEditablePropertyOption;
  98578. }
  98579. /**
  98580. * Decorator that flags a property in a node material block as being editable
  98581. */
  98582. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  98583. }
  98584. declare module BABYLON {
  98585. /**
  98586. * Block used to implement the refraction part of the sub surface module of the PBR material
  98587. */
  98588. export class RefractionBlock extends NodeMaterialBlock {
  98589. /** @hidden */
  98590. _define3DName: string;
  98591. /** @hidden */
  98592. _refractionMatrixName: string;
  98593. /** @hidden */
  98594. _defineLODRefractionAlpha: string;
  98595. /** @hidden */
  98596. _defineLinearSpecularRefraction: string;
  98597. /** @hidden */
  98598. _defineOppositeZ: string;
  98599. /** @hidden */
  98600. _cubeSamplerName: string;
  98601. /** @hidden */
  98602. _2DSamplerName: string;
  98603. /** @hidden */
  98604. _vRefractionMicrosurfaceInfosName: string;
  98605. /** @hidden */
  98606. _vRefractionInfosName: string;
  98607. private _scene;
  98608. /**
  98609. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  98610. * Materials half opaque for instance using refraction could benefit from this control.
  98611. */
  98612. linkRefractionWithTransparency: boolean;
  98613. /**
  98614. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  98615. */
  98616. invertRefractionY: boolean;
  98617. /**
  98618. * Gets or sets the texture associated with the node
  98619. */
  98620. texture: Nullable<BaseTexture>;
  98621. /**
  98622. * Create a new RefractionBlock
  98623. * @param name defines the block name
  98624. */
  98625. constructor(name: string);
  98626. /**
  98627. * Gets the current class name
  98628. * @returns the class name
  98629. */
  98630. getClassName(): string;
  98631. /**
  98632. * Gets the intensity input component
  98633. */
  98634. get intensity(): NodeMaterialConnectionPoint;
  98635. /**
  98636. * Gets the index of refraction input component
  98637. */
  98638. get indexOfRefraction(): NodeMaterialConnectionPoint;
  98639. /**
  98640. * Gets the tint at distance input component
  98641. */
  98642. get tintAtDistance(): NodeMaterialConnectionPoint;
  98643. /**
  98644. * Gets the view input component
  98645. */
  98646. get view(): NodeMaterialConnectionPoint;
  98647. /**
  98648. * Gets the refraction object output component
  98649. */
  98650. get refraction(): NodeMaterialConnectionPoint;
  98651. /**
  98652. * Returns true if the block has a texture
  98653. */
  98654. get hasTexture(): boolean;
  98655. protected _getTexture(): Nullable<BaseTexture>;
  98656. autoConfigure(material: NodeMaterial): void;
  98657. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  98658. isReady(): boolean;
  98659. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  98660. /**
  98661. * Gets the main code of the block (fragment side)
  98662. * @param state current state of the node material building
  98663. * @returns the shader code
  98664. */
  98665. getCode(state: NodeMaterialBuildState): string;
  98666. protected _buildBlock(state: NodeMaterialBuildState): this;
  98667. protected _dumpPropertiesCode(): string;
  98668. serialize(): any;
  98669. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  98670. }
  98671. }
  98672. declare module BABYLON {
  98673. /**
  98674. * Base block used as input for post process
  98675. */
  98676. export class CurrentScreenBlock extends NodeMaterialBlock {
  98677. private _samplerName;
  98678. private _linearDefineName;
  98679. private _gammaDefineName;
  98680. private _mainUVName;
  98681. private _tempTextureRead;
  98682. /**
  98683. * Gets or sets the texture associated with the node
  98684. */
  98685. texture: Nullable<BaseTexture>;
  98686. /**
  98687. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  98688. */
  98689. convertToGammaSpace: boolean;
  98690. /**
  98691. * Gets or sets a boolean indicating if content needs to be converted to linear space
  98692. */
  98693. convertToLinearSpace: boolean;
  98694. /**
  98695. * Create a new CurrentScreenBlock
  98696. * @param name defines the block name
  98697. */
  98698. constructor(name: string);
  98699. /**
  98700. * Gets the current class name
  98701. * @returns the class name
  98702. */
  98703. getClassName(): string;
  98704. /**
  98705. * Gets the uv input component
  98706. */
  98707. get uv(): NodeMaterialConnectionPoint;
  98708. /**
  98709. * Gets the rgba output component
  98710. */
  98711. get rgba(): NodeMaterialConnectionPoint;
  98712. /**
  98713. * Gets the rgb output component
  98714. */
  98715. get rgb(): NodeMaterialConnectionPoint;
  98716. /**
  98717. * Gets the r output component
  98718. */
  98719. get r(): NodeMaterialConnectionPoint;
  98720. /**
  98721. * Gets the g output component
  98722. */
  98723. get g(): NodeMaterialConnectionPoint;
  98724. /**
  98725. * Gets the b output component
  98726. */
  98727. get b(): NodeMaterialConnectionPoint;
  98728. /**
  98729. * Gets the a output component
  98730. */
  98731. get a(): NodeMaterialConnectionPoint;
  98732. /**
  98733. * Initialize the block and prepare the context for build
  98734. * @param state defines the state that will be used for the build
  98735. */
  98736. initialize(state: NodeMaterialBuildState): void;
  98737. get target(): NodeMaterialBlockTargets;
  98738. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  98739. isReady(): boolean;
  98740. private _injectVertexCode;
  98741. private _writeTextureRead;
  98742. private _writeOutput;
  98743. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  98744. serialize(): any;
  98745. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  98746. }
  98747. }
  98748. declare module BABYLON {
  98749. /**
  98750. * Base block used for the particle texture
  98751. */
  98752. export class ParticleTextureBlock extends NodeMaterialBlock {
  98753. private _samplerName;
  98754. private _linearDefineName;
  98755. private _gammaDefineName;
  98756. private _tempTextureRead;
  98757. /**
  98758. * Gets or sets the texture associated with the node
  98759. */
  98760. texture: Nullable<BaseTexture>;
  98761. /**
  98762. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  98763. */
  98764. convertToGammaSpace: boolean;
  98765. /**
  98766. * Gets or sets a boolean indicating if content needs to be converted to linear space
  98767. */
  98768. convertToLinearSpace: boolean;
  98769. /**
  98770. * Create a new ParticleTextureBlock
  98771. * @param name defines the block name
  98772. */
  98773. constructor(name: string);
  98774. /**
  98775. * Gets the current class name
  98776. * @returns the class name
  98777. */
  98778. getClassName(): string;
  98779. /**
  98780. * Gets the uv input component
  98781. */
  98782. get uv(): NodeMaterialConnectionPoint;
  98783. /**
  98784. * Gets the rgba output component
  98785. */
  98786. get rgba(): NodeMaterialConnectionPoint;
  98787. /**
  98788. * Gets the rgb output component
  98789. */
  98790. get rgb(): NodeMaterialConnectionPoint;
  98791. /**
  98792. * Gets the r output component
  98793. */
  98794. get r(): NodeMaterialConnectionPoint;
  98795. /**
  98796. * Gets the g output component
  98797. */
  98798. get g(): NodeMaterialConnectionPoint;
  98799. /**
  98800. * Gets the b output component
  98801. */
  98802. get b(): NodeMaterialConnectionPoint;
  98803. /**
  98804. * Gets the a output component
  98805. */
  98806. get a(): NodeMaterialConnectionPoint;
  98807. /**
  98808. * Initialize the block and prepare the context for build
  98809. * @param state defines the state that will be used for the build
  98810. */
  98811. initialize(state: NodeMaterialBuildState): void;
  98812. autoConfigure(material: NodeMaterial): void;
  98813. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  98814. isReady(): boolean;
  98815. private _writeOutput;
  98816. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  98817. serialize(): any;
  98818. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  98819. }
  98820. }
  98821. declare module BABYLON {
  98822. /**
  98823. * Class used to store shared data between 2 NodeMaterialBuildState
  98824. */
  98825. export class NodeMaterialBuildStateSharedData {
  98826. /**
  98827. * Gets the list of emitted varyings
  98828. */
  98829. temps: string[];
  98830. /**
  98831. * Gets the list of emitted varyings
  98832. */
  98833. varyings: string[];
  98834. /**
  98835. * Gets the varying declaration string
  98836. */
  98837. varyingDeclaration: string;
  98838. /**
  98839. * Input blocks
  98840. */
  98841. inputBlocks: InputBlock[];
  98842. /**
  98843. * Input blocks
  98844. */
  98845. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  98846. /**
  98847. * Bindable blocks (Blocks that need to set data to the effect)
  98848. */
  98849. bindableBlocks: NodeMaterialBlock[];
  98850. /**
  98851. * List of blocks that can provide a compilation fallback
  98852. */
  98853. blocksWithFallbacks: NodeMaterialBlock[];
  98854. /**
  98855. * List of blocks that can provide a define update
  98856. */
  98857. blocksWithDefines: NodeMaterialBlock[];
  98858. /**
  98859. * List of blocks that can provide a repeatable content
  98860. */
  98861. repeatableContentBlocks: NodeMaterialBlock[];
  98862. /**
  98863. * List of blocks that can provide a dynamic list of uniforms
  98864. */
  98865. dynamicUniformBlocks: NodeMaterialBlock[];
  98866. /**
  98867. * List of blocks that can block the isReady function for the material
  98868. */
  98869. blockingBlocks: NodeMaterialBlock[];
  98870. /**
  98871. * Gets the list of animated inputs
  98872. */
  98873. animatedInputs: InputBlock[];
  98874. /**
  98875. * Build Id used to avoid multiple recompilations
  98876. */
  98877. buildId: number;
  98878. /** List of emitted variables */
  98879. variableNames: {
  98880. [key: string]: number;
  98881. };
  98882. /** List of emitted defines */
  98883. defineNames: {
  98884. [key: string]: number;
  98885. };
  98886. /** Should emit comments? */
  98887. emitComments: boolean;
  98888. /** Emit build activity */
  98889. verbose: boolean;
  98890. /** Gets or sets the hosting scene */
  98891. scene: Scene;
  98892. /**
  98893. * Gets the compilation hints emitted at compilation time
  98894. */
  98895. hints: {
  98896. needWorldViewMatrix: boolean;
  98897. needWorldViewProjectionMatrix: boolean;
  98898. needAlphaBlending: boolean;
  98899. needAlphaTesting: boolean;
  98900. };
  98901. /**
  98902. * List of compilation checks
  98903. */
  98904. checks: {
  98905. emitVertex: boolean;
  98906. emitFragment: boolean;
  98907. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  98908. };
  98909. /**
  98910. * Is vertex program allowed to be empty?
  98911. */
  98912. allowEmptyVertexProgram: boolean;
  98913. /** Creates a new shared data */
  98914. constructor();
  98915. /**
  98916. * Emits console errors and exceptions if there is a failing check
  98917. */
  98918. emitErrors(): void;
  98919. }
  98920. }
  98921. declare module BABYLON {
  98922. /**
  98923. * Class used to store node based material build state
  98924. */
  98925. export class NodeMaterialBuildState {
  98926. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  98927. supportUniformBuffers: boolean;
  98928. /**
  98929. * Gets the list of emitted attributes
  98930. */
  98931. attributes: string[];
  98932. /**
  98933. * Gets the list of emitted uniforms
  98934. */
  98935. uniforms: string[];
  98936. /**
  98937. * Gets the list of emitted constants
  98938. */
  98939. constants: string[];
  98940. /**
  98941. * Gets the list of emitted samplers
  98942. */
  98943. samplers: string[];
  98944. /**
  98945. * Gets the list of emitted functions
  98946. */
  98947. functions: {
  98948. [key: string]: string;
  98949. };
  98950. /**
  98951. * Gets the list of emitted extensions
  98952. */
  98953. extensions: {
  98954. [key: string]: string;
  98955. };
  98956. /**
  98957. * Gets the target of the compilation state
  98958. */
  98959. target: NodeMaterialBlockTargets;
  98960. /**
  98961. * Gets the list of emitted counters
  98962. */
  98963. counters: {
  98964. [key: string]: number;
  98965. };
  98966. /**
  98967. * Shared data between multiple NodeMaterialBuildState instances
  98968. */
  98969. sharedData: NodeMaterialBuildStateSharedData;
  98970. /** @hidden */
  98971. _vertexState: NodeMaterialBuildState;
  98972. /** @hidden */
  98973. _attributeDeclaration: string;
  98974. /** @hidden */
  98975. _uniformDeclaration: string;
  98976. /** @hidden */
  98977. _constantDeclaration: string;
  98978. /** @hidden */
  98979. _samplerDeclaration: string;
  98980. /** @hidden */
  98981. _varyingTransfer: string;
  98982. /** @hidden */
  98983. _injectAtEnd: string;
  98984. private _repeatableContentAnchorIndex;
  98985. /** @hidden */
  98986. _builtCompilationString: string;
  98987. /**
  98988. * Gets the emitted compilation strings
  98989. */
  98990. compilationString: string;
  98991. /**
  98992. * Finalize the compilation strings
  98993. * @param state defines the current compilation state
  98994. */
  98995. finalize(state: NodeMaterialBuildState): void;
  98996. /** @hidden */
  98997. get _repeatableContentAnchor(): string;
  98998. /** @hidden */
  98999. _getFreeVariableName(prefix: string): string;
  99000. /** @hidden */
  99001. _getFreeDefineName(prefix: string): string;
  99002. /** @hidden */
  99003. _excludeVariableName(name: string): void;
  99004. /** @hidden */
  99005. _emit2DSampler(name: string): void;
  99006. /** @hidden */
  99007. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  99008. /** @hidden */
  99009. _emitExtension(name: string, extension: string, define?: string): void;
  99010. /** @hidden */
  99011. _emitFunction(name: string, code: string, comments: string): void;
  99012. /** @hidden */
  99013. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  99014. replaceStrings?: {
  99015. search: RegExp;
  99016. replace: string;
  99017. }[];
  99018. repeatKey?: string;
  99019. }): string;
  99020. /** @hidden */
  99021. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  99022. repeatKey?: string;
  99023. removeAttributes?: boolean;
  99024. removeUniforms?: boolean;
  99025. removeVaryings?: boolean;
  99026. removeIfDef?: boolean;
  99027. replaceStrings?: {
  99028. search: RegExp;
  99029. replace: string;
  99030. }[];
  99031. }, storeKey?: string): void;
  99032. /** @hidden */
  99033. _registerTempVariable(name: string): boolean;
  99034. /** @hidden */
  99035. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  99036. /** @hidden */
  99037. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  99038. /** @hidden */
  99039. _emitFloat(value: number): string;
  99040. }
  99041. }
  99042. declare module BABYLON {
  99043. /**
  99044. * Helper class used to generate session unique ID
  99045. */
  99046. export class UniqueIdGenerator {
  99047. private static _UniqueIdCounter;
  99048. /**
  99049. * Gets an unique (relatively to the current scene) Id
  99050. */
  99051. static get UniqueId(): number;
  99052. }
  99053. }
  99054. declare module BABYLON {
  99055. /**
  99056. * Defines a block that can be used inside a node based material
  99057. */
  99058. export class NodeMaterialBlock {
  99059. private _buildId;
  99060. private _buildTarget;
  99061. private _target;
  99062. private _isFinalMerger;
  99063. private _isInput;
  99064. protected _isUnique: boolean;
  99065. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  99066. inputsAreExclusive: boolean;
  99067. /** @hidden */
  99068. _codeVariableName: string;
  99069. /** @hidden */
  99070. _inputs: NodeMaterialConnectionPoint[];
  99071. /** @hidden */
  99072. _outputs: NodeMaterialConnectionPoint[];
  99073. /** @hidden */
  99074. _preparationId: number;
  99075. /**
  99076. * Gets or sets the name of the block
  99077. */
  99078. name: string;
  99079. /**
  99080. * Gets or sets the unique id of the node
  99081. */
  99082. uniqueId: number;
  99083. /**
  99084. * Gets or sets the comments associated with this block
  99085. */
  99086. comments: string;
  99087. /**
  99088. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  99089. */
  99090. get isUnique(): boolean;
  99091. /**
  99092. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  99093. */
  99094. get isFinalMerger(): boolean;
  99095. /**
  99096. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  99097. */
  99098. get isInput(): boolean;
  99099. /**
  99100. * Gets or sets the build Id
  99101. */
  99102. get buildId(): number;
  99103. set buildId(value: number);
  99104. /**
  99105. * Gets or sets the target of the block
  99106. */
  99107. get target(): NodeMaterialBlockTargets;
  99108. set target(value: NodeMaterialBlockTargets);
  99109. /**
  99110. * Gets the list of input points
  99111. */
  99112. get inputs(): NodeMaterialConnectionPoint[];
  99113. /** Gets the list of output points */
  99114. get outputs(): NodeMaterialConnectionPoint[];
  99115. /**
  99116. * Find an input by its name
  99117. * @param name defines the name of the input to look for
  99118. * @returns the input or null if not found
  99119. */
  99120. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  99121. /**
  99122. * Find an output by its name
  99123. * @param name defines the name of the outputto look for
  99124. * @returns the output or null if not found
  99125. */
  99126. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  99127. /**
  99128. * Creates a new NodeMaterialBlock
  99129. * @param name defines the block name
  99130. * @param target defines the target of that block (Vertex by default)
  99131. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  99132. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  99133. */
  99134. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  99135. /**
  99136. * Initialize the block and prepare the context for build
  99137. * @param state defines the state that will be used for the build
  99138. */
  99139. initialize(state: NodeMaterialBuildState): void;
  99140. /**
  99141. * Bind data to effect. Will only be called for blocks with isBindable === true
  99142. * @param effect defines the effect to bind data to
  99143. * @param nodeMaterial defines the hosting NodeMaterial
  99144. * @param mesh defines the mesh that will be rendered
  99145. * @param subMesh defines the submesh that will be rendered
  99146. */
  99147. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  99148. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  99149. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  99150. protected _writeFloat(value: number): string;
  99151. /**
  99152. * Gets the current class name e.g. "NodeMaterialBlock"
  99153. * @returns the class name
  99154. */
  99155. getClassName(): string;
  99156. /**
  99157. * Register a new input. Must be called inside a block constructor
  99158. * @param name defines the connection point name
  99159. * @param type defines the connection point type
  99160. * @param isOptional defines a boolean indicating that this input can be omitted
  99161. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  99162. * @param point an already created connection point. If not provided, create a new one
  99163. * @returns the current block
  99164. */
  99165. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  99166. /**
  99167. * Register a new output. Must be called inside a block constructor
  99168. * @param name defines the connection point name
  99169. * @param type defines the connection point type
  99170. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  99171. * @param point an already created connection point. If not provided, create a new one
  99172. * @returns the current block
  99173. */
  99174. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  99175. /**
  99176. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  99177. * @param forOutput defines an optional connection point to check compatibility with
  99178. * @returns the first available input or null
  99179. */
  99180. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  99181. /**
  99182. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  99183. * @param forBlock defines an optional block to check compatibility with
  99184. * @returns the first available input or null
  99185. */
  99186. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  99187. /**
  99188. * Gets the sibling of the given output
  99189. * @param current defines the current output
  99190. * @returns the next output in the list or null
  99191. */
  99192. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  99193. /**
  99194. * Connect current block with another block
  99195. * @param other defines the block to connect with
  99196. * @param options define the various options to help pick the right connections
  99197. * @returns the current block
  99198. */
  99199. connectTo(other: NodeMaterialBlock, options?: {
  99200. input?: string;
  99201. output?: string;
  99202. outputSwizzle?: string;
  99203. }): this | undefined;
  99204. protected _buildBlock(state: NodeMaterialBuildState): void;
  99205. /**
  99206. * Add uniforms, samplers and uniform buffers at compilation time
  99207. * @param state defines the state to update
  99208. * @param nodeMaterial defines the node material requesting the update
  99209. * @param defines defines the material defines to update
  99210. * @param uniformBuffers defines the list of uniform buffer names
  99211. */
  99212. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  99213. /**
  99214. * Add potential fallbacks if shader compilation fails
  99215. * @param mesh defines the mesh to be rendered
  99216. * @param fallbacks defines the current prioritized list of fallbacks
  99217. */
  99218. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  99219. /**
  99220. * Initialize defines for shader compilation
  99221. * @param mesh defines the mesh to be rendered
  99222. * @param nodeMaterial defines the node material requesting the update
  99223. * @param defines defines the material defines to update
  99224. * @param useInstances specifies that instances should be used
  99225. */
  99226. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  99227. /**
  99228. * Update defines for shader compilation
  99229. * @param mesh defines the mesh to be rendered
  99230. * @param nodeMaterial defines the node material requesting the update
  99231. * @param defines defines the material defines to update
  99232. * @param useInstances specifies that instances should be used
  99233. * @param subMesh defines which submesh to render
  99234. */
  99235. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  99236. /**
  99237. * Lets the block try to connect some inputs automatically
  99238. * @param material defines the hosting NodeMaterial
  99239. */
  99240. autoConfigure(material: NodeMaterial): void;
  99241. /**
  99242. * Function called when a block is declared as repeatable content generator
  99243. * @param vertexShaderState defines the current compilation state for the vertex shader
  99244. * @param fragmentShaderState defines the current compilation state for the fragment shader
  99245. * @param mesh defines the mesh to be rendered
  99246. * @param defines defines the material defines to update
  99247. */
  99248. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  99249. /**
  99250. * Checks if the block is ready
  99251. * @param mesh defines the mesh to be rendered
  99252. * @param nodeMaterial defines the node material requesting the update
  99253. * @param defines defines the material defines to update
  99254. * @param useInstances specifies that instances should be used
  99255. * @returns true if the block is ready
  99256. */
  99257. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  99258. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  99259. private _processBuild;
  99260. /**
  99261. * Compile the current node and generate the shader code
  99262. * @param state defines the current compilation state (uniforms, samplers, current string)
  99263. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  99264. * @returns true if already built
  99265. */
  99266. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  99267. protected _inputRename(name: string): string;
  99268. protected _outputRename(name: string): string;
  99269. protected _dumpPropertiesCode(): string;
  99270. /** @hidden */
  99271. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  99272. /** @hidden */
  99273. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  99274. /**
  99275. * Clone the current block to a new identical block
  99276. * @param scene defines the hosting scene
  99277. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  99278. * @returns a copy of the current block
  99279. */
  99280. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  99281. /**
  99282. * Serializes this block in a JSON representation
  99283. * @returns the serialized block object
  99284. */
  99285. serialize(): any;
  99286. /** @hidden */
  99287. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99288. private _deserializePortDisplayNamesAndExposedOnFrame;
  99289. /**
  99290. * Release resources
  99291. */
  99292. dispose(): void;
  99293. }
  99294. }
  99295. declare module BABYLON {
  99296. /**
  99297. * Base class of materials working in push mode in babylon JS
  99298. * @hidden
  99299. */
  99300. export class PushMaterial extends Material {
  99301. protected _activeEffect: Effect;
  99302. protected _normalMatrix: Matrix;
  99303. constructor(name: string, scene: Scene);
  99304. getEffect(): Effect;
  99305. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  99306. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  99307. /**
  99308. * Binds the given world matrix to the active effect
  99309. *
  99310. * @param world the matrix to bind
  99311. */
  99312. bindOnlyWorldMatrix(world: Matrix): void;
  99313. /**
  99314. * Binds the given normal matrix to the active effect
  99315. *
  99316. * @param normalMatrix the matrix to bind
  99317. */
  99318. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  99319. bind(world: Matrix, mesh?: Mesh): void;
  99320. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  99321. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  99322. }
  99323. }
  99324. declare module BABYLON {
  99325. /**
  99326. * Root class for all node material optimizers
  99327. */
  99328. export class NodeMaterialOptimizer {
  99329. /**
  99330. * Function used to optimize a NodeMaterial graph
  99331. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  99332. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  99333. */
  99334. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  99335. }
  99336. }
  99337. declare module BABYLON {
  99338. /**
  99339. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  99340. */
  99341. export class TransformBlock extends NodeMaterialBlock {
  99342. /**
  99343. * Defines the value to use to complement W value to transform it to a Vector4
  99344. */
  99345. complementW: number;
  99346. /**
  99347. * Defines the value to use to complement z value to transform it to a Vector4
  99348. */
  99349. complementZ: number;
  99350. /**
  99351. * Creates a new TransformBlock
  99352. * @param name defines the block name
  99353. */
  99354. constructor(name: string);
  99355. /**
  99356. * Gets the current class name
  99357. * @returns the class name
  99358. */
  99359. getClassName(): string;
  99360. /**
  99361. * Gets the vector input
  99362. */
  99363. get vector(): NodeMaterialConnectionPoint;
  99364. /**
  99365. * Gets the output component
  99366. */
  99367. get output(): NodeMaterialConnectionPoint;
  99368. /**
  99369. * Gets the xyz output component
  99370. */
  99371. get xyz(): NodeMaterialConnectionPoint;
  99372. /**
  99373. * Gets the matrix transform input
  99374. */
  99375. get transform(): NodeMaterialConnectionPoint;
  99376. protected _buildBlock(state: NodeMaterialBuildState): this;
  99377. /**
  99378. * Update defines for shader compilation
  99379. * @param mesh defines the mesh to be rendered
  99380. * @param nodeMaterial defines the node material requesting the update
  99381. * @param defines defines the material defines to update
  99382. * @param useInstances specifies that instances should be used
  99383. * @param subMesh defines which submesh to render
  99384. */
  99385. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  99386. serialize(): any;
  99387. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99388. protected _dumpPropertiesCode(): string;
  99389. }
  99390. }
  99391. declare module BABYLON {
  99392. /**
  99393. * Block used to output the vertex position
  99394. */
  99395. export class VertexOutputBlock extends NodeMaterialBlock {
  99396. /**
  99397. * Creates a new VertexOutputBlock
  99398. * @param name defines the block name
  99399. */
  99400. constructor(name: string);
  99401. /**
  99402. * Gets the current class name
  99403. * @returns the class name
  99404. */
  99405. getClassName(): string;
  99406. /**
  99407. * Gets the vector input component
  99408. */
  99409. get vector(): NodeMaterialConnectionPoint;
  99410. protected _buildBlock(state: NodeMaterialBuildState): this;
  99411. }
  99412. }
  99413. declare module BABYLON {
  99414. /**
  99415. * Block used to output the final color
  99416. */
  99417. export class FragmentOutputBlock extends NodeMaterialBlock {
  99418. /**
  99419. * Create a new FragmentOutputBlock
  99420. * @param name defines the block name
  99421. */
  99422. constructor(name: string);
  99423. /**
  99424. * Gets the current class name
  99425. * @returns the class name
  99426. */
  99427. getClassName(): string;
  99428. /**
  99429. * Gets the rgba input component
  99430. */
  99431. get rgba(): NodeMaterialConnectionPoint;
  99432. /**
  99433. * Gets the rgb input component
  99434. */
  99435. get rgb(): NodeMaterialConnectionPoint;
  99436. /**
  99437. * Gets the a input component
  99438. */
  99439. get a(): NodeMaterialConnectionPoint;
  99440. protected _buildBlock(state: NodeMaterialBuildState): this;
  99441. }
  99442. }
  99443. declare module BABYLON {
  99444. /**
  99445. * Block used for the particle ramp gradient section
  99446. */
  99447. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  99448. /**
  99449. * Create a new ParticleRampGradientBlock
  99450. * @param name defines the block name
  99451. */
  99452. constructor(name: string);
  99453. /**
  99454. * Gets the current class name
  99455. * @returns the class name
  99456. */
  99457. getClassName(): string;
  99458. /**
  99459. * Gets the color input component
  99460. */
  99461. get color(): NodeMaterialConnectionPoint;
  99462. /**
  99463. * Gets the rampColor output component
  99464. */
  99465. get rampColor(): NodeMaterialConnectionPoint;
  99466. /**
  99467. * Initialize the block and prepare the context for build
  99468. * @param state defines the state that will be used for the build
  99469. */
  99470. initialize(state: NodeMaterialBuildState): void;
  99471. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  99472. }
  99473. }
  99474. declare module BABYLON {
  99475. /**
  99476. * Block used for the particle blend multiply section
  99477. */
  99478. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  99479. /**
  99480. * Create a new ParticleBlendMultiplyBlock
  99481. * @param name defines the block name
  99482. */
  99483. constructor(name: string);
  99484. /**
  99485. * Gets the current class name
  99486. * @returns the class name
  99487. */
  99488. getClassName(): string;
  99489. /**
  99490. * Gets the color input component
  99491. */
  99492. get color(): NodeMaterialConnectionPoint;
  99493. /**
  99494. * Gets the alphaTexture input component
  99495. */
  99496. get alphaTexture(): NodeMaterialConnectionPoint;
  99497. /**
  99498. * Gets the alphaColor input component
  99499. */
  99500. get alphaColor(): NodeMaterialConnectionPoint;
  99501. /**
  99502. * Gets the blendColor output component
  99503. */
  99504. get blendColor(): NodeMaterialConnectionPoint;
  99505. /**
  99506. * Initialize the block and prepare the context for build
  99507. * @param state defines the state that will be used for the build
  99508. */
  99509. initialize(state: NodeMaterialBuildState): void;
  99510. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  99511. }
  99512. }
  99513. declare module BABYLON {
  99514. /**
  99515. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  99516. */
  99517. export class VectorMergerBlock extends NodeMaterialBlock {
  99518. /**
  99519. * Create a new VectorMergerBlock
  99520. * @param name defines the block name
  99521. */
  99522. constructor(name: string);
  99523. /**
  99524. * Gets the current class name
  99525. * @returns the class name
  99526. */
  99527. getClassName(): string;
  99528. /**
  99529. * Gets the xyz component (input)
  99530. */
  99531. get xyzIn(): NodeMaterialConnectionPoint;
  99532. /**
  99533. * Gets the xy component (input)
  99534. */
  99535. get xyIn(): NodeMaterialConnectionPoint;
  99536. /**
  99537. * Gets the x component (input)
  99538. */
  99539. get x(): NodeMaterialConnectionPoint;
  99540. /**
  99541. * Gets the y component (input)
  99542. */
  99543. get y(): NodeMaterialConnectionPoint;
  99544. /**
  99545. * Gets the z component (input)
  99546. */
  99547. get z(): NodeMaterialConnectionPoint;
  99548. /**
  99549. * Gets the w component (input)
  99550. */
  99551. get w(): NodeMaterialConnectionPoint;
  99552. /**
  99553. * Gets the xyzw component (output)
  99554. */
  99555. get xyzw(): NodeMaterialConnectionPoint;
  99556. /**
  99557. * Gets the xyz component (output)
  99558. */
  99559. get xyzOut(): NodeMaterialConnectionPoint;
  99560. /**
  99561. * Gets the xy component (output)
  99562. */
  99563. get xyOut(): NodeMaterialConnectionPoint;
  99564. /**
  99565. * Gets the xy component (output)
  99566. * @deprecated Please use xyOut instead.
  99567. */
  99568. get xy(): NodeMaterialConnectionPoint;
  99569. /**
  99570. * Gets the xyz component (output)
  99571. * @deprecated Please use xyzOut instead.
  99572. */
  99573. get xyz(): NodeMaterialConnectionPoint;
  99574. protected _buildBlock(state: NodeMaterialBuildState): this;
  99575. }
  99576. }
  99577. declare module BABYLON {
  99578. /**
  99579. * Block used to remap a float from a range to a new one
  99580. */
  99581. export class RemapBlock extends NodeMaterialBlock {
  99582. /**
  99583. * Gets or sets the source range
  99584. */
  99585. sourceRange: Vector2;
  99586. /**
  99587. * Gets or sets the target range
  99588. */
  99589. targetRange: Vector2;
  99590. /**
  99591. * Creates a new RemapBlock
  99592. * @param name defines the block name
  99593. */
  99594. constructor(name: string);
  99595. /**
  99596. * Gets the current class name
  99597. * @returns the class name
  99598. */
  99599. getClassName(): string;
  99600. /**
  99601. * Gets the input component
  99602. */
  99603. get input(): NodeMaterialConnectionPoint;
  99604. /**
  99605. * Gets the source min input component
  99606. */
  99607. get sourceMin(): NodeMaterialConnectionPoint;
  99608. /**
  99609. * Gets the source max input component
  99610. */
  99611. get sourceMax(): NodeMaterialConnectionPoint;
  99612. /**
  99613. * Gets the target min input component
  99614. */
  99615. get targetMin(): NodeMaterialConnectionPoint;
  99616. /**
  99617. * Gets the target max input component
  99618. */
  99619. get targetMax(): NodeMaterialConnectionPoint;
  99620. /**
  99621. * Gets the output component
  99622. */
  99623. get output(): NodeMaterialConnectionPoint;
  99624. protected _buildBlock(state: NodeMaterialBuildState): this;
  99625. protected _dumpPropertiesCode(): string;
  99626. serialize(): any;
  99627. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99628. }
  99629. }
  99630. declare module BABYLON {
  99631. /**
  99632. * Block used to multiply 2 values
  99633. */
  99634. export class MultiplyBlock extends NodeMaterialBlock {
  99635. /**
  99636. * Creates a new MultiplyBlock
  99637. * @param name defines the block name
  99638. */
  99639. constructor(name: string);
  99640. /**
  99641. * Gets the current class name
  99642. * @returns the class name
  99643. */
  99644. getClassName(): string;
  99645. /**
  99646. * Gets the left operand input component
  99647. */
  99648. get left(): NodeMaterialConnectionPoint;
  99649. /**
  99650. * Gets the right operand input component
  99651. */
  99652. get right(): NodeMaterialConnectionPoint;
  99653. /**
  99654. * Gets the output component
  99655. */
  99656. get output(): NodeMaterialConnectionPoint;
  99657. protected _buildBlock(state: NodeMaterialBuildState): this;
  99658. }
  99659. }
  99660. declare module BABYLON {
  99661. /**
  99662. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  99663. */
  99664. export class ColorSplitterBlock extends NodeMaterialBlock {
  99665. /**
  99666. * Create a new ColorSplitterBlock
  99667. * @param name defines the block name
  99668. */
  99669. constructor(name: string);
  99670. /**
  99671. * Gets the current class name
  99672. * @returns the class name
  99673. */
  99674. getClassName(): string;
  99675. /**
  99676. * Gets the rgba component (input)
  99677. */
  99678. get rgba(): NodeMaterialConnectionPoint;
  99679. /**
  99680. * Gets the rgb component (input)
  99681. */
  99682. get rgbIn(): NodeMaterialConnectionPoint;
  99683. /**
  99684. * Gets the rgb component (output)
  99685. */
  99686. get rgbOut(): NodeMaterialConnectionPoint;
  99687. /**
  99688. * Gets the r component (output)
  99689. */
  99690. get r(): NodeMaterialConnectionPoint;
  99691. /**
  99692. * Gets the g component (output)
  99693. */
  99694. get g(): NodeMaterialConnectionPoint;
  99695. /**
  99696. * Gets the b component (output)
  99697. */
  99698. get b(): NodeMaterialConnectionPoint;
  99699. /**
  99700. * Gets the a component (output)
  99701. */
  99702. get a(): NodeMaterialConnectionPoint;
  99703. protected _inputRename(name: string): string;
  99704. protected _outputRename(name: string): string;
  99705. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  99706. }
  99707. }
  99708. declare module BABYLON {
  99709. /**
  99710. * Interface used to configure the node material editor
  99711. */
  99712. export interface INodeMaterialEditorOptions {
  99713. /** Define the URl to load node editor script */
  99714. editorURL?: string;
  99715. }
  99716. /** @hidden */
  99717. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  99718. NORMAL: boolean;
  99719. TANGENT: boolean;
  99720. UV1: boolean;
  99721. /** BONES */
  99722. NUM_BONE_INFLUENCERS: number;
  99723. BonesPerMesh: number;
  99724. BONETEXTURE: boolean;
  99725. /** MORPH TARGETS */
  99726. MORPHTARGETS: boolean;
  99727. MORPHTARGETS_NORMAL: boolean;
  99728. MORPHTARGETS_TANGENT: boolean;
  99729. MORPHTARGETS_UV: boolean;
  99730. NUM_MORPH_INFLUENCERS: number;
  99731. /** IMAGE PROCESSING */
  99732. IMAGEPROCESSING: boolean;
  99733. VIGNETTE: boolean;
  99734. VIGNETTEBLENDMODEMULTIPLY: boolean;
  99735. VIGNETTEBLENDMODEOPAQUE: boolean;
  99736. TONEMAPPING: boolean;
  99737. TONEMAPPING_ACES: boolean;
  99738. CONTRAST: boolean;
  99739. EXPOSURE: boolean;
  99740. COLORCURVES: boolean;
  99741. COLORGRADING: boolean;
  99742. COLORGRADING3D: boolean;
  99743. SAMPLER3DGREENDEPTH: boolean;
  99744. SAMPLER3DBGRMAP: boolean;
  99745. IMAGEPROCESSINGPOSTPROCESS: boolean;
  99746. /** MISC. */
  99747. BUMPDIRECTUV: number;
  99748. constructor();
  99749. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  99750. }
  99751. /**
  99752. * Class used to configure NodeMaterial
  99753. */
  99754. export interface INodeMaterialOptions {
  99755. /**
  99756. * Defines if blocks should emit comments
  99757. */
  99758. emitComments: boolean;
  99759. }
  99760. /**
  99761. * Class used to create a node based material built by assembling shader blocks
  99762. */
  99763. export class NodeMaterial extends PushMaterial {
  99764. private static _BuildIdGenerator;
  99765. private _options;
  99766. private _vertexCompilationState;
  99767. private _fragmentCompilationState;
  99768. private _sharedData;
  99769. private _buildId;
  99770. private _buildWasSuccessful;
  99771. private _cachedWorldViewMatrix;
  99772. private _cachedWorldViewProjectionMatrix;
  99773. private _optimizers;
  99774. private _animationFrame;
  99775. /** Define the Url to load node editor script */
  99776. static EditorURL: string;
  99777. /** Define the Url to load snippets */
  99778. static SnippetUrl: string;
  99779. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  99780. static IgnoreTexturesAtLoadTime: boolean;
  99781. private BJSNODEMATERIALEDITOR;
  99782. /** Get the inspector from bundle or global */
  99783. private _getGlobalNodeMaterialEditor;
  99784. /**
  99785. * Snippet ID if the material was created from the snippet server
  99786. */
  99787. snippetId: string;
  99788. /**
  99789. * Gets or sets data used by visual editor
  99790. * @see https://nme.babylonjs.com
  99791. */
  99792. editorData: any;
  99793. /**
  99794. * 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)
  99795. */
  99796. ignoreAlpha: boolean;
  99797. /**
  99798. * Defines the maximum number of lights that can be used in the material
  99799. */
  99800. maxSimultaneousLights: number;
  99801. /**
  99802. * Observable raised when the material is built
  99803. */
  99804. onBuildObservable: Observable<NodeMaterial>;
  99805. /**
  99806. * Gets or sets the root nodes of the material vertex shader
  99807. */
  99808. _vertexOutputNodes: NodeMaterialBlock[];
  99809. /**
  99810. * Gets or sets the root nodes of the material fragment (pixel) shader
  99811. */
  99812. _fragmentOutputNodes: NodeMaterialBlock[];
  99813. /** Gets or sets options to control the node material overall behavior */
  99814. get options(): INodeMaterialOptions;
  99815. set options(options: INodeMaterialOptions);
  99816. /**
  99817. * Default configuration related to image processing available in the standard Material.
  99818. */
  99819. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  99820. /**
  99821. * Gets the image processing configuration used either in this material.
  99822. */
  99823. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  99824. /**
  99825. * Sets the Default image processing configuration used either in the this material.
  99826. *
  99827. * If sets to null, the scene one is in use.
  99828. */
  99829. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  99830. /**
  99831. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  99832. */
  99833. attachedBlocks: NodeMaterialBlock[];
  99834. /**
  99835. * Specifies the mode of the node material
  99836. * @hidden
  99837. */
  99838. _mode: NodeMaterialModes;
  99839. /**
  99840. * Gets the mode property
  99841. */
  99842. get mode(): NodeMaterialModes;
  99843. /**
  99844. * Create a new node based material
  99845. * @param name defines the material name
  99846. * @param scene defines the hosting scene
  99847. * @param options defines creation option
  99848. */
  99849. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  99850. /**
  99851. * Gets the current class name of the material e.g. "NodeMaterial"
  99852. * @returns the class name
  99853. */
  99854. getClassName(): string;
  99855. /**
  99856. * Keep track of the image processing observer to allow dispose and replace.
  99857. */
  99858. private _imageProcessingObserver;
  99859. /**
  99860. * Attaches a new image processing configuration to the Standard Material.
  99861. * @param configuration
  99862. */
  99863. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  99864. /**
  99865. * Get a block by its name
  99866. * @param name defines the name of the block to retrieve
  99867. * @returns the required block or null if not found
  99868. */
  99869. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  99870. /**
  99871. * Get a block by its name
  99872. * @param predicate defines the predicate used to find the good candidate
  99873. * @returns the required block or null if not found
  99874. */
  99875. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  99876. /**
  99877. * Get an input block by its name
  99878. * @param predicate defines the predicate used to find the good candidate
  99879. * @returns the required input block or null if not found
  99880. */
  99881. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  99882. /**
  99883. * Gets the list of input blocks attached to this material
  99884. * @returns an array of InputBlocks
  99885. */
  99886. getInputBlocks(): InputBlock[];
  99887. /**
  99888. * Adds a new optimizer to the list of optimizers
  99889. * @param optimizer defines the optimizers to add
  99890. * @returns the current material
  99891. */
  99892. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  99893. /**
  99894. * Remove an optimizer from the list of optimizers
  99895. * @param optimizer defines the optimizers to remove
  99896. * @returns the current material
  99897. */
  99898. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  99899. /**
  99900. * Add a new block to the list of output nodes
  99901. * @param node defines the node to add
  99902. * @returns the current material
  99903. */
  99904. addOutputNode(node: NodeMaterialBlock): this;
  99905. /**
  99906. * Remove a block from the list of root nodes
  99907. * @param node defines the node to remove
  99908. * @returns the current material
  99909. */
  99910. removeOutputNode(node: NodeMaterialBlock): this;
  99911. private _addVertexOutputNode;
  99912. private _removeVertexOutputNode;
  99913. private _addFragmentOutputNode;
  99914. private _removeFragmentOutputNode;
  99915. /**
  99916. * Specifies if the material will require alpha blending
  99917. * @returns a boolean specifying if alpha blending is needed
  99918. */
  99919. needAlphaBlending(): boolean;
  99920. /**
  99921. * Specifies if this material should be rendered in alpha test mode
  99922. * @returns a boolean specifying if an alpha test is needed.
  99923. */
  99924. needAlphaTesting(): boolean;
  99925. private _initializeBlock;
  99926. private _resetDualBlocks;
  99927. /**
  99928. * Remove a block from the current node material
  99929. * @param block defines the block to remove
  99930. */
  99931. removeBlock(block: NodeMaterialBlock): void;
  99932. /**
  99933. * Build the material and generates the inner effect
  99934. * @param verbose defines if the build should log activity
  99935. */
  99936. build(verbose?: boolean): void;
  99937. /**
  99938. * Runs an otpimization phase to try to improve the shader code
  99939. */
  99940. optimize(): void;
  99941. private _prepareDefinesForAttributes;
  99942. /**
  99943. * Create a post process from the material
  99944. * @param camera The camera to apply the render pass to.
  99945. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  99946. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  99947. * @param engine The engine which the post process will be applied. (default: current engine)
  99948. * @param reusable If the post process can be reused on the same frame. (default: false)
  99949. * @param textureType Type of textures used when performing the post process. (default: 0)
  99950. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  99951. * @returns the post process created
  99952. */
  99953. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  99954. /**
  99955. * Create the post process effect from the material
  99956. * @param postProcess The post process to create the effect for
  99957. */
  99958. createEffectForPostProcess(postProcess: PostProcess): void;
  99959. private _createEffectOrPostProcess;
  99960. private _createEffectForParticles;
  99961. /**
  99962. * Create the effect to be used as the custom effect for a particle system
  99963. * @param particleSystem Particle system to create the effect for
  99964. * @param onCompiled defines a function to call when the effect creation is successful
  99965. * @param onError defines a function to call when the effect creation has failed
  99966. */
  99967. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  99968. private _processDefines;
  99969. /**
  99970. * Get if the submesh is ready to be used and all its information available.
  99971. * Child classes can use it to update shaders
  99972. * @param mesh defines the mesh to check
  99973. * @param subMesh defines which submesh to check
  99974. * @param useInstances specifies that instances should be used
  99975. * @returns a boolean indicating that the submesh is ready or not
  99976. */
  99977. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  99978. /**
  99979. * Get a string representing the shaders built by the current node graph
  99980. */
  99981. get compiledShaders(): string;
  99982. /**
  99983. * Binds the world matrix to the material
  99984. * @param world defines the world transformation matrix
  99985. */
  99986. bindOnlyWorldMatrix(world: Matrix): void;
  99987. /**
  99988. * Binds the submesh to this material by preparing the effect and shader to draw
  99989. * @param world defines the world transformation matrix
  99990. * @param mesh defines the mesh containing the submesh
  99991. * @param subMesh defines the submesh to bind the material to
  99992. */
  99993. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  99994. /**
  99995. * Gets the active textures from the material
  99996. * @returns an array of textures
  99997. */
  99998. getActiveTextures(): BaseTexture[];
  99999. /**
  100000. * Gets the list of texture blocks
  100001. * @returns an array of texture blocks
  100002. */
  100003. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  100004. /**
  100005. * Specifies if the material uses a texture
  100006. * @param texture defines the texture to check against the material
  100007. * @returns a boolean specifying if the material uses the texture
  100008. */
  100009. hasTexture(texture: BaseTexture): boolean;
  100010. /**
  100011. * Disposes the material
  100012. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  100013. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  100014. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  100015. */
  100016. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  100017. /** Creates the node editor window. */
  100018. private _createNodeEditor;
  100019. /**
  100020. * Launch the node material editor
  100021. * @param config Define the configuration of the editor
  100022. * @return a promise fulfilled when the node editor is visible
  100023. */
  100024. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  100025. /**
  100026. * Clear the current material
  100027. */
  100028. clear(): void;
  100029. /**
  100030. * Clear the current material and set it to a default state
  100031. */
  100032. setToDefault(): void;
  100033. /**
  100034. * Clear the current material and set it to a default state for post process
  100035. */
  100036. setToDefaultPostProcess(): void;
  100037. /**
  100038. * Clear the current material and set it to a default state for particle
  100039. */
  100040. setToDefaultParticle(): void;
  100041. /**
  100042. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  100043. * @param url defines the url to load from
  100044. * @returns a promise that will fullfil when the material is fully loaded
  100045. */
  100046. loadAsync(url: string): Promise<void>;
  100047. private _gatherBlocks;
  100048. /**
  100049. * Generate a string containing the code declaration required to create an equivalent of this material
  100050. * @returns a string
  100051. */
  100052. generateCode(): string;
  100053. /**
  100054. * Serializes this material in a JSON representation
  100055. * @returns the serialized material object
  100056. */
  100057. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  100058. private _restoreConnections;
  100059. /**
  100060. * Clear the current graph and load a new one from a serialization object
  100061. * @param source defines the JSON representation of the material
  100062. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  100063. * @param merge defines whether or not the source must be merged or replace the current content
  100064. */
  100065. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  100066. /**
  100067. * Makes a duplicate of the current material.
  100068. * @param name - name to use for the new material.
  100069. */
  100070. clone(name: string): NodeMaterial;
  100071. /**
  100072. * Creates a node material from parsed material data
  100073. * @param source defines the JSON representation of the material
  100074. * @param scene defines the hosting scene
  100075. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  100076. * @returns a new node material
  100077. */
  100078. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  100079. /**
  100080. * Creates a node material from a snippet saved in a remote file
  100081. * @param name defines the name of the material to create
  100082. * @param url defines the url to load from
  100083. * @param scene defines the hosting scene
  100084. * @returns a promise that will resolve to the new node material
  100085. */
  100086. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  100087. /**
  100088. * Creates a node material from a snippet saved by the node material editor
  100089. * @param snippetId defines the snippet to load
  100090. * @param scene defines the hosting scene
  100091. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  100092. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  100093. * @returns a promise that will resolve to the new node material
  100094. */
  100095. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  100096. /**
  100097. * Creates a new node material set to default basic configuration
  100098. * @param name defines the name of the material
  100099. * @param scene defines the hosting scene
  100100. * @returns a new NodeMaterial
  100101. */
  100102. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  100103. }
  100104. }
  100105. declare module BABYLON {
  100106. /**
  100107. * Size options for a post process
  100108. */
  100109. export type PostProcessOptions = {
  100110. width: number;
  100111. height: number;
  100112. };
  100113. /**
  100114. * PostProcess can be used to apply a shader to a texture after it has been rendered
  100115. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  100116. */
  100117. export class PostProcess {
  100118. /** Name of the PostProcess. */
  100119. name: string;
  100120. /**
  100121. * Gets or sets the unique id of the post process
  100122. */
  100123. uniqueId: number;
  100124. /**
  100125. * Width of the texture to apply the post process on
  100126. */
  100127. width: number;
  100128. /**
  100129. * Height of the texture to apply the post process on
  100130. */
  100131. height: number;
  100132. /**
  100133. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  100134. */
  100135. nodeMaterialSource: Nullable<NodeMaterial>;
  100136. /**
  100137. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  100138. * @hidden
  100139. */
  100140. _outputTexture: Nullable<InternalTexture>;
  100141. /**
  100142. * Sampling mode used by the shader
  100143. * See https://doc.babylonjs.com/classes/3.1/texture
  100144. */
  100145. renderTargetSamplingMode: number;
  100146. /**
  100147. * Clear color to use when screen clearing
  100148. */
  100149. clearColor: Color4;
  100150. /**
  100151. * If the buffer needs to be cleared before applying the post process. (default: true)
  100152. * Should be set to false if shader will overwrite all previous pixels.
  100153. */
  100154. autoClear: boolean;
  100155. /**
  100156. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  100157. */
  100158. alphaMode: number;
  100159. /**
  100160. * Sets the setAlphaBlendConstants of the babylon engine
  100161. */
  100162. alphaConstants: Color4;
  100163. /**
  100164. * Animations to be used for the post processing
  100165. */
  100166. animations: Animation[];
  100167. /**
  100168. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  100169. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  100170. */
  100171. enablePixelPerfectMode: boolean;
  100172. /**
  100173. * Force the postprocess to be applied without taking in account viewport
  100174. */
  100175. forceFullscreenViewport: boolean;
  100176. /**
  100177. * List of inspectable custom properties (used by the Inspector)
  100178. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  100179. */
  100180. inspectableCustomProperties: IInspectable[];
  100181. /**
  100182. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  100183. *
  100184. * | Value | Type | Description |
  100185. * | ----- | ----------------------------------- | ----------- |
  100186. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  100187. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  100188. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  100189. *
  100190. */
  100191. scaleMode: number;
  100192. /**
  100193. * Force textures to be a power of two (default: false)
  100194. */
  100195. alwaysForcePOT: boolean;
  100196. private _samples;
  100197. /**
  100198. * Number of sample textures (default: 1)
  100199. */
  100200. get samples(): number;
  100201. set samples(n: number);
  100202. /**
  100203. * Modify the scale of the post process to be the same as the viewport (default: false)
  100204. */
  100205. adaptScaleToCurrentViewport: boolean;
  100206. private _camera;
  100207. private _scene;
  100208. private _engine;
  100209. private _options;
  100210. private _reusable;
  100211. private _textureType;
  100212. private _textureFormat;
  100213. /**
  100214. * Smart array of input and output textures for the post process.
  100215. * @hidden
  100216. */
  100217. _textures: SmartArray<InternalTexture>;
  100218. /**
  100219. * The index in _textures that corresponds to the output texture.
  100220. * @hidden
  100221. */
  100222. _currentRenderTextureInd: number;
  100223. private _effect;
  100224. private _samplers;
  100225. private _fragmentUrl;
  100226. private _vertexUrl;
  100227. private _parameters;
  100228. private _scaleRatio;
  100229. protected _indexParameters: any;
  100230. private _shareOutputWithPostProcess;
  100231. private _texelSize;
  100232. private _forcedOutputTexture;
  100233. /**
  100234. * Returns the fragment url or shader name used in the post process.
  100235. * @returns the fragment url or name in the shader store.
  100236. */
  100237. getEffectName(): string;
  100238. /**
  100239. * An event triggered when the postprocess is activated.
  100240. */
  100241. onActivateObservable: Observable<Camera>;
  100242. private _onActivateObserver;
  100243. /**
  100244. * A function that is added to the onActivateObservable
  100245. */
  100246. set onActivate(callback: Nullable<(camera: Camera) => void>);
  100247. /**
  100248. * An event triggered when the postprocess changes its size.
  100249. */
  100250. onSizeChangedObservable: Observable<PostProcess>;
  100251. private _onSizeChangedObserver;
  100252. /**
  100253. * A function that is added to the onSizeChangedObservable
  100254. */
  100255. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  100256. /**
  100257. * An event triggered when the postprocess applies its effect.
  100258. */
  100259. onApplyObservable: Observable<Effect>;
  100260. private _onApplyObserver;
  100261. /**
  100262. * A function that is added to the onApplyObservable
  100263. */
  100264. set onApply(callback: (effect: Effect) => void);
  100265. /**
  100266. * An event triggered before rendering the postprocess
  100267. */
  100268. onBeforeRenderObservable: Observable<Effect>;
  100269. private _onBeforeRenderObserver;
  100270. /**
  100271. * A function that is added to the onBeforeRenderObservable
  100272. */
  100273. set onBeforeRender(callback: (effect: Effect) => void);
  100274. /**
  100275. * An event triggered after rendering the postprocess
  100276. */
  100277. onAfterRenderObservable: Observable<Effect>;
  100278. private _onAfterRenderObserver;
  100279. /**
  100280. * A function that is added to the onAfterRenderObservable
  100281. */
  100282. set onAfterRender(callback: (efect: Effect) => void);
  100283. /**
  100284. * 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
  100285. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  100286. */
  100287. get inputTexture(): InternalTexture;
  100288. set inputTexture(value: InternalTexture);
  100289. /**
  100290. * Gets the camera which post process is applied to.
  100291. * @returns The camera the post process is applied to.
  100292. */
  100293. getCamera(): Camera;
  100294. /**
  100295. * Gets the texel size of the postprocess.
  100296. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  100297. */
  100298. get texelSize(): Vector2;
  100299. /**
  100300. * Creates a new instance PostProcess
  100301. * @param name The name of the PostProcess.
  100302. * @param fragmentUrl The url of the fragment shader to be used.
  100303. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  100304. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  100305. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  100306. * @param camera The camera to apply the render pass to.
  100307. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  100308. * @param engine The engine which the post process will be applied. (default: current engine)
  100309. * @param reusable If the post process can be reused on the same frame. (default: false)
  100310. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  100311. * @param textureType Type of textures used when performing the post process. (default: 0)
  100312. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  100313. * @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
  100314. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  100315. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  100316. */
  100317. constructor(
  100318. /** Name of the PostProcess. */
  100319. name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean, textureFormat?: number);
  100320. /**
  100321. * Gets a string idenfifying the name of the class
  100322. * @returns "PostProcess" string
  100323. */
  100324. getClassName(): string;
  100325. /**
  100326. * Gets the engine which this post process belongs to.
  100327. * @returns The engine the post process was enabled with.
  100328. */
  100329. getEngine(): Engine;
  100330. /**
  100331. * The effect that is created when initializing the post process.
  100332. * @returns The created effect corresponding the the postprocess.
  100333. */
  100334. getEffect(): Effect;
  100335. /**
  100336. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  100337. * @param postProcess The post process to share the output with.
  100338. * @returns This post process.
  100339. */
  100340. shareOutputWith(postProcess: PostProcess): PostProcess;
  100341. /**
  100342. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  100343. * This should be called if the post process that shares output with this post process is disabled/disposed.
  100344. */
  100345. useOwnOutput(): void;
  100346. /**
  100347. * Updates the effect with the current post process compile time values and recompiles the shader.
  100348. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  100349. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  100350. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  100351. * @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
  100352. * @param onCompiled Called when the shader has been compiled.
  100353. * @param onError Called if there is an error when compiling a shader.
  100354. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  100355. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  100356. */
  100357. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  100358. /**
  100359. * The post process is reusable if it can be used multiple times within one frame.
  100360. * @returns If the post process is reusable
  100361. */
  100362. isReusable(): boolean;
  100363. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  100364. markTextureDirty(): void;
  100365. /**
  100366. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  100367. * 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.
  100368. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  100369. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  100370. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  100371. * @returns The target texture that was bound to be written to.
  100372. */
  100373. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  100374. /**
  100375. * If the post process is supported.
  100376. */
  100377. get isSupported(): boolean;
  100378. /**
  100379. * The aspect ratio of the output texture.
  100380. */
  100381. get aspectRatio(): number;
  100382. /**
  100383. * Get a value indicating if the post-process is ready to be used
  100384. * @returns true if the post-process is ready (shader is compiled)
  100385. */
  100386. isReady(): boolean;
  100387. /**
  100388. * Binds all textures and uniforms to the shader, this will be run on every pass.
  100389. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  100390. */
  100391. apply(): Nullable<Effect>;
  100392. private _disposeTextures;
  100393. /**
  100394. * Disposes the post process.
  100395. * @param camera The camera to dispose the post process on.
  100396. */
  100397. dispose(camera?: Camera): void;
  100398. }
  100399. }
  100400. declare module BABYLON {
  100401. /** @hidden */
  100402. export var kernelBlurVaryingDeclaration: {
  100403. name: string;
  100404. shader: string;
  100405. };
  100406. }
  100407. declare module BABYLON {
  100408. /** @hidden */
  100409. export var kernelBlurFragment: {
  100410. name: string;
  100411. shader: string;
  100412. };
  100413. }
  100414. declare module BABYLON {
  100415. /** @hidden */
  100416. export var kernelBlurFragment2: {
  100417. name: string;
  100418. shader: string;
  100419. };
  100420. }
  100421. declare module BABYLON {
  100422. /** @hidden */
  100423. export var kernelBlurPixelShader: {
  100424. name: string;
  100425. shader: string;
  100426. };
  100427. }
  100428. declare module BABYLON {
  100429. /** @hidden */
  100430. export var kernelBlurVertex: {
  100431. name: string;
  100432. shader: string;
  100433. };
  100434. }
  100435. declare module BABYLON {
  100436. /** @hidden */
  100437. export var kernelBlurVertexShader: {
  100438. name: string;
  100439. shader: string;
  100440. };
  100441. }
  100442. declare module BABYLON {
  100443. /**
  100444. * The Blur Post Process which blurs an image based on a kernel and direction.
  100445. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  100446. */
  100447. export class BlurPostProcess extends PostProcess {
  100448. /** The direction in which to blur the image. */
  100449. direction: Vector2;
  100450. private blockCompilation;
  100451. protected _kernel: number;
  100452. protected _idealKernel: number;
  100453. protected _packedFloat: boolean;
  100454. private _staticDefines;
  100455. /**
  100456. * Sets the length in pixels of the blur sample region
  100457. */
  100458. set kernel(v: number);
  100459. /**
  100460. * Gets the length in pixels of the blur sample region
  100461. */
  100462. get kernel(): number;
  100463. /**
  100464. * Sets wether or not the blur needs to unpack/repack floats
  100465. */
  100466. set packedFloat(v: boolean);
  100467. /**
  100468. * Gets wether or not the blur is unpacking/repacking floats
  100469. */
  100470. get packedFloat(): boolean;
  100471. /**
  100472. * Creates a new instance BlurPostProcess
  100473. * @param name The name of the effect.
  100474. * @param direction The direction in which to blur the image.
  100475. * @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.
  100476. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  100477. * @param camera The camera to apply the render pass to.
  100478. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  100479. * @param engine The engine which the post process will be applied. (default: current engine)
  100480. * @param reusable If the post process can be reused on the same frame. (default: false)
  100481. * @param textureType Type of textures used when performing the post process. (default: 0)
  100482. * @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)
  100483. */
  100484. constructor(name: string,
  100485. /** The direction in which to blur the image. */
  100486. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  100487. /**
  100488. * Updates the effect with the current post process compile time values and recompiles the shader.
  100489. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  100490. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  100491. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  100492. * @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
  100493. * @param onCompiled Called when the shader has been compiled.
  100494. * @param onError Called if there is an error when compiling a shader.
  100495. */
  100496. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  100497. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  100498. /**
  100499. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  100500. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  100501. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  100502. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  100503. * The gaps between physical kernels are compensated for in the weighting of the samples
  100504. * @param idealKernel Ideal blur kernel.
  100505. * @return Nearest best kernel.
  100506. */
  100507. protected _nearestBestKernel(idealKernel: number): number;
  100508. /**
  100509. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  100510. * @param x The point on the Gaussian distribution to sample.
  100511. * @return the value of the Gaussian function at x.
  100512. */
  100513. protected _gaussianWeight(x: number): number;
  100514. /**
  100515. * Generates a string that can be used as a floating point number in GLSL.
  100516. * @param x Value to print.
  100517. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  100518. * @return GLSL float string.
  100519. */
  100520. protected _glslFloat(x: number, decimalFigures?: number): string;
  100521. }
  100522. }
  100523. declare module BABYLON {
  100524. /**
  100525. * Mirror texture can be used to simulate the view from a mirror in a scene.
  100526. * It will dynamically be rendered every frame to adapt to the camera point of view.
  100527. * You can then easily use it as a reflectionTexture on a flat surface.
  100528. * In case the surface is not a plane, please consider relying on reflection probes.
  100529. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  100530. */
  100531. export class MirrorTexture extends RenderTargetTexture {
  100532. private scene;
  100533. /**
  100534. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  100535. * 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.
  100536. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  100537. */
  100538. mirrorPlane: Plane;
  100539. /**
  100540. * Define the blur ratio used to blur the reflection if needed.
  100541. */
  100542. set blurRatio(value: number);
  100543. get blurRatio(): number;
  100544. /**
  100545. * Define the adaptive blur kernel used to blur the reflection if needed.
  100546. * This will autocompute the closest best match for the `blurKernel`
  100547. */
  100548. set adaptiveBlurKernel(value: number);
  100549. /**
  100550. * Define the blur kernel used to blur the reflection if needed.
  100551. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  100552. */
  100553. set blurKernel(value: number);
  100554. /**
  100555. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  100556. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  100557. */
  100558. set blurKernelX(value: number);
  100559. get blurKernelX(): number;
  100560. /**
  100561. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  100562. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  100563. */
  100564. set blurKernelY(value: number);
  100565. get blurKernelY(): number;
  100566. private _autoComputeBlurKernel;
  100567. protected _onRatioRescale(): void;
  100568. private _updateGammaSpace;
  100569. private _imageProcessingConfigChangeObserver;
  100570. private _transformMatrix;
  100571. private _mirrorMatrix;
  100572. private _savedViewMatrix;
  100573. private _blurX;
  100574. private _blurY;
  100575. private _adaptiveBlurKernel;
  100576. private _blurKernelX;
  100577. private _blurKernelY;
  100578. private _blurRatio;
  100579. /**
  100580. * Instantiates a Mirror Texture.
  100581. * Mirror texture can be used to simulate the view from a mirror in a scene.
  100582. * It will dynamically be rendered every frame to adapt to the camera point of view.
  100583. * You can then easily use it as a reflectionTexture on a flat surface.
  100584. * In case the surface is not a plane, please consider relying on reflection probes.
  100585. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  100586. * @param name
  100587. * @param size
  100588. * @param scene
  100589. * @param generateMipMaps
  100590. * @param type
  100591. * @param samplingMode
  100592. * @param generateDepthBuffer
  100593. */
  100594. constructor(name: string, size: number | {
  100595. width: number;
  100596. height: number;
  100597. } | {
  100598. ratio: number;
  100599. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  100600. private _preparePostProcesses;
  100601. /**
  100602. * Clone the mirror texture.
  100603. * @returns the cloned texture
  100604. */
  100605. clone(): MirrorTexture;
  100606. /**
  100607. * Serialize the texture to a JSON representation you could use in Parse later on
  100608. * @returns the serialized JSON representation
  100609. */
  100610. serialize(): any;
  100611. /**
  100612. * Dispose the texture and release its associated resources.
  100613. */
  100614. dispose(): void;
  100615. }
  100616. }
  100617. declare module BABYLON {
  100618. /**
  100619. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  100620. * @see http://doc.babylonjs.com/babylon101/materials#texture
  100621. */
  100622. export class Texture extends BaseTexture {
  100623. /**
  100624. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  100625. */
  100626. static SerializeBuffers: boolean;
  100627. /** @hidden */
  100628. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  100629. /** @hidden */
  100630. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  100631. /** @hidden */
  100632. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  100633. /** nearest is mag = nearest and min = nearest and mip = linear */
  100634. static readonly NEAREST_SAMPLINGMODE: number;
  100635. /** nearest is mag = nearest and min = nearest and mip = linear */
  100636. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  100637. /** Bilinear is mag = linear and min = linear and mip = nearest */
  100638. static readonly BILINEAR_SAMPLINGMODE: number;
  100639. /** Bilinear is mag = linear and min = linear and mip = nearest */
  100640. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  100641. /** Trilinear is mag = linear and min = linear and mip = linear */
  100642. static readonly TRILINEAR_SAMPLINGMODE: number;
  100643. /** Trilinear is mag = linear and min = linear and mip = linear */
  100644. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  100645. /** mag = nearest and min = nearest and mip = nearest */
  100646. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  100647. /** mag = nearest and min = linear and mip = nearest */
  100648. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  100649. /** mag = nearest and min = linear and mip = linear */
  100650. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  100651. /** mag = nearest and min = linear and mip = none */
  100652. static readonly NEAREST_LINEAR: number;
  100653. /** mag = nearest and min = nearest and mip = none */
  100654. static readonly NEAREST_NEAREST: number;
  100655. /** mag = linear and min = nearest and mip = nearest */
  100656. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  100657. /** mag = linear and min = nearest and mip = linear */
  100658. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  100659. /** mag = linear and min = linear and mip = none */
  100660. static readonly LINEAR_LINEAR: number;
  100661. /** mag = linear and min = nearest and mip = none */
  100662. static readonly LINEAR_NEAREST: number;
  100663. /** Explicit coordinates mode */
  100664. static readonly EXPLICIT_MODE: number;
  100665. /** Spherical coordinates mode */
  100666. static readonly SPHERICAL_MODE: number;
  100667. /** Planar coordinates mode */
  100668. static readonly PLANAR_MODE: number;
  100669. /** Cubic coordinates mode */
  100670. static readonly CUBIC_MODE: number;
  100671. /** Projection coordinates mode */
  100672. static readonly PROJECTION_MODE: number;
  100673. /** Inverse Cubic coordinates mode */
  100674. static readonly SKYBOX_MODE: number;
  100675. /** Inverse Cubic coordinates mode */
  100676. static readonly INVCUBIC_MODE: number;
  100677. /** Equirectangular coordinates mode */
  100678. static readonly EQUIRECTANGULAR_MODE: number;
  100679. /** Equirectangular Fixed coordinates mode */
  100680. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  100681. /** Equirectangular Fixed Mirrored coordinates mode */
  100682. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  100683. /** Texture is not repeating outside of 0..1 UVs */
  100684. static readonly CLAMP_ADDRESSMODE: number;
  100685. /** Texture is repeating outside of 0..1 UVs */
  100686. static readonly WRAP_ADDRESSMODE: number;
  100687. /** Texture is repeating and mirrored */
  100688. static readonly MIRROR_ADDRESSMODE: number;
  100689. /**
  100690. * 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
  100691. */
  100692. static UseSerializedUrlIfAny: boolean;
  100693. /**
  100694. * Define the url of the texture.
  100695. */
  100696. url: Nullable<string>;
  100697. /**
  100698. * Define an offset on the texture to offset the u coordinates of the UVs
  100699. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  100700. */
  100701. uOffset: number;
  100702. /**
  100703. * Define an offset on the texture to offset the v coordinates of the UVs
  100704. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  100705. */
  100706. vOffset: number;
  100707. /**
  100708. * Define an offset on the texture to scale the u coordinates of the UVs
  100709. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  100710. */
  100711. uScale: number;
  100712. /**
  100713. * Define an offset on the texture to scale the v coordinates of the UVs
  100714. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  100715. */
  100716. vScale: number;
  100717. /**
  100718. * Define an offset on the texture to rotate around the u coordinates of the UVs
  100719. * @see http://doc.babylonjs.com/how_to/more_materials
  100720. */
  100721. uAng: number;
  100722. /**
  100723. * Define an offset on the texture to rotate around the v coordinates of the UVs
  100724. * @see http://doc.babylonjs.com/how_to/more_materials
  100725. */
  100726. vAng: number;
  100727. /**
  100728. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  100729. * @see http://doc.babylonjs.com/how_to/more_materials
  100730. */
  100731. wAng: number;
  100732. /**
  100733. * Defines the center of rotation (U)
  100734. */
  100735. uRotationCenter: number;
  100736. /**
  100737. * Defines the center of rotation (V)
  100738. */
  100739. vRotationCenter: number;
  100740. /**
  100741. * Defines the center of rotation (W)
  100742. */
  100743. wRotationCenter: number;
  100744. /**
  100745. * Are mip maps generated for this texture or not.
  100746. */
  100747. get noMipmap(): boolean;
  100748. /**
  100749. * List of inspectable custom properties (used by the Inspector)
  100750. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  100751. */
  100752. inspectableCustomProperties: Nullable<IInspectable[]>;
  100753. private _noMipmap;
  100754. /** @hidden */
  100755. _invertY: boolean;
  100756. private _rowGenerationMatrix;
  100757. private _cachedTextureMatrix;
  100758. private _projectionModeMatrix;
  100759. private _t0;
  100760. private _t1;
  100761. private _t2;
  100762. private _cachedUOffset;
  100763. private _cachedVOffset;
  100764. private _cachedUScale;
  100765. private _cachedVScale;
  100766. private _cachedUAng;
  100767. private _cachedVAng;
  100768. private _cachedWAng;
  100769. private _cachedProjectionMatrixId;
  100770. private _cachedCoordinatesMode;
  100771. /** @hidden */
  100772. protected _initialSamplingMode: number;
  100773. /** @hidden */
  100774. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  100775. private _deleteBuffer;
  100776. protected _format: Nullable<number>;
  100777. private _delayedOnLoad;
  100778. private _delayedOnError;
  100779. private _mimeType?;
  100780. /**
  100781. * Observable triggered once the texture has been loaded.
  100782. */
  100783. onLoadObservable: Observable<Texture>;
  100784. protected _isBlocking: boolean;
  100785. /**
  100786. * Is the texture preventing material to render while loading.
  100787. * If false, a default texture will be used instead of the loading one during the preparation step.
  100788. */
  100789. set isBlocking(value: boolean);
  100790. get isBlocking(): boolean;
  100791. /**
  100792. * Get the current sampling mode associated with the texture.
  100793. */
  100794. get samplingMode(): number;
  100795. /**
  100796. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  100797. */
  100798. get invertY(): boolean;
  100799. /**
  100800. * Instantiates a new texture.
  100801. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  100802. * @see http://doc.babylonjs.com/babylon101/materials#texture
  100803. * @param url defines the url of the picture to load as a texture
  100804. * @param sceneOrEngine defines the scene or engine the texture will belong to
  100805. * @param noMipmap defines if the texture will require mip maps or not
  100806. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  100807. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  100808. * @param onLoad defines a callback triggered when the texture has been loaded
  100809. * @param onError defines a callback triggered when an error occurred during the loading session
  100810. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  100811. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  100812. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  100813. * @param mimeType defines an optional mime type information
  100814. */
  100815. 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);
  100816. /**
  100817. * Update the url (and optional buffer) of this texture if url was null during construction.
  100818. * @param url the url of the texture
  100819. * @param buffer the buffer of the texture (defaults to null)
  100820. * @param onLoad callback called when the texture is loaded (defaults to null)
  100821. */
  100822. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  100823. /**
  100824. * Finish the loading sequence of a texture flagged as delayed load.
  100825. * @hidden
  100826. */
  100827. delayLoad(): void;
  100828. private _prepareRowForTextureGeneration;
  100829. /**
  100830. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  100831. * @returns the transform matrix of the texture.
  100832. */
  100833. getTextureMatrix(uBase?: number): Matrix;
  100834. /**
  100835. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  100836. * @returns The reflection texture transform
  100837. */
  100838. getReflectionTextureMatrix(): Matrix;
  100839. /**
  100840. * Clones the texture.
  100841. * @returns the cloned texture
  100842. */
  100843. clone(): Texture;
  100844. /**
  100845. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  100846. * @returns The JSON representation of the texture
  100847. */
  100848. serialize(): any;
  100849. /**
  100850. * Get the current class name of the texture useful for serialization or dynamic coding.
  100851. * @returns "Texture"
  100852. */
  100853. getClassName(): string;
  100854. /**
  100855. * Dispose the texture and release its associated resources.
  100856. */
  100857. dispose(): void;
  100858. /**
  100859. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  100860. * @param parsedTexture Define the JSON representation of the texture
  100861. * @param scene Define the scene the parsed texture should be instantiated in
  100862. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  100863. * @returns The parsed texture if successful
  100864. */
  100865. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  100866. /**
  100867. * Creates a texture from its base 64 representation.
  100868. * @param data Define the base64 payload without the data: prefix
  100869. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  100870. * @param scene Define the scene the texture should belong to
  100871. * @param noMipmap Forces the texture to not create mip map information if true
  100872. * @param invertY define if the texture needs to be inverted on the y axis during loading
  100873. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  100874. * @param onLoad define a callback triggered when the texture has been loaded
  100875. * @param onError define a callback triggered when an error occurred during the loading session
  100876. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  100877. * @returns the created texture
  100878. */
  100879. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  100880. /**
  100881. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  100882. * @param data Define the base64 payload without the data: prefix
  100883. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  100884. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  100885. * @param scene Define the scene the texture should belong to
  100886. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  100887. * @param noMipmap Forces the texture to not create mip map information if true
  100888. * @param invertY define if the texture needs to be inverted on the y axis during loading
  100889. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  100890. * @param onLoad define a callback triggered when the texture has been loaded
  100891. * @param onError define a callback triggered when an error occurred during the loading session
  100892. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  100893. * @returns the created texture
  100894. */
  100895. 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;
  100896. }
  100897. }
  100898. declare module BABYLON {
  100899. /**
  100900. * PostProcessManager is used to manage one or more post processes or post process pipelines
  100901. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  100902. */
  100903. export class PostProcessManager {
  100904. private _scene;
  100905. private _indexBuffer;
  100906. private _vertexBuffers;
  100907. /**
  100908. * Creates a new instance PostProcess
  100909. * @param scene The scene that the post process is associated with.
  100910. */
  100911. constructor(scene: Scene);
  100912. private _prepareBuffers;
  100913. private _buildIndexBuffer;
  100914. /**
  100915. * Rebuilds the vertex buffers of the manager.
  100916. * @hidden
  100917. */
  100918. _rebuild(): void;
  100919. /**
  100920. * Prepares a frame to be run through a post process.
  100921. * @param sourceTexture The input texture to the post procesess. (default: null)
  100922. * @param postProcesses An array of post processes to be run. (default: null)
  100923. * @returns True if the post processes were able to be run.
  100924. * @hidden
  100925. */
  100926. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  100927. /**
  100928. * Manually render a set of post processes to a texture.
  100929. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  100930. * @param postProcesses An array of post processes to be run.
  100931. * @param targetTexture The target texture to render to.
  100932. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  100933. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  100934. * @param lodLevel defines which lod of the texture to render to
  100935. */
  100936. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  100937. /**
  100938. * Finalize the result of the output of the postprocesses.
  100939. * @param doNotPresent If true the result will not be displayed to the screen.
  100940. * @param targetTexture The target texture to render to.
  100941. * @param faceIndex The index of the face to bind the target texture to.
  100942. * @param postProcesses The array of post processes to render.
  100943. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  100944. * @hidden
  100945. */
  100946. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  100947. /**
  100948. * Disposes of the post process manager.
  100949. */
  100950. dispose(): void;
  100951. }
  100952. }
  100953. declare module BABYLON {
  100954. /**
  100955. * This Helps creating a texture that will be created from a camera in your scene.
  100956. * It is basically a dynamic texture that could be used to create special effects for instance.
  100957. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  100958. */
  100959. export class RenderTargetTexture extends Texture {
  100960. isCube: boolean;
  100961. /**
  100962. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  100963. */
  100964. static readonly REFRESHRATE_RENDER_ONCE: number;
  100965. /**
  100966. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  100967. */
  100968. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  100969. /**
  100970. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  100971. * the central point of your effect and can save a lot of performances.
  100972. */
  100973. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  100974. /**
  100975. * Use this predicate to dynamically define the list of mesh you want to render.
  100976. * If set, the renderList property will be overwritten.
  100977. */
  100978. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  100979. private _renderList;
  100980. /**
  100981. * Use this list to define the list of mesh you want to render.
  100982. */
  100983. get renderList(): Nullable<Array<AbstractMesh>>;
  100984. set renderList(value: Nullable<Array<AbstractMesh>>);
  100985. /**
  100986. * Use this function to overload the renderList array at rendering time.
  100987. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  100988. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  100989. * the cube (if the RTT is a cube, else layerOrFace=0).
  100990. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  100991. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  100992. * hold dummy elements!
  100993. */
  100994. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  100995. private _hookArray;
  100996. /**
  100997. * Define if particles should be rendered in your texture.
  100998. */
  100999. renderParticles: boolean;
  101000. /**
  101001. * Define if sprites should be rendered in your texture.
  101002. */
  101003. renderSprites: boolean;
  101004. /**
  101005. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  101006. */
  101007. coordinatesMode: number;
  101008. /**
  101009. * Define the camera used to render the texture.
  101010. */
  101011. activeCamera: Nullable<Camera>;
  101012. /**
  101013. * Override the mesh isReady function with your own one.
  101014. */
  101015. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  101016. /**
  101017. * Override the render function of the texture with your own one.
  101018. */
  101019. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  101020. /**
  101021. * Define if camera post processes should be use while rendering the texture.
  101022. */
  101023. useCameraPostProcesses: boolean;
  101024. /**
  101025. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  101026. */
  101027. ignoreCameraViewport: boolean;
  101028. private _postProcessManager;
  101029. private _postProcesses;
  101030. private _resizeObserver;
  101031. /**
  101032. * An event triggered when the texture is unbind.
  101033. */
  101034. onBeforeBindObservable: Observable<RenderTargetTexture>;
  101035. /**
  101036. * An event triggered when the texture is unbind.
  101037. */
  101038. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  101039. private _onAfterUnbindObserver;
  101040. /**
  101041. * Set a after unbind callback in the texture.
  101042. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  101043. */
  101044. set onAfterUnbind(callback: () => void);
  101045. /**
  101046. * An event triggered before rendering the texture
  101047. */
  101048. onBeforeRenderObservable: Observable<number>;
  101049. private _onBeforeRenderObserver;
  101050. /**
  101051. * Set a before render callback in the texture.
  101052. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  101053. */
  101054. set onBeforeRender(callback: (faceIndex: number) => void);
  101055. /**
  101056. * An event triggered after rendering the texture
  101057. */
  101058. onAfterRenderObservable: Observable<number>;
  101059. private _onAfterRenderObserver;
  101060. /**
  101061. * Set a after render callback in the texture.
  101062. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  101063. */
  101064. set onAfterRender(callback: (faceIndex: number) => void);
  101065. /**
  101066. * An event triggered after the texture clear
  101067. */
  101068. onClearObservable: Observable<Engine>;
  101069. private _onClearObserver;
  101070. /**
  101071. * Set a clear callback in the texture.
  101072. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  101073. */
  101074. set onClear(callback: (Engine: Engine) => void);
  101075. /**
  101076. * An event triggered when the texture is resized.
  101077. */
  101078. onResizeObservable: Observable<RenderTargetTexture>;
  101079. /**
  101080. * Define the clear color of the Render Target if it should be different from the scene.
  101081. */
  101082. clearColor: Color4;
  101083. protected _size: number | {
  101084. width: number;
  101085. height: number;
  101086. layers?: number;
  101087. };
  101088. protected _initialSizeParameter: number | {
  101089. width: number;
  101090. height: number;
  101091. } | {
  101092. ratio: number;
  101093. };
  101094. protected _sizeRatio: Nullable<number>;
  101095. /** @hidden */
  101096. _generateMipMaps: boolean;
  101097. protected _renderingManager: RenderingManager;
  101098. /** @hidden */
  101099. _waitingRenderList: string[];
  101100. protected _doNotChangeAspectRatio: boolean;
  101101. protected _currentRefreshId: number;
  101102. protected _refreshRate: number;
  101103. protected _textureMatrix: Matrix;
  101104. protected _samples: number;
  101105. protected _renderTargetOptions: RenderTargetCreationOptions;
  101106. /**
  101107. * Gets render target creation options that were used.
  101108. */
  101109. get renderTargetOptions(): RenderTargetCreationOptions;
  101110. protected _onRatioRescale(): void;
  101111. /**
  101112. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  101113. * It must define where the camera used to render the texture is set
  101114. */
  101115. boundingBoxPosition: Vector3;
  101116. private _boundingBoxSize;
  101117. /**
  101118. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  101119. * When defined, the cubemap will switch to local mode
  101120. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  101121. * @example https://www.babylonjs-playground.com/#RNASML
  101122. */
  101123. set boundingBoxSize(value: Vector3);
  101124. get boundingBoxSize(): Vector3;
  101125. /**
  101126. * In case the RTT has been created with a depth texture, get the associated
  101127. * depth texture.
  101128. * Otherwise, return null.
  101129. */
  101130. get depthStencilTexture(): Nullable<InternalTexture>;
  101131. /**
  101132. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  101133. * or used a shadow, depth texture...
  101134. * @param name The friendly name of the texture
  101135. * @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)
  101136. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  101137. * @param generateMipMaps True if mip maps need to be generated after render.
  101138. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  101139. * @param type The type of the buffer in the RTT (int, half float, float...)
  101140. * @param isCube True if a cube texture needs to be created
  101141. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  101142. * @param generateDepthBuffer True to generate a depth buffer
  101143. * @param generateStencilBuffer True to generate a stencil buffer
  101144. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  101145. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  101146. * @param delayAllocation if the texture allocation should be delayed (default: false)
  101147. */
  101148. constructor(name: string, size: number | {
  101149. width: number;
  101150. height: number;
  101151. layers?: number;
  101152. } | {
  101153. ratio: number;
  101154. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  101155. /**
  101156. * Creates a depth stencil texture.
  101157. * This is only available in WebGL 2 or with the depth texture extension available.
  101158. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  101159. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  101160. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  101161. */
  101162. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  101163. private _processSizeParameter;
  101164. /**
  101165. * Define the number of samples to use in case of MSAA.
  101166. * It defaults to one meaning no MSAA has been enabled.
  101167. */
  101168. get samples(): number;
  101169. set samples(value: number);
  101170. /**
  101171. * Resets the refresh counter of the texture and start bak from scratch.
  101172. * Could be useful to regenerate the texture if it is setup to render only once.
  101173. */
  101174. resetRefreshCounter(): void;
  101175. /**
  101176. * Define the refresh rate of the texture or the rendering frequency.
  101177. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  101178. */
  101179. get refreshRate(): number;
  101180. set refreshRate(value: number);
  101181. /**
  101182. * Adds a post process to the render target rendering passes.
  101183. * @param postProcess define the post process to add
  101184. */
  101185. addPostProcess(postProcess: PostProcess): void;
  101186. /**
  101187. * Clear all the post processes attached to the render target
  101188. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  101189. */
  101190. clearPostProcesses(dispose?: boolean): void;
  101191. /**
  101192. * Remove one of the post process from the list of attached post processes to the texture
  101193. * @param postProcess define the post process to remove from the list
  101194. */
  101195. removePostProcess(postProcess: PostProcess): void;
  101196. /** @hidden */
  101197. _shouldRender(): boolean;
  101198. /**
  101199. * Gets the actual render size of the texture.
  101200. * @returns the width of the render size
  101201. */
  101202. getRenderSize(): number;
  101203. /**
  101204. * Gets the actual render width of the texture.
  101205. * @returns the width of the render size
  101206. */
  101207. getRenderWidth(): number;
  101208. /**
  101209. * Gets the actual render height of the texture.
  101210. * @returns the height of the render size
  101211. */
  101212. getRenderHeight(): number;
  101213. /**
  101214. * Gets the actual number of layers of the texture.
  101215. * @returns the number of layers
  101216. */
  101217. getRenderLayers(): number;
  101218. /**
  101219. * Get if the texture can be rescaled or not.
  101220. */
  101221. get canRescale(): boolean;
  101222. /**
  101223. * Resize the texture using a ratio.
  101224. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  101225. */
  101226. scale(ratio: number): void;
  101227. /**
  101228. * Get the texture reflection matrix used to rotate/transform the reflection.
  101229. * @returns the reflection matrix
  101230. */
  101231. getReflectionTextureMatrix(): Matrix;
  101232. /**
  101233. * Resize the texture to a new desired size.
  101234. * Be carrefull as it will recreate all the data in the new texture.
  101235. * @param size Define the new size. It can be:
  101236. * - a number for squared texture,
  101237. * - an object containing { width: number, height: number }
  101238. * - or an object containing a ratio { ratio: number }
  101239. */
  101240. resize(size: number | {
  101241. width: number;
  101242. height: number;
  101243. } | {
  101244. ratio: number;
  101245. }): void;
  101246. private _defaultRenderListPrepared;
  101247. /**
  101248. * Renders all the objects from the render list into the texture.
  101249. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  101250. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  101251. */
  101252. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  101253. private _bestReflectionRenderTargetDimension;
  101254. private _prepareRenderingManager;
  101255. /**
  101256. * @hidden
  101257. * @param faceIndex face index to bind to if this is a cubetexture
  101258. * @param layer defines the index of the texture to bind in the array
  101259. */
  101260. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  101261. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  101262. private renderToTarget;
  101263. /**
  101264. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  101265. * This allowed control for front to back rendering or reversly depending of the special needs.
  101266. *
  101267. * @param renderingGroupId The rendering group id corresponding to its index
  101268. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  101269. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  101270. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  101271. */
  101272. 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;
  101273. /**
  101274. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  101275. *
  101276. * @param renderingGroupId The rendering group id corresponding to its index
  101277. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  101278. */
  101279. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  101280. /**
  101281. * Clones the texture.
  101282. * @returns the cloned texture
  101283. */
  101284. clone(): RenderTargetTexture;
  101285. /**
  101286. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  101287. * @returns The JSON representation of the texture
  101288. */
  101289. serialize(): any;
  101290. /**
  101291. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  101292. */
  101293. disposeFramebufferObjects(): void;
  101294. /**
  101295. * Dispose the texture and release its associated resources.
  101296. */
  101297. dispose(): void;
  101298. /** @hidden */
  101299. _rebuild(): void;
  101300. /**
  101301. * Clear the info related to rendering groups preventing retention point in material dispose.
  101302. */
  101303. freeRenderingGroups(): void;
  101304. /**
  101305. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  101306. * @returns the view count
  101307. */
  101308. getViewCount(): number;
  101309. }
  101310. }
  101311. declare module BABYLON {
  101312. /**
  101313. * Class used to manipulate GUIDs
  101314. */
  101315. export class GUID {
  101316. /**
  101317. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  101318. * Be aware Math.random() could cause collisions, but:
  101319. * "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"
  101320. * @returns a pseudo random id
  101321. */
  101322. static RandomId(): string;
  101323. }
  101324. }
  101325. declare module BABYLON {
  101326. /**
  101327. * Options to be used when creating a shadow depth material
  101328. */
  101329. export interface IIOptionShadowDepthMaterial {
  101330. /** Variables in the vertex shader code that need to have their names remapped.
  101331. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  101332. * "var_name" should be either: worldPos or vNormalW
  101333. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  101334. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  101335. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  101336. */
  101337. remappedVariables?: string[];
  101338. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  101339. standalone?: boolean;
  101340. }
  101341. /**
  101342. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  101343. */
  101344. export class ShadowDepthWrapper {
  101345. private _scene;
  101346. private _options?;
  101347. private _baseMaterial;
  101348. private _onEffectCreatedObserver;
  101349. private _subMeshToEffect;
  101350. private _subMeshToDepthEffect;
  101351. private _meshes;
  101352. /** @hidden */
  101353. _matriceNames: any;
  101354. /** Gets the standalone status of the wrapper */
  101355. get standalone(): boolean;
  101356. /** Gets the base material the wrapper is built upon */
  101357. get baseMaterial(): Material;
  101358. /**
  101359. * Instantiate a new shadow depth wrapper.
  101360. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  101361. * generate the shadow depth map. For more information, please refer to the documentation:
  101362. * https://doc.babylonjs.com/babylon101/shadows
  101363. * @param baseMaterial Material to wrap
  101364. * @param scene Define the scene the material belongs to
  101365. * @param options Options used to create the wrapper
  101366. */
  101367. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  101368. /**
  101369. * Gets the effect to use to generate the depth map
  101370. * @param subMesh subMesh to get the effect for
  101371. * @param shadowGenerator shadow generator to get the effect for
  101372. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  101373. */
  101374. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  101375. /**
  101376. * Specifies that the submesh is ready to be used for depth rendering
  101377. * @param subMesh submesh to check
  101378. * @param defines the list of defines to take into account when checking the effect
  101379. * @param shadowGenerator combined with subMesh, it defines the effect to check
  101380. * @param useInstances specifies that instances should be used
  101381. * @returns a boolean indicating that the submesh is ready or not
  101382. */
  101383. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  101384. /**
  101385. * Disposes the resources
  101386. */
  101387. dispose(): void;
  101388. private _makeEffect;
  101389. }
  101390. }
  101391. declare module BABYLON {
  101392. /**
  101393. * Options for compiling materials.
  101394. */
  101395. export interface IMaterialCompilationOptions {
  101396. /**
  101397. * Defines whether clip planes are enabled.
  101398. */
  101399. clipPlane: boolean;
  101400. /**
  101401. * Defines whether instances are enabled.
  101402. */
  101403. useInstances: boolean;
  101404. }
  101405. /**
  101406. * Options passed when calling customShaderNameResolve
  101407. */
  101408. export interface ICustomShaderNameResolveOptions {
  101409. /**
  101410. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  101411. */
  101412. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  101413. }
  101414. /**
  101415. * Base class for the main features of a material in Babylon.js
  101416. */
  101417. export class Material implements IAnimatable {
  101418. /**
  101419. * Returns the triangle fill mode
  101420. */
  101421. static readonly TriangleFillMode: number;
  101422. /**
  101423. * Returns the wireframe mode
  101424. */
  101425. static readonly WireFrameFillMode: number;
  101426. /**
  101427. * Returns the point fill mode
  101428. */
  101429. static readonly PointFillMode: number;
  101430. /**
  101431. * Returns the point list draw mode
  101432. */
  101433. static readonly PointListDrawMode: number;
  101434. /**
  101435. * Returns the line list draw mode
  101436. */
  101437. static readonly LineListDrawMode: number;
  101438. /**
  101439. * Returns the line loop draw mode
  101440. */
  101441. static readonly LineLoopDrawMode: number;
  101442. /**
  101443. * Returns the line strip draw mode
  101444. */
  101445. static readonly LineStripDrawMode: number;
  101446. /**
  101447. * Returns the triangle strip draw mode
  101448. */
  101449. static readonly TriangleStripDrawMode: number;
  101450. /**
  101451. * Returns the triangle fan draw mode
  101452. */
  101453. static readonly TriangleFanDrawMode: number;
  101454. /**
  101455. * Stores the clock-wise side orientation
  101456. */
  101457. static readonly ClockWiseSideOrientation: number;
  101458. /**
  101459. * Stores the counter clock-wise side orientation
  101460. */
  101461. static readonly CounterClockWiseSideOrientation: number;
  101462. /**
  101463. * The dirty texture flag value
  101464. */
  101465. static readonly TextureDirtyFlag: number;
  101466. /**
  101467. * The dirty light flag value
  101468. */
  101469. static readonly LightDirtyFlag: number;
  101470. /**
  101471. * The dirty fresnel flag value
  101472. */
  101473. static readonly FresnelDirtyFlag: number;
  101474. /**
  101475. * The dirty attribute flag value
  101476. */
  101477. static readonly AttributesDirtyFlag: number;
  101478. /**
  101479. * The dirty misc flag value
  101480. */
  101481. static readonly MiscDirtyFlag: number;
  101482. /**
  101483. * The all dirty flag value
  101484. */
  101485. static readonly AllDirtyFlag: number;
  101486. /**
  101487. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  101488. */
  101489. static readonly MATERIAL_OPAQUE: number;
  101490. /**
  101491. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  101492. */
  101493. static readonly MATERIAL_ALPHATEST: number;
  101494. /**
  101495. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  101496. */
  101497. static readonly MATERIAL_ALPHABLEND: number;
  101498. /**
  101499. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  101500. * They are also discarded below the alpha cutoff threshold to improve performances.
  101501. */
  101502. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  101503. /**
  101504. * The Whiteout method is used to blend normals.
  101505. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  101506. */
  101507. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  101508. /**
  101509. * The Reoriented Normal Mapping method is used to blend normals.
  101510. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  101511. */
  101512. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  101513. /**
  101514. * Custom callback helping to override the default shader used in the material.
  101515. */
  101516. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  101517. /**
  101518. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  101519. */
  101520. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  101521. /**
  101522. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  101523. * This means that the material can keep using a previous shader while a new one is being compiled.
  101524. * This is mostly used when shader parallel compilation is supported (true by default)
  101525. */
  101526. allowShaderHotSwapping: boolean;
  101527. /**
  101528. * The ID of the material
  101529. */
  101530. id: string;
  101531. /**
  101532. * Gets or sets the unique id of the material
  101533. */
  101534. uniqueId: number;
  101535. /**
  101536. * The name of the material
  101537. */
  101538. name: string;
  101539. /**
  101540. * Gets or sets user defined metadata
  101541. */
  101542. metadata: any;
  101543. /**
  101544. * For internal use only. Please do not use.
  101545. */
  101546. reservedDataStore: any;
  101547. /**
  101548. * Specifies if the ready state should be checked on each call
  101549. */
  101550. checkReadyOnEveryCall: boolean;
  101551. /**
  101552. * Specifies if the ready state should be checked once
  101553. */
  101554. checkReadyOnlyOnce: boolean;
  101555. /**
  101556. * The state of the material
  101557. */
  101558. state: string;
  101559. /**
  101560. * The alpha value of the material
  101561. */
  101562. protected _alpha: number;
  101563. /**
  101564. * List of inspectable custom properties (used by the Inspector)
  101565. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  101566. */
  101567. inspectableCustomProperties: IInspectable[];
  101568. /**
  101569. * Sets the alpha value of the material
  101570. */
  101571. set alpha(value: number);
  101572. /**
  101573. * Gets the alpha value of the material
  101574. */
  101575. get alpha(): number;
  101576. /**
  101577. * Specifies if back face culling is enabled
  101578. */
  101579. protected _backFaceCulling: boolean;
  101580. /**
  101581. * Sets the back-face culling state
  101582. */
  101583. set backFaceCulling(value: boolean);
  101584. /**
  101585. * Gets the back-face culling state
  101586. */
  101587. get backFaceCulling(): boolean;
  101588. /**
  101589. * Stores the value for side orientation
  101590. */
  101591. sideOrientation: number;
  101592. /**
  101593. * Callback triggered when the material is compiled
  101594. */
  101595. onCompiled: Nullable<(effect: Effect) => void>;
  101596. /**
  101597. * Callback triggered when an error occurs
  101598. */
  101599. onError: Nullable<(effect: Effect, errors: string) => void>;
  101600. /**
  101601. * Callback triggered to get the render target textures
  101602. */
  101603. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  101604. /**
  101605. * Gets a boolean indicating that current material needs to register RTT
  101606. */
  101607. get hasRenderTargetTextures(): boolean;
  101608. /**
  101609. * Specifies if the material should be serialized
  101610. */
  101611. doNotSerialize: boolean;
  101612. /**
  101613. * @hidden
  101614. */
  101615. _storeEffectOnSubMeshes: boolean;
  101616. /**
  101617. * Stores the animations for the material
  101618. */
  101619. animations: Nullable<Array<Animation>>;
  101620. /**
  101621. * An event triggered when the material is disposed
  101622. */
  101623. onDisposeObservable: Observable<Material>;
  101624. /**
  101625. * An observer which watches for dispose events
  101626. */
  101627. private _onDisposeObserver;
  101628. private _onUnBindObservable;
  101629. /**
  101630. * Called during a dispose event
  101631. */
  101632. set onDispose(callback: () => void);
  101633. private _onBindObservable;
  101634. /**
  101635. * An event triggered when the material is bound
  101636. */
  101637. get onBindObservable(): Observable<AbstractMesh>;
  101638. /**
  101639. * An observer which watches for bind events
  101640. */
  101641. private _onBindObserver;
  101642. /**
  101643. * Called during a bind event
  101644. */
  101645. set onBind(callback: (Mesh: AbstractMesh) => void);
  101646. /**
  101647. * An event triggered when the material is unbound
  101648. */
  101649. get onUnBindObservable(): Observable<Material>;
  101650. protected _onEffectCreatedObservable: Nullable<Observable<{
  101651. effect: Effect;
  101652. subMesh: Nullable<SubMesh>;
  101653. }>>;
  101654. /**
  101655. * An event triggered when the effect is (re)created
  101656. */
  101657. get onEffectCreatedObservable(): Observable<{
  101658. effect: Effect;
  101659. subMesh: Nullable<SubMesh>;
  101660. }>;
  101661. /**
  101662. * Stores the value of the alpha mode
  101663. */
  101664. private _alphaMode;
  101665. /**
  101666. * Sets the value of the alpha mode.
  101667. *
  101668. * | Value | Type | Description |
  101669. * | --- | --- | --- |
  101670. * | 0 | ALPHA_DISABLE | |
  101671. * | 1 | ALPHA_ADD | |
  101672. * | 2 | ALPHA_COMBINE | |
  101673. * | 3 | ALPHA_SUBTRACT | |
  101674. * | 4 | ALPHA_MULTIPLY | |
  101675. * | 5 | ALPHA_MAXIMIZED | |
  101676. * | 6 | ALPHA_ONEONE | |
  101677. * | 7 | ALPHA_PREMULTIPLIED | |
  101678. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  101679. * | 9 | ALPHA_INTERPOLATE | |
  101680. * | 10 | ALPHA_SCREENMODE | |
  101681. *
  101682. */
  101683. set alphaMode(value: number);
  101684. /**
  101685. * Gets the value of the alpha mode
  101686. */
  101687. get alphaMode(): number;
  101688. /**
  101689. * Stores the state of the need depth pre-pass value
  101690. */
  101691. private _needDepthPrePass;
  101692. /**
  101693. * Sets the need depth pre-pass value
  101694. */
  101695. set needDepthPrePass(value: boolean);
  101696. /**
  101697. * Gets the depth pre-pass value
  101698. */
  101699. get needDepthPrePass(): boolean;
  101700. /**
  101701. * Specifies if depth writing should be disabled
  101702. */
  101703. disableDepthWrite: boolean;
  101704. /**
  101705. * Specifies if color writing should be disabled
  101706. */
  101707. disableColorWrite: boolean;
  101708. /**
  101709. * Specifies if depth writing should be forced
  101710. */
  101711. forceDepthWrite: boolean;
  101712. /**
  101713. * Specifies the depth function that should be used. 0 means the default engine function
  101714. */
  101715. depthFunction: number;
  101716. /**
  101717. * Specifies if there should be a separate pass for culling
  101718. */
  101719. separateCullingPass: boolean;
  101720. /**
  101721. * Stores the state specifing if fog should be enabled
  101722. */
  101723. private _fogEnabled;
  101724. /**
  101725. * Sets the state for enabling fog
  101726. */
  101727. set fogEnabled(value: boolean);
  101728. /**
  101729. * Gets the value of the fog enabled state
  101730. */
  101731. get fogEnabled(): boolean;
  101732. /**
  101733. * Stores the size of points
  101734. */
  101735. pointSize: number;
  101736. /**
  101737. * Stores the z offset value
  101738. */
  101739. zOffset: number;
  101740. get wireframe(): boolean;
  101741. /**
  101742. * Sets the state of wireframe mode
  101743. */
  101744. set wireframe(value: boolean);
  101745. /**
  101746. * Gets the value specifying if point clouds are enabled
  101747. */
  101748. get pointsCloud(): boolean;
  101749. /**
  101750. * Sets the state of point cloud mode
  101751. */
  101752. set pointsCloud(value: boolean);
  101753. /**
  101754. * Gets the material fill mode
  101755. */
  101756. get fillMode(): number;
  101757. /**
  101758. * Sets the material fill mode
  101759. */
  101760. set fillMode(value: number);
  101761. /**
  101762. * @hidden
  101763. * Stores the effects for the material
  101764. */
  101765. _effect: Nullable<Effect>;
  101766. /**
  101767. * Specifies if uniform buffers should be used
  101768. */
  101769. private _useUBO;
  101770. /**
  101771. * Stores a reference to the scene
  101772. */
  101773. private _scene;
  101774. /**
  101775. * Stores the fill mode state
  101776. */
  101777. private _fillMode;
  101778. /**
  101779. * Specifies if the depth write state should be cached
  101780. */
  101781. private _cachedDepthWriteState;
  101782. /**
  101783. * Specifies if the color write state should be cached
  101784. */
  101785. private _cachedColorWriteState;
  101786. /**
  101787. * Specifies if the depth function state should be cached
  101788. */
  101789. private _cachedDepthFunctionState;
  101790. /**
  101791. * Stores the uniform buffer
  101792. */
  101793. protected _uniformBuffer: UniformBuffer;
  101794. /** @hidden */
  101795. _indexInSceneMaterialArray: number;
  101796. /** @hidden */
  101797. meshMap: Nullable<{
  101798. [id: string]: AbstractMesh | undefined;
  101799. }>;
  101800. /**
  101801. * Creates a material instance
  101802. * @param name defines the name of the material
  101803. * @param scene defines the scene to reference
  101804. * @param doNotAdd specifies if the material should be added to the scene
  101805. */
  101806. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  101807. /**
  101808. * Returns a string representation of the current material
  101809. * @param fullDetails defines a boolean indicating which levels of logging is desired
  101810. * @returns a string with material information
  101811. */
  101812. toString(fullDetails?: boolean): string;
  101813. /**
  101814. * Gets the class name of the material
  101815. * @returns a string with the class name of the material
  101816. */
  101817. getClassName(): string;
  101818. /**
  101819. * Specifies if updates for the material been locked
  101820. */
  101821. get isFrozen(): boolean;
  101822. /**
  101823. * Locks updates for the material
  101824. */
  101825. freeze(): void;
  101826. /**
  101827. * Unlocks updates for the material
  101828. */
  101829. unfreeze(): void;
  101830. /**
  101831. * Specifies if the material is ready to be used
  101832. * @param mesh defines the mesh to check
  101833. * @param useInstances specifies if instances should be used
  101834. * @returns a boolean indicating if the material is ready to be used
  101835. */
  101836. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101837. /**
  101838. * Specifies that the submesh is ready to be used
  101839. * @param mesh defines the mesh to check
  101840. * @param subMesh defines which submesh to check
  101841. * @param useInstances specifies that instances should be used
  101842. * @returns a boolean indicating that the submesh is ready or not
  101843. */
  101844. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  101845. /**
  101846. * Returns the material effect
  101847. * @returns the effect associated with the material
  101848. */
  101849. getEffect(): Nullable<Effect>;
  101850. /**
  101851. * Returns the current scene
  101852. * @returns a Scene
  101853. */
  101854. getScene(): Scene;
  101855. /**
  101856. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  101857. */
  101858. protected _forceAlphaTest: boolean;
  101859. /**
  101860. * The transparency mode of the material.
  101861. */
  101862. protected _transparencyMode: Nullable<number>;
  101863. /**
  101864. * Gets the current transparency mode.
  101865. */
  101866. get transparencyMode(): Nullable<number>;
  101867. /**
  101868. * Sets the transparency mode of the material.
  101869. *
  101870. * | Value | Type | Description |
  101871. * | ----- | ----------------------------------- | ----------- |
  101872. * | 0 | OPAQUE | |
  101873. * | 1 | ALPHATEST | |
  101874. * | 2 | ALPHABLEND | |
  101875. * | 3 | ALPHATESTANDBLEND | |
  101876. *
  101877. */
  101878. set transparencyMode(value: Nullable<number>);
  101879. /**
  101880. * Returns true if alpha blending should be disabled.
  101881. */
  101882. protected get _disableAlphaBlending(): boolean;
  101883. /**
  101884. * Specifies whether or not this material should be rendered in alpha blend mode.
  101885. * @returns a boolean specifying if alpha blending is needed
  101886. */
  101887. needAlphaBlending(): boolean;
  101888. /**
  101889. * Specifies if the mesh will require alpha blending
  101890. * @param mesh defines the mesh to check
  101891. * @returns a boolean specifying if alpha blending is needed for the mesh
  101892. */
  101893. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  101894. /**
  101895. * Specifies whether or not this material should be rendered in alpha test mode.
  101896. * @returns a boolean specifying if an alpha test is needed.
  101897. */
  101898. needAlphaTesting(): boolean;
  101899. /**
  101900. * Specifies if material alpha testing should be turned on for the mesh
  101901. * @param mesh defines the mesh to check
  101902. */
  101903. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  101904. /**
  101905. * Gets the texture used for the alpha test
  101906. * @returns the texture to use for alpha testing
  101907. */
  101908. getAlphaTestTexture(): Nullable<BaseTexture>;
  101909. /**
  101910. * Marks the material to indicate that it needs to be re-calculated
  101911. */
  101912. markDirty(): void;
  101913. /** @hidden */
  101914. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  101915. /**
  101916. * Binds the material to the mesh
  101917. * @param world defines the world transformation matrix
  101918. * @param mesh defines the mesh to bind the material to
  101919. */
  101920. bind(world: Matrix, mesh?: Mesh): void;
  101921. /**
  101922. * Binds the submesh to the material
  101923. * @param world defines the world transformation matrix
  101924. * @param mesh defines the mesh containing the submesh
  101925. * @param subMesh defines the submesh to bind the material to
  101926. */
  101927. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  101928. /**
  101929. * Binds the world matrix to the material
  101930. * @param world defines the world transformation matrix
  101931. */
  101932. bindOnlyWorldMatrix(world: Matrix): void;
  101933. /**
  101934. * Binds the scene's uniform buffer to the effect.
  101935. * @param effect defines the effect to bind to the scene uniform buffer
  101936. * @param sceneUbo defines the uniform buffer storing scene data
  101937. */
  101938. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  101939. /**
  101940. * Binds the view matrix to the effect
  101941. * @param effect defines the effect to bind the view matrix to
  101942. */
  101943. bindView(effect: Effect): void;
  101944. /**
  101945. * Binds the view projection matrix to the effect
  101946. * @param effect defines the effect to bind the view projection matrix to
  101947. */
  101948. bindViewProjection(effect: Effect): void;
  101949. /**
  101950. * Processes to execute after binding the material to a mesh
  101951. * @param mesh defines the rendered mesh
  101952. */
  101953. protected _afterBind(mesh?: Mesh): void;
  101954. /**
  101955. * Unbinds the material from the mesh
  101956. */
  101957. unbind(): void;
  101958. /**
  101959. * Gets the active textures from the material
  101960. * @returns an array of textures
  101961. */
  101962. getActiveTextures(): BaseTexture[];
  101963. /**
  101964. * Specifies if the material uses a texture
  101965. * @param texture defines the texture to check against the material
  101966. * @returns a boolean specifying if the material uses the texture
  101967. */
  101968. hasTexture(texture: BaseTexture): boolean;
  101969. /**
  101970. * Makes a duplicate of the material, and gives it a new name
  101971. * @param name defines the new name for the duplicated material
  101972. * @returns the cloned material
  101973. */
  101974. clone(name: string): Nullable<Material>;
  101975. /**
  101976. * Gets the meshes bound to the material
  101977. * @returns an array of meshes bound to the material
  101978. */
  101979. getBindedMeshes(): AbstractMesh[];
  101980. /**
  101981. * Force shader compilation
  101982. * @param mesh defines the mesh associated with this material
  101983. * @param onCompiled defines a function to execute once the material is compiled
  101984. * @param options defines the options to configure the compilation
  101985. * @param onError defines a function to execute if the material fails compiling
  101986. */
  101987. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  101988. /**
  101989. * Force shader compilation
  101990. * @param mesh defines the mesh that will use this material
  101991. * @param options defines additional options for compiling the shaders
  101992. * @returns a promise that resolves when the compilation completes
  101993. */
  101994. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  101995. private static readonly _AllDirtyCallBack;
  101996. private static readonly _ImageProcessingDirtyCallBack;
  101997. private static readonly _TextureDirtyCallBack;
  101998. private static readonly _FresnelDirtyCallBack;
  101999. private static readonly _MiscDirtyCallBack;
  102000. private static readonly _LightsDirtyCallBack;
  102001. private static readonly _AttributeDirtyCallBack;
  102002. private static _FresnelAndMiscDirtyCallBack;
  102003. private static _TextureAndMiscDirtyCallBack;
  102004. private static readonly _DirtyCallbackArray;
  102005. private static readonly _RunDirtyCallBacks;
  102006. /**
  102007. * Marks a define in the material to indicate that it needs to be re-computed
  102008. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  102009. */
  102010. markAsDirty(flag: number): void;
  102011. /**
  102012. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  102013. * @param func defines a function which checks material defines against the submeshes
  102014. */
  102015. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  102016. /**
  102017. * Indicates that we need to re-calculated for all submeshes
  102018. */
  102019. protected _markAllSubMeshesAsAllDirty(): void;
  102020. /**
  102021. * Indicates that image processing needs to be re-calculated for all submeshes
  102022. */
  102023. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  102024. /**
  102025. * Indicates that textures need to be re-calculated for all submeshes
  102026. */
  102027. protected _markAllSubMeshesAsTexturesDirty(): void;
  102028. /**
  102029. * Indicates that fresnel needs to be re-calculated for all submeshes
  102030. */
  102031. protected _markAllSubMeshesAsFresnelDirty(): void;
  102032. /**
  102033. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  102034. */
  102035. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  102036. /**
  102037. * Indicates that lights need to be re-calculated for all submeshes
  102038. */
  102039. protected _markAllSubMeshesAsLightsDirty(): void;
  102040. /**
  102041. * Indicates that attributes need to be re-calculated for all submeshes
  102042. */
  102043. protected _markAllSubMeshesAsAttributesDirty(): void;
  102044. /**
  102045. * Indicates that misc needs to be re-calculated for all submeshes
  102046. */
  102047. protected _markAllSubMeshesAsMiscDirty(): void;
  102048. /**
  102049. * Indicates that textures and misc need to be re-calculated for all submeshes
  102050. */
  102051. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  102052. /**
  102053. * Disposes the material
  102054. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102055. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102056. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102057. */
  102058. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102059. /** @hidden */
  102060. private releaseVertexArrayObject;
  102061. /**
  102062. * Serializes this material
  102063. * @returns the serialized material object
  102064. */
  102065. serialize(): any;
  102066. /**
  102067. * Creates a material from parsed material data
  102068. * @param parsedMaterial defines parsed material data
  102069. * @param scene defines the hosting scene
  102070. * @param rootUrl defines the root URL to use to load textures
  102071. * @returns a new material
  102072. */
  102073. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  102074. }
  102075. }
  102076. declare module BABYLON {
  102077. /**
  102078. * A multi-material is used to apply different materials to different parts of the same object without the need of
  102079. * separate meshes. This can be use to improve performances.
  102080. * @see http://doc.babylonjs.com/how_to/multi_materials
  102081. */
  102082. export class MultiMaterial extends Material {
  102083. private _subMaterials;
  102084. /**
  102085. * Gets or Sets the list of Materials used within the multi material.
  102086. * They need to be ordered according to the submeshes order in the associated mesh
  102087. */
  102088. get subMaterials(): Nullable<Material>[];
  102089. set subMaterials(value: Nullable<Material>[]);
  102090. /**
  102091. * Function used to align with Node.getChildren()
  102092. * @returns the list of Materials used within the multi material
  102093. */
  102094. getChildren(): Nullable<Material>[];
  102095. /**
  102096. * Instantiates a new Multi Material
  102097. * A multi-material is used to apply different materials to different parts of the same object without the need of
  102098. * separate meshes. This can be use to improve performances.
  102099. * @see http://doc.babylonjs.com/how_to/multi_materials
  102100. * @param name Define the name in the scene
  102101. * @param scene Define the scene the material belongs to
  102102. */
  102103. constructor(name: string, scene: Scene);
  102104. private _hookArray;
  102105. /**
  102106. * Get one of the submaterial by its index in the submaterials array
  102107. * @param index The index to look the sub material at
  102108. * @returns The Material if the index has been defined
  102109. */
  102110. getSubMaterial(index: number): Nullable<Material>;
  102111. /**
  102112. * Get the list of active textures for the whole sub materials list.
  102113. * @returns All the textures that will be used during the rendering
  102114. */
  102115. getActiveTextures(): BaseTexture[];
  102116. /**
  102117. * Gets the current class name of the material e.g. "MultiMaterial"
  102118. * Mainly use in serialization.
  102119. * @returns the class name
  102120. */
  102121. getClassName(): string;
  102122. /**
  102123. * Checks if the material is ready to render the requested sub mesh
  102124. * @param mesh Define the mesh the submesh belongs to
  102125. * @param subMesh Define the sub mesh to look readyness for
  102126. * @param useInstances Define whether or not the material is used with instances
  102127. * @returns true if ready, otherwise false
  102128. */
  102129. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102130. /**
  102131. * Clones the current material and its related sub materials
  102132. * @param name Define the name of the newly cloned material
  102133. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  102134. * @returns the cloned material
  102135. */
  102136. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  102137. /**
  102138. * Serializes the materials into a JSON representation.
  102139. * @returns the JSON representation
  102140. */
  102141. serialize(): any;
  102142. /**
  102143. * Dispose the material and release its associated resources
  102144. * @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)
  102145. * @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)
  102146. * @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)
  102147. */
  102148. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  102149. /**
  102150. * Creates a MultiMaterial from parsed MultiMaterial data.
  102151. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  102152. * @param scene defines the hosting scene
  102153. * @returns a new MultiMaterial
  102154. */
  102155. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  102156. }
  102157. }
  102158. declare module BABYLON {
  102159. /**
  102160. * Defines a subdivision inside a mesh
  102161. */
  102162. export class SubMesh implements ICullable {
  102163. /** the material index to use */
  102164. materialIndex: number;
  102165. /** vertex index start */
  102166. verticesStart: number;
  102167. /** vertices count */
  102168. verticesCount: number;
  102169. /** index start */
  102170. indexStart: number;
  102171. /** indices count */
  102172. indexCount: number;
  102173. /** @hidden */
  102174. _materialDefines: Nullable<MaterialDefines>;
  102175. /** @hidden */
  102176. _materialEffect: Nullable<Effect>;
  102177. /** @hidden */
  102178. _effectOverride: Nullable<Effect>;
  102179. /**
  102180. * Gets material defines used by the effect associated to the sub mesh
  102181. */
  102182. get materialDefines(): Nullable<MaterialDefines>;
  102183. /**
  102184. * Sets material defines used by the effect associated to the sub mesh
  102185. */
  102186. set materialDefines(defines: Nullable<MaterialDefines>);
  102187. /**
  102188. * Gets associated effect
  102189. */
  102190. get effect(): Nullable<Effect>;
  102191. /**
  102192. * Sets associated effect (effect used to render this submesh)
  102193. * @param effect defines the effect to associate with
  102194. * @param defines defines the set of defines used to compile this effect
  102195. */
  102196. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  102197. /** @hidden */
  102198. _linesIndexCount: number;
  102199. private _mesh;
  102200. private _renderingMesh;
  102201. private _boundingInfo;
  102202. private _linesIndexBuffer;
  102203. /** @hidden */
  102204. _lastColliderWorldVertices: Nullable<Vector3[]>;
  102205. /** @hidden */
  102206. _trianglePlanes: Plane[];
  102207. /** @hidden */
  102208. _lastColliderTransformMatrix: Nullable<Matrix>;
  102209. /** @hidden */
  102210. _renderId: number;
  102211. /** @hidden */
  102212. _alphaIndex: number;
  102213. /** @hidden */
  102214. _distanceToCamera: number;
  102215. /** @hidden */
  102216. _id: number;
  102217. private _currentMaterial;
  102218. /**
  102219. * Add a new submesh to a mesh
  102220. * @param materialIndex defines the material index to use
  102221. * @param verticesStart defines vertex index start
  102222. * @param verticesCount defines vertices count
  102223. * @param indexStart defines index start
  102224. * @param indexCount defines indices count
  102225. * @param mesh defines the parent mesh
  102226. * @param renderingMesh defines an optional rendering mesh
  102227. * @param createBoundingBox defines if bounding box should be created for this submesh
  102228. * @returns the new submesh
  102229. */
  102230. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  102231. /**
  102232. * Creates a new submesh
  102233. * @param materialIndex defines the material index to use
  102234. * @param verticesStart defines vertex index start
  102235. * @param verticesCount defines vertices count
  102236. * @param indexStart defines index start
  102237. * @param indexCount defines indices count
  102238. * @param mesh defines the parent mesh
  102239. * @param renderingMesh defines an optional rendering mesh
  102240. * @param createBoundingBox defines if bounding box should be created for this submesh
  102241. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  102242. */
  102243. constructor(
  102244. /** the material index to use */
  102245. materialIndex: number,
  102246. /** vertex index start */
  102247. verticesStart: number,
  102248. /** vertices count */
  102249. verticesCount: number,
  102250. /** index start */
  102251. indexStart: number,
  102252. /** indices count */
  102253. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  102254. /**
  102255. * Returns true if this submesh covers the entire parent mesh
  102256. * @ignorenaming
  102257. */
  102258. get IsGlobal(): boolean;
  102259. /**
  102260. * Returns the submesh BoudingInfo object
  102261. * @returns current bounding info (or mesh's one if the submesh is global)
  102262. */
  102263. getBoundingInfo(): BoundingInfo;
  102264. /**
  102265. * Sets the submesh BoundingInfo
  102266. * @param boundingInfo defines the new bounding info to use
  102267. * @returns the SubMesh
  102268. */
  102269. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  102270. /**
  102271. * Returns the mesh of the current submesh
  102272. * @return the parent mesh
  102273. */
  102274. getMesh(): AbstractMesh;
  102275. /**
  102276. * Returns the rendering mesh of the submesh
  102277. * @returns the rendering mesh (could be different from parent mesh)
  102278. */
  102279. getRenderingMesh(): Mesh;
  102280. /**
  102281. * Returns the replacement mesh of the submesh
  102282. * @returns the replacement mesh (could be different from parent mesh)
  102283. */
  102284. getReplacementMesh(): Nullable<AbstractMesh>;
  102285. /**
  102286. * Returns the effective mesh of the submesh
  102287. * @returns the effective mesh (could be different from parent mesh)
  102288. */
  102289. getEffectiveMesh(): AbstractMesh;
  102290. /**
  102291. * Returns the submesh material
  102292. * @returns null or the current material
  102293. */
  102294. getMaterial(): Nullable<Material>;
  102295. private _IsMultiMaterial;
  102296. /**
  102297. * Sets a new updated BoundingInfo object to the submesh
  102298. * @param data defines an optional position array to use to determine the bounding info
  102299. * @returns the SubMesh
  102300. */
  102301. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  102302. /** @hidden */
  102303. _checkCollision(collider: Collider): boolean;
  102304. /**
  102305. * Updates the submesh BoundingInfo
  102306. * @param world defines the world matrix to use to update the bounding info
  102307. * @returns the submesh
  102308. */
  102309. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  102310. /**
  102311. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  102312. * @param frustumPlanes defines the frustum planes
  102313. * @returns true if the submesh is intersecting with the frustum
  102314. */
  102315. isInFrustum(frustumPlanes: Plane[]): boolean;
  102316. /**
  102317. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  102318. * @param frustumPlanes defines the frustum planes
  102319. * @returns true if the submesh is inside the frustum
  102320. */
  102321. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  102322. /**
  102323. * Renders the submesh
  102324. * @param enableAlphaMode defines if alpha needs to be used
  102325. * @returns the submesh
  102326. */
  102327. render(enableAlphaMode: boolean): SubMesh;
  102328. /**
  102329. * @hidden
  102330. */
  102331. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  102332. /**
  102333. * Checks if the submesh intersects with a ray
  102334. * @param ray defines the ray to test
  102335. * @returns true is the passed ray intersects the submesh bounding box
  102336. */
  102337. canIntersects(ray: Ray): boolean;
  102338. /**
  102339. * Intersects current submesh with a ray
  102340. * @param ray defines the ray to test
  102341. * @param positions defines mesh's positions array
  102342. * @param indices defines mesh's indices array
  102343. * @param fastCheck defines if the first intersection will be used (and not the closest)
  102344. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  102345. * @returns intersection info or null if no intersection
  102346. */
  102347. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  102348. /** @hidden */
  102349. private _intersectLines;
  102350. /** @hidden */
  102351. private _intersectUnIndexedLines;
  102352. /** @hidden */
  102353. private _intersectTriangles;
  102354. /** @hidden */
  102355. private _intersectUnIndexedTriangles;
  102356. /** @hidden */
  102357. _rebuild(): void;
  102358. /**
  102359. * Creates a new submesh from the passed mesh
  102360. * @param newMesh defines the new hosting mesh
  102361. * @param newRenderingMesh defines an optional rendering mesh
  102362. * @returns the new submesh
  102363. */
  102364. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  102365. /**
  102366. * Release associated resources
  102367. */
  102368. dispose(): void;
  102369. /**
  102370. * Gets the class name
  102371. * @returns the string "SubMesh".
  102372. */
  102373. getClassName(): string;
  102374. /**
  102375. * Creates a new submesh from indices data
  102376. * @param materialIndex the index of the main mesh material
  102377. * @param startIndex the index where to start the copy in the mesh indices array
  102378. * @param indexCount the number of indices to copy then from the startIndex
  102379. * @param mesh the main mesh to create the submesh from
  102380. * @param renderingMesh the optional rendering mesh
  102381. * @returns a new submesh
  102382. */
  102383. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  102384. }
  102385. }
  102386. declare module BABYLON {
  102387. /**
  102388. * Class used to represent data loading progression
  102389. */
  102390. export class SceneLoaderFlags {
  102391. private static _ForceFullSceneLoadingForIncremental;
  102392. private static _ShowLoadingScreen;
  102393. private static _CleanBoneMatrixWeights;
  102394. private static _loggingLevel;
  102395. /**
  102396. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  102397. */
  102398. static get ForceFullSceneLoadingForIncremental(): boolean;
  102399. static set ForceFullSceneLoadingForIncremental(value: boolean);
  102400. /**
  102401. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  102402. */
  102403. static get ShowLoadingScreen(): boolean;
  102404. static set ShowLoadingScreen(value: boolean);
  102405. /**
  102406. * Defines the current logging level (while loading the scene)
  102407. * @ignorenaming
  102408. */
  102409. static get loggingLevel(): number;
  102410. static set loggingLevel(value: number);
  102411. /**
  102412. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  102413. */
  102414. static get CleanBoneMatrixWeights(): boolean;
  102415. static set CleanBoneMatrixWeights(value: boolean);
  102416. }
  102417. }
  102418. declare module BABYLON {
  102419. /**
  102420. * Class used to store geometry data (vertex buffers + index buffer)
  102421. */
  102422. export class Geometry implements IGetSetVerticesData {
  102423. /**
  102424. * Gets or sets the ID of the geometry
  102425. */
  102426. id: string;
  102427. /**
  102428. * Gets or sets the unique ID of the geometry
  102429. */
  102430. uniqueId: number;
  102431. /**
  102432. * Gets the delay loading state of the geometry (none by default which means not delayed)
  102433. */
  102434. delayLoadState: number;
  102435. /**
  102436. * Gets the file containing the data to load when running in delay load state
  102437. */
  102438. delayLoadingFile: Nullable<string>;
  102439. /**
  102440. * Callback called when the geometry is updated
  102441. */
  102442. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  102443. private _scene;
  102444. private _engine;
  102445. private _meshes;
  102446. private _totalVertices;
  102447. /** @hidden */
  102448. _indices: IndicesArray;
  102449. /** @hidden */
  102450. _vertexBuffers: {
  102451. [key: string]: VertexBuffer;
  102452. };
  102453. private _isDisposed;
  102454. private _extend;
  102455. private _boundingBias;
  102456. /** @hidden */
  102457. _delayInfo: Array<string>;
  102458. private _indexBuffer;
  102459. private _indexBufferIsUpdatable;
  102460. /** @hidden */
  102461. _boundingInfo: Nullable<BoundingInfo>;
  102462. /** @hidden */
  102463. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  102464. /** @hidden */
  102465. _softwareSkinningFrameId: number;
  102466. private _vertexArrayObjects;
  102467. private _updatable;
  102468. /** @hidden */
  102469. _positions: Nullable<Vector3[]>;
  102470. /**
  102471. * 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
  102472. */
  102473. get boundingBias(): Vector2;
  102474. /**
  102475. * 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
  102476. */
  102477. set boundingBias(value: Vector2);
  102478. /**
  102479. * Static function used to attach a new empty geometry to a mesh
  102480. * @param mesh defines the mesh to attach the geometry to
  102481. * @returns the new Geometry
  102482. */
  102483. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  102484. /** Get the list of meshes using this geometry */
  102485. get meshes(): Mesh[];
  102486. /**
  102487. * Creates a new geometry
  102488. * @param id defines the unique ID
  102489. * @param scene defines the hosting scene
  102490. * @param vertexData defines the VertexData used to get geometry data
  102491. * @param updatable defines if geometry must be updatable (false by default)
  102492. * @param mesh defines the mesh that will be associated with the geometry
  102493. */
  102494. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  102495. /**
  102496. * Gets the current extend of the geometry
  102497. */
  102498. get extend(): {
  102499. minimum: Vector3;
  102500. maximum: Vector3;
  102501. };
  102502. /**
  102503. * Gets the hosting scene
  102504. * @returns the hosting Scene
  102505. */
  102506. getScene(): Scene;
  102507. /**
  102508. * Gets the hosting engine
  102509. * @returns the hosting Engine
  102510. */
  102511. getEngine(): Engine;
  102512. /**
  102513. * Defines if the geometry is ready to use
  102514. * @returns true if the geometry is ready to be used
  102515. */
  102516. isReady(): boolean;
  102517. /**
  102518. * Gets a value indicating that the geometry should not be serialized
  102519. */
  102520. get doNotSerialize(): boolean;
  102521. /** @hidden */
  102522. _rebuild(): void;
  102523. /**
  102524. * Affects all geometry data in one call
  102525. * @param vertexData defines the geometry data
  102526. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  102527. */
  102528. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  102529. /**
  102530. * Set specific vertex data
  102531. * @param kind defines the data kind (Position, normal, etc...)
  102532. * @param data defines the vertex data to use
  102533. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  102534. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  102535. */
  102536. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  102537. /**
  102538. * Removes a specific vertex data
  102539. * @param kind defines the data kind (Position, normal, etc...)
  102540. */
  102541. removeVerticesData(kind: string): void;
  102542. /**
  102543. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  102544. * @param buffer defines the vertex buffer to use
  102545. * @param totalVertices defines the total number of vertices for position kind (could be null)
  102546. */
  102547. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  102548. /**
  102549. * Update a specific vertex buffer
  102550. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  102551. * It will do nothing if the buffer is not updatable
  102552. * @param kind defines the data kind (Position, normal, etc...)
  102553. * @param data defines the data to use
  102554. * @param offset defines the offset in the target buffer where to store the data
  102555. * @param useBytes set to true if the offset is in bytes
  102556. */
  102557. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  102558. /**
  102559. * Update a specific vertex buffer
  102560. * This function will create a new buffer if the current one is not updatable
  102561. * @param kind defines the data kind (Position, normal, etc...)
  102562. * @param data defines the data to use
  102563. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  102564. */
  102565. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  102566. private _updateBoundingInfo;
  102567. /** @hidden */
  102568. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  102569. /**
  102570. * Gets total number of vertices
  102571. * @returns the total number of vertices
  102572. */
  102573. getTotalVertices(): number;
  102574. /**
  102575. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  102576. * @param kind defines the data kind (Position, normal, etc...)
  102577. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  102578. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  102579. * @returns a float array containing vertex data
  102580. */
  102581. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  102582. /**
  102583. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  102584. * @param kind defines the data kind (Position, normal, etc...)
  102585. * @returns true if the vertex buffer with the specified kind is updatable
  102586. */
  102587. isVertexBufferUpdatable(kind: string): boolean;
  102588. /**
  102589. * Gets a specific vertex buffer
  102590. * @param kind defines the data kind (Position, normal, etc...)
  102591. * @returns a VertexBuffer
  102592. */
  102593. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  102594. /**
  102595. * Returns all vertex buffers
  102596. * @return an object holding all vertex buffers indexed by kind
  102597. */
  102598. getVertexBuffers(): Nullable<{
  102599. [key: string]: VertexBuffer;
  102600. }>;
  102601. /**
  102602. * Gets a boolean indicating if specific vertex buffer is present
  102603. * @param kind defines the data kind (Position, normal, etc...)
  102604. * @returns true if data is present
  102605. */
  102606. isVerticesDataPresent(kind: string): boolean;
  102607. /**
  102608. * Gets a list of all attached data kinds (Position, normal, etc...)
  102609. * @returns a list of string containing all kinds
  102610. */
  102611. getVerticesDataKinds(): string[];
  102612. /**
  102613. * Update index buffer
  102614. * @param indices defines the indices to store in the index buffer
  102615. * @param offset defines the offset in the target buffer where to store the data
  102616. * @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)
  102617. */
  102618. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  102619. /**
  102620. * Creates a new index buffer
  102621. * @param indices defines the indices to store in the index buffer
  102622. * @param totalVertices defines the total number of vertices (could be null)
  102623. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  102624. */
  102625. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  102626. /**
  102627. * Return the total number of indices
  102628. * @returns the total number of indices
  102629. */
  102630. getTotalIndices(): number;
  102631. /**
  102632. * Gets the index buffer array
  102633. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  102634. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  102635. * @returns the index buffer array
  102636. */
  102637. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  102638. /**
  102639. * Gets the index buffer
  102640. * @return the index buffer
  102641. */
  102642. getIndexBuffer(): Nullable<DataBuffer>;
  102643. /** @hidden */
  102644. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  102645. /**
  102646. * Release the associated resources for a specific mesh
  102647. * @param mesh defines the source mesh
  102648. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  102649. */
  102650. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  102651. /**
  102652. * Apply current geometry to a given mesh
  102653. * @param mesh defines the mesh to apply geometry to
  102654. */
  102655. applyToMesh(mesh: Mesh): void;
  102656. private _updateExtend;
  102657. private _applyToMesh;
  102658. private notifyUpdate;
  102659. /**
  102660. * Load the geometry if it was flagged as delay loaded
  102661. * @param scene defines the hosting scene
  102662. * @param onLoaded defines a callback called when the geometry is loaded
  102663. */
  102664. load(scene: Scene, onLoaded?: () => void): void;
  102665. private _queueLoad;
  102666. /**
  102667. * Invert the geometry to move from a right handed system to a left handed one.
  102668. */
  102669. toLeftHanded(): void;
  102670. /** @hidden */
  102671. _resetPointsArrayCache(): void;
  102672. /** @hidden */
  102673. _generatePointsArray(): boolean;
  102674. /**
  102675. * Gets a value indicating if the geometry is disposed
  102676. * @returns true if the geometry was disposed
  102677. */
  102678. isDisposed(): boolean;
  102679. private _disposeVertexArrayObjects;
  102680. /**
  102681. * Free all associated resources
  102682. */
  102683. dispose(): void;
  102684. /**
  102685. * Clone the current geometry into a new geometry
  102686. * @param id defines the unique ID of the new geometry
  102687. * @returns a new geometry object
  102688. */
  102689. copy(id: string): Geometry;
  102690. /**
  102691. * Serialize the current geometry info (and not the vertices data) into a JSON object
  102692. * @return a JSON representation of the current geometry data (without the vertices data)
  102693. */
  102694. serialize(): any;
  102695. private toNumberArray;
  102696. /**
  102697. * Serialize all vertices data into a JSON oject
  102698. * @returns a JSON representation of the current geometry data
  102699. */
  102700. serializeVerticeData(): any;
  102701. /**
  102702. * Extracts a clone of a mesh geometry
  102703. * @param mesh defines the source mesh
  102704. * @param id defines the unique ID of the new geometry object
  102705. * @returns the new geometry object
  102706. */
  102707. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  102708. /**
  102709. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  102710. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  102711. * Be aware Math.random() could cause collisions, but:
  102712. * "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"
  102713. * @returns a string containing a new GUID
  102714. */
  102715. static RandomId(): string;
  102716. /** @hidden */
  102717. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  102718. private static _CleanMatricesWeights;
  102719. /**
  102720. * Create a new geometry from persisted data (Using .babylon file format)
  102721. * @param parsedVertexData defines the persisted data
  102722. * @param scene defines the hosting scene
  102723. * @param rootUrl defines the root url to use to load assets (like delayed data)
  102724. * @returns the new geometry object
  102725. */
  102726. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  102727. }
  102728. }
  102729. declare module BABYLON {
  102730. /**
  102731. * Define an interface for all classes that will get and set the data on vertices
  102732. */
  102733. export interface IGetSetVerticesData {
  102734. /**
  102735. * Gets a boolean indicating if specific vertex data is present
  102736. * @param kind defines the vertex data kind to use
  102737. * @returns true is data kind is present
  102738. */
  102739. isVerticesDataPresent(kind: string): boolean;
  102740. /**
  102741. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  102742. * @param kind defines the data kind (Position, normal, etc...)
  102743. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  102744. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  102745. * @returns a float array containing vertex data
  102746. */
  102747. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  102748. /**
  102749. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  102750. * @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.
  102751. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  102752. * @returns the indices array or an empty array if the mesh has no geometry
  102753. */
  102754. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  102755. /**
  102756. * Set specific vertex data
  102757. * @param kind defines the data kind (Position, normal, etc...)
  102758. * @param data defines the vertex data to use
  102759. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  102760. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  102761. */
  102762. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  102763. /**
  102764. * Update a specific associated vertex buffer
  102765. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  102766. * - VertexBuffer.PositionKind
  102767. * - VertexBuffer.UVKind
  102768. * - VertexBuffer.UV2Kind
  102769. * - VertexBuffer.UV3Kind
  102770. * - VertexBuffer.UV4Kind
  102771. * - VertexBuffer.UV5Kind
  102772. * - VertexBuffer.UV6Kind
  102773. * - VertexBuffer.ColorKind
  102774. * - VertexBuffer.MatricesIndicesKind
  102775. * - VertexBuffer.MatricesIndicesExtraKind
  102776. * - VertexBuffer.MatricesWeightsKind
  102777. * - VertexBuffer.MatricesWeightsExtraKind
  102778. * @param data defines the data source
  102779. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  102780. * @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)
  102781. */
  102782. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  102783. /**
  102784. * Creates a new index buffer
  102785. * @param indices defines the indices to store in the index buffer
  102786. * @param totalVertices defines the total number of vertices (could be null)
  102787. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  102788. */
  102789. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  102790. }
  102791. /**
  102792. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  102793. */
  102794. export class VertexData {
  102795. /**
  102796. * Mesh side orientation : usually the external or front surface
  102797. */
  102798. static readonly FRONTSIDE: number;
  102799. /**
  102800. * Mesh side orientation : usually the internal or back surface
  102801. */
  102802. static readonly BACKSIDE: number;
  102803. /**
  102804. * Mesh side orientation : both internal and external or front and back surfaces
  102805. */
  102806. static readonly DOUBLESIDE: number;
  102807. /**
  102808. * Mesh side orientation : by default, `FRONTSIDE`
  102809. */
  102810. static readonly DEFAULTSIDE: number;
  102811. /**
  102812. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  102813. */
  102814. positions: Nullable<FloatArray>;
  102815. /**
  102816. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  102817. */
  102818. normals: Nullable<FloatArray>;
  102819. /**
  102820. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  102821. */
  102822. tangents: Nullable<FloatArray>;
  102823. /**
  102824. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  102825. */
  102826. uvs: Nullable<FloatArray>;
  102827. /**
  102828. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  102829. */
  102830. uvs2: Nullable<FloatArray>;
  102831. /**
  102832. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  102833. */
  102834. uvs3: Nullable<FloatArray>;
  102835. /**
  102836. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  102837. */
  102838. uvs4: Nullable<FloatArray>;
  102839. /**
  102840. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  102841. */
  102842. uvs5: Nullable<FloatArray>;
  102843. /**
  102844. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  102845. */
  102846. uvs6: Nullable<FloatArray>;
  102847. /**
  102848. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  102849. */
  102850. colors: Nullable<FloatArray>;
  102851. /**
  102852. * 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).
  102853. */
  102854. matricesIndices: Nullable<FloatArray>;
  102855. /**
  102856. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  102857. */
  102858. matricesWeights: Nullable<FloatArray>;
  102859. /**
  102860. * An array extending the number of possible indices
  102861. */
  102862. matricesIndicesExtra: Nullable<FloatArray>;
  102863. /**
  102864. * An array extending the number of possible weights when the number of indices is extended
  102865. */
  102866. matricesWeightsExtra: Nullable<FloatArray>;
  102867. /**
  102868. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  102869. */
  102870. indices: Nullable<IndicesArray>;
  102871. /**
  102872. * Uses the passed data array to set the set the values for the specified kind of data
  102873. * @param data a linear array of floating numbers
  102874. * @param kind the type of data that is being set, eg positions, colors etc
  102875. */
  102876. set(data: FloatArray, kind: string): void;
  102877. /**
  102878. * Associates the vertexData to the passed Mesh.
  102879. * Sets it as updatable or not (default `false`)
  102880. * @param mesh the mesh the vertexData is applied to
  102881. * @param updatable when used and having the value true allows new data to update the vertexData
  102882. * @returns the VertexData
  102883. */
  102884. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  102885. /**
  102886. * Associates the vertexData to the passed Geometry.
  102887. * Sets it as updatable or not (default `false`)
  102888. * @param geometry the geometry the vertexData is applied to
  102889. * @param updatable when used and having the value true allows new data to update the vertexData
  102890. * @returns VertexData
  102891. */
  102892. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  102893. /**
  102894. * Updates the associated mesh
  102895. * @param mesh the mesh to be updated
  102896. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  102897. * @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
  102898. * @returns VertexData
  102899. */
  102900. updateMesh(mesh: Mesh): VertexData;
  102901. /**
  102902. * Updates the associated geometry
  102903. * @param geometry the geometry to be updated
  102904. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  102905. * @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
  102906. * @returns VertexData.
  102907. */
  102908. updateGeometry(geometry: Geometry): VertexData;
  102909. private _applyTo;
  102910. private _update;
  102911. /**
  102912. * Transforms each position and each normal of the vertexData according to the passed Matrix
  102913. * @param matrix the transforming matrix
  102914. * @returns the VertexData
  102915. */
  102916. transform(matrix: Matrix): VertexData;
  102917. /**
  102918. * Merges the passed VertexData into the current one
  102919. * @param other the VertexData to be merged into the current one
  102920. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  102921. * @returns the modified VertexData
  102922. */
  102923. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  102924. private _mergeElement;
  102925. private _validate;
  102926. /**
  102927. * Serializes the VertexData
  102928. * @returns a serialized object
  102929. */
  102930. serialize(): any;
  102931. /**
  102932. * Extracts the vertexData from a mesh
  102933. * @param mesh the mesh from which to extract the VertexData
  102934. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  102935. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  102936. * @returns the object VertexData associated to the passed mesh
  102937. */
  102938. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  102939. /**
  102940. * Extracts the vertexData from the geometry
  102941. * @param geometry the geometry from which to extract the VertexData
  102942. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  102943. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  102944. * @returns the object VertexData associated to the passed mesh
  102945. */
  102946. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  102947. private static _ExtractFrom;
  102948. /**
  102949. * Creates the VertexData for a Ribbon
  102950. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  102951. * * pathArray array of paths, each of which an array of successive Vector3
  102952. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  102953. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  102954. * * 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
  102955. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  102956. * * 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)
  102957. * * 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)
  102958. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  102959. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  102960. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  102961. * @returns the VertexData of the ribbon
  102962. */
  102963. static CreateRibbon(options: {
  102964. pathArray: Vector3[][];
  102965. closeArray?: boolean;
  102966. closePath?: boolean;
  102967. offset?: number;
  102968. sideOrientation?: number;
  102969. frontUVs?: Vector4;
  102970. backUVs?: Vector4;
  102971. invertUV?: boolean;
  102972. uvs?: Vector2[];
  102973. colors?: Color4[];
  102974. }): VertexData;
  102975. /**
  102976. * Creates the VertexData for a box
  102977. * @param options an object used to set the following optional parameters for the box, required but can be empty
  102978. * * size sets the width, height and depth of the box to the value of size, optional default 1
  102979. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  102980. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  102981. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  102982. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  102983. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  102984. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  102985. * * 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)
  102986. * * 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)
  102987. * @returns the VertexData of the box
  102988. */
  102989. static CreateBox(options: {
  102990. size?: number;
  102991. width?: number;
  102992. height?: number;
  102993. depth?: number;
  102994. faceUV?: Vector4[];
  102995. faceColors?: Color4[];
  102996. sideOrientation?: number;
  102997. frontUVs?: Vector4;
  102998. backUVs?: Vector4;
  102999. }): VertexData;
  103000. /**
  103001. * Creates the VertexData for a tiled box
  103002. * @param options an object used to set the following optional parameters for the box, required but can be empty
  103003. * * faceTiles sets the pattern, tile size and number of tiles for a face
  103004. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  103005. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  103006. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103007. * @returns the VertexData of the box
  103008. */
  103009. static CreateTiledBox(options: {
  103010. pattern?: number;
  103011. width?: number;
  103012. height?: number;
  103013. depth?: number;
  103014. tileSize?: number;
  103015. tileWidth?: number;
  103016. tileHeight?: number;
  103017. alignHorizontal?: number;
  103018. alignVertical?: number;
  103019. faceUV?: Vector4[];
  103020. faceColors?: Color4[];
  103021. sideOrientation?: number;
  103022. }): VertexData;
  103023. /**
  103024. * Creates the VertexData for a tiled plane
  103025. * @param options an object used to set the following optional parameters for the box, required but can be empty
  103026. * * pattern a limited pattern arrangement depending on the number
  103027. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  103028. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  103029. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  103030. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103031. * * 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)
  103032. * * 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)
  103033. * @returns the VertexData of the tiled plane
  103034. */
  103035. static CreateTiledPlane(options: {
  103036. pattern?: number;
  103037. tileSize?: number;
  103038. tileWidth?: number;
  103039. tileHeight?: number;
  103040. size?: number;
  103041. width?: number;
  103042. height?: number;
  103043. alignHorizontal?: number;
  103044. alignVertical?: number;
  103045. sideOrientation?: number;
  103046. frontUVs?: Vector4;
  103047. backUVs?: Vector4;
  103048. }): VertexData;
  103049. /**
  103050. * Creates the VertexData for an ellipsoid, defaults to a sphere
  103051. * @param options an object used to set the following optional parameters for the box, required but can be empty
  103052. * * segments sets the number of horizontal strips optional, default 32
  103053. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  103054. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  103055. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  103056. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  103057. * * 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
  103058. * * 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
  103059. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103060. * * 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)
  103061. * * 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)
  103062. * @returns the VertexData of the ellipsoid
  103063. */
  103064. static CreateSphere(options: {
  103065. segments?: number;
  103066. diameter?: number;
  103067. diameterX?: number;
  103068. diameterY?: number;
  103069. diameterZ?: number;
  103070. arc?: number;
  103071. slice?: number;
  103072. sideOrientation?: number;
  103073. frontUVs?: Vector4;
  103074. backUVs?: Vector4;
  103075. }): VertexData;
  103076. /**
  103077. * Creates the VertexData for a cylinder, cone or prism
  103078. * @param options an object used to set the following optional parameters for the box, required but can be empty
  103079. * * height sets the height (y direction) of the cylinder, optional, default 2
  103080. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  103081. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  103082. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  103083. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  103084. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  103085. * * 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
  103086. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  103087. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  103088. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  103089. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  103090. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103091. * * 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)
  103092. * * 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)
  103093. * @returns the VertexData of the cylinder, cone or prism
  103094. */
  103095. static CreateCylinder(options: {
  103096. height?: number;
  103097. diameterTop?: number;
  103098. diameterBottom?: number;
  103099. diameter?: number;
  103100. tessellation?: number;
  103101. subdivisions?: number;
  103102. arc?: number;
  103103. faceColors?: Color4[];
  103104. faceUV?: Vector4[];
  103105. hasRings?: boolean;
  103106. enclose?: boolean;
  103107. sideOrientation?: number;
  103108. frontUVs?: Vector4;
  103109. backUVs?: Vector4;
  103110. }): VertexData;
  103111. /**
  103112. * Creates the VertexData for a torus
  103113. * @param options an object used to set the following optional parameters for the box, required but can be empty
  103114. * * diameter the diameter of the torus, optional default 1
  103115. * * thickness the diameter of the tube forming the torus, optional default 0.5
  103116. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  103117. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103118. * * 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)
  103119. * * 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)
  103120. * @returns the VertexData of the torus
  103121. */
  103122. static CreateTorus(options: {
  103123. diameter?: number;
  103124. thickness?: number;
  103125. tessellation?: number;
  103126. sideOrientation?: number;
  103127. frontUVs?: Vector4;
  103128. backUVs?: Vector4;
  103129. }): VertexData;
  103130. /**
  103131. * Creates the VertexData of the LineSystem
  103132. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  103133. * - lines an array of lines, each line being an array of successive Vector3
  103134. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  103135. * @returns the VertexData of the LineSystem
  103136. */
  103137. static CreateLineSystem(options: {
  103138. lines: Vector3[][];
  103139. colors?: Nullable<Color4[][]>;
  103140. }): VertexData;
  103141. /**
  103142. * Create the VertexData for a DashedLines
  103143. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  103144. * - points an array successive Vector3
  103145. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  103146. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  103147. * - dashNb the intended total number of dashes, optional, default 200
  103148. * @returns the VertexData for the DashedLines
  103149. */
  103150. static CreateDashedLines(options: {
  103151. points: Vector3[];
  103152. dashSize?: number;
  103153. gapSize?: number;
  103154. dashNb?: number;
  103155. }): VertexData;
  103156. /**
  103157. * Creates the VertexData for a Ground
  103158. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  103159. * - width the width (x direction) of the ground, optional, default 1
  103160. * - height the height (z direction) of the ground, optional, default 1
  103161. * - subdivisions the number of subdivisions per side, optional, default 1
  103162. * @returns the VertexData of the Ground
  103163. */
  103164. static CreateGround(options: {
  103165. width?: number;
  103166. height?: number;
  103167. subdivisions?: number;
  103168. subdivisionsX?: number;
  103169. subdivisionsY?: number;
  103170. }): VertexData;
  103171. /**
  103172. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  103173. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  103174. * * xmin the ground minimum X coordinate, optional, default -1
  103175. * * zmin the ground minimum Z coordinate, optional, default -1
  103176. * * xmax the ground maximum X coordinate, optional, default 1
  103177. * * zmax the ground maximum Z coordinate, optional, default 1
  103178. * * 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}
  103179. * * 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}
  103180. * @returns the VertexData of the TiledGround
  103181. */
  103182. static CreateTiledGround(options: {
  103183. xmin: number;
  103184. zmin: number;
  103185. xmax: number;
  103186. zmax: number;
  103187. subdivisions?: {
  103188. w: number;
  103189. h: number;
  103190. };
  103191. precision?: {
  103192. w: number;
  103193. h: number;
  103194. };
  103195. }): VertexData;
  103196. /**
  103197. * Creates the VertexData of the Ground designed from a heightmap
  103198. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  103199. * * width the width (x direction) of the ground
  103200. * * height the height (z direction) of the ground
  103201. * * subdivisions the number of subdivisions per side
  103202. * * minHeight the minimum altitude on the ground, optional, default 0
  103203. * * maxHeight the maximum altitude on the ground, optional default 1
  103204. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  103205. * * buffer the array holding the image color data
  103206. * * bufferWidth the width of image
  103207. * * bufferHeight the height of image
  103208. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  103209. * @returns the VertexData of the Ground designed from a heightmap
  103210. */
  103211. static CreateGroundFromHeightMap(options: {
  103212. width: number;
  103213. height: number;
  103214. subdivisions: number;
  103215. minHeight: number;
  103216. maxHeight: number;
  103217. colorFilter: Color3;
  103218. buffer: Uint8Array;
  103219. bufferWidth: number;
  103220. bufferHeight: number;
  103221. alphaFilter: number;
  103222. }): VertexData;
  103223. /**
  103224. * Creates the VertexData for a Plane
  103225. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  103226. * * size sets the width and height of the plane to the value of size, optional default 1
  103227. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  103228. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  103229. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103230. * * 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)
  103231. * * 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)
  103232. * @returns the VertexData of the box
  103233. */
  103234. static CreatePlane(options: {
  103235. size?: number;
  103236. width?: number;
  103237. height?: number;
  103238. sideOrientation?: number;
  103239. frontUVs?: Vector4;
  103240. backUVs?: Vector4;
  103241. }): VertexData;
  103242. /**
  103243. * Creates the VertexData of the Disc or regular Polygon
  103244. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  103245. * * radius the radius of the disc, optional default 0.5
  103246. * * tessellation the number of polygon sides, optional, default 64
  103247. * * 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
  103248. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103249. * * 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)
  103250. * * 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)
  103251. * @returns the VertexData of the box
  103252. */
  103253. static CreateDisc(options: {
  103254. radius?: number;
  103255. tessellation?: number;
  103256. arc?: number;
  103257. sideOrientation?: number;
  103258. frontUVs?: Vector4;
  103259. backUVs?: Vector4;
  103260. }): VertexData;
  103261. /**
  103262. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  103263. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  103264. * @param polygon a mesh built from polygonTriangulation.build()
  103265. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103266. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  103267. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  103268. * @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)
  103269. * @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)
  103270. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  103271. * @returns the VertexData of the Polygon
  103272. */
  103273. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  103274. /**
  103275. * Creates the VertexData of the IcoSphere
  103276. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  103277. * * radius the radius of the IcoSphere, optional default 1
  103278. * * radiusX allows stretching in the x direction, optional, default radius
  103279. * * radiusY allows stretching in the y direction, optional, default radius
  103280. * * radiusZ allows stretching in the z direction, optional, default radius
  103281. * * flat when true creates a flat shaded mesh, optional, default true
  103282. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  103283. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103284. * * 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)
  103285. * * 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)
  103286. * @returns the VertexData of the IcoSphere
  103287. */
  103288. static CreateIcoSphere(options: {
  103289. radius?: number;
  103290. radiusX?: number;
  103291. radiusY?: number;
  103292. radiusZ?: number;
  103293. flat?: boolean;
  103294. subdivisions?: number;
  103295. sideOrientation?: number;
  103296. frontUVs?: Vector4;
  103297. backUVs?: Vector4;
  103298. }): VertexData;
  103299. /**
  103300. * Creates the VertexData for a Polyhedron
  103301. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  103302. * * type provided types are:
  103303. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  103304. * * 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)
  103305. * * size the size of the IcoSphere, optional default 1
  103306. * * sizeX allows stretching in the x direction, optional, default size
  103307. * * sizeY allows stretching in the y direction, optional, default size
  103308. * * sizeZ allows stretching in the z direction, optional, default size
  103309. * * 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
  103310. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  103311. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  103312. * * flat when true creates a flat shaded mesh, optional, default true
  103313. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  103314. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103315. * * 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)
  103316. * * 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)
  103317. * @returns the VertexData of the Polyhedron
  103318. */
  103319. static CreatePolyhedron(options: {
  103320. type?: number;
  103321. size?: number;
  103322. sizeX?: number;
  103323. sizeY?: number;
  103324. sizeZ?: number;
  103325. custom?: any;
  103326. faceUV?: Vector4[];
  103327. faceColors?: Color4[];
  103328. flat?: boolean;
  103329. sideOrientation?: number;
  103330. frontUVs?: Vector4;
  103331. backUVs?: Vector4;
  103332. }): VertexData;
  103333. /**
  103334. * Creates the VertexData for a TorusKnot
  103335. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  103336. * * radius the radius of the torus knot, optional, default 2
  103337. * * tube the thickness of the tube, optional, default 0.5
  103338. * * radialSegments the number of sides on each tube segments, optional, default 32
  103339. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  103340. * * p the number of windings around the z axis, optional, default 2
  103341. * * q the number of windings around the x axis, optional, default 3
  103342. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  103343. * * 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)
  103344. * * 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)
  103345. * @returns the VertexData of the Torus Knot
  103346. */
  103347. static CreateTorusKnot(options: {
  103348. radius?: number;
  103349. tube?: number;
  103350. radialSegments?: number;
  103351. tubularSegments?: number;
  103352. p?: number;
  103353. q?: number;
  103354. sideOrientation?: number;
  103355. frontUVs?: Vector4;
  103356. backUVs?: Vector4;
  103357. }): VertexData;
  103358. /**
  103359. * Compute normals for given positions and indices
  103360. * @param positions an array of vertex positions, [...., x, y, z, ......]
  103361. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  103362. * @param normals an array of vertex normals, [...., x, y, z, ......]
  103363. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  103364. * * facetNormals : optional array of facet normals (vector3)
  103365. * * facetPositions : optional array of facet positions (vector3)
  103366. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  103367. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  103368. * * bInfo : optional bounding info, required for facetPartitioning computation
  103369. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  103370. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  103371. * * useRightHandedSystem: optional boolean to for right handed system computation
  103372. * * depthSort : optional boolean to enable the facet depth sort computation
  103373. * * distanceTo : optional Vector3 to compute the facet depth from this location
  103374. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  103375. */
  103376. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  103377. facetNormals?: any;
  103378. facetPositions?: any;
  103379. facetPartitioning?: any;
  103380. ratio?: number;
  103381. bInfo?: any;
  103382. bbSize?: Vector3;
  103383. subDiv?: any;
  103384. useRightHandedSystem?: boolean;
  103385. depthSort?: boolean;
  103386. distanceTo?: Vector3;
  103387. depthSortedFacets?: any;
  103388. }): void;
  103389. /** @hidden */
  103390. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  103391. /**
  103392. * Applies VertexData created from the imported parameters to the geometry
  103393. * @param parsedVertexData the parsed data from an imported file
  103394. * @param geometry the geometry to apply the VertexData to
  103395. */
  103396. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  103397. }
  103398. }
  103399. declare module BABYLON {
  103400. /**
  103401. * Defines a target to use with MorphTargetManager
  103402. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  103403. */
  103404. export class MorphTarget implements IAnimatable {
  103405. /** defines the name of the target */
  103406. name: string;
  103407. /**
  103408. * Gets or sets the list of animations
  103409. */
  103410. animations: Animation[];
  103411. private _scene;
  103412. private _positions;
  103413. private _normals;
  103414. private _tangents;
  103415. private _uvs;
  103416. private _influence;
  103417. private _uniqueId;
  103418. /**
  103419. * Observable raised when the influence changes
  103420. */
  103421. onInfluenceChanged: Observable<boolean>;
  103422. /** @hidden */
  103423. _onDataLayoutChanged: Observable<void>;
  103424. /**
  103425. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  103426. */
  103427. get influence(): number;
  103428. set influence(influence: number);
  103429. /**
  103430. * Gets or sets the id of the morph Target
  103431. */
  103432. id: string;
  103433. private _animationPropertiesOverride;
  103434. /**
  103435. * Gets or sets the animation properties override
  103436. */
  103437. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  103438. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  103439. /**
  103440. * Creates a new MorphTarget
  103441. * @param name defines the name of the target
  103442. * @param influence defines the influence to use
  103443. * @param scene defines the scene the morphtarget belongs to
  103444. */
  103445. constructor(
  103446. /** defines the name of the target */
  103447. name: string, influence?: number, scene?: Nullable<Scene>);
  103448. /**
  103449. * Gets the unique ID of this manager
  103450. */
  103451. get uniqueId(): number;
  103452. /**
  103453. * Gets a boolean defining if the target contains position data
  103454. */
  103455. get hasPositions(): boolean;
  103456. /**
  103457. * Gets a boolean defining if the target contains normal data
  103458. */
  103459. get hasNormals(): boolean;
  103460. /**
  103461. * Gets a boolean defining if the target contains tangent data
  103462. */
  103463. get hasTangents(): boolean;
  103464. /**
  103465. * Gets a boolean defining if the target contains texture coordinates data
  103466. */
  103467. get hasUVs(): boolean;
  103468. /**
  103469. * Affects position data to this target
  103470. * @param data defines the position data to use
  103471. */
  103472. setPositions(data: Nullable<FloatArray>): void;
  103473. /**
  103474. * Gets the position data stored in this target
  103475. * @returns a FloatArray containing the position data (or null if not present)
  103476. */
  103477. getPositions(): Nullable<FloatArray>;
  103478. /**
  103479. * Affects normal data to this target
  103480. * @param data defines the normal data to use
  103481. */
  103482. setNormals(data: Nullable<FloatArray>): void;
  103483. /**
  103484. * Gets the normal data stored in this target
  103485. * @returns a FloatArray containing the normal data (or null if not present)
  103486. */
  103487. getNormals(): Nullable<FloatArray>;
  103488. /**
  103489. * Affects tangent data to this target
  103490. * @param data defines the tangent data to use
  103491. */
  103492. setTangents(data: Nullable<FloatArray>): void;
  103493. /**
  103494. * Gets the tangent data stored in this target
  103495. * @returns a FloatArray containing the tangent data (or null if not present)
  103496. */
  103497. getTangents(): Nullable<FloatArray>;
  103498. /**
  103499. * Affects texture coordinates data to this target
  103500. * @param data defines the texture coordinates data to use
  103501. */
  103502. setUVs(data: Nullable<FloatArray>): void;
  103503. /**
  103504. * Gets the texture coordinates data stored in this target
  103505. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  103506. */
  103507. getUVs(): Nullable<FloatArray>;
  103508. /**
  103509. * Clone the current target
  103510. * @returns a new MorphTarget
  103511. */
  103512. clone(): MorphTarget;
  103513. /**
  103514. * Serializes the current target into a Serialization object
  103515. * @returns the serialized object
  103516. */
  103517. serialize(): any;
  103518. /**
  103519. * Returns the string "MorphTarget"
  103520. * @returns "MorphTarget"
  103521. */
  103522. getClassName(): string;
  103523. /**
  103524. * Creates a new target from serialized data
  103525. * @param serializationObject defines the serialized data to use
  103526. * @returns a new MorphTarget
  103527. */
  103528. static Parse(serializationObject: any): MorphTarget;
  103529. /**
  103530. * Creates a MorphTarget from mesh data
  103531. * @param mesh defines the source mesh
  103532. * @param name defines the name to use for the new target
  103533. * @param influence defines the influence to attach to the target
  103534. * @returns a new MorphTarget
  103535. */
  103536. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  103537. }
  103538. }
  103539. declare module BABYLON {
  103540. /**
  103541. * This class is used to deform meshes using morphing between different targets
  103542. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  103543. */
  103544. export class MorphTargetManager {
  103545. private _targets;
  103546. private _targetInfluenceChangedObservers;
  103547. private _targetDataLayoutChangedObservers;
  103548. private _activeTargets;
  103549. private _scene;
  103550. private _influences;
  103551. private _supportsNormals;
  103552. private _supportsTangents;
  103553. private _supportsUVs;
  103554. private _vertexCount;
  103555. private _uniqueId;
  103556. private _tempInfluences;
  103557. /**
  103558. * Gets or sets a boolean indicating if normals must be morphed
  103559. */
  103560. enableNormalMorphing: boolean;
  103561. /**
  103562. * Gets or sets a boolean indicating if tangents must be morphed
  103563. */
  103564. enableTangentMorphing: boolean;
  103565. /**
  103566. * Gets or sets a boolean indicating if UV must be morphed
  103567. */
  103568. enableUVMorphing: boolean;
  103569. /**
  103570. * Creates a new MorphTargetManager
  103571. * @param scene defines the current scene
  103572. */
  103573. constructor(scene?: Nullable<Scene>);
  103574. /**
  103575. * Gets the unique ID of this manager
  103576. */
  103577. get uniqueId(): number;
  103578. /**
  103579. * Gets the number of vertices handled by this manager
  103580. */
  103581. get vertexCount(): number;
  103582. /**
  103583. * Gets a boolean indicating if this manager supports morphing of normals
  103584. */
  103585. get supportsNormals(): boolean;
  103586. /**
  103587. * Gets a boolean indicating if this manager supports morphing of tangents
  103588. */
  103589. get supportsTangents(): boolean;
  103590. /**
  103591. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  103592. */
  103593. get supportsUVs(): boolean;
  103594. /**
  103595. * Gets the number of targets stored in this manager
  103596. */
  103597. get numTargets(): number;
  103598. /**
  103599. * Gets the number of influencers (ie. the number of targets with influences > 0)
  103600. */
  103601. get numInfluencers(): number;
  103602. /**
  103603. * Gets the list of influences (one per target)
  103604. */
  103605. get influences(): Float32Array;
  103606. /**
  103607. * Gets the active target at specified index. An active target is a target with an influence > 0
  103608. * @param index defines the index to check
  103609. * @returns the requested target
  103610. */
  103611. getActiveTarget(index: number): MorphTarget;
  103612. /**
  103613. * Gets the target at specified index
  103614. * @param index defines the index to check
  103615. * @returns the requested target
  103616. */
  103617. getTarget(index: number): MorphTarget;
  103618. /**
  103619. * Add a new target to this manager
  103620. * @param target defines the target to add
  103621. */
  103622. addTarget(target: MorphTarget): void;
  103623. /**
  103624. * Removes a target from the manager
  103625. * @param target defines the target to remove
  103626. */
  103627. removeTarget(target: MorphTarget): void;
  103628. /**
  103629. * Clone the current manager
  103630. * @returns a new MorphTargetManager
  103631. */
  103632. clone(): MorphTargetManager;
  103633. /**
  103634. * Serializes the current manager into a Serialization object
  103635. * @returns the serialized object
  103636. */
  103637. serialize(): any;
  103638. private _syncActiveTargets;
  103639. /**
  103640. * Syncrhonize the targets with all the meshes using this morph target manager
  103641. */
  103642. synchronize(): void;
  103643. /**
  103644. * Creates a new MorphTargetManager from serialized data
  103645. * @param serializationObject defines the serialized data
  103646. * @param scene defines the hosting scene
  103647. * @returns the new MorphTargetManager
  103648. */
  103649. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  103650. }
  103651. }
  103652. declare module BABYLON {
  103653. /**
  103654. * Class used to represent a specific level of detail of a mesh
  103655. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  103656. */
  103657. export class MeshLODLevel {
  103658. /** Defines the distance where this level should start being displayed */
  103659. distance: number;
  103660. /** Defines the mesh to use to render this level */
  103661. mesh: Nullable<Mesh>;
  103662. /**
  103663. * Creates a new LOD level
  103664. * @param distance defines the distance where this level should star being displayed
  103665. * @param mesh defines the mesh to use to render this level
  103666. */
  103667. constructor(
  103668. /** Defines the distance where this level should start being displayed */
  103669. distance: number,
  103670. /** Defines the mesh to use to render this level */
  103671. mesh: Nullable<Mesh>);
  103672. }
  103673. }
  103674. declare module BABYLON {
  103675. /**
  103676. * Helper class used to generate a canvas to manipulate images
  103677. */
  103678. export class CanvasGenerator {
  103679. /**
  103680. * Create a new canvas (or offscreen canvas depending on the context)
  103681. * @param width defines the expected width
  103682. * @param height defines the expected height
  103683. * @return a new canvas or offscreen canvas
  103684. */
  103685. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  103686. }
  103687. }
  103688. declare module BABYLON {
  103689. /**
  103690. * Mesh representing the gorund
  103691. */
  103692. export class GroundMesh extends Mesh {
  103693. /** If octree should be generated */
  103694. generateOctree: boolean;
  103695. private _heightQuads;
  103696. /** @hidden */
  103697. _subdivisionsX: number;
  103698. /** @hidden */
  103699. _subdivisionsY: number;
  103700. /** @hidden */
  103701. _width: number;
  103702. /** @hidden */
  103703. _height: number;
  103704. /** @hidden */
  103705. _minX: number;
  103706. /** @hidden */
  103707. _maxX: number;
  103708. /** @hidden */
  103709. _minZ: number;
  103710. /** @hidden */
  103711. _maxZ: number;
  103712. constructor(name: string, scene: Scene);
  103713. /**
  103714. * "GroundMesh"
  103715. * @returns "GroundMesh"
  103716. */
  103717. getClassName(): string;
  103718. /**
  103719. * The minimum of x and y subdivisions
  103720. */
  103721. get subdivisions(): number;
  103722. /**
  103723. * X subdivisions
  103724. */
  103725. get subdivisionsX(): number;
  103726. /**
  103727. * Y subdivisions
  103728. */
  103729. get subdivisionsY(): number;
  103730. /**
  103731. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  103732. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  103733. * @param chunksCount the number of subdivisions for x and y
  103734. * @param octreeBlocksSize (Default: 32)
  103735. */
  103736. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  103737. /**
  103738. * Returns a height (y) value in the Worl system :
  103739. * the ground altitude at the coordinates (x, z) expressed in the World system.
  103740. * @param x x coordinate
  103741. * @param z z coordinate
  103742. * @returns the ground y position if (x, z) are outside the ground surface.
  103743. */
  103744. getHeightAtCoordinates(x: number, z: number): number;
  103745. /**
  103746. * Returns a normalized vector (Vector3) orthogonal to the ground
  103747. * at the ground coordinates (x, z) expressed in the World system.
  103748. * @param x x coordinate
  103749. * @param z z coordinate
  103750. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  103751. */
  103752. getNormalAtCoordinates(x: number, z: number): Vector3;
  103753. /**
  103754. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  103755. * at the ground coordinates (x, z) expressed in the World system.
  103756. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  103757. * @param x x coordinate
  103758. * @param z z coordinate
  103759. * @param ref vector to store the result
  103760. * @returns the GroundMesh.
  103761. */
  103762. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  103763. /**
  103764. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  103765. * if the ground has been updated.
  103766. * This can be used in the render loop.
  103767. * @returns the GroundMesh.
  103768. */
  103769. updateCoordinateHeights(): GroundMesh;
  103770. private _getFacetAt;
  103771. private _initHeightQuads;
  103772. private _computeHeightQuads;
  103773. /**
  103774. * Serializes this ground mesh
  103775. * @param serializationObject object to write serialization to
  103776. */
  103777. serialize(serializationObject: any): void;
  103778. /**
  103779. * Parses a serialized ground mesh
  103780. * @param parsedMesh the serialized mesh
  103781. * @param scene the scene to create the ground mesh in
  103782. * @returns the created ground mesh
  103783. */
  103784. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  103785. }
  103786. }
  103787. declare module BABYLON {
  103788. /**
  103789. * Interface for Physics-Joint data
  103790. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  103791. */
  103792. export interface PhysicsJointData {
  103793. /**
  103794. * The main pivot of the joint
  103795. */
  103796. mainPivot?: Vector3;
  103797. /**
  103798. * The connected pivot of the joint
  103799. */
  103800. connectedPivot?: Vector3;
  103801. /**
  103802. * The main axis of the joint
  103803. */
  103804. mainAxis?: Vector3;
  103805. /**
  103806. * The connected axis of the joint
  103807. */
  103808. connectedAxis?: Vector3;
  103809. /**
  103810. * The collision of the joint
  103811. */
  103812. collision?: boolean;
  103813. /**
  103814. * Native Oimo/Cannon/Energy data
  103815. */
  103816. nativeParams?: any;
  103817. }
  103818. /**
  103819. * This is a holder class for the physics joint created by the physics plugin
  103820. * It holds a set of functions to control the underlying joint
  103821. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  103822. */
  103823. export class PhysicsJoint {
  103824. /**
  103825. * The type of the physics joint
  103826. */
  103827. type: number;
  103828. /**
  103829. * The data for the physics joint
  103830. */
  103831. jointData: PhysicsJointData;
  103832. private _physicsJoint;
  103833. protected _physicsPlugin: IPhysicsEnginePlugin;
  103834. /**
  103835. * Initializes the physics joint
  103836. * @param type The type of the physics joint
  103837. * @param jointData The data for the physics joint
  103838. */
  103839. constructor(
  103840. /**
  103841. * The type of the physics joint
  103842. */
  103843. type: number,
  103844. /**
  103845. * The data for the physics joint
  103846. */
  103847. jointData: PhysicsJointData);
  103848. /**
  103849. * Gets the physics joint
  103850. */
  103851. get physicsJoint(): any;
  103852. /**
  103853. * Sets the physics joint
  103854. */
  103855. set physicsJoint(newJoint: any);
  103856. /**
  103857. * Sets the physics plugin
  103858. */
  103859. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  103860. /**
  103861. * Execute a function that is physics-plugin specific.
  103862. * @param {Function} func the function that will be executed.
  103863. * It accepts two parameters: the physics world and the physics joint
  103864. */
  103865. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  103866. /**
  103867. * Distance-Joint type
  103868. */
  103869. static DistanceJoint: number;
  103870. /**
  103871. * Hinge-Joint type
  103872. */
  103873. static HingeJoint: number;
  103874. /**
  103875. * Ball-and-Socket joint type
  103876. */
  103877. static BallAndSocketJoint: number;
  103878. /**
  103879. * Wheel-Joint type
  103880. */
  103881. static WheelJoint: number;
  103882. /**
  103883. * Slider-Joint type
  103884. */
  103885. static SliderJoint: number;
  103886. /**
  103887. * Prismatic-Joint type
  103888. */
  103889. static PrismaticJoint: number;
  103890. /**
  103891. * Universal-Joint type
  103892. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  103893. */
  103894. static UniversalJoint: number;
  103895. /**
  103896. * Hinge-Joint 2 type
  103897. */
  103898. static Hinge2Joint: number;
  103899. /**
  103900. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  103901. */
  103902. static PointToPointJoint: number;
  103903. /**
  103904. * Spring-Joint type
  103905. */
  103906. static SpringJoint: number;
  103907. /**
  103908. * Lock-Joint type
  103909. */
  103910. static LockJoint: number;
  103911. }
  103912. /**
  103913. * A class representing a physics distance joint
  103914. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  103915. */
  103916. export class DistanceJoint extends PhysicsJoint {
  103917. /**
  103918. *
  103919. * @param jointData The data for the Distance-Joint
  103920. */
  103921. constructor(jointData: DistanceJointData);
  103922. /**
  103923. * Update the predefined distance.
  103924. * @param maxDistance The maximum preferred distance
  103925. * @param minDistance The minimum preferred distance
  103926. */
  103927. updateDistance(maxDistance: number, minDistance?: number): void;
  103928. }
  103929. /**
  103930. * Represents a Motor-Enabled Joint
  103931. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  103932. */
  103933. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  103934. /**
  103935. * Initializes the Motor-Enabled Joint
  103936. * @param type The type of the joint
  103937. * @param jointData The physica joint data for the joint
  103938. */
  103939. constructor(type: number, jointData: PhysicsJointData);
  103940. /**
  103941. * Set the motor values.
  103942. * Attention, this function is plugin specific. Engines won't react 100% the same.
  103943. * @param force the force to apply
  103944. * @param maxForce max force for this motor.
  103945. */
  103946. setMotor(force?: number, maxForce?: number): void;
  103947. /**
  103948. * Set the motor's limits.
  103949. * Attention, this function is plugin specific. Engines won't react 100% the same.
  103950. * @param upperLimit The upper limit of the motor
  103951. * @param lowerLimit The lower limit of the motor
  103952. */
  103953. setLimit(upperLimit: number, lowerLimit?: number): void;
  103954. }
  103955. /**
  103956. * This class represents a single physics Hinge-Joint
  103957. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  103958. */
  103959. export class HingeJoint extends MotorEnabledJoint {
  103960. /**
  103961. * Initializes the Hinge-Joint
  103962. * @param jointData The joint data for the Hinge-Joint
  103963. */
  103964. constructor(jointData: PhysicsJointData);
  103965. /**
  103966. * Set the motor values.
  103967. * Attention, this function is plugin specific. Engines won't react 100% the same.
  103968. * @param {number} force the force to apply
  103969. * @param {number} maxForce max force for this motor.
  103970. */
  103971. setMotor(force?: number, maxForce?: number): void;
  103972. /**
  103973. * Set the motor's limits.
  103974. * Attention, this function is plugin specific. Engines won't react 100% the same.
  103975. * @param upperLimit The upper limit of the motor
  103976. * @param lowerLimit The lower limit of the motor
  103977. */
  103978. setLimit(upperLimit: number, lowerLimit?: number): void;
  103979. }
  103980. /**
  103981. * This class represents a dual hinge physics joint (same as wheel joint)
  103982. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  103983. */
  103984. export class Hinge2Joint extends MotorEnabledJoint {
  103985. /**
  103986. * Initializes the Hinge2-Joint
  103987. * @param jointData The joint data for the Hinge2-Joint
  103988. */
  103989. constructor(jointData: PhysicsJointData);
  103990. /**
  103991. * Set the motor values.
  103992. * Attention, this function is plugin specific. Engines won't react 100% the same.
  103993. * @param {number} targetSpeed the speed the motor is to reach
  103994. * @param {number} maxForce max force for this motor.
  103995. * @param {motorIndex} the motor's index, 0 or 1.
  103996. */
  103997. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  103998. /**
  103999. * Set the motor limits.
  104000. * Attention, this function is plugin specific. Engines won't react 100% the same.
  104001. * @param {number} upperLimit the upper limit
  104002. * @param {number} lowerLimit lower limit
  104003. * @param {motorIndex} the motor's index, 0 or 1.
  104004. */
  104005. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  104006. }
  104007. /**
  104008. * Interface for a motor enabled joint
  104009. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  104010. */
  104011. export interface IMotorEnabledJoint {
  104012. /**
  104013. * Physics joint
  104014. */
  104015. physicsJoint: any;
  104016. /**
  104017. * Sets the motor of the motor-enabled joint
  104018. * @param force The force of the motor
  104019. * @param maxForce The maximum force of the motor
  104020. * @param motorIndex The index of the motor
  104021. */
  104022. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  104023. /**
  104024. * Sets the limit of the motor
  104025. * @param upperLimit The upper limit of the motor
  104026. * @param lowerLimit The lower limit of the motor
  104027. * @param motorIndex The index of the motor
  104028. */
  104029. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  104030. }
  104031. /**
  104032. * Joint data for a Distance-Joint
  104033. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  104034. */
  104035. export interface DistanceJointData extends PhysicsJointData {
  104036. /**
  104037. * Max distance the 2 joint objects can be apart
  104038. */
  104039. maxDistance: number;
  104040. }
  104041. /**
  104042. * Joint data from a spring joint
  104043. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  104044. */
  104045. export interface SpringJointData extends PhysicsJointData {
  104046. /**
  104047. * Length of the spring
  104048. */
  104049. length: number;
  104050. /**
  104051. * Stiffness of the spring
  104052. */
  104053. stiffness: number;
  104054. /**
  104055. * Damping of the spring
  104056. */
  104057. damping: number;
  104058. /** this callback will be called when applying the force to the impostors. */
  104059. forceApplicationCallback: () => void;
  104060. }
  104061. }
  104062. declare module BABYLON {
  104063. /**
  104064. * Holds the data for the raycast result
  104065. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  104066. */
  104067. export class PhysicsRaycastResult {
  104068. private _hasHit;
  104069. private _hitDistance;
  104070. private _hitNormalWorld;
  104071. private _hitPointWorld;
  104072. private _rayFromWorld;
  104073. private _rayToWorld;
  104074. /**
  104075. * Gets if there was a hit
  104076. */
  104077. get hasHit(): boolean;
  104078. /**
  104079. * Gets the distance from the hit
  104080. */
  104081. get hitDistance(): number;
  104082. /**
  104083. * Gets the hit normal/direction in the world
  104084. */
  104085. get hitNormalWorld(): Vector3;
  104086. /**
  104087. * Gets the hit point in the world
  104088. */
  104089. get hitPointWorld(): Vector3;
  104090. /**
  104091. * Gets the ray "start point" of the ray in the world
  104092. */
  104093. get rayFromWorld(): Vector3;
  104094. /**
  104095. * Gets the ray "end point" of the ray in the world
  104096. */
  104097. get rayToWorld(): Vector3;
  104098. /**
  104099. * Sets the hit data (normal & point in world space)
  104100. * @param hitNormalWorld defines the normal in world space
  104101. * @param hitPointWorld defines the point in world space
  104102. */
  104103. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  104104. /**
  104105. * Sets the distance from the start point to the hit point
  104106. * @param distance
  104107. */
  104108. setHitDistance(distance: number): void;
  104109. /**
  104110. * Calculates the distance manually
  104111. */
  104112. calculateHitDistance(): void;
  104113. /**
  104114. * Resets all the values to default
  104115. * @param from The from point on world space
  104116. * @param to The to point on world space
  104117. */
  104118. reset(from?: Vector3, to?: Vector3): void;
  104119. }
  104120. /**
  104121. * Interface for the size containing width and height
  104122. */
  104123. interface IXYZ {
  104124. /**
  104125. * X
  104126. */
  104127. x: number;
  104128. /**
  104129. * Y
  104130. */
  104131. y: number;
  104132. /**
  104133. * Z
  104134. */
  104135. z: number;
  104136. }
  104137. }
  104138. declare module BABYLON {
  104139. /**
  104140. * Interface used to describe a physics joint
  104141. */
  104142. export interface PhysicsImpostorJoint {
  104143. /** Defines the main impostor to which the joint is linked */
  104144. mainImpostor: PhysicsImpostor;
  104145. /** Defines the impostor that is connected to the main impostor using this joint */
  104146. connectedImpostor: PhysicsImpostor;
  104147. /** Defines the joint itself */
  104148. joint: PhysicsJoint;
  104149. }
  104150. /** @hidden */
  104151. export interface IPhysicsEnginePlugin {
  104152. world: any;
  104153. name: string;
  104154. setGravity(gravity: Vector3): void;
  104155. setTimeStep(timeStep: number): void;
  104156. getTimeStep(): number;
  104157. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  104158. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  104159. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  104160. generatePhysicsBody(impostor: PhysicsImpostor): void;
  104161. removePhysicsBody(impostor: PhysicsImpostor): void;
  104162. generateJoint(joint: PhysicsImpostorJoint): void;
  104163. removeJoint(joint: PhysicsImpostorJoint): void;
  104164. isSupported(): boolean;
  104165. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  104166. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  104167. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  104168. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  104169. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  104170. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  104171. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  104172. getBodyMass(impostor: PhysicsImpostor): number;
  104173. getBodyFriction(impostor: PhysicsImpostor): number;
  104174. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  104175. getBodyRestitution(impostor: PhysicsImpostor): number;
  104176. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  104177. getBodyPressure?(impostor: PhysicsImpostor): number;
  104178. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  104179. getBodyStiffness?(impostor: PhysicsImpostor): number;
  104180. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  104181. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  104182. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  104183. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  104184. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  104185. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  104186. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  104187. sleepBody(impostor: PhysicsImpostor): void;
  104188. wakeUpBody(impostor: PhysicsImpostor): void;
  104189. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  104190. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  104191. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  104192. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  104193. getRadius(impostor: PhysicsImpostor): number;
  104194. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  104195. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  104196. dispose(): void;
  104197. }
  104198. /**
  104199. * Interface used to define a physics engine
  104200. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  104201. */
  104202. export interface IPhysicsEngine {
  104203. /**
  104204. * Gets the gravity vector used by the simulation
  104205. */
  104206. gravity: Vector3;
  104207. /**
  104208. * Sets the gravity vector used by the simulation
  104209. * @param gravity defines the gravity vector to use
  104210. */
  104211. setGravity(gravity: Vector3): void;
  104212. /**
  104213. * Set the time step of the physics engine.
  104214. * Default is 1/60.
  104215. * To slow it down, enter 1/600 for example.
  104216. * To speed it up, 1/30
  104217. * @param newTimeStep the new timestep to apply to this world.
  104218. */
  104219. setTimeStep(newTimeStep: number): void;
  104220. /**
  104221. * Get the time step of the physics engine.
  104222. * @returns the current time step
  104223. */
  104224. getTimeStep(): number;
  104225. /**
  104226. * Set the sub time step of the physics engine.
  104227. * Default is 0 meaning there is no sub steps
  104228. * To increase physics resolution precision, set a small value (like 1 ms)
  104229. * @param subTimeStep defines the new sub timestep used for physics resolution.
  104230. */
  104231. setSubTimeStep(subTimeStep: number): void;
  104232. /**
  104233. * Get the sub time step of the physics engine.
  104234. * @returns the current sub time step
  104235. */
  104236. getSubTimeStep(): number;
  104237. /**
  104238. * Release all resources
  104239. */
  104240. dispose(): void;
  104241. /**
  104242. * Gets the name of the current physics plugin
  104243. * @returns the name of the plugin
  104244. */
  104245. getPhysicsPluginName(): string;
  104246. /**
  104247. * Adding a new impostor for the impostor tracking.
  104248. * This will be done by the impostor itself.
  104249. * @param impostor the impostor to add
  104250. */
  104251. addImpostor(impostor: PhysicsImpostor): void;
  104252. /**
  104253. * Remove an impostor from the engine.
  104254. * This impostor and its mesh will not longer be updated by the physics engine.
  104255. * @param impostor the impostor to remove
  104256. */
  104257. removeImpostor(impostor: PhysicsImpostor): void;
  104258. /**
  104259. * Add a joint to the physics engine
  104260. * @param mainImpostor defines the main impostor to which the joint is added.
  104261. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  104262. * @param joint defines the joint that will connect both impostors.
  104263. */
  104264. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  104265. /**
  104266. * Removes a joint from the simulation
  104267. * @param mainImpostor defines the impostor used with the joint
  104268. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  104269. * @param joint defines the joint to remove
  104270. */
  104271. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  104272. /**
  104273. * Gets the current plugin used to run the simulation
  104274. * @returns current plugin
  104275. */
  104276. getPhysicsPlugin(): IPhysicsEnginePlugin;
  104277. /**
  104278. * Gets the list of physic impostors
  104279. * @returns an array of PhysicsImpostor
  104280. */
  104281. getImpostors(): Array<PhysicsImpostor>;
  104282. /**
  104283. * Gets the impostor for a physics enabled object
  104284. * @param object defines the object impersonated by the impostor
  104285. * @returns the PhysicsImpostor or null if not found
  104286. */
  104287. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  104288. /**
  104289. * Gets the impostor for a physics body object
  104290. * @param body defines physics body used by the impostor
  104291. * @returns the PhysicsImpostor or null if not found
  104292. */
  104293. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  104294. /**
  104295. * Does a raycast in the physics world
  104296. * @param from when should the ray start?
  104297. * @param to when should the ray end?
  104298. * @returns PhysicsRaycastResult
  104299. */
  104300. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  104301. /**
  104302. * Called by the scene. No need to call it.
  104303. * @param delta defines the timespam between frames
  104304. */
  104305. _step(delta: number): void;
  104306. }
  104307. }
  104308. declare module BABYLON {
  104309. /**
  104310. * The interface for the physics imposter parameters
  104311. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  104312. */
  104313. export interface PhysicsImpostorParameters {
  104314. /**
  104315. * The mass of the physics imposter
  104316. */
  104317. mass: number;
  104318. /**
  104319. * The friction of the physics imposter
  104320. */
  104321. friction?: number;
  104322. /**
  104323. * The coefficient of restitution of the physics imposter
  104324. */
  104325. restitution?: number;
  104326. /**
  104327. * The native options of the physics imposter
  104328. */
  104329. nativeOptions?: any;
  104330. /**
  104331. * Specifies if the parent should be ignored
  104332. */
  104333. ignoreParent?: boolean;
  104334. /**
  104335. * Specifies if bi-directional transformations should be disabled
  104336. */
  104337. disableBidirectionalTransformation?: boolean;
  104338. /**
  104339. * The pressure inside the physics imposter, soft object only
  104340. */
  104341. pressure?: number;
  104342. /**
  104343. * The stiffness the physics imposter, soft object only
  104344. */
  104345. stiffness?: number;
  104346. /**
  104347. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  104348. */
  104349. velocityIterations?: number;
  104350. /**
  104351. * The number of iterations used in maintaining consistent vertex positions, soft object only
  104352. */
  104353. positionIterations?: number;
  104354. /**
  104355. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  104356. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  104357. * Add to fix multiple points
  104358. */
  104359. fixedPoints?: number;
  104360. /**
  104361. * The collision margin around a soft object
  104362. */
  104363. margin?: number;
  104364. /**
  104365. * The collision margin around a soft object
  104366. */
  104367. damping?: number;
  104368. /**
  104369. * The path for a rope based on an extrusion
  104370. */
  104371. path?: any;
  104372. /**
  104373. * The shape of an extrusion used for a rope based on an extrusion
  104374. */
  104375. shape?: any;
  104376. }
  104377. /**
  104378. * Interface for a physics-enabled object
  104379. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  104380. */
  104381. export interface IPhysicsEnabledObject {
  104382. /**
  104383. * The position of the physics-enabled object
  104384. */
  104385. position: Vector3;
  104386. /**
  104387. * The rotation of the physics-enabled object
  104388. */
  104389. rotationQuaternion: Nullable<Quaternion>;
  104390. /**
  104391. * The scale of the physics-enabled object
  104392. */
  104393. scaling: Vector3;
  104394. /**
  104395. * The rotation of the physics-enabled object
  104396. */
  104397. rotation?: Vector3;
  104398. /**
  104399. * The parent of the physics-enabled object
  104400. */
  104401. parent?: any;
  104402. /**
  104403. * The bounding info of the physics-enabled object
  104404. * @returns The bounding info of the physics-enabled object
  104405. */
  104406. getBoundingInfo(): BoundingInfo;
  104407. /**
  104408. * Computes the world matrix
  104409. * @param force Specifies if the world matrix should be computed by force
  104410. * @returns A world matrix
  104411. */
  104412. computeWorldMatrix(force: boolean): Matrix;
  104413. /**
  104414. * Gets the world matrix
  104415. * @returns A world matrix
  104416. */
  104417. getWorldMatrix?(): Matrix;
  104418. /**
  104419. * Gets the child meshes
  104420. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  104421. * @returns An array of abstract meshes
  104422. */
  104423. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  104424. /**
  104425. * Gets the vertex data
  104426. * @param kind The type of vertex data
  104427. * @returns A nullable array of numbers, or a float32 array
  104428. */
  104429. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  104430. /**
  104431. * Gets the indices from the mesh
  104432. * @returns A nullable array of index arrays
  104433. */
  104434. getIndices?(): Nullable<IndicesArray>;
  104435. /**
  104436. * Gets the scene from the mesh
  104437. * @returns the indices array or null
  104438. */
  104439. getScene?(): Scene;
  104440. /**
  104441. * Gets the absolute position from the mesh
  104442. * @returns the absolute position
  104443. */
  104444. getAbsolutePosition(): Vector3;
  104445. /**
  104446. * Gets the absolute pivot point from the mesh
  104447. * @returns the absolute pivot point
  104448. */
  104449. getAbsolutePivotPoint(): Vector3;
  104450. /**
  104451. * Rotates the mesh
  104452. * @param axis The axis of rotation
  104453. * @param amount The amount of rotation
  104454. * @param space The space of the rotation
  104455. * @returns The rotation transform node
  104456. */
  104457. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  104458. /**
  104459. * Translates the mesh
  104460. * @param axis The axis of translation
  104461. * @param distance The distance of translation
  104462. * @param space The space of the translation
  104463. * @returns The transform node
  104464. */
  104465. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  104466. /**
  104467. * Sets the absolute position of the mesh
  104468. * @param absolutePosition The absolute position of the mesh
  104469. * @returns The transform node
  104470. */
  104471. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  104472. /**
  104473. * Gets the class name of the mesh
  104474. * @returns The class name
  104475. */
  104476. getClassName(): string;
  104477. }
  104478. /**
  104479. * Represents a physics imposter
  104480. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  104481. */
  104482. export class PhysicsImpostor {
  104483. /**
  104484. * The physics-enabled object used as the physics imposter
  104485. */
  104486. object: IPhysicsEnabledObject;
  104487. /**
  104488. * The type of the physics imposter
  104489. */
  104490. type: number;
  104491. private _options;
  104492. private _scene?;
  104493. /**
  104494. * The default object size of the imposter
  104495. */
  104496. static DEFAULT_OBJECT_SIZE: Vector3;
  104497. /**
  104498. * The identity quaternion of the imposter
  104499. */
  104500. static IDENTITY_QUATERNION: Quaternion;
  104501. /** @hidden */
  104502. _pluginData: any;
  104503. private _physicsEngine;
  104504. private _physicsBody;
  104505. private _bodyUpdateRequired;
  104506. private _onBeforePhysicsStepCallbacks;
  104507. private _onAfterPhysicsStepCallbacks;
  104508. /** @hidden */
  104509. _onPhysicsCollideCallbacks: Array<{
  104510. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  104511. otherImpostors: Array<PhysicsImpostor>;
  104512. }>;
  104513. private _deltaPosition;
  104514. private _deltaRotation;
  104515. private _deltaRotationConjugated;
  104516. /** @hidden */
  104517. _isFromLine: boolean;
  104518. private _parent;
  104519. private _isDisposed;
  104520. private static _tmpVecs;
  104521. private static _tmpQuat;
  104522. /**
  104523. * Specifies if the physics imposter is disposed
  104524. */
  104525. get isDisposed(): boolean;
  104526. /**
  104527. * Gets the mass of the physics imposter
  104528. */
  104529. get mass(): number;
  104530. set mass(value: number);
  104531. /**
  104532. * Gets the coefficient of friction
  104533. */
  104534. get friction(): number;
  104535. /**
  104536. * Sets the coefficient of friction
  104537. */
  104538. set friction(value: number);
  104539. /**
  104540. * Gets the coefficient of restitution
  104541. */
  104542. get restitution(): number;
  104543. /**
  104544. * Sets the coefficient of restitution
  104545. */
  104546. set restitution(value: number);
  104547. /**
  104548. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  104549. */
  104550. get pressure(): number;
  104551. /**
  104552. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  104553. */
  104554. set pressure(value: number);
  104555. /**
  104556. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  104557. */
  104558. get stiffness(): number;
  104559. /**
  104560. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  104561. */
  104562. set stiffness(value: number);
  104563. /**
  104564. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  104565. */
  104566. get velocityIterations(): number;
  104567. /**
  104568. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  104569. */
  104570. set velocityIterations(value: number);
  104571. /**
  104572. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  104573. */
  104574. get positionIterations(): number;
  104575. /**
  104576. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  104577. */
  104578. set positionIterations(value: number);
  104579. /**
  104580. * The unique id of the physics imposter
  104581. * set by the physics engine when adding this impostor to the array
  104582. */
  104583. uniqueId: number;
  104584. /**
  104585. * @hidden
  104586. */
  104587. soft: boolean;
  104588. /**
  104589. * @hidden
  104590. */
  104591. segments: number;
  104592. private _joints;
  104593. /**
  104594. * Initializes the physics imposter
  104595. * @param object The physics-enabled object used as the physics imposter
  104596. * @param type The type of the physics imposter
  104597. * @param _options The options for the physics imposter
  104598. * @param _scene The Babylon scene
  104599. */
  104600. constructor(
  104601. /**
  104602. * The physics-enabled object used as the physics imposter
  104603. */
  104604. object: IPhysicsEnabledObject,
  104605. /**
  104606. * The type of the physics imposter
  104607. */
  104608. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  104609. /**
  104610. * This function will completly initialize this impostor.
  104611. * It will create a new body - but only if this mesh has no parent.
  104612. * If it has, this impostor will not be used other than to define the impostor
  104613. * of the child mesh.
  104614. * @hidden
  104615. */
  104616. _init(): void;
  104617. private _getPhysicsParent;
  104618. /**
  104619. * Should a new body be generated.
  104620. * @returns boolean specifying if body initialization is required
  104621. */
  104622. isBodyInitRequired(): boolean;
  104623. /**
  104624. * Sets the updated scaling
  104625. * @param updated Specifies if the scaling is updated
  104626. */
  104627. setScalingUpdated(): void;
  104628. /**
  104629. * Force a regeneration of this or the parent's impostor's body.
  104630. * Use under cautious - This will remove all joints already implemented.
  104631. */
  104632. forceUpdate(): void;
  104633. /**
  104634. * Gets the body that holds this impostor. Either its own, or its parent.
  104635. */
  104636. get physicsBody(): any;
  104637. /**
  104638. * Get the parent of the physics imposter
  104639. * @returns Physics imposter or null
  104640. */
  104641. get parent(): Nullable<PhysicsImpostor>;
  104642. /**
  104643. * Sets the parent of the physics imposter
  104644. */
  104645. set parent(value: Nullable<PhysicsImpostor>);
  104646. /**
  104647. * Set the physics body. Used mainly by the physics engine/plugin
  104648. */
  104649. set physicsBody(physicsBody: any);
  104650. /**
  104651. * Resets the update flags
  104652. */
  104653. resetUpdateFlags(): void;
  104654. /**
  104655. * Gets the object extend size
  104656. * @returns the object extend size
  104657. */
  104658. getObjectExtendSize(): Vector3;
  104659. /**
  104660. * Gets the object center
  104661. * @returns The object center
  104662. */
  104663. getObjectCenter(): Vector3;
  104664. /**
  104665. * Get a specific parameter from the options parameters
  104666. * @param paramName The object parameter name
  104667. * @returns The object parameter
  104668. */
  104669. getParam(paramName: string): any;
  104670. /**
  104671. * Sets a specific parameter in the options given to the physics plugin
  104672. * @param paramName The parameter name
  104673. * @param value The value of the parameter
  104674. */
  104675. setParam(paramName: string, value: number): void;
  104676. /**
  104677. * Specifically change the body's mass option. Won't recreate the physics body object
  104678. * @param mass The mass of the physics imposter
  104679. */
  104680. setMass(mass: number): void;
  104681. /**
  104682. * Gets the linear velocity
  104683. * @returns linear velocity or null
  104684. */
  104685. getLinearVelocity(): Nullable<Vector3>;
  104686. /**
  104687. * Sets the linear velocity
  104688. * @param velocity linear velocity or null
  104689. */
  104690. setLinearVelocity(velocity: Nullable<Vector3>): void;
  104691. /**
  104692. * Gets the angular velocity
  104693. * @returns angular velocity or null
  104694. */
  104695. getAngularVelocity(): Nullable<Vector3>;
  104696. /**
  104697. * Sets the angular velocity
  104698. * @param velocity The velocity or null
  104699. */
  104700. setAngularVelocity(velocity: Nullable<Vector3>): void;
  104701. /**
  104702. * Execute a function with the physics plugin native code
  104703. * Provide a function the will have two variables - the world object and the physics body object
  104704. * @param func The function to execute with the physics plugin native code
  104705. */
  104706. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  104707. /**
  104708. * Register a function that will be executed before the physics world is stepping forward
  104709. * @param func The function to execute before the physics world is stepped forward
  104710. */
  104711. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  104712. /**
  104713. * Unregister a function that will be executed before the physics world is stepping forward
  104714. * @param func The function to execute before the physics world is stepped forward
  104715. */
  104716. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  104717. /**
  104718. * Register a function that will be executed after the physics step
  104719. * @param func The function to execute after physics step
  104720. */
  104721. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  104722. /**
  104723. * Unregisters a function that will be executed after the physics step
  104724. * @param func The function to execute after physics step
  104725. */
  104726. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  104727. /**
  104728. * register a function that will be executed when this impostor collides against a different body
  104729. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  104730. * @param func Callback that is executed on collision
  104731. */
  104732. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  104733. /**
  104734. * Unregisters the physics imposter on contact
  104735. * @param collideAgainst The physics object to collide against
  104736. * @param func Callback to execute on collision
  104737. */
  104738. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  104739. private _tmpQuat;
  104740. private _tmpQuat2;
  104741. /**
  104742. * Get the parent rotation
  104743. * @returns The parent rotation
  104744. */
  104745. getParentsRotation(): Quaternion;
  104746. /**
  104747. * this function is executed by the physics engine.
  104748. */
  104749. beforeStep: () => void;
  104750. /**
  104751. * this function is executed by the physics engine
  104752. */
  104753. afterStep: () => void;
  104754. /**
  104755. * Legacy collision detection event support
  104756. */
  104757. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  104758. /**
  104759. * event and body object due to cannon's event-based architecture.
  104760. */
  104761. onCollide: (e: {
  104762. body: any;
  104763. }) => void;
  104764. /**
  104765. * Apply a force
  104766. * @param force The force to apply
  104767. * @param contactPoint The contact point for the force
  104768. * @returns The physics imposter
  104769. */
  104770. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  104771. /**
  104772. * Apply an impulse
  104773. * @param force The impulse force
  104774. * @param contactPoint The contact point for the impulse force
  104775. * @returns The physics imposter
  104776. */
  104777. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  104778. /**
  104779. * A help function to create a joint
  104780. * @param otherImpostor A physics imposter used to create a joint
  104781. * @param jointType The type of joint
  104782. * @param jointData The data for the joint
  104783. * @returns The physics imposter
  104784. */
  104785. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  104786. /**
  104787. * Add a joint to this impostor with a different impostor
  104788. * @param otherImpostor A physics imposter used to add a joint
  104789. * @param joint The joint to add
  104790. * @returns The physics imposter
  104791. */
  104792. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  104793. /**
  104794. * Add an anchor to a cloth impostor
  104795. * @param otherImpostor rigid impostor to anchor to
  104796. * @param width ratio across width from 0 to 1
  104797. * @param height ratio up height from 0 to 1
  104798. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  104799. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  104800. * @returns impostor the soft imposter
  104801. */
  104802. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  104803. /**
  104804. * Add a hook to a rope impostor
  104805. * @param otherImpostor rigid impostor to anchor to
  104806. * @param length ratio across rope from 0 to 1
  104807. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  104808. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  104809. * @returns impostor the rope imposter
  104810. */
  104811. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  104812. /**
  104813. * Will keep this body still, in a sleep mode.
  104814. * @returns the physics imposter
  104815. */
  104816. sleep(): PhysicsImpostor;
  104817. /**
  104818. * Wake the body up.
  104819. * @returns The physics imposter
  104820. */
  104821. wakeUp(): PhysicsImpostor;
  104822. /**
  104823. * Clones the physics imposter
  104824. * @param newObject The physics imposter clones to this physics-enabled object
  104825. * @returns A nullable physics imposter
  104826. */
  104827. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  104828. /**
  104829. * Disposes the physics imposter
  104830. */
  104831. dispose(): void;
  104832. /**
  104833. * Sets the delta position
  104834. * @param position The delta position amount
  104835. */
  104836. setDeltaPosition(position: Vector3): void;
  104837. /**
  104838. * Sets the delta rotation
  104839. * @param rotation The delta rotation amount
  104840. */
  104841. setDeltaRotation(rotation: Quaternion): void;
  104842. /**
  104843. * Gets the box size of the physics imposter and stores the result in the input parameter
  104844. * @param result Stores the box size
  104845. * @returns The physics imposter
  104846. */
  104847. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  104848. /**
  104849. * Gets the radius of the physics imposter
  104850. * @returns Radius of the physics imposter
  104851. */
  104852. getRadius(): number;
  104853. /**
  104854. * Sync a bone with this impostor
  104855. * @param bone The bone to sync to the impostor.
  104856. * @param boneMesh The mesh that the bone is influencing.
  104857. * @param jointPivot The pivot of the joint / bone in local space.
  104858. * @param distToJoint Optional distance from the impostor to the joint.
  104859. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  104860. */
  104861. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  104862. /**
  104863. * Sync impostor to a bone
  104864. * @param bone The bone that the impostor will be synced to.
  104865. * @param boneMesh The mesh that the bone is influencing.
  104866. * @param jointPivot The pivot of the joint / bone in local space.
  104867. * @param distToJoint Optional distance from the impostor to the joint.
  104868. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  104869. * @param boneAxis Optional vector3 axis the bone is aligned with
  104870. */
  104871. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  104872. /**
  104873. * No-Imposter type
  104874. */
  104875. static NoImpostor: number;
  104876. /**
  104877. * Sphere-Imposter type
  104878. */
  104879. static SphereImpostor: number;
  104880. /**
  104881. * Box-Imposter type
  104882. */
  104883. static BoxImpostor: number;
  104884. /**
  104885. * Plane-Imposter type
  104886. */
  104887. static PlaneImpostor: number;
  104888. /**
  104889. * Mesh-imposter type
  104890. */
  104891. static MeshImpostor: number;
  104892. /**
  104893. * Capsule-Impostor type (Ammo.js plugin only)
  104894. */
  104895. static CapsuleImpostor: number;
  104896. /**
  104897. * Cylinder-Imposter type
  104898. */
  104899. static CylinderImpostor: number;
  104900. /**
  104901. * Particle-Imposter type
  104902. */
  104903. static ParticleImpostor: number;
  104904. /**
  104905. * Heightmap-Imposter type
  104906. */
  104907. static HeightmapImpostor: number;
  104908. /**
  104909. * ConvexHull-Impostor type (Ammo.js plugin only)
  104910. */
  104911. static ConvexHullImpostor: number;
  104912. /**
  104913. * Custom-Imposter type (Ammo.js plugin only)
  104914. */
  104915. static CustomImpostor: number;
  104916. /**
  104917. * Rope-Imposter type
  104918. */
  104919. static RopeImpostor: number;
  104920. /**
  104921. * Cloth-Imposter type
  104922. */
  104923. static ClothImpostor: number;
  104924. /**
  104925. * Softbody-Imposter type
  104926. */
  104927. static SoftbodyImpostor: number;
  104928. }
  104929. }
  104930. declare module BABYLON {
  104931. /**
  104932. * @hidden
  104933. **/
  104934. export class _CreationDataStorage {
  104935. closePath?: boolean;
  104936. closeArray?: boolean;
  104937. idx: number[];
  104938. dashSize: number;
  104939. gapSize: number;
  104940. path3D: Path3D;
  104941. pathArray: Vector3[][];
  104942. arc: number;
  104943. radius: number;
  104944. cap: number;
  104945. tessellation: number;
  104946. }
  104947. /**
  104948. * @hidden
  104949. **/
  104950. class _InstanceDataStorage {
  104951. visibleInstances: any;
  104952. batchCache: _InstancesBatch;
  104953. instancesBufferSize: number;
  104954. instancesBuffer: Nullable<Buffer>;
  104955. instancesData: Float32Array;
  104956. overridenInstanceCount: number;
  104957. isFrozen: boolean;
  104958. previousBatch: Nullable<_InstancesBatch>;
  104959. hardwareInstancedRendering: boolean;
  104960. sideOrientation: number;
  104961. manualUpdate: boolean;
  104962. }
  104963. /**
  104964. * @hidden
  104965. **/
  104966. export class _InstancesBatch {
  104967. mustReturn: boolean;
  104968. visibleInstances: Nullable<InstancedMesh[]>[];
  104969. renderSelf: boolean[];
  104970. hardwareInstancedRendering: boolean[];
  104971. }
  104972. /**
  104973. * @hidden
  104974. **/
  104975. class _ThinInstanceDataStorage {
  104976. instancesCount: number;
  104977. matrixBuffer: Nullable<Buffer>;
  104978. matrixBufferSize: number;
  104979. matrixData: Nullable<Float32Array>;
  104980. boundingVectors: Array<Vector3>;
  104981. }
  104982. /**
  104983. * Class used to represent renderable models
  104984. */
  104985. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  104986. /**
  104987. * Mesh side orientation : usually the external or front surface
  104988. */
  104989. static readonly FRONTSIDE: number;
  104990. /**
  104991. * Mesh side orientation : usually the internal or back surface
  104992. */
  104993. static readonly BACKSIDE: number;
  104994. /**
  104995. * Mesh side orientation : both internal and external or front and back surfaces
  104996. */
  104997. static readonly DOUBLESIDE: number;
  104998. /**
  104999. * Mesh side orientation : by default, `FRONTSIDE`
  105000. */
  105001. static readonly DEFAULTSIDE: number;
  105002. /**
  105003. * Mesh cap setting : no cap
  105004. */
  105005. static readonly NO_CAP: number;
  105006. /**
  105007. * Mesh cap setting : one cap at the beginning of the mesh
  105008. */
  105009. static readonly CAP_START: number;
  105010. /**
  105011. * Mesh cap setting : one cap at the end of the mesh
  105012. */
  105013. static readonly CAP_END: number;
  105014. /**
  105015. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  105016. */
  105017. static readonly CAP_ALL: number;
  105018. /**
  105019. * Mesh pattern setting : no flip or rotate
  105020. */
  105021. static readonly NO_FLIP: number;
  105022. /**
  105023. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  105024. */
  105025. static readonly FLIP_TILE: number;
  105026. /**
  105027. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  105028. */
  105029. static readonly ROTATE_TILE: number;
  105030. /**
  105031. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  105032. */
  105033. static readonly FLIP_ROW: number;
  105034. /**
  105035. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  105036. */
  105037. static readonly ROTATE_ROW: number;
  105038. /**
  105039. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  105040. */
  105041. static readonly FLIP_N_ROTATE_TILE: number;
  105042. /**
  105043. * Mesh pattern setting : rotate pattern and rotate
  105044. */
  105045. static readonly FLIP_N_ROTATE_ROW: number;
  105046. /**
  105047. * Mesh tile positioning : part tiles same on left/right or top/bottom
  105048. */
  105049. static readonly CENTER: number;
  105050. /**
  105051. * Mesh tile positioning : part tiles on left
  105052. */
  105053. static readonly LEFT: number;
  105054. /**
  105055. * Mesh tile positioning : part tiles on right
  105056. */
  105057. static readonly RIGHT: number;
  105058. /**
  105059. * Mesh tile positioning : part tiles on top
  105060. */
  105061. static readonly TOP: number;
  105062. /**
  105063. * Mesh tile positioning : part tiles on bottom
  105064. */
  105065. static readonly BOTTOM: number;
  105066. /**
  105067. * Gets the default side orientation.
  105068. * @param orientation the orientation to value to attempt to get
  105069. * @returns the default orientation
  105070. * @hidden
  105071. */
  105072. static _GetDefaultSideOrientation(orientation?: number): number;
  105073. private _internalMeshDataInfo;
  105074. /**
  105075. * An event triggered before rendering the mesh
  105076. */
  105077. get onBeforeRenderObservable(): Observable<Mesh>;
  105078. /**
  105079. * An event triggered before binding the mesh
  105080. */
  105081. get onBeforeBindObservable(): Observable<Mesh>;
  105082. /**
  105083. * An event triggered after rendering the mesh
  105084. */
  105085. get onAfterRenderObservable(): Observable<Mesh>;
  105086. /**
  105087. * An event triggered before drawing the mesh
  105088. */
  105089. get onBeforeDrawObservable(): Observable<Mesh>;
  105090. private _onBeforeDrawObserver;
  105091. /**
  105092. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  105093. */
  105094. set onBeforeDraw(callback: () => void);
  105095. get hasInstances(): boolean;
  105096. get hasThinInstances(): boolean;
  105097. /**
  105098. * Gets the delay loading state of the mesh (when delay loading is turned on)
  105099. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  105100. */
  105101. delayLoadState: number;
  105102. /**
  105103. * Gets the list of instances created from this mesh
  105104. * it is not supposed to be modified manually.
  105105. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  105106. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  105107. */
  105108. instances: InstancedMesh[];
  105109. /**
  105110. * Gets the file containing delay loading data for this mesh
  105111. */
  105112. delayLoadingFile: string;
  105113. /** @hidden */
  105114. _binaryInfo: any;
  105115. /**
  105116. * User defined function used to change how LOD level selection is done
  105117. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  105118. */
  105119. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  105120. /**
  105121. * Gets or sets the morph target manager
  105122. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  105123. */
  105124. get morphTargetManager(): Nullable<MorphTargetManager>;
  105125. set morphTargetManager(value: Nullable<MorphTargetManager>);
  105126. /** @hidden */
  105127. _creationDataStorage: Nullable<_CreationDataStorage>;
  105128. /** @hidden */
  105129. _geometry: Nullable<Geometry>;
  105130. /** @hidden */
  105131. _delayInfo: Array<string>;
  105132. /** @hidden */
  105133. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  105134. /** @hidden */
  105135. _instanceDataStorage: _InstanceDataStorage;
  105136. /** @hidden */
  105137. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  105138. private _effectiveMaterial;
  105139. /** @hidden */
  105140. _shouldGenerateFlatShading: boolean;
  105141. /** @hidden */
  105142. _originalBuilderSideOrientation: number;
  105143. /**
  105144. * Use this property to change the original side orientation defined at construction time
  105145. */
  105146. overrideMaterialSideOrientation: Nullable<number>;
  105147. /**
  105148. * Gets the source mesh (the one used to clone this one from)
  105149. */
  105150. get source(): Nullable<Mesh>;
  105151. /**
  105152. * Gets or sets a boolean indicating that this mesh does not use index buffer
  105153. */
  105154. get isUnIndexed(): boolean;
  105155. set isUnIndexed(value: boolean);
  105156. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  105157. get worldMatrixInstancedBuffer(): Float32Array;
  105158. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  105159. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  105160. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  105161. /**
  105162. * @constructor
  105163. * @param name The value used by scene.getMeshByName() to do a lookup.
  105164. * @param scene The scene to add this mesh to.
  105165. * @param parent The parent of this mesh, if it has one
  105166. * @param source An optional Mesh from which geometry is shared, cloned.
  105167. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  105168. * When false, achieved by calling a clone(), also passing False.
  105169. * This will make creation of children, recursive.
  105170. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  105171. */
  105172. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  105173. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  105174. doNotInstantiate: boolean;
  105175. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  105176. /**
  105177. * Gets the class name
  105178. * @returns the string "Mesh".
  105179. */
  105180. getClassName(): string;
  105181. /** @hidden */
  105182. get _isMesh(): boolean;
  105183. /**
  105184. * Returns a description of this mesh
  105185. * @param fullDetails define if full details about this mesh must be used
  105186. * @returns a descriptive string representing this mesh
  105187. */
  105188. toString(fullDetails?: boolean): string;
  105189. /** @hidden */
  105190. _unBindEffect(): void;
  105191. /**
  105192. * Gets a boolean indicating if this mesh has LOD
  105193. */
  105194. get hasLODLevels(): boolean;
  105195. /**
  105196. * Gets the list of MeshLODLevel associated with the current mesh
  105197. * @returns an array of MeshLODLevel
  105198. */
  105199. getLODLevels(): MeshLODLevel[];
  105200. private _sortLODLevels;
  105201. /**
  105202. * Add a mesh as LOD level triggered at the given distance.
  105203. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  105204. * @param distance The distance from the center of the object to show this level
  105205. * @param mesh The mesh to be added as LOD level (can be null)
  105206. * @return This mesh (for chaining)
  105207. */
  105208. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  105209. /**
  105210. * Returns the LOD level mesh at the passed distance or null if not found.
  105211. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  105212. * @param distance The distance from the center of the object to show this level
  105213. * @returns a Mesh or `null`
  105214. */
  105215. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  105216. /**
  105217. * Remove a mesh from the LOD array
  105218. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  105219. * @param mesh defines the mesh to be removed
  105220. * @return This mesh (for chaining)
  105221. */
  105222. removeLODLevel(mesh: Mesh): Mesh;
  105223. /**
  105224. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  105225. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  105226. * @param camera defines the camera to use to compute distance
  105227. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  105228. * @return This mesh (for chaining)
  105229. */
  105230. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  105231. /**
  105232. * Gets the mesh internal Geometry object
  105233. */
  105234. get geometry(): Nullable<Geometry>;
  105235. /**
  105236. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  105237. * @returns the total number of vertices
  105238. */
  105239. getTotalVertices(): number;
  105240. /**
  105241. * Returns the content of an associated vertex buffer
  105242. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  105243. * - VertexBuffer.PositionKind
  105244. * - VertexBuffer.UVKind
  105245. * - VertexBuffer.UV2Kind
  105246. * - VertexBuffer.UV3Kind
  105247. * - VertexBuffer.UV4Kind
  105248. * - VertexBuffer.UV5Kind
  105249. * - VertexBuffer.UV6Kind
  105250. * - VertexBuffer.ColorKind
  105251. * - VertexBuffer.MatricesIndicesKind
  105252. * - VertexBuffer.MatricesIndicesExtraKind
  105253. * - VertexBuffer.MatricesWeightsKind
  105254. * - VertexBuffer.MatricesWeightsExtraKind
  105255. * @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
  105256. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  105257. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  105258. */
  105259. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105260. /**
  105261. * Returns the mesh VertexBuffer object from the requested `kind`
  105262. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  105263. * - VertexBuffer.PositionKind
  105264. * - VertexBuffer.NormalKind
  105265. * - VertexBuffer.UVKind
  105266. * - VertexBuffer.UV2Kind
  105267. * - VertexBuffer.UV3Kind
  105268. * - VertexBuffer.UV4Kind
  105269. * - VertexBuffer.UV5Kind
  105270. * - VertexBuffer.UV6Kind
  105271. * - VertexBuffer.ColorKind
  105272. * - VertexBuffer.MatricesIndicesKind
  105273. * - VertexBuffer.MatricesIndicesExtraKind
  105274. * - VertexBuffer.MatricesWeightsKind
  105275. * - VertexBuffer.MatricesWeightsExtraKind
  105276. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  105277. */
  105278. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105279. /**
  105280. * Tests if a specific vertex buffer is associated with this mesh
  105281. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  105282. * - VertexBuffer.PositionKind
  105283. * - VertexBuffer.NormalKind
  105284. * - VertexBuffer.UVKind
  105285. * - VertexBuffer.UV2Kind
  105286. * - VertexBuffer.UV3Kind
  105287. * - VertexBuffer.UV4Kind
  105288. * - VertexBuffer.UV5Kind
  105289. * - VertexBuffer.UV6Kind
  105290. * - VertexBuffer.ColorKind
  105291. * - VertexBuffer.MatricesIndicesKind
  105292. * - VertexBuffer.MatricesIndicesExtraKind
  105293. * - VertexBuffer.MatricesWeightsKind
  105294. * - VertexBuffer.MatricesWeightsExtraKind
  105295. * @returns a boolean
  105296. */
  105297. isVerticesDataPresent(kind: string): boolean;
  105298. /**
  105299. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  105300. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  105301. * - VertexBuffer.PositionKind
  105302. * - VertexBuffer.UVKind
  105303. * - VertexBuffer.UV2Kind
  105304. * - VertexBuffer.UV3Kind
  105305. * - VertexBuffer.UV4Kind
  105306. * - VertexBuffer.UV5Kind
  105307. * - VertexBuffer.UV6Kind
  105308. * - VertexBuffer.ColorKind
  105309. * - VertexBuffer.MatricesIndicesKind
  105310. * - VertexBuffer.MatricesIndicesExtraKind
  105311. * - VertexBuffer.MatricesWeightsKind
  105312. * - VertexBuffer.MatricesWeightsExtraKind
  105313. * @returns a boolean
  105314. */
  105315. isVertexBufferUpdatable(kind: string): boolean;
  105316. /**
  105317. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  105318. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  105319. * - VertexBuffer.PositionKind
  105320. * - VertexBuffer.NormalKind
  105321. * - VertexBuffer.UVKind
  105322. * - VertexBuffer.UV2Kind
  105323. * - VertexBuffer.UV3Kind
  105324. * - VertexBuffer.UV4Kind
  105325. * - VertexBuffer.UV5Kind
  105326. * - VertexBuffer.UV6Kind
  105327. * - VertexBuffer.ColorKind
  105328. * - VertexBuffer.MatricesIndicesKind
  105329. * - VertexBuffer.MatricesIndicesExtraKind
  105330. * - VertexBuffer.MatricesWeightsKind
  105331. * - VertexBuffer.MatricesWeightsExtraKind
  105332. * @returns an array of strings
  105333. */
  105334. getVerticesDataKinds(): string[];
  105335. /**
  105336. * Returns a positive integer : the total number of indices in this mesh geometry.
  105337. * @returns the numner of indices or zero if the mesh has no geometry.
  105338. */
  105339. getTotalIndices(): number;
  105340. /**
  105341. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105342. * @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.
  105343. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105344. * @returns the indices array or an empty array if the mesh has no geometry
  105345. */
  105346. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105347. get isBlocked(): boolean;
  105348. /**
  105349. * Determine if the current mesh is ready to be rendered
  105350. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  105351. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  105352. * @returns true if all associated assets are ready (material, textures, shaders)
  105353. */
  105354. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  105355. /**
  105356. * 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.
  105357. */
  105358. get areNormalsFrozen(): boolean;
  105359. /**
  105360. * 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.
  105361. * @returns the current mesh
  105362. */
  105363. freezeNormals(): Mesh;
  105364. /**
  105365. * 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
  105366. * @returns the current mesh
  105367. */
  105368. unfreezeNormals(): Mesh;
  105369. /**
  105370. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  105371. */
  105372. set overridenInstanceCount(count: number);
  105373. /** @hidden */
  105374. _preActivate(): Mesh;
  105375. /** @hidden */
  105376. _preActivateForIntermediateRendering(renderId: number): Mesh;
  105377. /** @hidden */
  105378. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  105379. protected _afterComputeWorldMatrix(): void;
  105380. /** @hidden */
  105381. _postActivate(): void;
  105382. /**
  105383. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  105384. * This means the mesh underlying bounding box and sphere are recomputed.
  105385. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  105386. * @returns the current mesh
  105387. */
  105388. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  105389. /** @hidden */
  105390. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  105391. /**
  105392. * This function will subdivide the mesh into multiple submeshes
  105393. * @param count defines the expected number of submeshes
  105394. */
  105395. subdivide(count: number): void;
  105396. /**
  105397. * Copy a FloatArray into a specific associated vertex buffer
  105398. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105399. * - VertexBuffer.PositionKind
  105400. * - VertexBuffer.UVKind
  105401. * - VertexBuffer.UV2Kind
  105402. * - VertexBuffer.UV3Kind
  105403. * - VertexBuffer.UV4Kind
  105404. * - VertexBuffer.UV5Kind
  105405. * - VertexBuffer.UV6Kind
  105406. * - VertexBuffer.ColorKind
  105407. * - VertexBuffer.MatricesIndicesKind
  105408. * - VertexBuffer.MatricesIndicesExtraKind
  105409. * - VertexBuffer.MatricesWeightsKind
  105410. * - VertexBuffer.MatricesWeightsExtraKind
  105411. * @param data defines the data source
  105412. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  105413. * @param stride defines the data stride size (can be null)
  105414. * @returns the current mesh
  105415. */
  105416. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  105417. /**
  105418. * Delete a vertex buffer associated with this mesh
  105419. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  105420. * - VertexBuffer.PositionKind
  105421. * - VertexBuffer.UVKind
  105422. * - VertexBuffer.UV2Kind
  105423. * - VertexBuffer.UV3Kind
  105424. * - VertexBuffer.UV4Kind
  105425. * - VertexBuffer.UV5Kind
  105426. * - VertexBuffer.UV6Kind
  105427. * - VertexBuffer.ColorKind
  105428. * - VertexBuffer.MatricesIndicesKind
  105429. * - VertexBuffer.MatricesIndicesExtraKind
  105430. * - VertexBuffer.MatricesWeightsKind
  105431. * - VertexBuffer.MatricesWeightsExtraKind
  105432. */
  105433. removeVerticesData(kind: string): void;
  105434. /**
  105435. * Flags an associated vertex buffer as updatable
  105436. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  105437. * - VertexBuffer.PositionKind
  105438. * - VertexBuffer.UVKind
  105439. * - VertexBuffer.UV2Kind
  105440. * - VertexBuffer.UV3Kind
  105441. * - VertexBuffer.UV4Kind
  105442. * - VertexBuffer.UV5Kind
  105443. * - VertexBuffer.UV6Kind
  105444. * - VertexBuffer.ColorKind
  105445. * - VertexBuffer.MatricesIndicesKind
  105446. * - VertexBuffer.MatricesIndicesExtraKind
  105447. * - VertexBuffer.MatricesWeightsKind
  105448. * - VertexBuffer.MatricesWeightsExtraKind
  105449. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  105450. */
  105451. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  105452. /**
  105453. * Sets the mesh global Vertex Buffer
  105454. * @param buffer defines the buffer to use
  105455. * @returns the current mesh
  105456. */
  105457. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  105458. /**
  105459. * Update a specific associated vertex buffer
  105460. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105461. * - VertexBuffer.PositionKind
  105462. * - VertexBuffer.UVKind
  105463. * - VertexBuffer.UV2Kind
  105464. * - VertexBuffer.UV3Kind
  105465. * - VertexBuffer.UV4Kind
  105466. * - VertexBuffer.UV5Kind
  105467. * - VertexBuffer.UV6Kind
  105468. * - VertexBuffer.ColorKind
  105469. * - VertexBuffer.MatricesIndicesKind
  105470. * - VertexBuffer.MatricesIndicesExtraKind
  105471. * - VertexBuffer.MatricesWeightsKind
  105472. * - VertexBuffer.MatricesWeightsExtraKind
  105473. * @param data defines the data source
  105474. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105475. * @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)
  105476. * @returns the current mesh
  105477. */
  105478. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  105479. /**
  105480. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  105481. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  105482. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  105483. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  105484. * @returns the current mesh
  105485. */
  105486. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  105487. /**
  105488. * Creates a un-shared specific occurence of the geometry for the mesh.
  105489. * @returns the current mesh
  105490. */
  105491. makeGeometryUnique(): Mesh;
  105492. /**
  105493. * Set the index buffer of this mesh
  105494. * @param indices defines the source data
  105495. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  105496. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  105497. * @returns the current mesh
  105498. */
  105499. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  105500. /**
  105501. * Update the current index buffer
  105502. * @param indices defines the source data
  105503. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  105504. * @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)
  105505. * @returns the current mesh
  105506. */
  105507. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  105508. /**
  105509. * Invert the geometry to move from a right handed system to a left handed one.
  105510. * @returns the current mesh
  105511. */
  105512. toLeftHanded(): Mesh;
  105513. /** @hidden */
  105514. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  105515. /** @hidden */
  105516. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  105517. /**
  105518. * Registers for this mesh a javascript function called just before the rendering process
  105519. * @param func defines the function to call before rendering this mesh
  105520. * @returns the current mesh
  105521. */
  105522. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  105523. /**
  105524. * Disposes a previously registered javascript function called before the rendering
  105525. * @param func defines the function to remove
  105526. * @returns the current mesh
  105527. */
  105528. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  105529. /**
  105530. * Registers for this mesh a javascript function called just after the rendering is complete
  105531. * @param func defines the function to call after rendering this mesh
  105532. * @returns the current mesh
  105533. */
  105534. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  105535. /**
  105536. * Disposes a previously registered javascript function called after the rendering.
  105537. * @param func defines the function to remove
  105538. * @returns the current mesh
  105539. */
  105540. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  105541. /** @hidden */
  105542. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  105543. /** @hidden */
  105544. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  105545. /** @hidden */
  105546. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  105547. /** @hidden */
  105548. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  105549. /** @hidden */
  105550. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  105551. /** @hidden */
  105552. _rebuild(): void;
  105553. /** @hidden */
  105554. _freeze(): void;
  105555. /** @hidden */
  105556. _unFreeze(): void;
  105557. /**
  105558. * 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
  105559. * @param subMesh defines the subMesh to render
  105560. * @param enableAlphaMode defines if alpha mode can be changed
  105561. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  105562. * @returns the current mesh
  105563. */
  105564. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  105565. private _onBeforeDraw;
  105566. /**
  105567. * Renormalize the mesh and patch it up if there are no weights
  105568. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  105569. * However in the case of zero weights then we set just a single influence to 1.
  105570. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  105571. */
  105572. cleanMatrixWeights(): void;
  105573. private normalizeSkinFourWeights;
  105574. private normalizeSkinWeightsAndExtra;
  105575. /**
  105576. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  105577. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  105578. * the user know there was an issue with importing the mesh
  105579. * @returns a validation object with skinned, valid and report string
  105580. */
  105581. validateSkinning(): {
  105582. skinned: boolean;
  105583. valid: boolean;
  105584. report: string;
  105585. };
  105586. /** @hidden */
  105587. _checkDelayState(): Mesh;
  105588. private _queueLoad;
  105589. /**
  105590. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  105591. * A mesh is in the frustum if its bounding box intersects the frustum
  105592. * @param frustumPlanes defines the frustum to test
  105593. * @returns true if the mesh is in the frustum planes
  105594. */
  105595. isInFrustum(frustumPlanes: Plane[]): boolean;
  105596. /**
  105597. * Sets the mesh material by the material or multiMaterial `id` property
  105598. * @param id is a string identifying the material or the multiMaterial
  105599. * @returns the current mesh
  105600. */
  105601. setMaterialByID(id: string): Mesh;
  105602. /**
  105603. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  105604. * @returns an array of IAnimatable
  105605. */
  105606. getAnimatables(): IAnimatable[];
  105607. /**
  105608. * Modifies the mesh geometry according to the passed transformation matrix.
  105609. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  105610. * The mesh normals are modified using the same transformation.
  105611. * Note that, under the hood, this method sets a new VertexBuffer each call.
  105612. * @param transform defines the transform matrix to use
  105613. * @see http://doc.babylonjs.com/resources/baking_transformations
  105614. * @returns the current mesh
  105615. */
  105616. bakeTransformIntoVertices(transform: Matrix): Mesh;
  105617. /**
  105618. * Modifies the mesh geometry according to its own current World Matrix.
  105619. * The mesh World Matrix is then reset.
  105620. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  105621. * Note that, under the hood, this method sets a new VertexBuffer each call.
  105622. * @see http://doc.babylonjs.com/resources/baking_transformations
  105623. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  105624. * @returns the current mesh
  105625. */
  105626. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  105627. /** @hidden */
  105628. get _positions(): Nullable<Vector3[]>;
  105629. /** @hidden */
  105630. _resetPointsArrayCache(): Mesh;
  105631. /** @hidden */
  105632. _generatePointsArray(): boolean;
  105633. /**
  105634. * Returns a new Mesh object generated from the current mesh properties.
  105635. * This method must not get confused with createInstance()
  105636. * @param name is a string, the name given to the new mesh
  105637. * @param newParent can be any Node object (default `null`)
  105638. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  105639. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  105640. * @returns a new mesh
  105641. */
  105642. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  105643. /**
  105644. * Releases resources associated with this mesh.
  105645. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  105646. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  105647. */
  105648. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  105649. /** @hidden */
  105650. _disposeInstanceSpecificData(): void;
  105651. /** @hidden */
  105652. _disposeThinInstanceSpecificData(): void;
  105653. /**
  105654. * Modifies the mesh geometry according to a displacement map.
  105655. * 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.
  105656. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  105657. * @param url is a string, the URL from the image file is to be downloaded.
  105658. * @param minHeight is the lower limit of the displacement.
  105659. * @param maxHeight is the upper limit of the displacement.
  105660. * @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.
  105661. * @param uvOffset is an optional vector2 used to offset UV.
  105662. * @param uvScale is an optional vector2 used to scale UV.
  105663. * @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.
  105664. * @returns the Mesh.
  105665. */
  105666. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  105667. /**
  105668. * Modifies the mesh geometry according to a displacementMap buffer.
  105669. * 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.
  105670. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  105671. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  105672. * @param heightMapWidth is the width of the buffer image.
  105673. * @param heightMapHeight is the height of the buffer image.
  105674. * @param minHeight is the lower limit of the displacement.
  105675. * @param maxHeight is the upper limit of the displacement.
  105676. * @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.
  105677. * @param uvOffset is an optional vector2 used to offset UV.
  105678. * @param uvScale is an optional vector2 used to scale UV.
  105679. * @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.
  105680. * @returns the Mesh.
  105681. */
  105682. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  105683. /**
  105684. * Modify the mesh to get a flat shading rendering.
  105685. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  105686. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  105687. * @returns current mesh
  105688. */
  105689. convertToFlatShadedMesh(): Mesh;
  105690. /**
  105691. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  105692. * In other words, more vertices, no more indices and a single bigger VBO.
  105693. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  105694. * @returns current mesh
  105695. */
  105696. convertToUnIndexedMesh(): Mesh;
  105697. /**
  105698. * Inverses facet orientations.
  105699. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  105700. * @param flipNormals will also inverts the normals
  105701. * @returns current mesh
  105702. */
  105703. flipFaces(flipNormals?: boolean): Mesh;
  105704. /**
  105705. * Increase the number of facets and hence vertices in a mesh
  105706. * Vertex normals are interpolated from existing vertex normals
  105707. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  105708. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  105709. */
  105710. increaseVertices(numberPerEdge: number): void;
  105711. /**
  105712. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  105713. * This will undo any application of covertToFlatShadedMesh
  105714. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  105715. */
  105716. forceSharedVertices(): void;
  105717. /** @hidden */
  105718. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  105719. /** @hidden */
  105720. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  105721. /**
  105722. * Creates a new InstancedMesh object from the mesh model.
  105723. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  105724. * @param name defines the name of the new instance
  105725. * @returns a new InstancedMesh
  105726. */
  105727. createInstance(name: string): InstancedMesh;
  105728. /**
  105729. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  105730. * After this call, all the mesh instances have the same submeshes than the current mesh.
  105731. * @returns the current mesh
  105732. */
  105733. synchronizeInstances(): Mesh;
  105734. /**
  105735. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  105736. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  105737. * This should be used together with the simplification to avoid disappearing triangles.
  105738. * @param successCallback an optional success callback to be called after the optimization finished.
  105739. * @returns the current mesh
  105740. */
  105741. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  105742. /**
  105743. * Serialize current mesh
  105744. * @param serializationObject defines the object which will receive the serialization data
  105745. */
  105746. serialize(serializationObject: any): void;
  105747. /** @hidden */
  105748. _syncGeometryWithMorphTargetManager(): void;
  105749. /** @hidden */
  105750. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  105751. /**
  105752. * Returns a new Mesh object parsed from the source provided.
  105753. * @param parsedMesh is the source
  105754. * @param scene defines the hosting scene
  105755. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  105756. * @returns a new Mesh
  105757. */
  105758. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  105759. /**
  105760. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  105761. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  105762. * @param name defines the name of the mesh to create
  105763. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  105764. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  105765. * @param closePath creates a seam between the first and the last points of each path of the path array
  105766. * @param offset is taken in account only if the `pathArray` is containing a single path
  105767. * @param scene defines the hosting scene
  105768. * @param updatable defines if the mesh must be flagged as updatable
  105769. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105770. * @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)
  105771. * @returns a new Mesh
  105772. */
  105773. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  105774. /**
  105775. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  105776. * @param name defines the name of the mesh to create
  105777. * @param radius sets the radius size (float) of the polygon (default 0.5)
  105778. * @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
  105779. * @param scene defines the hosting scene
  105780. * @param updatable defines if the mesh must be flagged as updatable
  105781. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105782. * @returns a new Mesh
  105783. */
  105784. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  105785. /**
  105786. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  105787. * @param name defines the name of the mesh to create
  105788. * @param size sets the size (float) of each box side (default 1)
  105789. * @param scene defines the hosting scene
  105790. * @param updatable defines if the mesh must be flagged as updatable
  105791. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105792. * @returns a new Mesh
  105793. */
  105794. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  105795. /**
  105796. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  105797. * @param name defines the name of the mesh to create
  105798. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  105799. * @param diameter sets the diameter size (float) of the sphere (default 1)
  105800. * @param scene defines the hosting scene
  105801. * @param updatable defines if the mesh must be flagged as updatable
  105802. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105803. * @returns a new Mesh
  105804. */
  105805. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  105806. /**
  105807. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  105808. * @param name defines the name of the mesh to create
  105809. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  105810. * @param diameter sets the diameter size (float) of the sphere (default 1)
  105811. * @param scene defines the hosting scene
  105812. * @returns a new Mesh
  105813. */
  105814. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  105815. /**
  105816. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  105817. * @param name defines the name of the mesh to create
  105818. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  105819. * @param diameterTop set the top cap diameter (floats, default 1)
  105820. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  105821. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  105822. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  105823. * @param scene defines the hosting scene
  105824. * @param updatable defines if the mesh must be flagged as updatable
  105825. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105826. * @returns a new Mesh
  105827. */
  105828. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  105829. /**
  105830. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  105831. * @param name defines the name of the mesh to create
  105832. * @param diameter sets the diameter size (float) of the torus (default 1)
  105833. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  105834. * @param tessellation sets the number of torus sides (postive integer, default 16)
  105835. * @param scene defines the hosting scene
  105836. * @param updatable defines if the mesh must be flagged as updatable
  105837. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105838. * @returns a new Mesh
  105839. */
  105840. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  105841. /**
  105842. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  105843. * @param name defines the name of the mesh to create
  105844. * @param radius sets the global radius size (float) of the torus knot (default 2)
  105845. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  105846. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  105847. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  105848. * @param p the number of windings on X axis (positive integers, default 2)
  105849. * @param q the number of windings on Y axis (positive integers, default 3)
  105850. * @param scene defines the hosting scene
  105851. * @param updatable defines if the mesh must be flagged as updatable
  105852. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105853. * @returns a new Mesh
  105854. */
  105855. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  105856. /**
  105857. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  105858. * @param name defines the name of the mesh to create
  105859. * @param points is an array successive Vector3
  105860. * @param scene defines the hosting scene
  105861. * @param updatable defines if the mesh must be flagged as updatable
  105862. * @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).
  105863. * @returns a new Mesh
  105864. */
  105865. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  105866. /**
  105867. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  105868. * @param name defines the name of the mesh to create
  105869. * @param points is an array successive Vector3
  105870. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  105871. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  105872. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  105873. * @param scene defines the hosting scene
  105874. * @param updatable defines if the mesh must be flagged as updatable
  105875. * @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)
  105876. * @returns a new Mesh
  105877. */
  105878. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  105879. /**
  105880. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  105881. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  105882. * 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.
  105883. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105884. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  105885. * Remember you can only change the shape positions, not their number when updating a polygon.
  105886. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  105887. * @param name defines the name of the mesh to create
  105888. * @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
  105889. * @param scene defines the hosting scene
  105890. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  105891. * @param updatable defines if the mesh must be flagged as updatable
  105892. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105893. * @param earcutInjection can be used to inject your own earcut reference
  105894. * @returns a new Mesh
  105895. */
  105896. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  105897. /**
  105898. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  105899. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  105900. * @param name defines the name of the mesh to create
  105901. * @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
  105902. * @param depth defines the height of extrusion
  105903. * @param scene defines the hosting scene
  105904. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  105905. * @param updatable defines if the mesh must be flagged as updatable
  105906. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105907. * @param earcutInjection can be used to inject your own earcut reference
  105908. * @returns a new Mesh
  105909. */
  105910. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  105911. /**
  105912. * Creates an extruded shape mesh.
  105913. * 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
  105914. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  105915. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  105916. * @param name defines the name of the mesh to create
  105917. * @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
  105918. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  105919. * @param scale is the value to scale the shape
  105920. * @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
  105921. * @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
  105922. * @param scene defines the hosting scene
  105923. * @param updatable defines if the mesh must be flagged as updatable
  105924. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105925. * @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)
  105926. * @returns a new Mesh
  105927. */
  105928. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  105929. /**
  105930. * Creates an custom extruded shape mesh.
  105931. * The custom extrusion is a parametric shape.
  105932. * It has no predefined shape. Its final shape will depend on the input parameters.
  105933. * Please consider using the same method from the MeshBuilder class instead
  105934. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  105935. * @param name defines the name of the mesh to create
  105936. * @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
  105937. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  105938. * @param scaleFunction is a custom Javascript function called on each path point
  105939. * @param rotationFunction is a custom Javascript function called on each path point
  105940. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  105941. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  105942. * @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
  105943. * @param scene defines the hosting scene
  105944. * @param updatable defines if the mesh must be flagged as updatable
  105945. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105946. * @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)
  105947. * @returns a new Mesh
  105948. */
  105949. 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;
  105950. /**
  105951. * Creates lathe mesh.
  105952. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  105953. * Please consider using the same method from the MeshBuilder class instead
  105954. * @param name defines the name of the mesh to create
  105955. * @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
  105956. * @param radius is the radius value of the lathe
  105957. * @param tessellation is the side number of the lathe.
  105958. * @param scene defines the hosting scene
  105959. * @param updatable defines if the mesh must be flagged as updatable
  105960. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105961. * @returns a new Mesh
  105962. */
  105963. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  105964. /**
  105965. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  105966. * @param name defines the name of the mesh to create
  105967. * @param size sets the size (float) of both sides of the plane at once (default 1)
  105968. * @param scene defines the hosting scene
  105969. * @param updatable defines if the mesh must be flagged as updatable
  105970. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  105971. * @returns a new Mesh
  105972. */
  105973. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  105974. /**
  105975. * Creates a ground mesh.
  105976. * Please consider using the same method from the MeshBuilder class instead
  105977. * @param name defines the name of the mesh to create
  105978. * @param width set the width of the ground
  105979. * @param height set the height of the ground
  105980. * @param subdivisions sets the number of subdivisions per side
  105981. * @param scene defines the hosting scene
  105982. * @param updatable defines if the mesh must be flagged as updatable
  105983. * @returns a new Mesh
  105984. */
  105985. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  105986. /**
  105987. * Creates a tiled ground mesh.
  105988. * Please consider using the same method from the MeshBuilder class instead
  105989. * @param name defines the name of the mesh to create
  105990. * @param xmin set the ground minimum X coordinate
  105991. * @param zmin set the ground minimum Y coordinate
  105992. * @param xmax set the ground maximum X coordinate
  105993. * @param zmax set the ground maximum Z coordinate
  105994. * @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
  105995. * @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
  105996. * @param scene defines the hosting scene
  105997. * @param updatable defines if the mesh must be flagged as updatable
  105998. * @returns a new Mesh
  105999. */
  106000. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  106001. w: number;
  106002. h: number;
  106003. }, precision: {
  106004. w: number;
  106005. h: number;
  106006. }, scene: Scene, updatable?: boolean): Mesh;
  106007. /**
  106008. * Creates a ground mesh from a height map.
  106009. * Please consider using the same method from the MeshBuilder class instead
  106010. * @see http://doc.babylonjs.com/babylon101/height_map
  106011. * @param name defines the name of the mesh to create
  106012. * @param url sets the URL of the height map image resource
  106013. * @param width set the ground width size
  106014. * @param height set the ground height size
  106015. * @param subdivisions sets the number of subdivision per side
  106016. * @param minHeight is the minimum altitude on the ground
  106017. * @param maxHeight is the maximum altitude on the ground
  106018. * @param scene defines the hosting scene
  106019. * @param updatable defines if the mesh must be flagged as updatable
  106020. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  106021. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  106022. * @returns a new Mesh
  106023. */
  106024. 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;
  106025. /**
  106026. * Creates a tube mesh.
  106027. * The tube is a parametric shape.
  106028. * It has no predefined shape. Its final shape will depend on the input parameters.
  106029. * Please consider using the same method from the MeshBuilder class instead
  106030. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  106031. * @param name defines the name of the mesh to create
  106032. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  106033. * @param radius sets the tube radius size
  106034. * @param tessellation is the number of sides on the tubular surface
  106035. * @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
  106036. * @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
  106037. * @param scene defines the hosting scene
  106038. * @param updatable defines if the mesh must be flagged as updatable
  106039. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  106040. * @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)
  106041. * @returns a new Mesh
  106042. */
  106043. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  106044. (i: number, distance: number): number;
  106045. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  106046. /**
  106047. * Creates a polyhedron mesh.
  106048. * Please consider using the same method from the MeshBuilder class instead.
  106049. * * 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
  106050. * * The parameter `size` (positive float, default 1) sets the polygon size
  106051. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  106052. * * 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`
  106053. * * 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
  106054. * * 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)`)
  106055. * * 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
  106056. * * 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
  106057. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106058. * * If you create a double-sided mesh, you can choose what parts of 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
  106059. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  106060. * @param name defines the name of the mesh to create
  106061. * @param options defines the options used to create the mesh
  106062. * @param scene defines the hosting scene
  106063. * @returns a new Mesh
  106064. */
  106065. static CreatePolyhedron(name: string, options: {
  106066. type?: number;
  106067. size?: number;
  106068. sizeX?: number;
  106069. sizeY?: number;
  106070. sizeZ?: number;
  106071. custom?: any;
  106072. faceUV?: Vector4[];
  106073. faceColors?: Color4[];
  106074. updatable?: boolean;
  106075. sideOrientation?: number;
  106076. }, scene: Scene): Mesh;
  106077. /**
  106078. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  106079. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  106080. * * 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`)
  106081. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  106082. * * 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
  106083. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106084. * * If you create a double-sided mesh, you can choose what parts of 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
  106085. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  106086. * @param name defines the name of the mesh
  106087. * @param options defines the options used to create the mesh
  106088. * @param scene defines the hosting scene
  106089. * @returns a new Mesh
  106090. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  106091. */
  106092. static CreateIcoSphere(name: string, options: {
  106093. radius?: number;
  106094. flat?: boolean;
  106095. subdivisions?: number;
  106096. sideOrientation?: number;
  106097. updatable?: boolean;
  106098. }, scene: Scene): Mesh;
  106099. /**
  106100. * Creates a decal mesh.
  106101. * Please consider using the same method from the MeshBuilder class instead.
  106102. * A decal is a mesh usually applied as a model onto the surface of another mesh
  106103. * @param name defines the name of the mesh
  106104. * @param sourceMesh defines the mesh receiving the decal
  106105. * @param position sets the position of the decal in world coordinates
  106106. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  106107. * @param size sets the decal scaling
  106108. * @param angle sets the angle to rotate the decal
  106109. * @returns a new Mesh
  106110. */
  106111. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  106112. /**
  106113. * Prepare internal position array for software CPU skinning
  106114. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  106115. */
  106116. setPositionsForCPUSkinning(): Float32Array;
  106117. /**
  106118. * Prepare internal normal array for software CPU skinning
  106119. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  106120. */
  106121. setNormalsForCPUSkinning(): Float32Array;
  106122. /**
  106123. * Updates the vertex buffer by applying transformation from the bones
  106124. * @param skeleton defines the skeleton to apply to current mesh
  106125. * @returns the current mesh
  106126. */
  106127. applySkeleton(skeleton: Skeleton): Mesh;
  106128. /**
  106129. * 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
  106130. * @param meshes defines the list of meshes to scan
  106131. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  106132. */
  106133. static MinMax(meshes: AbstractMesh[]): {
  106134. min: Vector3;
  106135. max: Vector3;
  106136. };
  106137. /**
  106138. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  106139. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  106140. * @returns a vector3
  106141. */
  106142. static Center(meshesOrMinMaxVector: {
  106143. min: Vector3;
  106144. max: Vector3;
  106145. } | AbstractMesh[]): Vector3;
  106146. /**
  106147. * Merge the array of meshes into a single mesh for performance reasons.
  106148. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  106149. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  106150. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  106151. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  106152. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  106153. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  106154. * @returns a new mesh
  106155. */
  106156. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  106157. /** @hidden */
  106158. addInstance(instance: InstancedMesh): void;
  106159. /** @hidden */
  106160. removeInstance(instance: InstancedMesh): void;
  106161. }
  106162. }
  106163. declare module BABYLON {
  106164. /**
  106165. * This is the base class of all the camera used in the application.
  106166. * @see http://doc.babylonjs.com/features/cameras
  106167. */
  106168. export class Camera extends Node {
  106169. /** @hidden */
  106170. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  106171. /**
  106172. * This is the default projection mode used by the cameras.
  106173. * It helps recreating a feeling of perspective and better appreciate depth.
  106174. * This is the best way to simulate real life cameras.
  106175. */
  106176. static readonly PERSPECTIVE_CAMERA: number;
  106177. /**
  106178. * This helps creating camera with an orthographic mode.
  106179. * 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.
  106180. */
  106181. static readonly ORTHOGRAPHIC_CAMERA: number;
  106182. /**
  106183. * This is the default FOV mode for perspective cameras.
  106184. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  106185. */
  106186. static readonly FOVMODE_VERTICAL_FIXED: number;
  106187. /**
  106188. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  106189. */
  106190. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  106191. /**
  106192. * This specifies ther is no need for a camera rig.
  106193. * Basically only one eye is rendered corresponding to the camera.
  106194. */
  106195. static readonly RIG_MODE_NONE: number;
  106196. /**
  106197. * Simulates a camera Rig with one blue eye and one red eye.
  106198. * This can be use with 3d blue and red glasses.
  106199. */
  106200. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  106201. /**
  106202. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  106203. */
  106204. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  106205. /**
  106206. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  106207. */
  106208. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  106209. /**
  106210. * Defines that both eyes of the camera will be rendered over under each other.
  106211. */
  106212. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  106213. /**
  106214. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  106215. */
  106216. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  106217. /**
  106218. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  106219. */
  106220. static readonly RIG_MODE_VR: number;
  106221. /**
  106222. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  106223. */
  106224. static readonly RIG_MODE_WEBVR: number;
  106225. /**
  106226. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  106227. */
  106228. static readonly RIG_MODE_CUSTOM: number;
  106229. /**
  106230. * Defines if by default attaching controls should prevent the default javascript event to continue.
  106231. */
  106232. static ForceAttachControlToAlwaysPreventDefault: boolean;
  106233. /**
  106234. * Define the input manager associated with the camera.
  106235. */
  106236. inputs: CameraInputsManager<Camera>;
  106237. /** @hidden */
  106238. _position: Vector3;
  106239. /**
  106240. * Define the current local position of the camera in the scene
  106241. */
  106242. get position(): Vector3;
  106243. set position(newPosition: Vector3);
  106244. /**
  106245. * The vector the camera should consider as up.
  106246. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  106247. */
  106248. upVector: Vector3;
  106249. /**
  106250. * Define the current limit on the left side for an orthographic camera
  106251. * In scene unit
  106252. */
  106253. orthoLeft: Nullable<number>;
  106254. /**
  106255. * Define the current limit on the right side for an orthographic camera
  106256. * In scene unit
  106257. */
  106258. orthoRight: Nullable<number>;
  106259. /**
  106260. * Define the current limit on the bottom side for an orthographic camera
  106261. * In scene unit
  106262. */
  106263. orthoBottom: Nullable<number>;
  106264. /**
  106265. * Define the current limit on the top side for an orthographic camera
  106266. * In scene unit
  106267. */
  106268. orthoTop: Nullable<number>;
  106269. /**
  106270. * Field Of View is set in Radians. (default is 0.8)
  106271. */
  106272. fov: number;
  106273. /**
  106274. * Define the minimum distance the camera can see from.
  106275. * This is important to note that the depth buffer are not infinite and the closer it starts
  106276. * the more your scene might encounter depth fighting issue.
  106277. */
  106278. minZ: number;
  106279. /**
  106280. * Define the maximum distance the camera can see to.
  106281. * This is important to note that the depth buffer are not infinite and the further it end
  106282. * the more your scene might encounter depth fighting issue.
  106283. */
  106284. maxZ: number;
  106285. /**
  106286. * Define the default inertia of the camera.
  106287. * This helps giving a smooth feeling to the camera movement.
  106288. */
  106289. inertia: number;
  106290. /**
  106291. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  106292. */
  106293. mode: number;
  106294. /**
  106295. * Define whether the camera is intermediate.
  106296. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  106297. */
  106298. isIntermediate: boolean;
  106299. /**
  106300. * Define the viewport of the camera.
  106301. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  106302. */
  106303. viewport: Viewport;
  106304. /**
  106305. * Restricts the camera to viewing objects with the same layerMask.
  106306. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  106307. */
  106308. layerMask: number;
  106309. /**
  106310. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  106311. */
  106312. fovMode: number;
  106313. /**
  106314. * Rig mode of the camera.
  106315. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  106316. * This is normally controlled byt the camera themselves as internal use.
  106317. */
  106318. cameraRigMode: number;
  106319. /**
  106320. * Defines the distance between both "eyes" in case of a RIG
  106321. */
  106322. interaxialDistance: number;
  106323. /**
  106324. * Defines if stereoscopic rendering is done side by side or over under.
  106325. */
  106326. isStereoscopicSideBySide: boolean;
  106327. /**
  106328. * 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
  106329. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  106330. * else in the scene. (Eg. security camera)
  106331. *
  106332. * 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)
  106333. */
  106334. customRenderTargets: RenderTargetTexture[];
  106335. /**
  106336. * When set, the camera will render to this render target instead of the default canvas
  106337. *
  106338. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  106339. */
  106340. outputRenderTarget: Nullable<RenderTargetTexture>;
  106341. /**
  106342. * Observable triggered when the camera view matrix has changed.
  106343. */
  106344. onViewMatrixChangedObservable: Observable<Camera>;
  106345. /**
  106346. * Observable triggered when the camera Projection matrix has changed.
  106347. */
  106348. onProjectionMatrixChangedObservable: Observable<Camera>;
  106349. /**
  106350. * Observable triggered when the inputs have been processed.
  106351. */
  106352. onAfterCheckInputsObservable: Observable<Camera>;
  106353. /**
  106354. * Observable triggered when reset has been called and applied to the camera.
  106355. */
  106356. onRestoreStateObservable: Observable<Camera>;
  106357. /**
  106358. * Is this camera a part of a rig system?
  106359. */
  106360. isRigCamera: boolean;
  106361. /**
  106362. * If isRigCamera set to true this will be set with the parent camera.
  106363. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  106364. */
  106365. rigParent?: Camera;
  106366. /** @hidden */
  106367. _cameraRigParams: any;
  106368. /** @hidden */
  106369. _rigCameras: Camera[];
  106370. /** @hidden */
  106371. _rigPostProcess: Nullable<PostProcess>;
  106372. protected _webvrViewMatrix: Matrix;
  106373. /** @hidden */
  106374. _skipRendering: boolean;
  106375. /** @hidden */
  106376. _projectionMatrix: Matrix;
  106377. /** @hidden */
  106378. _postProcesses: Nullable<PostProcess>[];
  106379. /** @hidden */
  106380. _activeMeshes: SmartArray<AbstractMesh>;
  106381. protected _globalPosition: Vector3;
  106382. /** @hidden */
  106383. _computedViewMatrix: Matrix;
  106384. private _doNotComputeProjectionMatrix;
  106385. private _transformMatrix;
  106386. private _frustumPlanes;
  106387. private _refreshFrustumPlanes;
  106388. private _storedFov;
  106389. private _stateStored;
  106390. /**
  106391. * Instantiates a new camera object.
  106392. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  106393. * @see http://doc.babylonjs.com/features/cameras
  106394. * @param name Defines the name of the camera in the scene
  106395. * @param position Defines the position of the camera
  106396. * @param scene Defines the scene the camera belongs too
  106397. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  106398. */
  106399. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  106400. /**
  106401. * Store current camera state (fov, position, etc..)
  106402. * @returns the camera
  106403. */
  106404. storeState(): Camera;
  106405. /**
  106406. * Restores the camera state values if it has been stored. You must call storeState() first
  106407. */
  106408. protected _restoreStateValues(): boolean;
  106409. /**
  106410. * Restored camera state. You must call storeState() first.
  106411. * @returns true if restored and false otherwise
  106412. */
  106413. restoreState(): boolean;
  106414. /**
  106415. * Gets the class name of the camera.
  106416. * @returns the class name
  106417. */
  106418. getClassName(): string;
  106419. /** @hidden */
  106420. readonly _isCamera: boolean;
  106421. /**
  106422. * Gets a string representation of the camera useful for debug purpose.
  106423. * @param fullDetails Defines that a more verboe level of logging is required
  106424. * @returns the string representation
  106425. */
  106426. toString(fullDetails?: boolean): string;
  106427. /**
  106428. * Gets the current world space position of the camera.
  106429. */
  106430. get globalPosition(): Vector3;
  106431. /**
  106432. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  106433. * @returns the active meshe list
  106434. */
  106435. getActiveMeshes(): SmartArray<AbstractMesh>;
  106436. /**
  106437. * Check whether a mesh is part of the current active mesh list of the camera
  106438. * @param mesh Defines the mesh to check
  106439. * @returns true if active, false otherwise
  106440. */
  106441. isActiveMesh(mesh: Mesh): boolean;
  106442. /**
  106443. * Is this camera ready to be used/rendered
  106444. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  106445. * @return true if the camera is ready
  106446. */
  106447. isReady(completeCheck?: boolean): boolean;
  106448. /** @hidden */
  106449. _initCache(): void;
  106450. /** @hidden */
  106451. _updateCache(ignoreParentClass?: boolean): void;
  106452. /** @hidden */
  106453. _isSynchronized(): boolean;
  106454. /** @hidden */
  106455. _isSynchronizedViewMatrix(): boolean;
  106456. /** @hidden */
  106457. _isSynchronizedProjectionMatrix(): boolean;
  106458. /**
  106459. * Attach the input controls to a specific dom element to get the input from.
  106460. * @param element Defines the element the controls should be listened from
  106461. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106462. */
  106463. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106464. /**
  106465. * Detach the current controls from the specified dom element.
  106466. * @param element Defines the element to stop listening the inputs from
  106467. */
  106468. detachControl(element: HTMLElement): void;
  106469. /**
  106470. * Update the camera state according to the different inputs gathered during the frame.
  106471. */
  106472. update(): void;
  106473. /** @hidden */
  106474. _checkInputs(): void;
  106475. /** @hidden */
  106476. get rigCameras(): Camera[];
  106477. /**
  106478. * Gets the post process used by the rig cameras
  106479. */
  106480. get rigPostProcess(): Nullable<PostProcess>;
  106481. /**
  106482. * Internal, gets the first post proces.
  106483. * @returns the first post process to be run on this camera.
  106484. */
  106485. _getFirstPostProcess(): Nullable<PostProcess>;
  106486. private _cascadePostProcessesToRigCams;
  106487. /**
  106488. * Attach a post process to the camera.
  106489. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  106490. * @param postProcess The post process to attach to the camera
  106491. * @param insertAt The position of the post process in case several of them are in use in the scene
  106492. * @returns the position the post process has been inserted at
  106493. */
  106494. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  106495. /**
  106496. * Detach a post process to the camera.
  106497. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  106498. * @param postProcess The post process to detach from the camera
  106499. */
  106500. detachPostProcess(postProcess: PostProcess): void;
  106501. /**
  106502. * Gets the current world matrix of the camera
  106503. */
  106504. getWorldMatrix(): Matrix;
  106505. /** @hidden */
  106506. _getViewMatrix(): Matrix;
  106507. /**
  106508. * Gets the current view matrix of the camera.
  106509. * @param force forces the camera to recompute the matrix without looking at the cached state
  106510. * @returns the view matrix
  106511. */
  106512. getViewMatrix(force?: boolean): Matrix;
  106513. /**
  106514. * Freeze the projection matrix.
  106515. * It will prevent the cache check of the camera projection compute and can speed up perf
  106516. * if no parameter of the camera are meant to change
  106517. * @param projection Defines manually a projection if necessary
  106518. */
  106519. freezeProjectionMatrix(projection?: Matrix): void;
  106520. /**
  106521. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  106522. */
  106523. unfreezeProjectionMatrix(): void;
  106524. /**
  106525. * Gets the current projection matrix of the camera.
  106526. * @param force forces the camera to recompute the matrix without looking at the cached state
  106527. * @returns the projection matrix
  106528. */
  106529. getProjectionMatrix(force?: boolean): Matrix;
  106530. /**
  106531. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  106532. * @returns a Matrix
  106533. */
  106534. getTransformationMatrix(): Matrix;
  106535. private _updateFrustumPlanes;
  106536. /**
  106537. * Checks if a cullable object (mesh...) is in the camera frustum
  106538. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  106539. * @param target The object to check
  106540. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  106541. * @returns true if the object is in frustum otherwise false
  106542. */
  106543. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  106544. /**
  106545. * Checks if a cullable object (mesh...) is in the camera frustum
  106546. * Unlike isInFrustum this cheks the full bounding box
  106547. * @param target The object to check
  106548. * @returns true if the object is in frustum otherwise false
  106549. */
  106550. isCompletelyInFrustum(target: ICullable): boolean;
  106551. /**
  106552. * Gets a ray in the forward direction from the camera.
  106553. * @param length Defines the length of the ray to create
  106554. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  106555. * @param origin Defines the start point of the ray which defaults to the camera position
  106556. * @returns the forward ray
  106557. */
  106558. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  106559. /**
  106560. * Releases resources associated with this node.
  106561. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  106562. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  106563. */
  106564. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  106565. /** @hidden */
  106566. _isLeftCamera: boolean;
  106567. /**
  106568. * Gets the left camera of a rig setup in case of Rigged Camera
  106569. */
  106570. get isLeftCamera(): boolean;
  106571. /** @hidden */
  106572. _isRightCamera: boolean;
  106573. /**
  106574. * Gets the right camera of a rig setup in case of Rigged Camera
  106575. */
  106576. get isRightCamera(): boolean;
  106577. /**
  106578. * Gets the left camera of a rig setup in case of Rigged Camera
  106579. */
  106580. get leftCamera(): Nullable<FreeCamera>;
  106581. /**
  106582. * Gets the right camera of a rig setup in case of Rigged Camera
  106583. */
  106584. get rightCamera(): Nullable<FreeCamera>;
  106585. /**
  106586. * Gets the left camera target of a rig setup in case of Rigged Camera
  106587. * @returns the target position
  106588. */
  106589. getLeftTarget(): Nullable<Vector3>;
  106590. /**
  106591. * Gets the right camera target of a rig setup in case of Rigged Camera
  106592. * @returns the target position
  106593. */
  106594. getRightTarget(): Nullable<Vector3>;
  106595. /**
  106596. * @hidden
  106597. */
  106598. setCameraRigMode(mode: number, rigParams: any): void;
  106599. /** @hidden */
  106600. static _setStereoscopicRigMode(camera: Camera): void;
  106601. /** @hidden */
  106602. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  106603. /** @hidden */
  106604. static _setVRRigMode(camera: Camera, rigParams: any): void;
  106605. /** @hidden */
  106606. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  106607. /** @hidden */
  106608. _getVRProjectionMatrix(): Matrix;
  106609. protected _updateCameraRotationMatrix(): void;
  106610. protected _updateWebVRCameraRotationMatrix(): void;
  106611. /**
  106612. * This function MUST be overwritten by the different WebVR cameras available.
  106613. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  106614. * @hidden
  106615. */
  106616. _getWebVRProjectionMatrix(): Matrix;
  106617. /**
  106618. * This function MUST be overwritten by the different WebVR cameras available.
  106619. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  106620. * @hidden
  106621. */
  106622. _getWebVRViewMatrix(): Matrix;
  106623. /** @hidden */
  106624. setCameraRigParameter(name: string, value: any): void;
  106625. /**
  106626. * needs to be overridden by children so sub has required properties to be copied
  106627. * @hidden
  106628. */
  106629. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  106630. /**
  106631. * May need to be overridden by children
  106632. * @hidden
  106633. */
  106634. _updateRigCameras(): void;
  106635. /** @hidden */
  106636. _setupInputs(): void;
  106637. /**
  106638. * Serialiaze the camera setup to a json represention
  106639. * @returns the JSON representation
  106640. */
  106641. serialize(): any;
  106642. /**
  106643. * Clones the current camera.
  106644. * @param name The cloned camera name
  106645. * @returns the cloned camera
  106646. */
  106647. clone(name: string): Camera;
  106648. /**
  106649. * Gets the direction of the camera relative to a given local axis.
  106650. * @param localAxis Defines the reference axis to provide a relative direction.
  106651. * @return the direction
  106652. */
  106653. getDirection(localAxis: Vector3): Vector3;
  106654. /**
  106655. * Returns the current camera absolute rotation
  106656. */
  106657. get absoluteRotation(): Quaternion;
  106658. /**
  106659. * Gets the direction of the camera relative to a given local axis into a passed vector.
  106660. * @param localAxis Defines the reference axis to provide a relative direction.
  106661. * @param result Defines the vector to store the result in
  106662. */
  106663. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  106664. /**
  106665. * Gets a camera constructor for a given camera type
  106666. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  106667. * @param name The name of the camera the result will be able to instantiate
  106668. * @param scene The scene the result will construct the camera in
  106669. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  106670. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  106671. * @returns a factory method to construc the camera
  106672. */
  106673. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  106674. /**
  106675. * Compute the world matrix of the camera.
  106676. * @returns the camera world matrix
  106677. */
  106678. computeWorldMatrix(): Matrix;
  106679. /**
  106680. * Parse a JSON and creates the camera from the parsed information
  106681. * @param parsedCamera The JSON to parse
  106682. * @param scene The scene to instantiate the camera in
  106683. * @returns the newly constructed camera
  106684. */
  106685. static Parse(parsedCamera: any, scene: Scene): Camera;
  106686. }
  106687. }
  106688. declare module BABYLON {
  106689. /**
  106690. * Class containing static functions to help procedurally build meshes
  106691. */
  106692. export class DiscBuilder {
  106693. /**
  106694. * Creates a plane polygonal mesh. By default, this is a disc
  106695. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  106696. * * 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
  106697. * * 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
  106698. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  106699. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  106700. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  106701. * @param name defines the name of the mesh
  106702. * @param options defines the options used to create the mesh
  106703. * @param scene defines the hosting scene
  106704. * @returns the plane polygonal mesh
  106705. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  106706. */
  106707. static CreateDisc(name: string, options: {
  106708. radius?: number;
  106709. tessellation?: number;
  106710. arc?: number;
  106711. updatable?: boolean;
  106712. sideOrientation?: number;
  106713. frontUVs?: Vector4;
  106714. backUVs?: Vector4;
  106715. }, scene?: Nullable<Scene>): Mesh;
  106716. }
  106717. }
  106718. declare module BABYLON {
  106719. /**
  106720. * Options to be used when creating a FresnelParameters.
  106721. */
  106722. export type IFresnelParametersCreationOptions = {
  106723. /**
  106724. * Define the color used on edges (grazing angle)
  106725. */
  106726. leftColor?: Color3;
  106727. /**
  106728. * Define the color used on center
  106729. */
  106730. rightColor?: Color3;
  106731. /**
  106732. * Define bias applied to computed fresnel term
  106733. */
  106734. bias?: number;
  106735. /**
  106736. * Defined the power exponent applied to fresnel term
  106737. */
  106738. power?: number;
  106739. /**
  106740. * Define if the fresnel effect is enable or not.
  106741. */
  106742. isEnabled?: boolean;
  106743. };
  106744. /**
  106745. * Serialized format for FresnelParameters.
  106746. */
  106747. export type IFresnelParametersSerialized = {
  106748. /**
  106749. * Define the color used on edges (grazing angle) [as an array]
  106750. */
  106751. leftColor: number[];
  106752. /**
  106753. * Define the color used on center [as an array]
  106754. */
  106755. rightColor: number[];
  106756. /**
  106757. * Define bias applied to computed fresnel term
  106758. */
  106759. bias: number;
  106760. /**
  106761. * Defined the power exponent applied to fresnel term
  106762. */
  106763. power?: number;
  106764. /**
  106765. * Define if the fresnel effect is enable or not.
  106766. */
  106767. isEnabled: boolean;
  106768. };
  106769. /**
  106770. * This represents all the required information to add a fresnel effect on a material:
  106771. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  106772. */
  106773. export class FresnelParameters {
  106774. private _isEnabled;
  106775. /**
  106776. * Define if the fresnel effect is enable or not.
  106777. */
  106778. get isEnabled(): boolean;
  106779. set isEnabled(value: boolean);
  106780. /**
  106781. * Define the color used on edges (grazing angle)
  106782. */
  106783. leftColor: Color3;
  106784. /**
  106785. * Define the color used on center
  106786. */
  106787. rightColor: Color3;
  106788. /**
  106789. * Define bias applied to computed fresnel term
  106790. */
  106791. bias: number;
  106792. /**
  106793. * Defined the power exponent applied to fresnel term
  106794. */
  106795. power: number;
  106796. /**
  106797. * Creates a new FresnelParameters object.
  106798. *
  106799. * @param options provide your own settings to optionally to override defaults
  106800. */
  106801. constructor(options?: IFresnelParametersCreationOptions);
  106802. /**
  106803. * Clones the current fresnel and its valuues
  106804. * @returns a clone fresnel configuration
  106805. */
  106806. clone(): FresnelParameters;
  106807. /**
  106808. * Determines equality between FresnelParameters objects
  106809. * @param otherFresnelParameters defines the second operand
  106810. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  106811. */
  106812. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  106813. /**
  106814. * Serializes the current fresnel parameters to a JSON representation.
  106815. * @return the JSON serialization
  106816. */
  106817. serialize(): IFresnelParametersSerialized;
  106818. /**
  106819. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  106820. * @param parsedFresnelParameters Define the JSON representation
  106821. * @returns the parsed parameters
  106822. */
  106823. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  106824. }
  106825. }
  106826. declare module BABYLON {
  106827. /**
  106828. * This groups all the flags used to control the materials channel.
  106829. */
  106830. export class MaterialFlags {
  106831. private static _DiffuseTextureEnabled;
  106832. /**
  106833. * Are diffuse textures enabled in the application.
  106834. */
  106835. static get DiffuseTextureEnabled(): boolean;
  106836. static set DiffuseTextureEnabled(value: boolean);
  106837. private static _DetailTextureEnabled;
  106838. /**
  106839. * Are detail textures enabled in the application.
  106840. */
  106841. static get DetailTextureEnabled(): boolean;
  106842. static set DetailTextureEnabled(value: boolean);
  106843. private static _AmbientTextureEnabled;
  106844. /**
  106845. * Are ambient textures enabled in the application.
  106846. */
  106847. static get AmbientTextureEnabled(): boolean;
  106848. static set AmbientTextureEnabled(value: boolean);
  106849. private static _OpacityTextureEnabled;
  106850. /**
  106851. * Are opacity textures enabled in the application.
  106852. */
  106853. static get OpacityTextureEnabled(): boolean;
  106854. static set OpacityTextureEnabled(value: boolean);
  106855. private static _ReflectionTextureEnabled;
  106856. /**
  106857. * Are reflection textures enabled in the application.
  106858. */
  106859. static get ReflectionTextureEnabled(): boolean;
  106860. static set ReflectionTextureEnabled(value: boolean);
  106861. private static _EmissiveTextureEnabled;
  106862. /**
  106863. * Are emissive textures enabled in the application.
  106864. */
  106865. static get EmissiveTextureEnabled(): boolean;
  106866. static set EmissiveTextureEnabled(value: boolean);
  106867. private static _SpecularTextureEnabled;
  106868. /**
  106869. * Are specular textures enabled in the application.
  106870. */
  106871. static get SpecularTextureEnabled(): boolean;
  106872. static set SpecularTextureEnabled(value: boolean);
  106873. private static _BumpTextureEnabled;
  106874. /**
  106875. * Are bump textures enabled in the application.
  106876. */
  106877. static get BumpTextureEnabled(): boolean;
  106878. static set BumpTextureEnabled(value: boolean);
  106879. private static _LightmapTextureEnabled;
  106880. /**
  106881. * Are lightmap textures enabled in the application.
  106882. */
  106883. static get LightmapTextureEnabled(): boolean;
  106884. static set LightmapTextureEnabled(value: boolean);
  106885. private static _RefractionTextureEnabled;
  106886. /**
  106887. * Are refraction textures enabled in the application.
  106888. */
  106889. static get RefractionTextureEnabled(): boolean;
  106890. static set RefractionTextureEnabled(value: boolean);
  106891. private static _ColorGradingTextureEnabled;
  106892. /**
  106893. * Are color grading textures enabled in the application.
  106894. */
  106895. static get ColorGradingTextureEnabled(): boolean;
  106896. static set ColorGradingTextureEnabled(value: boolean);
  106897. private static _FresnelEnabled;
  106898. /**
  106899. * Are fresnels enabled in the application.
  106900. */
  106901. static get FresnelEnabled(): boolean;
  106902. static set FresnelEnabled(value: boolean);
  106903. private static _ClearCoatTextureEnabled;
  106904. /**
  106905. * Are clear coat textures enabled in the application.
  106906. */
  106907. static get ClearCoatTextureEnabled(): boolean;
  106908. static set ClearCoatTextureEnabled(value: boolean);
  106909. private static _ClearCoatBumpTextureEnabled;
  106910. /**
  106911. * Are clear coat bump textures enabled in the application.
  106912. */
  106913. static get ClearCoatBumpTextureEnabled(): boolean;
  106914. static set ClearCoatBumpTextureEnabled(value: boolean);
  106915. private static _ClearCoatTintTextureEnabled;
  106916. /**
  106917. * Are clear coat tint textures enabled in the application.
  106918. */
  106919. static get ClearCoatTintTextureEnabled(): boolean;
  106920. static set ClearCoatTintTextureEnabled(value: boolean);
  106921. private static _SheenTextureEnabled;
  106922. /**
  106923. * Are sheen textures enabled in the application.
  106924. */
  106925. static get SheenTextureEnabled(): boolean;
  106926. static set SheenTextureEnabled(value: boolean);
  106927. private static _AnisotropicTextureEnabled;
  106928. /**
  106929. * Are anisotropic textures enabled in the application.
  106930. */
  106931. static get AnisotropicTextureEnabled(): boolean;
  106932. static set AnisotropicTextureEnabled(value: boolean);
  106933. private static _ThicknessTextureEnabled;
  106934. /**
  106935. * Are thickness textures enabled in the application.
  106936. */
  106937. static get ThicknessTextureEnabled(): boolean;
  106938. static set ThicknessTextureEnabled(value: boolean);
  106939. }
  106940. }
  106941. declare module BABYLON {
  106942. /** @hidden */
  106943. export var defaultFragmentDeclaration: {
  106944. name: string;
  106945. shader: string;
  106946. };
  106947. }
  106948. declare module BABYLON {
  106949. /** @hidden */
  106950. export var defaultUboDeclaration: {
  106951. name: string;
  106952. shader: string;
  106953. };
  106954. }
  106955. declare module BABYLON {
  106956. /** @hidden */
  106957. export var lightFragmentDeclaration: {
  106958. name: string;
  106959. shader: string;
  106960. };
  106961. }
  106962. declare module BABYLON {
  106963. /** @hidden */
  106964. export var lightUboDeclaration: {
  106965. name: string;
  106966. shader: string;
  106967. };
  106968. }
  106969. declare module BABYLON {
  106970. /** @hidden */
  106971. export var lightsFragmentFunctions: {
  106972. name: string;
  106973. shader: string;
  106974. };
  106975. }
  106976. declare module BABYLON {
  106977. /** @hidden */
  106978. export var shadowsFragmentFunctions: {
  106979. name: string;
  106980. shader: string;
  106981. };
  106982. }
  106983. declare module BABYLON {
  106984. /** @hidden */
  106985. export var fresnelFunction: {
  106986. name: string;
  106987. shader: string;
  106988. };
  106989. }
  106990. declare module BABYLON {
  106991. /** @hidden */
  106992. export var bumpFragmentMainFunctions: {
  106993. name: string;
  106994. shader: string;
  106995. };
  106996. }
  106997. declare module BABYLON {
  106998. /** @hidden */
  106999. export var bumpFragmentFunctions: {
  107000. name: string;
  107001. shader: string;
  107002. };
  107003. }
  107004. declare module BABYLON {
  107005. /** @hidden */
  107006. export var logDepthDeclaration: {
  107007. name: string;
  107008. shader: string;
  107009. };
  107010. }
  107011. declare module BABYLON {
  107012. /** @hidden */
  107013. export var bumpFragment: {
  107014. name: string;
  107015. shader: string;
  107016. };
  107017. }
  107018. declare module BABYLON {
  107019. /** @hidden */
  107020. export var depthPrePass: {
  107021. name: string;
  107022. shader: string;
  107023. };
  107024. }
  107025. declare module BABYLON {
  107026. /** @hidden */
  107027. export var lightFragment: {
  107028. name: string;
  107029. shader: string;
  107030. };
  107031. }
  107032. declare module BABYLON {
  107033. /** @hidden */
  107034. export var logDepthFragment: {
  107035. name: string;
  107036. shader: string;
  107037. };
  107038. }
  107039. declare module BABYLON {
  107040. /** @hidden */
  107041. export var defaultPixelShader: {
  107042. name: string;
  107043. shader: string;
  107044. };
  107045. }
  107046. declare module BABYLON {
  107047. /** @hidden */
  107048. export var defaultVertexDeclaration: {
  107049. name: string;
  107050. shader: string;
  107051. };
  107052. }
  107053. declare module BABYLON {
  107054. /** @hidden */
  107055. export var bumpVertexDeclaration: {
  107056. name: string;
  107057. shader: string;
  107058. };
  107059. }
  107060. declare module BABYLON {
  107061. /** @hidden */
  107062. export var bumpVertex: {
  107063. name: string;
  107064. shader: string;
  107065. };
  107066. }
  107067. declare module BABYLON {
  107068. /** @hidden */
  107069. export var fogVertex: {
  107070. name: string;
  107071. shader: string;
  107072. };
  107073. }
  107074. declare module BABYLON {
  107075. /** @hidden */
  107076. export var shadowsVertex: {
  107077. name: string;
  107078. shader: string;
  107079. };
  107080. }
  107081. declare module BABYLON {
  107082. /** @hidden */
  107083. export var pointCloudVertex: {
  107084. name: string;
  107085. shader: string;
  107086. };
  107087. }
  107088. declare module BABYLON {
  107089. /** @hidden */
  107090. export var logDepthVertex: {
  107091. name: string;
  107092. shader: string;
  107093. };
  107094. }
  107095. declare module BABYLON {
  107096. /** @hidden */
  107097. export var defaultVertexShader: {
  107098. name: string;
  107099. shader: string;
  107100. };
  107101. }
  107102. declare module BABYLON {
  107103. /**
  107104. * @hidden
  107105. */
  107106. export interface IMaterialDetailMapDefines {
  107107. DETAIL: boolean;
  107108. DETAILDIRECTUV: number;
  107109. DETAIL_NORMALBLENDMETHOD: number;
  107110. /** @hidden */
  107111. _areTexturesDirty: boolean;
  107112. }
  107113. /**
  107114. * Define the code related to the detail map parameters of a material
  107115. *
  107116. * Inspired from:
  107117. * Unity: https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@9.0/manual/Mask-Map-and-Detail-Map.html and https://docs.unity3d.com/Manual/StandardShaderMaterialParameterDetail.html
  107118. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  107119. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  107120. */
  107121. export class DetailMapConfiguration {
  107122. private _texture;
  107123. /**
  107124. * The detail texture of the material.
  107125. */
  107126. texture: Nullable<BaseTexture>;
  107127. /**
  107128. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  107129. * Bigger values mean stronger blending
  107130. */
  107131. diffuseBlendLevel: number;
  107132. /**
  107133. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  107134. * Bigger values mean stronger blending. Only used with PBR materials
  107135. */
  107136. roughnessBlendLevel: number;
  107137. /**
  107138. * Defines how strong the bump effect from the detail map is
  107139. * Bigger values mean stronger effect
  107140. */
  107141. bumpLevel: number;
  107142. private _normalBlendMethod;
  107143. /**
  107144. * The method used to blend the bump and detail normals together
  107145. */
  107146. normalBlendMethod: number;
  107147. private _isEnabled;
  107148. /**
  107149. * Enable or disable the detail map on this material
  107150. */
  107151. isEnabled: boolean;
  107152. /** @hidden */
  107153. private _internalMarkAllSubMeshesAsTexturesDirty;
  107154. /** @hidden */
  107155. _markAllSubMeshesAsTexturesDirty(): void;
  107156. /**
  107157. * Instantiate a new detail map
  107158. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  107159. */
  107160. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  107161. /**
  107162. * Gets whether the submesh is ready to be used or not.
  107163. * @param defines the list of "defines" to update.
  107164. * @param scene defines the scene the material belongs to.
  107165. * @returns - boolean indicating that the submesh is ready or not.
  107166. */
  107167. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  107168. /**
  107169. * Update the defines for detail map usage
  107170. * @param defines the list of "defines" to update.
  107171. * @param scene defines the scene the material belongs to.
  107172. */
  107173. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  107174. /**
  107175. * Binds the material data.
  107176. * @param uniformBuffer defines the Uniform buffer to fill in.
  107177. * @param scene defines the scene the material belongs to.
  107178. * @param isFrozen defines whether the material is frozen or not.
  107179. */
  107180. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  107181. /**
  107182. * Checks to see if a texture is used in the material.
  107183. * @param texture - Base texture to use.
  107184. * @returns - Boolean specifying if a texture is used in the material.
  107185. */
  107186. hasTexture(texture: BaseTexture): boolean;
  107187. /**
  107188. * Returns an array of the actively used textures.
  107189. * @param activeTextures Array of BaseTextures
  107190. */
  107191. getActiveTextures(activeTextures: BaseTexture[]): void;
  107192. /**
  107193. * Returns the animatable textures.
  107194. * @param animatables Array of animatable textures.
  107195. */
  107196. getAnimatables(animatables: IAnimatable[]): void;
  107197. /**
  107198. * Disposes the resources of the material.
  107199. * @param forceDisposeTextures - Forces the disposal of all textures.
  107200. */
  107201. dispose(forceDisposeTextures?: boolean): void;
  107202. /**
  107203. * Get the current class name useful for serialization or dynamic coding.
  107204. * @returns "DetailMap"
  107205. */
  107206. getClassName(): string;
  107207. /**
  107208. * Add the required uniforms to the current list.
  107209. * @param uniforms defines the current uniform list.
  107210. */
  107211. static AddUniforms(uniforms: string[]): void;
  107212. /**
  107213. * Add the required samplers to the current list.
  107214. * @param samplers defines the current sampler list.
  107215. */
  107216. static AddSamplers(samplers: string[]): void;
  107217. /**
  107218. * Add the required uniforms to the current buffer.
  107219. * @param uniformBuffer defines the current uniform buffer.
  107220. */
  107221. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  107222. /**
  107223. * Makes a duplicate of the current instance into another one.
  107224. * @param detailMap define the instance where to copy the info
  107225. */
  107226. copyTo(detailMap: DetailMapConfiguration): void;
  107227. /**
  107228. * Serializes this detail map instance
  107229. * @returns - An object with the serialized instance.
  107230. */
  107231. serialize(): any;
  107232. /**
  107233. * Parses a detail map setting from a serialized object.
  107234. * @param source - Serialized object.
  107235. * @param scene Defines the scene we are parsing for
  107236. * @param rootUrl Defines the rootUrl to load from
  107237. */
  107238. parse(source: any, scene: Scene, rootUrl: string): void;
  107239. }
  107240. }
  107241. declare module BABYLON {
  107242. /** @hidden */
  107243. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  107244. MAINUV1: boolean;
  107245. MAINUV2: boolean;
  107246. DIFFUSE: boolean;
  107247. DIFFUSEDIRECTUV: number;
  107248. DETAIL: boolean;
  107249. DETAILDIRECTUV: number;
  107250. DETAIL_NORMALBLENDMETHOD: number;
  107251. AMBIENT: boolean;
  107252. AMBIENTDIRECTUV: number;
  107253. OPACITY: boolean;
  107254. OPACITYDIRECTUV: number;
  107255. OPACITYRGB: boolean;
  107256. REFLECTION: boolean;
  107257. EMISSIVE: boolean;
  107258. EMISSIVEDIRECTUV: number;
  107259. SPECULAR: boolean;
  107260. SPECULARDIRECTUV: number;
  107261. BUMP: boolean;
  107262. BUMPDIRECTUV: number;
  107263. PARALLAX: boolean;
  107264. PARALLAXOCCLUSION: boolean;
  107265. SPECULAROVERALPHA: boolean;
  107266. CLIPPLANE: boolean;
  107267. CLIPPLANE2: boolean;
  107268. CLIPPLANE3: boolean;
  107269. CLIPPLANE4: boolean;
  107270. CLIPPLANE5: boolean;
  107271. CLIPPLANE6: boolean;
  107272. ALPHATEST: boolean;
  107273. DEPTHPREPASS: boolean;
  107274. ALPHAFROMDIFFUSE: boolean;
  107275. POINTSIZE: boolean;
  107276. FOG: boolean;
  107277. SPECULARTERM: boolean;
  107278. DIFFUSEFRESNEL: boolean;
  107279. OPACITYFRESNEL: boolean;
  107280. REFLECTIONFRESNEL: boolean;
  107281. REFRACTIONFRESNEL: boolean;
  107282. EMISSIVEFRESNEL: boolean;
  107283. FRESNEL: boolean;
  107284. NORMAL: boolean;
  107285. UV1: boolean;
  107286. UV2: boolean;
  107287. VERTEXCOLOR: boolean;
  107288. VERTEXALPHA: boolean;
  107289. NUM_BONE_INFLUENCERS: number;
  107290. BonesPerMesh: number;
  107291. BONETEXTURE: boolean;
  107292. INSTANCES: boolean;
  107293. THIN_INSTANCES: boolean;
  107294. GLOSSINESS: boolean;
  107295. ROUGHNESS: boolean;
  107296. EMISSIVEASILLUMINATION: boolean;
  107297. LINKEMISSIVEWITHDIFFUSE: boolean;
  107298. REFLECTIONFRESNELFROMSPECULAR: boolean;
  107299. LIGHTMAP: boolean;
  107300. LIGHTMAPDIRECTUV: number;
  107301. OBJECTSPACE_NORMALMAP: boolean;
  107302. USELIGHTMAPASSHADOWMAP: boolean;
  107303. REFLECTIONMAP_3D: boolean;
  107304. REFLECTIONMAP_SPHERICAL: boolean;
  107305. REFLECTIONMAP_PLANAR: boolean;
  107306. REFLECTIONMAP_CUBIC: boolean;
  107307. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  107308. REFLECTIONMAP_PROJECTION: boolean;
  107309. REFLECTIONMAP_SKYBOX: boolean;
  107310. REFLECTIONMAP_EXPLICIT: boolean;
  107311. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  107312. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  107313. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  107314. INVERTCUBICMAP: boolean;
  107315. LOGARITHMICDEPTH: boolean;
  107316. REFRACTION: boolean;
  107317. REFRACTIONMAP_3D: boolean;
  107318. REFLECTIONOVERALPHA: boolean;
  107319. TWOSIDEDLIGHTING: boolean;
  107320. SHADOWFLOAT: boolean;
  107321. MORPHTARGETS: boolean;
  107322. MORPHTARGETS_NORMAL: boolean;
  107323. MORPHTARGETS_TANGENT: boolean;
  107324. MORPHTARGETS_UV: boolean;
  107325. NUM_MORPH_INFLUENCERS: number;
  107326. NONUNIFORMSCALING: boolean;
  107327. PREMULTIPLYALPHA: boolean;
  107328. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  107329. ALPHABLEND: boolean;
  107330. RGBDLIGHTMAP: boolean;
  107331. RGBDREFLECTION: boolean;
  107332. RGBDREFRACTION: boolean;
  107333. IMAGEPROCESSING: boolean;
  107334. VIGNETTE: boolean;
  107335. VIGNETTEBLENDMODEMULTIPLY: boolean;
  107336. VIGNETTEBLENDMODEOPAQUE: boolean;
  107337. TONEMAPPING: boolean;
  107338. TONEMAPPING_ACES: boolean;
  107339. CONTRAST: boolean;
  107340. COLORCURVES: boolean;
  107341. COLORGRADING: boolean;
  107342. COLORGRADING3D: boolean;
  107343. SAMPLER3DGREENDEPTH: boolean;
  107344. SAMPLER3DBGRMAP: boolean;
  107345. IMAGEPROCESSINGPOSTPROCESS: boolean;
  107346. MULTIVIEW: boolean;
  107347. /**
  107348. * If the reflection texture on this material is in linear color space
  107349. * @hidden
  107350. */
  107351. IS_REFLECTION_LINEAR: boolean;
  107352. /**
  107353. * If the refraction texture on this material is in linear color space
  107354. * @hidden
  107355. */
  107356. IS_REFRACTION_LINEAR: boolean;
  107357. EXPOSURE: boolean;
  107358. constructor();
  107359. setReflectionMode(modeToEnable: string): void;
  107360. }
  107361. /**
  107362. * This is the default material used in Babylon. It is the best trade off between quality
  107363. * and performances.
  107364. * @see http://doc.babylonjs.com/babylon101/materials
  107365. */
  107366. export class StandardMaterial extends PushMaterial {
  107367. private _diffuseTexture;
  107368. /**
  107369. * The basic texture of the material as viewed under a light.
  107370. */
  107371. diffuseTexture: Nullable<BaseTexture>;
  107372. private _ambientTexture;
  107373. /**
  107374. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  107375. */
  107376. ambientTexture: Nullable<BaseTexture>;
  107377. private _opacityTexture;
  107378. /**
  107379. * Define the transparency of the material from a texture.
  107380. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  107381. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  107382. */
  107383. opacityTexture: Nullable<BaseTexture>;
  107384. private _reflectionTexture;
  107385. /**
  107386. * Define the texture used to display the reflection.
  107387. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  107388. */
  107389. reflectionTexture: Nullable<BaseTexture>;
  107390. private _emissiveTexture;
  107391. /**
  107392. * Define texture of the material as if self lit.
  107393. * This will be mixed in the final result even in the absence of light.
  107394. */
  107395. emissiveTexture: Nullable<BaseTexture>;
  107396. private _specularTexture;
  107397. /**
  107398. * Define how the color and intensity of the highlight given by the light in the material.
  107399. */
  107400. specularTexture: Nullable<BaseTexture>;
  107401. private _bumpTexture;
  107402. /**
  107403. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  107404. * 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.
  107405. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  107406. */
  107407. bumpTexture: Nullable<BaseTexture>;
  107408. private _lightmapTexture;
  107409. /**
  107410. * Complex lighting can be computationally expensive to compute at runtime.
  107411. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  107412. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  107413. */
  107414. lightmapTexture: Nullable<BaseTexture>;
  107415. private _refractionTexture;
  107416. /**
  107417. * Define the texture used to display the refraction.
  107418. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  107419. */
  107420. refractionTexture: Nullable<BaseTexture>;
  107421. /**
  107422. * The color of the material lit by the environmental background lighting.
  107423. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  107424. */
  107425. ambientColor: Color3;
  107426. /**
  107427. * The basic color of the material as viewed under a light.
  107428. */
  107429. diffuseColor: Color3;
  107430. /**
  107431. * Define how the color and intensity of the highlight given by the light in the material.
  107432. */
  107433. specularColor: Color3;
  107434. /**
  107435. * Define the color of the material as if self lit.
  107436. * This will be mixed in the final result even in the absence of light.
  107437. */
  107438. emissiveColor: Color3;
  107439. /**
  107440. * Defines how sharp are the highlights in the material.
  107441. * The bigger the value the sharper giving a more glossy feeling to the result.
  107442. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  107443. */
  107444. specularPower: number;
  107445. private _useAlphaFromDiffuseTexture;
  107446. /**
  107447. * Does the transparency come from the diffuse texture alpha channel.
  107448. */
  107449. useAlphaFromDiffuseTexture: boolean;
  107450. private _useEmissiveAsIllumination;
  107451. /**
  107452. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  107453. */
  107454. useEmissiveAsIllumination: boolean;
  107455. private _linkEmissiveWithDiffuse;
  107456. /**
  107457. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  107458. * the emissive level when the final color is close to one.
  107459. */
  107460. linkEmissiveWithDiffuse: boolean;
  107461. private _useSpecularOverAlpha;
  107462. /**
  107463. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  107464. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  107465. */
  107466. useSpecularOverAlpha: boolean;
  107467. private _useReflectionOverAlpha;
  107468. /**
  107469. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  107470. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  107471. */
  107472. useReflectionOverAlpha: boolean;
  107473. private _disableLighting;
  107474. /**
  107475. * Does lights from the scene impacts this material.
  107476. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  107477. */
  107478. disableLighting: boolean;
  107479. private _useObjectSpaceNormalMap;
  107480. /**
  107481. * Allows using an object space normal map (instead of tangent space).
  107482. */
  107483. useObjectSpaceNormalMap: boolean;
  107484. private _useParallax;
  107485. /**
  107486. * Is parallax enabled or not.
  107487. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  107488. */
  107489. useParallax: boolean;
  107490. private _useParallaxOcclusion;
  107491. /**
  107492. * Is parallax occlusion enabled or not.
  107493. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  107494. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  107495. */
  107496. useParallaxOcclusion: boolean;
  107497. /**
  107498. * 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.
  107499. */
  107500. parallaxScaleBias: number;
  107501. private _roughness;
  107502. /**
  107503. * Helps to define how blurry the reflections should appears in the material.
  107504. */
  107505. roughness: number;
  107506. /**
  107507. * In case of refraction, define the value of the index of refraction.
  107508. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  107509. */
  107510. indexOfRefraction: number;
  107511. /**
  107512. * Invert the refraction texture alongside the y axis.
  107513. * It can be useful with procedural textures or probe for instance.
  107514. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  107515. */
  107516. invertRefractionY: boolean;
  107517. /**
  107518. * Defines the alpha limits in alpha test mode.
  107519. */
  107520. alphaCutOff: number;
  107521. private _useLightmapAsShadowmap;
  107522. /**
  107523. * In case of light mapping, define whether the map contains light or shadow informations.
  107524. */
  107525. useLightmapAsShadowmap: boolean;
  107526. private _diffuseFresnelParameters;
  107527. /**
  107528. * Define the diffuse fresnel parameters of the material.
  107529. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  107530. */
  107531. diffuseFresnelParameters: FresnelParameters;
  107532. private _opacityFresnelParameters;
  107533. /**
  107534. * Define the opacity fresnel parameters of the material.
  107535. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  107536. */
  107537. opacityFresnelParameters: FresnelParameters;
  107538. private _reflectionFresnelParameters;
  107539. /**
  107540. * Define the reflection fresnel parameters of the material.
  107541. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  107542. */
  107543. reflectionFresnelParameters: FresnelParameters;
  107544. private _refractionFresnelParameters;
  107545. /**
  107546. * Define the refraction fresnel parameters of the material.
  107547. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  107548. */
  107549. refractionFresnelParameters: FresnelParameters;
  107550. private _emissiveFresnelParameters;
  107551. /**
  107552. * Define the emissive fresnel parameters of the material.
  107553. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  107554. */
  107555. emissiveFresnelParameters: FresnelParameters;
  107556. private _useReflectionFresnelFromSpecular;
  107557. /**
  107558. * If true automatically deducts the fresnels values from the material specularity.
  107559. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  107560. */
  107561. useReflectionFresnelFromSpecular: boolean;
  107562. private _useGlossinessFromSpecularMapAlpha;
  107563. /**
  107564. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  107565. */
  107566. useGlossinessFromSpecularMapAlpha: boolean;
  107567. private _maxSimultaneousLights;
  107568. /**
  107569. * Defines the maximum number of lights that can be used in the material
  107570. */
  107571. maxSimultaneousLights: number;
  107572. private _invertNormalMapX;
  107573. /**
  107574. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  107575. */
  107576. invertNormalMapX: boolean;
  107577. private _invertNormalMapY;
  107578. /**
  107579. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  107580. */
  107581. invertNormalMapY: boolean;
  107582. private _twoSidedLighting;
  107583. /**
  107584. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  107585. */
  107586. twoSidedLighting: boolean;
  107587. /**
  107588. * Default configuration related to image processing available in the standard Material.
  107589. */
  107590. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  107591. /**
  107592. * Gets the image processing configuration used either in this material.
  107593. */
  107594. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  107595. /**
  107596. * Sets the Default image processing configuration used either in the this material.
  107597. *
  107598. * If sets to null, the scene one is in use.
  107599. */
  107600. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  107601. /**
  107602. * Keep track of the image processing observer to allow dispose and replace.
  107603. */
  107604. private _imageProcessingObserver;
  107605. /**
  107606. * Attaches a new image processing configuration to the Standard Material.
  107607. * @param configuration
  107608. */
  107609. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  107610. /**
  107611. * Gets wether the color curves effect is enabled.
  107612. */
  107613. get cameraColorCurvesEnabled(): boolean;
  107614. /**
  107615. * Sets wether the color curves effect is enabled.
  107616. */
  107617. set cameraColorCurvesEnabled(value: boolean);
  107618. /**
  107619. * Gets wether the color grading effect is enabled.
  107620. */
  107621. get cameraColorGradingEnabled(): boolean;
  107622. /**
  107623. * Gets wether the color grading effect is enabled.
  107624. */
  107625. set cameraColorGradingEnabled(value: boolean);
  107626. /**
  107627. * Gets wether tonemapping is enabled or not.
  107628. */
  107629. get cameraToneMappingEnabled(): boolean;
  107630. /**
  107631. * Sets wether tonemapping is enabled or not
  107632. */
  107633. set cameraToneMappingEnabled(value: boolean);
  107634. /**
  107635. * The camera exposure used on this material.
  107636. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  107637. * This corresponds to a photographic exposure.
  107638. */
  107639. get cameraExposure(): number;
  107640. /**
  107641. * The camera exposure used on this material.
  107642. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  107643. * This corresponds to a photographic exposure.
  107644. */
  107645. set cameraExposure(value: number);
  107646. /**
  107647. * Gets The camera contrast used on this material.
  107648. */
  107649. get cameraContrast(): number;
  107650. /**
  107651. * Sets The camera contrast used on this material.
  107652. */
  107653. set cameraContrast(value: number);
  107654. /**
  107655. * Gets the Color Grading 2D Lookup Texture.
  107656. */
  107657. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  107658. /**
  107659. * Sets the Color Grading 2D Lookup Texture.
  107660. */
  107661. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  107662. /**
  107663. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  107664. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  107665. * 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;
  107666. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  107667. */
  107668. get cameraColorCurves(): Nullable<ColorCurves>;
  107669. /**
  107670. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  107671. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  107672. * 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;
  107673. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  107674. */
  107675. set cameraColorCurves(value: Nullable<ColorCurves>);
  107676. /**
  107677. * Defines the detail map parameters for the material.
  107678. */
  107679. readonly detailMap: DetailMapConfiguration;
  107680. protected _renderTargets: SmartArray<RenderTargetTexture>;
  107681. protected _worldViewProjectionMatrix: Matrix;
  107682. protected _globalAmbientColor: Color3;
  107683. protected _useLogarithmicDepth: boolean;
  107684. protected _rebuildInParallel: boolean;
  107685. /**
  107686. * Instantiates a new standard material.
  107687. * This is the default material used in Babylon. It is the best trade off between quality
  107688. * and performances.
  107689. * @see http://doc.babylonjs.com/babylon101/materials
  107690. * @param name Define the name of the material in the scene
  107691. * @param scene Define the scene the material belong to
  107692. */
  107693. constructor(name: string, scene: Scene);
  107694. /**
  107695. * Gets a boolean indicating that current material needs to register RTT
  107696. */
  107697. get hasRenderTargetTextures(): boolean;
  107698. /**
  107699. * Gets the current class name of the material e.g. "StandardMaterial"
  107700. * Mainly use in serialization.
  107701. * @returns the class name
  107702. */
  107703. getClassName(): string;
  107704. /**
  107705. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  107706. * You can try switching to logarithmic depth.
  107707. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  107708. */
  107709. get useLogarithmicDepth(): boolean;
  107710. set useLogarithmicDepth(value: boolean);
  107711. /**
  107712. * Specifies if the material will require alpha blending
  107713. * @returns a boolean specifying if alpha blending is needed
  107714. */
  107715. needAlphaBlending(): boolean;
  107716. /**
  107717. * Specifies if this material should be rendered in alpha test mode
  107718. * @returns a boolean specifying if an alpha test is needed.
  107719. */
  107720. needAlphaTesting(): boolean;
  107721. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  107722. /**
  107723. * Get the texture used for alpha test purpose.
  107724. * @returns the diffuse texture in case of the standard material.
  107725. */
  107726. getAlphaTestTexture(): Nullable<BaseTexture>;
  107727. /**
  107728. * Get if the submesh is ready to be used and all its information available.
  107729. * Child classes can use it to update shaders
  107730. * @param mesh defines the mesh to check
  107731. * @param subMesh defines which submesh to check
  107732. * @param useInstances specifies that instances should be used
  107733. * @returns a boolean indicating that the submesh is ready or not
  107734. */
  107735. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  107736. /**
  107737. * Builds the material UBO layouts.
  107738. * Used internally during the effect preparation.
  107739. */
  107740. buildUniformLayout(): void;
  107741. /**
  107742. * Unbinds the material from the mesh
  107743. */
  107744. unbind(): void;
  107745. /**
  107746. * Binds the submesh to this material by preparing the effect and shader to draw
  107747. * @param world defines the world transformation matrix
  107748. * @param mesh defines the mesh containing the submesh
  107749. * @param subMesh defines the submesh to bind the material to
  107750. */
  107751. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  107752. /**
  107753. * Get the list of animatables in the material.
  107754. * @returns the list of animatables object used in the material
  107755. */
  107756. getAnimatables(): IAnimatable[];
  107757. /**
  107758. * Gets the active textures from the material
  107759. * @returns an array of textures
  107760. */
  107761. getActiveTextures(): BaseTexture[];
  107762. /**
  107763. * Specifies if the material uses a texture
  107764. * @param texture defines the texture to check against the material
  107765. * @returns a boolean specifying if the material uses the texture
  107766. */
  107767. hasTexture(texture: BaseTexture): boolean;
  107768. /**
  107769. * Disposes the material
  107770. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  107771. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  107772. */
  107773. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  107774. /**
  107775. * Makes a duplicate of the material, and gives it a new name
  107776. * @param name defines the new name for the duplicated material
  107777. * @returns the cloned material
  107778. */
  107779. clone(name: string): StandardMaterial;
  107780. /**
  107781. * Serializes this material in a JSON representation
  107782. * @returns the serialized material object
  107783. */
  107784. serialize(): any;
  107785. /**
  107786. * Creates a standard material from parsed material data
  107787. * @param source defines the JSON representation of the material
  107788. * @param scene defines the hosting scene
  107789. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  107790. * @returns a new standard material
  107791. */
  107792. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  107793. /**
  107794. * Are diffuse textures enabled in the application.
  107795. */
  107796. static get DiffuseTextureEnabled(): boolean;
  107797. static set DiffuseTextureEnabled(value: boolean);
  107798. /**
  107799. * Are detail textures enabled in the application.
  107800. */
  107801. static get DetailTextureEnabled(): boolean;
  107802. static set DetailTextureEnabled(value: boolean);
  107803. /**
  107804. * Are ambient textures enabled in the application.
  107805. */
  107806. static get AmbientTextureEnabled(): boolean;
  107807. static set AmbientTextureEnabled(value: boolean);
  107808. /**
  107809. * Are opacity textures enabled in the application.
  107810. */
  107811. static get OpacityTextureEnabled(): boolean;
  107812. static set OpacityTextureEnabled(value: boolean);
  107813. /**
  107814. * Are reflection textures enabled in the application.
  107815. */
  107816. static get ReflectionTextureEnabled(): boolean;
  107817. static set ReflectionTextureEnabled(value: boolean);
  107818. /**
  107819. * Are emissive textures enabled in the application.
  107820. */
  107821. static get EmissiveTextureEnabled(): boolean;
  107822. static set EmissiveTextureEnabled(value: boolean);
  107823. /**
  107824. * Are specular textures enabled in the application.
  107825. */
  107826. static get SpecularTextureEnabled(): boolean;
  107827. static set SpecularTextureEnabled(value: boolean);
  107828. /**
  107829. * Are bump textures enabled in the application.
  107830. */
  107831. static get BumpTextureEnabled(): boolean;
  107832. static set BumpTextureEnabled(value: boolean);
  107833. /**
  107834. * Are lightmap textures enabled in the application.
  107835. */
  107836. static get LightmapTextureEnabled(): boolean;
  107837. static set LightmapTextureEnabled(value: boolean);
  107838. /**
  107839. * Are refraction textures enabled in the application.
  107840. */
  107841. static get RefractionTextureEnabled(): boolean;
  107842. static set RefractionTextureEnabled(value: boolean);
  107843. /**
  107844. * Are color grading textures enabled in the application.
  107845. */
  107846. static get ColorGradingTextureEnabled(): boolean;
  107847. static set ColorGradingTextureEnabled(value: boolean);
  107848. /**
  107849. * Are fresnels enabled in the application.
  107850. */
  107851. static get FresnelEnabled(): boolean;
  107852. static set FresnelEnabled(value: boolean);
  107853. }
  107854. }
  107855. declare module BABYLON {
  107856. /**
  107857. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  107858. *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.
  107859. * The SPS is also a particle system. It provides some methods to manage the particles.
  107860. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  107861. *
  107862. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  107863. */
  107864. export class SolidParticleSystem implements IDisposable {
  107865. /**
  107866. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  107867. * Example : var p = SPS.particles[i];
  107868. */
  107869. particles: SolidParticle[];
  107870. /**
  107871. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  107872. */
  107873. nbParticles: number;
  107874. /**
  107875. * If the particles must ever face the camera (default false). Useful for planar particles.
  107876. */
  107877. billboard: boolean;
  107878. /**
  107879. * Recompute normals when adding a shape
  107880. */
  107881. recomputeNormals: boolean;
  107882. /**
  107883. * This a counter ofr your own usage. It's not set by any SPS functions.
  107884. */
  107885. counter: number;
  107886. /**
  107887. * The SPS name. This name is also given to the underlying mesh.
  107888. */
  107889. name: string;
  107890. /**
  107891. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  107892. */
  107893. mesh: Mesh;
  107894. /**
  107895. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  107896. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  107897. */
  107898. vars: any;
  107899. /**
  107900. * This array is populated when the SPS is set as 'pickable'.
  107901. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  107902. * Each element of this array is an object `{idx: int, faceId: int}`.
  107903. * `idx` is the picked particle index in the `SPS.particles` array
  107904. * `faceId` is the picked face index counted within this particle.
  107905. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  107906. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  107907. * Use the method SPS.pickedParticle(pickingInfo) instead.
  107908. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  107909. */
  107910. pickedParticles: {
  107911. idx: number;
  107912. faceId: number;
  107913. }[];
  107914. /**
  107915. * This array is populated when the SPS is set as 'pickable'
  107916. * Each key of this array is a submesh index.
  107917. * Each element of this array is a second array defined like this :
  107918. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  107919. * Each element of this second array is an object `{idx: int, faceId: int}`.
  107920. * `idx` is the picked particle index in the `SPS.particles` array
  107921. * `faceId` is the picked face index counted within this particle.
  107922. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  107923. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  107924. */
  107925. pickedBySubMesh: {
  107926. idx: number;
  107927. faceId: number;
  107928. }[][];
  107929. /**
  107930. * This array is populated when `enableDepthSort` is set to true.
  107931. * Each element of this array is an instance of the class DepthSortedParticle.
  107932. */
  107933. depthSortedParticles: DepthSortedParticle[];
  107934. /**
  107935. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  107936. * @hidden
  107937. */
  107938. _bSphereOnly: boolean;
  107939. /**
  107940. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  107941. * @hidden
  107942. */
  107943. _bSphereRadiusFactor: number;
  107944. private _scene;
  107945. private _positions;
  107946. private _indices;
  107947. private _normals;
  107948. private _colors;
  107949. private _uvs;
  107950. private _indices32;
  107951. private _positions32;
  107952. private _normals32;
  107953. private _fixedNormal32;
  107954. private _colors32;
  107955. private _uvs32;
  107956. private _index;
  107957. private _updatable;
  107958. private _pickable;
  107959. private _isVisibilityBoxLocked;
  107960. private _alwaysVisible;
  107961. private _depthSort;
  107962. private _expandable;
  107963. private _shapeCounter;
  107964. private _copy;
  107965. private _color;
  107966. private _computeParticleColor;
  107967. private _computeParticleTexture;
  107968. private _computeParticleRotation;
  107969. private _computeParticleVertex;
  107970. private _computeBoundingBox;
  107971. private _depthSortParticles;
  107972. private _camera;
  107973. private _mustUnrotateFixedNormals;
  107974. private _particlesIntersect;
  107975. private _needs32Bits;
  107976. private _isNotBuilt;
  107977. private _lastParticleId;
  107978. private _idxOfId;
  107979. private _multimaterialEnabled;
  107980. private _useModelMaterial;
  107981. private _indicesByMaterial;
  107982. private _materialIndexes;
  107983. private _depthSortFunction;
  107984. private _materialSortFunction;
  107985. private _materials;
  107986. private _multimaterial;
  107987. private _materialIndexesById;
  107988. private _defaultMaterial;
  107989. private _autoUpdateSubMeshes;
  107990. private _tmpVertex;
  107991. /**
  107992. * Creates a SPS (Solid Particle System) object.
  107993. * @param name (String) is the SPS name, this will be the underlying mesh name.
  107994. * @param scene (Scene) is the scene in which the SPS is added.
  107995. * @param options defines the options of the sps e.g.
  107996. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  107997. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  107998. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  107999. * * useModelMaterial (optional boolean, defaut false) : if the model materials must be used to create the SPS multimaterial. This enables the multimaterial supports of the SPS.
  108000. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  108001. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  108002. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  108003. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  108004. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  108005. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  108006. */
  108007. constructor(name: string, scene: Scene, options?: {
  108008. updatable?: boolean;
  108009. isPickable?: boolean;
  108010. enableDepthSort?: boolean;
  108011. particleIntersection?: boolean;
  108012. boundingSphereOnly?: boolean;
  108013. bSphereRadiusFactor?: number;
  108014. expandable?: boolean;
  108015. useModelMaterial?: boolean;
  108016. enableMultiMaterial?: boolean;
  108017. });
  108018. /**
  108019. * Builds the SPS underlying mesh. Returns a standard Mesh.
  108020. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  108021. * @returns the created mesh
  108022. */
  108023. buildMesh(): Mesh;
  108024. /**
  108025. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  108026. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  108027. * Thus the particles generated from `digest()` have their property `position` set yet.
  108028. * @param mesh ( Mesh ) is the mesh to be digested
  108029. * @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
  108030. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  108031. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  108032. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  108033. * @returns the current SPS
  108034. */
  108035. digest(mesh: Mesh, options?: {
  108036. facetNb?: number;
  108037. number?: number;
  108038. delta?: number;
  108039. storage?: [];
  108040. }): SolidParticleSystem;
  108041. /**
  108042. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  108043. * @hidden
  108044. */
  108045. private _unrotateFixedNormals;
  108046. /**
  108047. * Resets the temporary working copy particle
  108048. * @hidden
  108049. */
  108050. private _resetCopy;
  108051. /**
  108052. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  108053. * @param p the current index in the positions array to be updated
  108054. * @param ind the current index in the indices array
  108055. * @param shape a Vector3 array, the shape geometry
  108056. * @param positions the positions array to be updated
  108057. * @param meshInd the shape indices array
  108058. * @param indices the indices array to be updated
  108059. * @param meshUV the shape uv array
  108060. * @param uvs the uv array to be updated
  108061. * @param meshCol the shape color array
  108062. * @param colors the color array to be updated
  108063. * @param meshNor the shape normals array
  108064. * @param normals the normals array to be updated
  108065. * @param idx the particle index
  108066. * @param idxInShape the particle index in its shape
  108067. * @param options the addShape() method passed options
  108068. * @model the particle model
  108069. * @hidden
  108070. */
  108071. private _meshBuilder;
  108072. /**
  108073. * Returns a shape Vector3 array from positions float array
  108074. * @param positions float array
  108075. * @returns a vector3 array
  108076. * @hidden
  108077. */
  108078. private _posToShape;
  108079. /**
  108080. * Returns a shapeUV array from a float uvs (array deep copy)
  108081. * @param uvs as a float array
  108082. * @returns a shapeUV array
  108083. * @hidden
  108084. */
  108085. private _uvsToShapeUV;
  108086. /**
  108087. * Adds a new particle object in the particles array
  108088. * @param idx particle index in particles array
  108089. * @param id particle id
  108090. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  108091. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  108092. * @param model particle ModelShape object
  108093. * @param shapeId model shape identifier
  108094. * @param idxInShape index of the particle in the current model
  108095. * @param bInfo model bounding info object
  108096. * @param storage target storage array, if any
  108097. * @hidden
  108098. */
  108099. private _addParticle;
  108100. /**
  108101. * Adds some particles to the SPS from the model shape. Returns the shape id.
  108102. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  108103. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  108104. * @param nb (positive integer) the number of particles to be created from this model
  108105. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  108106. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  108107. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  108108. * @returns the number of shapes in the system
  108109. */
  108110. addShape(mesh: Mesh, nb: number, options?: {
  108111. positionFunction?: any;
  108112. vertexFunction?: any;
  108113. storage?: [];
  108114. }): number;
  108115. /**
  108116. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  108117. * @hidden
  108118. */
  108119. private _rebuildParticle;
  108120. /**
  108121. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  108122. * @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.
  108123. * @returns the SPS.
  108124. */
  108125. rebuildMesh(reset?: boolean): SolidParticleSystem;
  108126. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  108127. * Returns an array with the removed particles.
  108128. * 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.
  108129. * The SPS can't be empty so at least one particle needs to remain in place.
  108130. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  108131. * @param start index of the first particle to remove
  108132. * @param end index of the last particle to remove (included)
  108133. * @returns an array populated with the removed particles
  108134. */
  108135. removeParticles(start: number, end: number): SolidParticle[];
  108136. /**
  108137. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  108138. * @param solidParticleArray an array populated with Solid Particles objects
  108139. * @returns the SPS
  108140. */
  108141. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  108142. /**
  108143. * Creates a new particle and modifies the SPS mesh geometry :
  108144. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  108145. * - calls _addParticle() to populate the particle array
  108146. * factorized code from addShape() and insertParticlesFromArray()
  108147. * @param idx particle index in the particles array
  108148. * @param i particle index in its shape
  108149. * @param modelShape particle ModelShape object
  108150. * @param shape shape vertex array
  108151. * @param meshInd shape indices array
  108152. * @param meshUV shape uv array
  108153. * @param meshCol shape color array
  108154. * @param meshNor shape normals array
  108155. * @param bbInfo shape bounding info
  108156. * @param storage target particle storage
  108157. * @options addShape() passed options
  108158. * @hidden
  108159. */
  108160. private _insertNewParticle;
  108161. /**
  108162. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  108163. * This method calls `updateParticle()` for each particle of the SPS.
  108164. * For an animated SPS, it is usually called within the render loop.
  108165. * 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.
  108166. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  108167. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  108168. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  108169. * @returns the SPS.
  108170. */
  108171. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  108172. /**
  108173. * Disposes the SPS.
  108174. */
  108175. dispose(): void;
  108176. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  108177. * idx is the particle index in the SPS
  108178. * faceId is the picked face index counted within this particle.
  108179. * Returns null if the pickInfo can't identify a picked particle.
  108180. * @param pickingInfo (PickingInfo object)
  108181. * @returns {idx: number, faceId: number} or null
  108182. */
  108183. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  108184. idx: number;
  108185. faceId: number;
  108186. }>;
  108187. /**
  108188. * Returns a SolidParticle object from its identifier : particle.id
  108189. * @param id (integer) the particle Id
  108190. * @returns the searched particle or null if not found in the SPS.
  108191. */
  108192. getParticleById(id: number): Nullable<SolidParticle>;
  108193. /**
  108194. * Returns a new array populated with the particles having the passed shapeId.
  108195. * @param shapeId (integer) the shape identifier
  108196. * @returns a new solid particle array
  108197. */
  108198. getParticlesByShapeId(shapeId: number): SolidParticle[];
  108199. /**
  108200. * Populates the passed array "ref" with the particles having the passed shapeId.
  108201. * @param shapeId the shape identifier
  108202. * @returns the SPS
  108203. * @param ref
  108204. */
  108205. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  108206. /**
  108207. * Computes the required SubMeshes according the materials assigned to the particles.
  108208. * @returns the solid particle system.
  108209. * Does nothing if called before the SPS mesh is built.
  108210. */
  108211. computeSubMeshes(): SolidParticleSystem;
  108212. /**
  108213. * Sorts the solid particles by material when MultiMaterial is enabled.
  108214. * Updates the indices32 array.
  108215. * Updates the indicesByMaterial array.
  108216. * Updates the mesh indices array.
  108217. * @returns the SPS
  108218. * @hidden
  108219. */
  108220. private _sortParticlesByMaterial;
  108221. /**
  108222. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  108223. * @hidden
  108224. */
  108225. private _setMaterialIndexesById;
  108226. /**
  108227. * Returns an array with unique values of Materials from the passed array
  108228. * @param array the material array to be checked and filtered
  108229. * @hidden
  108230. */
  108231. private _filterUniqueMaterialId;
  108232. /**
  108233. * Sets a new Standard Material as _defaultMaterial if not already set.
  108234. * @hidden
  108235. */
  108236. private _setDefaultMaterial;
  108237. /**
  108238. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  108239. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  108240. * @returns the SPS.
  108241. */
  108242. refreshVisibleSize(): SolidParticleSystem;
  108243. /**
  108244. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  108245. * @param size the size (float) of the visibility box
  108246. * note : this doesn't lock the SPS mesh bounding box.
  108247. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  108248. */
  108249. setVisibilityBox(size: number): void;
  108250. /**
  108251. * Gets whether the SPS as always visible or not
  108252. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  108253. */
  108254. get isAlwaysVisible(): boolean;
  108255. /**
  108256. * Sets the SPS as always visible or not
  108257. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  108258. */
  108259. set isAlwaysVisible(val: boolean);
  108260. /**
  108261. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  108262. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  108263. */
  108264. set isVisibilityBoxLocked(val: boolean);
  108265. /**
  108266. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  108267. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  108268. */
  108269. get isVisibilityBoxLocked(): boolean;
  108270. /**
  108271. * Tells to `setParticles()` to compute the particle rotations or not.
  108272. * Default value : true. The SPS is faster when it's set to false.
  108273. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  108274. */
  108275. set computeParticleRotation(val: boolean);
  108276. /**
  108277. * Tells to `setParticles()` to compute the particle colors or not.
  108278. * Default value : true. The SPS is faster when it's set to false.
  108279. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  108280. */
  108281. set computeParticleColor(val: boolean);
  108282. set computeParticleTexture(val: boolean);
  108283. /**
  108284. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  108285. * Default value : false. The SPS is faster when it's set to false.
  108286. * Note : the particle custom vertex positions aren't stored values.
  108287. */
  108288. set computeParticleVertex(val: boolean);
  108289. /**
  108290. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  108291. */
  108292. set computeBoundingBox(val: boolean);
  108293. /**
  108294. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  108295. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  108296. * Default : `true`
  108297. */
  108298. set depthSortParticles(val: boolean);
  108299. /**
  108300. * Gets if `setParticles()` computes the particle rotations or not.
  108301. * Default value : true. The SPS is faster when it's set to false.
  108302. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  108303. */
  108304. get computeParticleRotation(): boolean;
  108305. /**
  108306. * Gets if `setParticles()` computes the particle colors or not.
  108307. * Default value : true. The SPS is faster when it's set to false.
  108308. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  108309. */
  108310. get computeParticleColor(): boolean;
  108311. /**
  108312. * Gets if `setParticles()` computes the particle textures or not.
  108313. * Default value : true. The SPS is faster when it's set to false.
  108314. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  108315. */
  108316. get computeParticleTexture(): boolean;
  108317. /**
  108318. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  108319. * Default value : false. The SPS is faster when it's set to false.
  108320. * Note : the particle custom vertex positions aren't stored values.
  108321. */
  108322. get computeParticleVertex(): boolean;
  108323. /**
  108324. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  108325. */
  108326. get computeBoundingBox(): boolean;
  108327. /**
  108328. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  108329. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  108330. * Default : `true`
  108331. */
  108332. get depthSortParticles(): boolean;
  108333. /**
  108334. * Gets if the SPS is created as expandable at construction time.
  108335. * Default : `false`
  108336. */
  108337. get expandable(): boolean;
  108338. /**
  108339. * Gets if the SPS supports the Multi Materials
  108340. */
  108341. get multimaterialEnabled(): boolean;
  108342. /**
  108343. * Gets if the SPS uses the model materials for its own multimaterial.
  108344. */
  108345. get useModelMaterial(): boolean;
  108346. /**
  108347. * The SPS used material array.
  108348. */
  108349. get materials(): Material[];
  108350. /**
  108351. * Sets the SPS MultiMaterial from the passed materials.
  108352. * Note : the passed array is internally copied and not used then by reference.
  108353. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  108354. */
  108355. setMultiMaterial(materials: Material[]): void;
  108356. /**
  108357. * The SPS computed multimaterial object
  108358. */
  108359. get multimaterial(): MultiMaterial;
  108360. set multimaterial(mm: MultiMaterial);
  108361. /**
  108362. * If the subMeshes must be updated on the next call to setParticles()
  108363. */
  108364. get autoUpdateSubMeshes(): boolean;
  108365. set autoUpdateSubMeshes(val: boolean);
  108366. /**
  108367. * This function does nothing. It may be overwritten to set all the particle first values.
  108368. * The SPS doesn't call this function, you may have to call it by your own.
  108369. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  108370. */
  108371. initParticles(): void;
  108372. /**
  108373. * This function does nothing. It may be overwritten to recycle a particle.
  108374. * The SPS doesn't call this function, you may have to call it by your own.
  108375. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  108376. * @param particle The particle to recycle
  108377. * @returns the recycled particle
  108378. */
  108379. recycleParticle(particle: SolidParticle): SolidParticle;
  108380. /**
  108381. * Updates a particle : this function should be overwritten by the user.
  108382. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  108383. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  108384. * @example : just set a particle position or velocity and recycle conditions
  108385. * @param particle The particle to update
  108386. * @returns the updated particle
  108387. */
  108388. updateParticle(particle: SolidParticle): SolidParticle;
  108389. /**
  108390. * Updates a vertex of a particle : it can be overwritten by the user.
  108391. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  108392. * @param particle the current particle
  108393. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  108394. * @param pt the index of the current vertex in the particle shape
  108395. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  108396. * @example : just set a vertex particle position or color
  108397. * @returns the sps
  108398. */
  108399. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  108400. /**
  108401. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  108402. * This does nothing and may be overwritten by the user.
  108403. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  108404. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  108405. * @param update the boolean update value actually passed to setParticles()
  108406. */
  108407. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  108408. /**
  108409. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  108410. * This will be passed three parameters.
  108411. * This does nothing and may be overwritten by the user.
  108412. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  108413. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  108414. * @param update the boolean update value actually passed to setParticles()
  108415. */
  108416. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  108417. }
  108418. }
  108419. declare module BABYLON {
  108420. /**
  108421. * Represents one particle of a solid particle system.
  108422. */
  108423. export class SolidParticle {
  108424. /**
  108425. * particle global index
  108426. */
  108427. idx: number;
  108428. /**
  108429. * particle identifier
  108430. */
  108431. id: number;
  108432. /**
  108433. * The color of the particle
  108434. */
  108435. color: Nullable<Color4>;
  108436. /**
  108437. * The world space position of the particle.
  108438. */
  108439. position: Vector3;
  108440. /**
  108441. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  108442. */
  108443. rotation: Vector3;
  108444. /**
  108445. * The world space rotation quaternion of the particle.
  108446. */
  108447. rotationQuaternion: Nullable<Quaternion>;
  108448. /**
  108449. * The scaling of the particle.
  108450. */
  108451. scaling: Vector3;
  108452. /**
  108453. * The uvs of the particle.
  108454. */
  108455. uvs: Vector4;
  108456. /**
  108457. * The current speed of the particle.
  108458. */
  108459. velocity: Vector3;
  108460. /**
  108461. * The pivot point in the particle local space.
  108462. */
  108463. pivot: Vector3;
  108464. /**
  108465. * Must the particle be translated from its pivot point in its local space ?
  108466. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  108467. * Default : false
  108468. */
  108469. translateFromPivot: boolean;
  108470. /**
  108471. * Is the particle active or not ?
  108472. */
  108473. alive: boolean;
  108474. /**
  108475. * Is the particle visible or not ?
  108476. */
  108477. isVisible: boolean;
  108478. /**
  108479. * Index of this particle in the global "positions" array (Internal use)
  108480. * @hidden
  108481. */
  108482. _pos: number;
  108483. /**
  108484. * @hidden Index of this particle in the global "indices" array (Internal use)
  108485. */
  108486. _ind: number;
  108487. /**
  108488. * @hidden ModelShape of this particle (Internal use)
  108489. */
  108490. _model: ModelShape;
  108491. /**
  108492. * ModelShape id of this particle
  108493. */
  108494. shapeId: number;
  108495. /**
  108496. * Index of the particle in its shape id
  108497. */
  108498. idxInShape: number;
  108499. /**
  108500. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  108501. */
  108502. _modelBoundingInfo: BoundingInfo;
  108503. /**
  108504. * @hidden Particle BoundingInfo object (Internal use)
  108505. */
  108506. _boundingInfo: BoundingInfo;
  108507. /**
  108508. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  108509. */
  108510. _sps: SolidParticleSystem;
  108511. /**
  108512. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  108513. */
  108514. _stillInvisible: boolean;
  108515. /**
  108516. * @hidden Last computed particle rotation matrix
  108517. */
  108518. _rotationMatrix: number[];
  108519. /**
  108520. * Parent particle Id, if any.
  108521. * Default null.
  108522. */
  108523. parentId: Nullable<number>;
  108524. /**
  108525. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  108526. */
  108527. materialIndex: Nullable<number>;
  108528. /**
  108529. * Custom object or properties.
  108530. */
  108531. props: Nullable<any>;
  108532. /**
  108533. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  108534. * The possible values are :
  108535. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  108536. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  108537. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  108538. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  108539. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  108540. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  108541. * */
  108542. cullingStrategy: number;
  108543. /**
  108544. * @hidden Internal global position in the SPS.
  108545. */
  108546. _globalPosition: Vector3;
  108547. /**
  108548. * Creates a Solid Particle object.
  108549. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  108550. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  108551. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  108552. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  108553. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  108554. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  108555. * @param shapeId (integer) is the model shape identifier in the SPS.
  108556. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  108557. * @param sps defines the sps it is associated to
  108558. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  108559. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  108560. */
  108561. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  108562. /**
  108563. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  108564. * @param target the particle target
  108565. * @returns the current particle
  108566. */
  108567. copyToRef(target: SolidParticle): SolidParticle;
  108568. /**
  108569. * Legacy support, changed scale to scaling
  108570. */
  108571. get scale(): Vector3;
  108572. /**
  108573. * Legacy support, changed scale to scaling
  108574. */
  108575. set scale(scale: Vector3);
  108576. /**
  108577. * Legacy support, changed quaternion to rotationQuaternion
  108578. */
  108579. get quaternion(): Nullable<Quaternion>;
  108580. /**
  108581. * Legacy support, changed quaternion to rotationQuaternion
  108582. */
  108583. set quaternion(q: Nullable<Quaternion>);
  108584. /**
  108585. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  108586. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  108587. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  108588. * @returns true if it intersects
  108589. */
  108590. intersectsMesh(target: Mesh | SolidParticle): boolean;
  108591. /**
  108592. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  108593. * A particle is in the frustum if its bounding box intersects the frustum
  108594. * @param frustumPlanes defines the frustum to test
  108595. * @returns true if the particle is in the frustum planes
  108596. */
  108597. isInFrustum(frustumPlanes: Plane[]): boolean;
  108598. /**
  108599. * get the rotation matrix of the particle
  108600. * @hidden
  108601. */
  108602. getRotationMatrix(m: Matrix): void;
  108603. }
  108604. /**
  108605. * Represents the shape of the model used by one particle of a solid particle system.
  108606. * SPS internal tool, don't use it manually.
  108607. */
  108608. export class ModelShape {
  108609. /**
  108610. * The shape id
  108611. * @hidden
  108612. */
  108613. shapeID: number;
  108614. /**
  108615. * flat array of model positions (internal use)
  108616. * @hidden
  108617. */
  108618. _shape: Vector3[];
  108619. /**
  108620. * flat array of model UVs (internal use)
  108621. * @hidden
  108622. */
  108623. _shapeUV: number[];
  108624. /**
  108625. * color array of the model
  108626. * @hidden
  108627. */
  108628. _shapeColors: number[];
  108629. /**
  108630. * indices array of the model
  108631. * @hidden
  108632. */
  108633. _indices: number[];
  108634. /**
  108635. * normals array of the model
  108636. * @hidden
  108637. */
  108638. _normals: number[];
  108639. /**
  108640. * length of the shape in the model indices array (internal use)
  108641. * @hidden
  108642. */
  108643. _indicesLength: number;
  108644. /**
  108645. * Custom position function (internal use)
  108646. * @hidden
  108647. */
  108648. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  108649. /**
  108650. * Custom vertex function (internal use)
  108651. * @hidden
  108652. */
  108653. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  108654. /**
  108655. * Model material (internal use)
  108656. * @hidden
  108657. */
  108658. _material: Nullable<Material>;
  108659. /**
  108660. * 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.
  108661. * SPS internal tool, don't use it manually.
  108662. * @hidden
  108663. */
  108664. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>, material: Nullable<Material>);
  108665. }
  108666. /**
  108667. * Represents a Depth Sorted Particle in the solid particle system.
  108668. * @hidden
  108669. */
  108670. export class DepthSortedParticle {
  108671. /**
  108672. * Particle index
  108673. */
  108674. idx: number;
  108675. /**
  108676. * Index of the particle in the "indices" array
  108677. */
  108678. ind: number;
  108679. /**
  108680. * Length of the particle shape in the "indices" array
  108681. */
  108682. indicesLength: number;
  108683. /**
  108684. * Squared distance from the particle to the camera
  108685. */
  108686. sqDistance: number;
  108687. /**
  108688. * Material index when used with MultiMaterials
  108689. */
  108690. materialIndex: number;
  108691. /**
  108692. * Creates a new sorted particle
  108693. * @param materialIndex
  108694. */
  108695. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  108696. }
  108697. /**
  108698. * Represents a solid particle vertex
  108699. */
  108700. export class SolidParticleVertex {
  108701. /**
  108702. * Vertex position
  108703. */
  108704. position: Vector3;
  108705. /**
  108706. * Vertex color
  108707. */
  108708. color: Color4;
  108709. /**
  108710. * Vertex UV
  108711. */
  108712. uv: Vector2;
  108713. /**
  108714. * Creates a new solid particle vertex
  108715. */
  108716. constructor();
  108717. /** Vertex x coordinate */
  108718. get x(): number;
  108719. set x(val: number);
  108720. /** Vertex y coordinate */
  108721. get y(): number;
  108722. set y(val: number);
  108723. /** Vertex z coordinate */
  108724. get z(): number;
  108725. set z(val: number);
  108726. }
  108727. }
  108728. declare module BABYLON {
  108729. /**
  108730. * @hidden
  108731. */
  108732. export class _MeshCollisionData {
  108733. _checkCollisions: boolean;
  108734. _collisionMask: number;
  108735. _collisionGroup: number;
  108736. _surroundingMeshes: Nullable<AbstractMesh[]>;
  108737. _collider: Nullable<Collider>;
  108738. _oldPositionForCollisions: Vector3;
  108739. _diffPositionForCollisions: Vector3;
  108740. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  108741. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  108742. }
  108743. }
  108744. declare module BABYLON {
  108745. /** @hidden */
  108746. class _FacetDataStorage {
  108747. facetPositions: Vector3[];
  108748. facetNormals: Vector3[];
  108749. facetPartitioning: number[][];
  108750. facetNb: number;
  108751. partitioningSubdivisions: number;
  108752. partitioningBBoxRatio: number;
  108753. facetDataEnabled: boolean;
  108754. facetParameters: any;
  108755. bbSize: Vector3;
  108756. subDiv: {
  108757. max: number;
  108758. X: number;
  108759. Y: number;
  108760. Z: number;
  108761. };
  108762. facetDepthSort: boolean;
  108763. facetDepthSortEnabled: boolean;
  108764. depthSortedIndices: IndicesArray;
  108765. depthSortedFacets: {
  108766. ind: number;
  108767. sqDistance: number;
  108768. }[];
  108769. facetDepthSortFunction: (f1: {
  108770. ind: number;
  108771. sqDistance: number;
  108772. }, f2: {
  108773. ind: number;
  108774. sqDistance: number;
  108775. }) => number;
  108776. facetDepthSortFrom: Vector3;
  108777. facetDepthSortOrigin: Vector3;
  108778. invertedMatrix: Matrix;
  108779. }
  108780. /**
  108781. * @hidden
  108782. **/
  108783. class _InternalAbstractMeshDataInfo {
  108784. _hasVertexAlpha: boolean;
  108785. _useVertexColors: boolean;
  108786. _numBoneInfluencers: number;
  108787. _applyFog: boolean;
  108788. _receiveShadows: boolean;
  108789. _facetData: _FacetDataStorage;
  108790. _visibility: number;
  108791. _skeleton: Nullable<Skeleton>;
  108792. _layerMask: number;
  108793. _computeBonesUsingShaders: boolean;
  108794. _isActive: boolean;
  108795. _onlyForInstances: boolean;
  108796. _isActiveIntermediate: boolean;
  108797. _onlyForInstancesIntermediate: boolean;
  108798. _actAsRegularMesh: boolean;
  108799. }
  108800. /**
  108801. * Class used to store all common mesh properties
  108802. */
  108803. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  108804. /** No occlusion */
  108805. static OCCLUSION_TYPE_NONE: number;
  108806. /** Occlusion set to optimisitic */
  108807. static OCCLUSION_TYPE_OPTIMISTIC: number;
  108808. /** Occlusion set to strict */
  108809. static OCCLUSION_TYPE_STRICT: number;
  108810. /** Use an accurante occlusion algorithm */
  108811. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  108812. /** Use a conservative occlusion algorithm */
  108813. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  108814. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  108815. * Test order :
  108816. * Is the bounding sphere outside the frustum ?
  108817. * If not, are the bounding box vertices outside the frustum ?
  108818. * It not, then the cullable object is in the frustum.
  108819. */
  108820. static readonly CULLINGSTRATEGY_STANDARD: number;
  108821. /** Culling strategy : Bounding Sphere Only.
  108822. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  108823. * It's also less accurate than the standard because some not visible objects can still be selected.
  108824. * Test : is the bounding sphere outside the frustum ?
  108825. * If not, then the cullable object is in the frustum.
  108826. */
  108827. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  108828. /** Culling strategy : Optimistic Inclusion.
  108829. * This in an inclusion test first, then the standard exclusion test.
  108830. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  108831. * 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.
  108832. * Anyway, it's as accurate as the standard strategy.
  108833. * Test :
  108834. * Is the cullable object bounding sphere center in the frustum ?
  108835. * If not, apply the default culling strategy.
  108836. */
  108837. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  108838. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  108839. * This in an inclusion test first, then the bounding sphere only exclusion test.
  108840. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  108841. * 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.
  108842. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  108843. * Test :
  108844. * Is the cullable object bounding sphere center in the frustum ?
  108845. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  108846. */
  108847. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  108848. /**
  108849. * No billboard
  108850. */
  108851. static get BILLBOARDMODE_NONE(): number;
  108852. /** Billboard on X axis */
  108853. static get BILLBOARDMODE_X(): number;
  108854. /** Billboard on Y axis */
  108855. static get BILLBOARDMODE_Y(): number;
  108856. /** Billboard on Z axis */
  108857. static get BILLBOARDMODE_Z(): number;
  108858. /** Billboard on all axes */
  108859. static get BILLBOARDMODE_ALL(): number;
  108860. /** Billboard on using position instead of orientation */
  108861. static get BILLBOARDMODE_USE_POSITION(): number;
  108862. /** @hidden */
  108863. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  108864. /**
  108865. * The culling strategy to use to check whether the mesh must be rendered or not.
  108866. * This value can be changed at any time and will be used on the next render mesh selection.
  108867. * The possible values are :
  108868. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  108869. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  108870. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  108871. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  108872. * Please read each static variable documentation to get details about the culling process.
  108873. * */
  108874. cullingStrategy: number;
  108875. /**
  108876. * Gets the number of facets in the mesh
  108877. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  108878. */
  108879. get facetNb(): number;
  108880. /**
  108881. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  108882. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  108883. */
  108884. get partitioningSubdivisions(): number;
  108885. set partitioningSubdivisions(nb: number);
  108886. /**
  108887. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  108888. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  108889. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  108890. */
  108891. get partitioningBBoxRatio(): number;
  108892. set partitioningBBoxRatio(ratio: number);
  108893. /**
  108894. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  108895. * Works only for updatable meshes.
  108896. * Doesn't work with multi-materials
  108897. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  108898. */
  108899. get mustDepthSortFacets(): boolean;
  108900. set mustDepthSortFacets(sort: boolean);
  108901. /**
  108902. * The location (Vector3) where the facet depth sort must be computed from.
  108903. * By default, the active camera position.
  108904. * Used only when facet depth sort is enabled
  108905. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  108906. */
  108907. get facetDepthSortFrom(): Vector3;
  108908. set facetDepthSortFrom(location: Vector3);
  108909. /**
  108910. * gets a boolean indicating if facetData is enabled
  108911. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  108912. */
  108913. get isFacetDataEnabled(): boolean;
  108914. /** @hidden */
  108915. _updateNonUniformScalingState(value: boolean): boolean;
  108916. /**
  108917. * An event triggered when this mesh collides with another one
  108918. */
  108919. onCollideObservable: Observable<AbstractMesh>;
  108920. /** Set a function to call when this mesh collides with another one */
  108921. set onCollide(callback: () => void);
  108922. /**
  108923. * An event triggered when the collision's position changes
  108924. */
  108925. onCollisionPositionChangeObservable: Observable<Vector3>;
  108926. /** Set a function to call when the collision's position changes */
  108927. set onCollisionPositionChange(callback: () => void);
  108928. /**
  108929. * An event triggered when material is changed
  108930. */
  108931. onMaterialChangedObservable: Observable<AbstractMesh>;
  108932. /**
  108933. * Gets or sets the orientation for POV movement & rotation
  108934. */
  108935. definedFacingForward: boolean;
  108936. /** @hidden */
  108937. _occlusionQuery: Nullable<WebGLQuery>;
  108938. /** @hidden */
  108939. _renderingGroup: Nullable<RenderingGroup>;
  108940. /**
  108941. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  108942. */
  108943. get visibility(): number;
  108944. /**
  108945. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  108946. */
  108947. set visibility(value: number);
  108948. /** Gets or sets the alpha index used to sort transparent meshes
  108949. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  108950. */
  108951. alphaIndex: number;
  108952. /**
  108953. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  108954. */
  108955. isVisible: boolean;
  108956. /**
  108957. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  108958. */
  108959. isPickable: boolean;
  108960. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  108961. showSubMeshesBoundingBox: boolean;
  108962. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  108963. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  108964. */
  108965. isBlocker: boolean;
  108966. /**
  108967. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  108968. */
  108969. enablePointerMoveEvents: boolean;
  108970. /**
  108971. * Specifies the rendering group id for this mesh (0 by default)
  108972. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  108973. */
  108974. renderingGroupId: number;
  108975. private _material;
  108976. /** Gets or sets current material */
  108977. get material(): Nullable<Material>;
  108978. set material(value: Nullable<Material>);
  108979. /**
  108980. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  108981. * @see http://doc.babylonjs.com/babylon101/shadows
  108982. */
  108983. get receiveShadows(): boolean;
  108984. set receiveShadows(value: boolean);
  108985. /** Defines color to use when rendering outline */
  108986. outlineColor: Color3;
  108987. /** Define width to use when rendering outline */
  108988. outlineWidth: number;
  108989. /** Defines color to use when rendering overlay */
  108990. overlayColor: Color3;
  108991. /** Defines alpha to use when rendering overlay */
  108992. overlayAlpha: number;
  108993. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  108994. get hasVertexAlpha(): boolean;
  108995. set hasVertexAlpha(value: boolean);
  108996. /** 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) */
  108997. get useVertexColors(): boolean;
  108998. set useVertexColors(value: boolean);
  108999. /**
  109000. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  109001. */
  109002. get computeBonesUsingShaders(): boolean;
  109003. set computeBonesUsingShaders(value: boolean);
  109004. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  109005. get numBoneInfluencers(): number;
  109006. set numBoneInfluencers(value: number);
  109007. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  109008. get applyFog(): boolean;
  109009. set applyFog(value: boolean);
  109010. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  109011. useOctreeForRenderingSelection: boolean;
  109012. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  109013. useOctreeForPicking: boolean;
  109014. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  109015. useOctreeForCollisions: boolean;
  109016. /**
  109017. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  109018. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  109019. */
  109020. get layerMask(): number;
  109021. set layerMask(value: number);
  109022. /**
  109023. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  109024. */
  109025. alwaysSelectAsActiveMesh: boolean;
  109026. /**
  109027. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  109028. */
  109029. doNotSyncBoundingInfo: boolean;
  109030. /**
  109031. * Gets or sets the current action manager
  109032. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  109033. */
  109034. actionManager: Nullable<AbstractActionManager>;
  109035. private _meshCollisionData;
  109036. /**
  109037. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  109038. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  109039. */
  109040. ellipsoid: Vector3;
  109041. /**
  109042. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  109043. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  109044. */
  109045. ellipsoidOffset: Vector3;
  109046. /**
  109047. * Gets or sets a collision mask used to mask collisions (default is -1).
  109048. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  109049. */
  109050. get collisionMask(): number;
  109051. set collisionMask(mask: number);
  109052. /**
  109053. * Gets or sets the current collision group mask (-1 by default).
  109054. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  109055. */
  109056. get collisionGroup(): number;
  109057. set collisionGroup(mask: number);
  109058. /**
  109059. * Gets or sets current surrounding meshes (null by default).
  109060. *
  109061. * By default collision detection is tested against every mesh in the scene.
  109062. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  109063. * meshes will be tested for the collision.
  109064. *
  109065. * Note: if set to an empty array no collision will happen when this mesh is moved.
  109066. */
  109067. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  109068. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  109069. /**
  109070. * Defines edge width used when edgesRenderer is enabled
  109071. * @see https://www.babylonjs-playground.com/#10OJSG#13
  109072. */
  109073. edgesWidth: number;
  109074. /**
  109075. * Defines edge color used when edgesRenderer is enabled
  109076. * @see https://www.babylonjs-playground.com/#10OJSG#13
  109077. */
  109078. edgesColor: Color4;
  109079. /** @hidden */
  109080. _edgesRenderer: Nullable<IEdgesRenderer>;
  109081. /** @hidden */
  109082. _masterMesh: Nullable<AbstractMesh>;
  109083. /** @hidden */
  109084. _boundingInfo: Nullable<BoundingInfo>;
  109085. /** @hidden */
  109086. _renderId: number;
  109087. /**
  109088. * Gets or sets the list of subMeshes
  109089. * @see http://doc.babylonjs.com/how_to/multi_materials
  109090. */
  109091. subMeshes: SubMesh[];
  109092. /** @hidden */
  109093. _intersectionsInProgress: AbstractMesh[];
  109094. /** @hidden */
  109095. _unIndexed: boolean;
  109096. /** @hidden */
  109097. _lightSources: Light[];
  109098. /** Gets the list of lights affecting that mesh */
  109099. get lightSources(): Light[];
  109100. /** @hidden */
  109101. get _positions(): Nullable<Vector3[]>;
  109102. /** @hidden */
  109103. _waitingData: {
  109104. lods: Nullable<any>;
  109105. actions: Nullable<any>;
  109106. freezeWorldMatrix: Nullable<boolean>;
  109107. };
  109108. /** @hidden */
  109109. _bonesTransformMatrices: Nullable<Float32Array>;
  109110. /** @hidden */
  109111. _transformMatrixTexture: Nullable<RawTexture>;
  109112. /**
  109113. * Gets or sets a skeleton to apply skining transformations
  109114. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  109115. */
  109116. set skeleton(value: Nullable<Skeleton>);
  109117. get skeleton(): Nullable<Skeleton>;
  109118. /**
  109119. * An event triggered when the mesh is rebuilt.
  109120. */
  109121. onRebuildObservable: Observable<AbstractMesh>;
  109122. /**
  109123. * Creates a new AbstractMesh
  109124. * @param name defines the name of the mesh
  109125. * @param scene defines the hosting scene
  109126. */
  109127. constructor(name: string, scene?: Nullable<Scene>);
  109128. /**
  109129. * Returns the string "AbstractMesh"
  109130. * @returns "AbstractMesh"
  109131. */
  109132. getClassName(): string;
  109133. /**
  109134. * Gets a string representation of the current mesh
  109135. * @param fullDetails defines a boolean indicating if full details must be included
  109136. * @returns a string representation of the current mesh
  109137. */
  109138. toString(fullDetails?: boolean): string;
  109139. /**
  109140. * @hidden
  109141. */
  109142. protected _getEffectiveParent(): Nullable<Node>;
  109143. /** @hidden */
  109144. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  109145. /** @hidden */
  109146. _rebuild(): void;
  109147. /** @hidden */
  109148. _resyncLightSources(): void;
  109149. /** @hidden */
  109150. _resyncLightSource(light: Light): void;
  109151. /** @hidden */
  109152. _unBindEffect(): void;
  109153. /** @hidden */
  109154. _removeLightSource(light: Light, dispose: boolean): void;
  109155. private _markSubMeshesAsDirty;
  109156. /** @hidden */
  109157. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  109158. /** @hidden */
  109159. _markSubMeshesAsAttributesDirty(): void;
  109160. /** @hidden */
  109161. _markSubMeshesAsMiscDirty(): void;
  109162. /**
  109163. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  109164. */
  109165. get scaling(): Vector3;
  109166. set scaling(newScaling: Vector3);
  109167. /**
  109168. * Returns true if the mesh is blocked. Implemented by child classes
  109169. */
  109170. get isBlocked(): boolean;
  109171. /**
  109172. * Returns the mesh itself by default. Implemented by child classes
  109173. * @param camera defines the camera to use to pick the right LOD level
  109174. * @returns the currentAbstractMesh
  109175. */
  109176. getLOD(camera: Camera): Nullable<AbstractMesh>;
  109177. /**
  109178. * Returns 0 by default. Implemented by child classes
  109179. * @returns an integer
  109180. */
  109181. getTotalVertices(): number;
  109182. /**
  109183. * Returns a positive integer : the total number of indices in this mesh geometry.
  109184. * @returns the numner of indices or zero if the mesh has no geometry.
  109185. */
  109186. getTotalIndices(): number;
  109187. /**
  109188. * Returns null by default. Implemented by child classes
  109189. * @returns null
  109190. */
  109191. getIndices(): Nullable<IndicesArray>;
  109192. /**
  109193. * Returns the array of the requested vertex data kind. Implemented by child classes
  109194. * @param kind defines the vertex data kind to use
  109195. * @returns null
  109196. */
  109197. getVerticesData(kind: string): Nullable<FloatArray>;
  109198. /**
  109199. * Sets the vertex data of the mesh geometry for the requested `kind`.
  109200. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  109201. * Note that a new underlying VertexBuffer object is created each call.
  109202. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  109203. * @param kind defines vertex data kind:
  109204. * * VertexBuffer.PositionKind
  109205. * * VertexBuffer.UVKind
  109206. * * VertexBuffer.UV2Kind
  109207. * * VertexBuffer.UV3Kind
  109208. * * VertexBuffer.UV4Kind
  109209. * * VertexBuffer.UV5Kind
  109210. * * VertexBuffer.UV6Kind
  109211. * * VertexBuffer.ColorKind
  109212. * * VertexBuffer.MatricesIndicesKind
  109213. * * VertexBuffer.MatricesIndicesExtraKind
  109214. * * VertexBuffer.MatricesWeightsKind
  109215. * * VertexBuffer.MatricesWeightsExtraKind
  109216. * @param data defines the data source
  109217. * @param updatable defines if the data must be flagged as updatable (or static)
  109218. * @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
  109219. * @returns the current mesh
  109220. */
  109221. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  109222. /**
  109223. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  109224. * If the mesh has no geometry, it is simply returned as it is.
  109225. * @param kind defines vertex data kind:
  109226. * * VertexBuffer.PositionKind
  109227. * * VertexBuffer.UVKind
  109228. * * VertexBuffer.UV2Kind
  109229. * * VertexBuffer.UV3Kind
  109230. * * VertexBuffer.UV4Kind
  109231. * * VertexBuffer.UV5Kind
  109232. * * VertexBuffer.UV6Kind
  109233. * * VertexBuffer.ColorKind
  109234. * * VertexBuffer.MatricesIndicesKind
  109235. * * VertexBuffer.MatricesIndicesExtraKind
  109236. * * VertexBuffer.MatricesWeightsKind
  109237. * * VertexBuffer.MatricesWeightsExtraKind
  109238. * @param data defines the data source
  109239. * @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
  109240. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  109241. * @returns the current mesh
  109242. */
  109243. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  109244. /**
  109245. * Sets the mesh indices,
  109246. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  109247. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  109248. * @param totalVertices Defines the total number of vertices
  109249. * @returns the current mesh
  109250. */
  109251. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  109252. /**
  109253. * Gets a boolean indicating if specific vertex data is present
  109254. * @param kind defines the vertex data kind to use
  109255. * @returns true is data kind is present
  109256. */
  109257. isVerticesDataPresent(kind: string): boolean;
  109258. /**
  109259. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  109260. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  109261. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  109262. * @returns a BoundingInfo
  109263. */
  109264. getBoundingInfo(): BoundingInfo;
  109265. /**
  109266. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  109267. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  109268. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  109269. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  109270. * @returns the current mesh
  109271. */
  109272. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  109273. /**
  109274. * Overwrite the current bounding info
  109275. * @param boundingInfo defines the new bounding info
  109276. * @returns the current mesh
  109277. */
  109278. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  109279. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  109280. get useBones(): boolean;
  109281. /** @hidden */
  109282. _preActivate(): void;
  109283. /** @hidden */
  109284. _preActivateForIntermediateRendering(renderId: number): void;
  109285. /** @hidden */
  109286. _activate(renderId: number, intermediateRendering: boolean): boolean;
  109287. /** @hidden */
  109288. _postActivate(): void;
  109289. /** @hidden */
  109290. _freeze(): void;
  109291. /** @hidden */
  109292. _unFreeze(): void;
  109293. /**
  109294. * Gets the current world matrix
  109295. * @returns a Matrix
  109296. */
  109297. getWorldMatrix(): Matrix;
  109298. /** @hidden */
  109299. _getWorldMatrixDeterminant(): number;
  109300. /**
  109301. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  109302. */
  109303. get isAnInstance(): boolean;
  109304. /**
  109305. * Gets a boolean indicating if this mesh has instances
  109306. */
  109307. get hasInstances(): boolean;
  109308. /**
  109309. * Gets a boolean indicating if this mesh has thin instances
  109310. */
  109311. get hasThinInstances(): boolean;
  109312. /**
  109313. * Perform relative position change from the point of view of behind the front of the mesh.
  109314. * This is performed taking into account the meshes current rotation, so you do not have to care.
  109315. * Supports definition of mesh facing forward or backward
  109316. * @param amountRight defines the distance on the right axis
  109317. * @param amountUp defines the distance on the up axis
  109318. * @param amountForward defines the distance on the forward axis
  109319. * @returns the current mesh
  109320. */
  109321. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  109322. /**
  109323. * Calculate relative position change from the point of view of behind the front of the mesh.
  109324. * This is performed taking into account the meshes current rotation, so you do not have to care.
  109325. * Supports definition of mesh facing forward or backward
  109326. * @param amountRight defines the distance on the right axis
  109327. * @param amountUp defines the distance on the up axis
  109328. * @param amountForward defines the distance on the forward axis
  109329. * @returns the new displacement vector
  109330. */
  109331. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  109332. /**
  109333. * Perform relative rotation change from the point of view of behind the front of the mesh.
  109334. * Supports definition of mesh facing forward or backward
  109335. * @param flipBack defines the flip
  109336. * @param twirlClockwise defines the twirl
  109337. * @param tiltRight defines the tilt
  109338. * @returns the current mesh
  109339. */
  109340. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  109341. /**
  109342. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  109343. * Supports definition of mesh facing forward or backward.
  109344. * @param flipBack defines the flip
  109345. * @param twirlClockwise defines the twirl
  109346. * @param tiltRight defines the tilt
  109347. * @returns the new rotation vector
  109348. */
  109349. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  109350. /**
  109351. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  109352. * This means the mesh underlying bounding box and sphere are recomputed.
  109353. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  109354. * @returns the current mesh
  109355. */
  109356. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  109357. /** @hidden */
  109358. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  109359. /** @hidden */
  109360. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  109361. /** @hidden */
  109362. _updateBoundingInfo(): AbstractMesh;
  109363. /** @hidden */
  109364. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  109365. /** @hidden */
  109366. protected _afterComputeWorldMatrix(): void;
  109367. /** @hidden */
  109368. get _effectiveMesh(): AbstractMesh;
  109369. /**
  109370. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  109371. * A mesh is in the frustum if its bounding box intersects the frustum
  109372. * @param frustumPlanes defines the frustum to test
  109373. * @returns true if the mesh is in the frustum planes
  109374. */
  109375. isInFrustum(frustumPlanes: Plane[]): boolean;
  109376. /**
  109377. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  109378. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  109379. * @param frustumPlanes defines the frustum to test
  109380. * @returns true if the mesh is completely in the frustum planes
  109381. */
  109382. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  109383. /**
  109384. * True if the mesh intersects another mesh or a SolidParticle object
  109385. * @param mesh defines a target mesh or SolidParticle to test
  109386. * @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)
  109387. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  109388. * @returns true if there is an intersection
  109389. */
  109390. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  109391. /**
  109392. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  109393. * @param point defines the point to test
  109394. * @returns true if there is an intersection
  109395. */
  109396. intersectsPoint(point: Vector3): boolean;
  109397. /**
  109398. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  109399. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  109400. */
  109401. get checkCollisions(): boolean;
  109402. set checkCollisions(collisionEnabled: boolean);
  109403. /**
  109404. * Gets Collider object used to compute collisions (not physics)
  109405. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  109406. */
  109407. get collider(): Nullable<Collider>;
  109408. /**
  109409. * Move the mesh using collision engine
  109410. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  109411. * @param displacement defines the requested displacement vector
  109412. * @returns the current mesh
  109413. */
  109414. moveWithCollisions(displacement: Vector3): AbstractMesh;
  109415. private _onCollisionPositionChange;
  109416. /** @hidden */
  109417. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  109418. /** @hidden */
  109419. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  109420. /** @hidden */
  109421. _checkCollision(collider: Collider): AbstractMesh;
  109422. /** @hidden */
  109423. _generatePointsArray(): boolean;
  109424. /**
  109425. * Checks if the passed Ray intersects with the mesh
  109426. * @param ray defines the ray to use
  109427. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  109428. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  109429. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  109430. * @returns the picking info
  109431. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  109432. */
  109433. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean): PickingInfo;
  109434. /**
  109435. * Clones the current mesh
  109436. * @param name defines the mesh name
  109437. * @param newParent defines the new mesh parent
  109438. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  109439. * @returns the new mesh
  109440. */
  109441. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  109442. /**
  109443. * Disposes all the submeshes of the current meshnp
  109444. * @returns the current mesh
  109445. */
  109446. releaseSubMeshes(): AbstractMesh;
  109447. /**
  109448. * Releases resources associated with this abstract mesh.
  109449. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109450. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109451. */
  109452. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109453. /**
  109454. * Adds the passed mesh as a child to the current mesh
  109455. * @param mesh defines the child mesh
  109456. * @returns the current mesh
  109457. */
  109458. addChild(mesh: AbstractMesh): AbstractMesh;
  109459. /**
  109460. * Removes the passed mesh from the current mesh children list
  109461. * @param mesh defines the child mesh
  109462. * @returns the current mesh
  109463. */
  109464. removeChild(mesh: AbstractMesh): AbstractMesh;
  109465. /** @hidden */
  109466. private _initFacetData;
  109467. /**
  109468. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  109469. * This method can be called within the render loop.
  109470. * 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
  109471. * @returns the current mesh
  109472. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109473. */
  109474. updateFacetData(): AbstractMesh;
  109475. /**
  109476. * Returns the facetLocalNormals array.
  109477. * The normals are expressed in the mesh local spac
  109478. * @returns an array of Vector3
  109479. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109480. */
  109481. getFacetLocalNormals(): Vector3[];
  109482. /**
  109483. * Returns the facetLocalPositions array.
  109484. * The facet positions are expressed in the mesh local space
  109485. * @returns an array of Vector3
  109486. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109487. */
  109488. getFacetLocalPositions(): Vector3[];
  109489. /**
  109490. * Returns the facetLocalPartioning array
  109491. * @returns an array of array of numbers
  109492. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109493. */
  109494. getFacetLocalPartitioning(): number[][];
  109495. /**
  109496. * Returns the i-th facet position in the world system.
  109497. * This method allocates a new Vector3 per call
  109498. * @param i defines the facet index
  109499. * @returns a new Vector3
  109500. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109501. */
  109502. getFacetPosition(i: number): Vector3;
  109503. /**
  109504. * Sets the reference Vector3 with the i-th facet position in the world system
  109505. * @param i defines the facet index
  109506. * @param ref defines the target vector
  109507. * @returns the current mesh
  109508. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109509. */
  109510. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  109511. /**
  109512. * Returns the i-th facet normal in the world system.
  109513. * This method allocates a new Vector3 per call
  109514. * @param i defines the facet index
  109515. * @returns a new Vector3
  109516. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109517. */
  109518. getFacetNormal(i: number): Vector3;
  109519. /**
  109520. * Sets the reference Vector3 with the i-th facet normal in the world system
  109521. * @param i defines the facet index
  109522. * @param ref defines the target vector
  109523. * @returns the current mesh
  109524. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109525. */
  109526. getFacetNormalToRef(i: number, ref: Vector3): this;
  109527. /**
  109528. * 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)
  109529. * @param x defines x coordinate
  109530. * @param y defines y coordinate
  109531. * @param z defines z coordinate
  109532. * @returns the array of facet indexes
  109533. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109534. */
  109535. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  109536. /**
  109537. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  109538. * @param projected sets as the (x,y,z) world projection on the facet
  109539. * @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
  109540. * @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
  109541. * @param x defines x coordinate
  109542. * @param y defines y coordinate
  109543. * @param z defines z coordinate
  109544. * @returns the face index if found (or null instead)
  109545. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109546. */
  109547. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  109548. /**
  109549. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  109550. * @param projected sets as the (x,y,z) local projection on the facet
  109551. * @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
  109552. * @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
  109553. * @param x defines x coordinate
  109554. * @param y defines y coordinate
  109555. * @param z defines z coordinate
  109556. * @returns the face index if found (or null instead)
  109557. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109558. */
  109559. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  109560. /**
  109561. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  109562. * @returns the parameters
  109563. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109564. */
  109565. getFacetDataParameters(): any;
  109566. /**
  109567. * Disables the feature FacetData and frees the related memory
  109568. * @returns the current mesh
  109569. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  109570. */
  109571. disableFacetData(): AbstractMesh;
  109572. /**
  109573. * Updates the AbstractMesh indices array
  109574. * @param indices defines the data source
  109575. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  109576. * @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)
  109577. * @returns the current mesh
  109578. */
  109579. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  109580. /**
  109581. * Creates new normals data for the mesh
  109582. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  109583. * @returns the current mesh
  109584. */
  109585. createNormals(updatable: boolean): AbstractMesh;
  109586. /**
  109587. * Align the mesh with a normal
  109588. * @param normal defines the normal to use
  109589. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  109590. * @returns the current mesh
  109591. */
  109592. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  109593. /** @hidden */
  109594. _checkOcclusionQuery(): boolean;
  109595. /**
  109596. * Disables the mesh edge rendering mode
  109597. * @returns the currentAbstractMesh
  109598. */
  109599. disableEdgesRendering(): AbstractMesh;
  109600. /**
  109601. * Enables the edge rendering mode on the mesh.
  109602. * This mode makes the mesh edges visible
  109603. * @param epsilon defines the maximal distance between two angles to detect a face
  109604. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  109605. * @returns the currentAbstractMesh
  109606. * @see https://www.babylonjs-playground.com/#19O9TU#0
  109607. */
  109608. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  109609. /**
  109610. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  109611. * @returns an array of particle systems in the scene that use the mesh as an emitter
  109612. */
  109613. getConnectedParticleSystems(): IParticleSystem[];
  109614. }
  109615. }
  109616. declare module BABYLON {
  109617. /**
  109618. * Interface used to define ActionEvent
  109619. */
  109620. export interface IActionEvent {
  109621. /** The mesh or sprite that triggered the action */
  109622. source: any;
  109623. /** The X mouse cursor position at the time of the event */
  109624. pointerX: number;
  109625. /** The Y mouse cursor position at the time of the event */
  109626. pointerY: number;
  109627. /** The mesh that is currently pointed at (can be null) */
  109628. meshUnderPointer: Nullable<AbstractMesh>;
  109629. /** the original (browser) event that triggered the ActionEvent */
  109630. sourceEvent?: any;
  109631. /** additional data for the event */
  109632. additionalData?: any;
  109633. }
  109634. /**
  109635. * ActionEvent is the event being sent when an action is triggered.
  109636. */
  109637. export class ActionEvent implements IActionEvent {
  109638. /** The mesh or sprite that triggered the action */
  109639. source: any;
  109640. /** The X mouse cursor position at the time of the event */
  109641. pointerX: number;
  109642. /** The Y mouse cursor position at the time of the event */
  109643. pointerY: number;
  109644. /** The mesh that is currently pointed at (can be null) */
  109645. meshUnderPointer: Nullable<AbstractMesh>;
  109646. /** the original (browser) event that triggered the ActionEvent */
  109647. sourceEvent?: any;
  109648. /** additional data for the event */
  109649. additionalData?: any;
  109650. /**
  109651. * Creates a new ActionEvent
  109652. * @param source The mesh or sprite that triggered the action
  109653. * @param pointerX The X mouse cursor position at the time of the event
  109654. * @param pointerY The Y mouse cursor position at the time of the event
  109655. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  109656. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  109657. * @param additionalData additional data for the event
  109658. */
  109659. constructor(
  109660. /** The mesh or sprite that triggered the action */
  109661. source: any,
  109662. /** The X mouse cursor position at the time of the event */
  109663. pointerX: number,
  109664. /** The Y mouse cursor position at the time of the event */
  109665. pointerY: number,
  109666. /** The mesh that is currently pointed at (can be null) */
  109667. meshUnderPointer: Nullable<AbstractMesh>,
  109668. /** the original (browser) event that triggered the ActionEvent */
  109669. sourceEvent?: any,
  109670. /** additional data for the event */
  109671. additionalData?: any);
  109672. /**
  109673. * Helper function to auto-create an ActionEvent from a source mesh.
  109674. * @param source The source mesh that triggered the event
  109675. * @param evt The original (browser) event
  109676. * @param additionalData additional data for the event
  109677. * @returns the new ActionEvent
  109678. */
  109679. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  109680. /**
  109681. * Helper function to auto-create an ActionEvent from a source sprite
  109682. * @param source The source sprite that triggered the event
  109683. * @param scene Scene associated with the sprite
  109684. * @param evt The original (browser) event
  109685. * @param additionalData additional data for the event
  109686. * @returns the new ActionEvent
  109687. */
  109688. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  109689. /**
  109690. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  109691. * @param scene the scene where the event occurred
  109692. * @param evt The original (browser) event
  109693. * @returns the new ActionEvent
  109694. */
  109695. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  109696. /**
  109697. * Helper function to auto-create an ActionEvent from a primitive
  109698. * @param prim defines the target primitive
  109699. * @param pointerPos defines the pointer position
  109700. * @param evt The original (browser) event
  109701. * @param additionalData additional data for the event
  109702. * @returns the new ActionEvent
  109703. */
  109704. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  109705. }
  109706. }
  109707. declare module BABYLON {
  109708. /**
  109709. * Abstract class used to decouple action Manager from scene and meshes.
  109710. * Do not instantiate.
  109711. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  109712. */
  109713. export abstract class AbstractActionManager implements IDisposable {
  109714. /** Gets the list of active triggers */
  109715. static Triggers: {
  109716. [key: string]: number;
  109717. };
  109718. /** Gets the cursor to use when hovering items */
  109719. hoverCursor: string;
  109720. /** Gets the list of actions */
  109721. actions: IAction[];
  109722. /**
  109723. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  109724. */
  109725. isRecursive: boolean;
  109726. /**
  109727. * Releases all associated resources
  109728. */
  109729. abstract dispose(): void;
  109730. /**
  109731. * Does this action manager has pointer triggers
  109732. */
  109733. abstract get hasPointerTriggers(): boolean;
  109734. /**
  109735. * Does this action manager has pick triggers
  109736. */
  109737. abstract get hasPickTriggers(): boolean;
  109738. /**
  109739. * Process a specific trigger
  109740. * @param trigger defines the trigger to process
  109741. * @param evt defines the event details to be processed
  109742. */
  109743. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  109744. /**
  109745. * Does this action manager handles actions of any of the given triggers
  109746. * @param triggers defines the triggers to be tested
  109747. * @return a boolean indicating whether one (or more) of the triggers is handled
  109748. */
  109749. abstract hasSpecificTriggers(triggers: number[]): boolean;
  109750. /**
  109751. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  109752. * speed.
  109753. * @param triggerA defines the trigger to be tested
  109754. * @param triggerB defines the trigger to be tested
  109755. * @return a boolean indicating whether one (or more) of the triggers is handled
  109756. */
  109757. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  109758. /**
  109759. * Does this action manager handles actions of a given trigger
  109760. * @param trigger defines the trigger to be tested
  109761. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  109762. * @return whether the trigger is handled
  109763. */
  109764. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  109765. /**
  109766. * Serialize this manager to a JSON object
  109767. * @param name defines the property name to store this manager
  109768. * @returns a JSON representation of this manager
  109769. */
  109770. abstract serialize(name: string): any;
  109771. /**
  109772. * Registers an action to this action manager
  109773. * @param action defines the action to be registered
  109774. * @return the action amended (prepared) after registration
  109775. */
  109776. abstract registerAction(action: IAction): Nullable<IAction>;
  109777. /**
  109778. * Unregisters an action to this action manager
  109779. * @param action defines the action to be unregistered
  109780. * @return a boolean indicating whether the action has been unregistered
  109781. */
  109782. abstract unregisterAction(action: IAction): Boolean;
  109783. /**
  109784. * Does exist one action manager with at least one trigger
  109785. **/
  109786. static get HasTriggers(): boolean;
  109787. /**
  109788. * Does exist one action manager with at least one pick trigger
  109789. **/
  109790. static get HasPickTriggers(): boolean;
  109791. /**
  109792. * Does exist one action manager that handles actions of a given trigger
  109793. * @param trigger defines the trigger to be tested
  109794. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  109795. **/
  109796. static HasSpecificTrigger(trigger: number): boolean;
  109797. }
  109798. }
  109799. declare module BABYLON {
  109800. /**
  109801. * Defines how a node can be built from a string name.
  109802. */
  109803. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  109804. /**
  109805. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  109806. */
  109807. export class Node implements IBehaviorAware<Node> {
  109808. /** @hidden */
  109809. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  109810. private static _NodeConstructors;
  109811. /**
  109812. * Add a new node constructor
  109813. * @param type defines the type name of the node to construct
  109814. * @param constructorFunc defines the constructor function
  109815. */
  109816. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  109817. /**
  109818. * Returns a node constructor based on type name
  109819. * @param type defines the type name
  109820. * @param name defines the new node name
  109821. * @param scene defines the hosting scene
  109822. * @param options defines optional options to transmit to constructors
  109823. * @returns the new constructor or null
  109824. */
  109825. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  109826. /**
  109827. * Gets or sets the name of the node
  109828. */
  109829. name: string;
  109830. /**
  109831. * Gets or sets the id of the node
  109832. */
  109833. id: string;
  109834. /**
  109835. * Gets or sets the unique id of the node
  109836. */
  109837. uniqueId: number;
  109838. /**
  109839. * Gets or sets a string used to store user defined state for the node
  109840. */
  109841. state: string;
  109842. /**
  109843. * Gets or sets an object used to store user defined information for the node
  109844. */
  109845. metadata: any;
  109846. /**
  109847. * For internal use only. Please do not use.
  109848. */
  109849. reservedDataStore: any;
  109850. /**
  109851. * List of inspectable custom properties (used by the Inspector)
  109852. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  109853. */
  109854. inspectableCustomProperties: IInspectable[];
  109855. private _doNotSerialize;
  109856. /**
  109857. * Gets or sets a boolean used to define if the node must be serialized
  109858. */
  109859. get doNotSerialize(): boolean;
  109860. set doNotSerialize(value: boolean);
  109861. /** @hidden */
  109862. _isDisposed: boolean;
  109863. /**
  109864. * Gets a list of Animations associated with the node
  109865. */
  109866. animations: Animation[];
  109867. protected _ranges: {
  109868. [name: string]: Nullable<AnimationRange>;
  109869. };
  109870. /**
  109871. * Callback raised when the node is ready to be used
  109872. */
  109873. onReady: Nullable<(node: Node) => void>;
  109874. private _isEnabled;
  109875. private _isParentEnabled;
  109876. private _isReady;
  109877. /** @hidden */
  109878. _currentRenderId: number;
  109879. private _parentUpdateId;
  109880. /** @hidden */
  109881. _childUpdateId: number;
  109882. /** @hidden */
  109883. _waitingParentId: Nullable<string>;
  109884. /** @hidden */
  109885. _scene: Scene;
  109886. /** @hidden */
  109887. _cache: any;
  109888. private _parentNode;
  109889. private _children;
  109890. /** @hidden */
  109891. _worldMatrix: Matrix;
  109892. /** @hidden */
  109893. _worldMatrixDeterminant: number;
  109894. /** @hidden */
  109895. _worldMatrixDeterminantIsDirty: boolean;
  109896. /** @hidden */
  109897. private _sceneRootNodesIndex;
  109898. /**
  109899. * Gets a boolean indicating if the node has been disposed
  109900. * @returns true if the node was disposed
  109901. */
  109902. isDisposed(): boolean;
  109903. /**
  109904. * Gets or sets the parent of the node (without keeping the current position in the scene)
  109905. * @see https://doc.babylonjs.com/how_to/parenting
  109906. */
  109907. set parent(parent: Nullable<Node>);
  109908. get parent(): Nullable<Node>;
  109909. /** @hidden */
  109910. _addToSceneRootNodes(): void;
  109911. /** @hidden */
  109912. _removeFromSceneRootNodes(): void;
  109913. private _animationPropertiesOverride;
  109914. /**
  109915. * Gets or sets the animation properties override
  109916. */
  109917. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  109918. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  109919. /**
  109920. * Gets a string idenfifying the name of the class
  109921. * @returns "Node" string
  109922. */
  109923. getClassName(): string;
  109924. /** @hidden */
  109925. readonly _isNode: boolean;
  109926. /**
  109927. * An event triggered when the mesh is disposed
  109928. */
  109929. onDisposeObservable: Observable<Node>;
  109930. private _onDisposeObserver;
  109931. /**
  109932. * Sets a callback that will be raised when the node will be disposed
  109933. */
  109934. set onDispose(callback: () => void);
  109935. /**
  109936. * Creates a new Node
  109937. * @param name the name and id to be given to this node
  109938. * @param scene the scene this node will be added to
  109939. */
  109940. constructor(name: string, scene?: Nullable<Scene>);
  109941. /**
  109942. * Gets the scene of the node
  109943. * @returns a scene
  109944. */
  109945. getScene(): Scene;
  109946. /**
  109947. * Gets the engine of the node
  109948. * @returns a Engine
  109949. */
  109950. getEngine(): Engine;
  109951. private _behaviors;
  109952. /**
  109953. * Attach a behavior to the node
  109954. * @see http://doc.babylonjs.com/features/behaviour
  109955. * @param behavior defines the behavior to attach
  109956. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  109957. * @returns the current Node
  109958. */
  109959. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  109960. /**
  109961. * Remove an attached behavior
  109962. * @see http://doc.babylonjs.com/features/behaviour
  109963. * @param behavior defines the behavior to attach
  109964. * @returns the current Node
  109965. */
  109966. removeBehavior(behavior: Behavior<Node>): Node;
  109967. /**
  109968. * Gets the list of attached behaviors
  109969. * @see http://doc.babylonjs.com/features/behaviour
  109970. */
  109971. get behaviors(): Behavior<Node>[];
  109972. /**
  109973. * Gets an attached behavior by name
  109974. * @param name defines the name of the behavior to look for
  109975. * @see http://doc.babylonjs.com/features/behaviour
  109976. * @returns null if behavior was not found else the requested behavior
  109977. */
  109978. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  109979. /**
  109980. * Returns the latest update of the World matrix
  109981. * @returns a Matrix
  109982. */
  109983. getWorldMatrix(): Matrix;
  109984. /** @hidden */
  109985. _getWorldMatrixDeterminant(): number;
  109986. /**
  109987. * Returns directly the latest state of the mesh World matrix.
  109988. * A Matrix is returned.
  109989. */
  109990. get worldMatrixFromCache(): Matrix;
  109991. /** @hidden */
  109992. _initCache(): void;
  109993. /** @hidden */
  109994. updateCache(force?: boolean): void;
  109995. /** @hidden */
  109996. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  109997. /** @hidden */
  109998. _updateCache(ignoreParentClass?: boolean): void;
  109999. /** @hidden */
  110000. _isSynchronized(): boolean;
  110001. /** @hidden */
  110002. _markSyncedWithParent(): void;
  110003. /** @hidden */
  110004. isSynchronizedWithParent(): boolean;
  110005. /** @hidden */
  110006. isSynchronized(): boolean;
  110007. /**
  110008. * Is this node ready to be used/rendered
  110009. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  110010. * @return true if the node is ready
  110011. */
  110012. isReady(completeCheck?: boolean): boolean;
  110013. /**
  110014. * Is this node enabled?
  110015. * 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
  110016. * @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
  110017. * @return whether this node (and its parent) is enabled
  110018. */
  110019. isEnabled(checkAncestors?: boolean): boolean;
  110020. /** @hidden */
  110021. protected _syncParentEnabledState(): void;
  110022. /**
  110023. * Set the enabled state of this node
  110024. * @param value defines the new enabled state
  110025. */
  110026. setEnabled(value: boolean): void;
  110027. /**
  110028. * Is this node a descendant of the given node?
  110029. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  110030. * @param ancestor defines the parent node to inspect
  110031. * @returns a boolean indicating if this node is a descendant of the given node
  110032. */
  110033. isDescendantOf(ancestor: Node): boolean;
  110034. /** @hidden */
  110035. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  110036. /**
  110037. * Will return all nodes that have this node as ascendant
  110038. * @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
  110039. * @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
  110040. * @return all children nodes of all types
  110041. */
  110042. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  110043. /**
  110044. * Get all child-meshes of this node
  110045. * @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)
  110046. * @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
  110047. * @returns an array of AbstractMesh
  110048. */
  110049. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  110050. /**
  110051. * Get all direct children of this node
  110052. * @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
  110053. * @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)
  110054. * @returns an array of Node
  110055. */
  110056. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  110057. /** @hidden */
  110058. _setReady(state: boolean): void;
  110059. /**
  110060. * Get an animation by name
  110061. * @param name defines the name of the animation to look for
  110062. * @returns null if not found else the requested animation
  110063. */
  110064. getAnimationByName(name: string): Nullable<Animation>;
  110065. /**
  110066. * Creates an animation range for this node
  110067. * @param name defines the name of the range
  110068. * @param from defines the starting key
  110069. * @param to defines the end key
  110070. */
  110071. createAnimationRange(name: string, from: number, to: number): void;
  110072. /**
  110073. * Delete a specific animation range
  110074. * @param name defines the name of the range to delete
  110075. * @param deleteFrames defines if animation frames from the range must be deleted as well
  110076. */
  110077. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  110078. /**
  110079. * Get an animation range by name
  110080. * @param name defines the name of the animation range to look for
  110081. * @returns null if not found else the requested animation range
  110082. */
  110083. getAnimationRange(name: string): Nullable<AnimationRange>;
  110084. /**
  110085. * Gets the list of all animation ranges defined on this node
  110086. * @returns an array
  110087. */
  110088. getAnimationRanges(): Nullable<AnimationRange>[];
  110089. /**
  110090. * Will start the animation sequence
  110091. * @param name defines the range frames for animation sequence
  110092. * @param loop defines if the animation should loop (false by default)
  110093. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  110094. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  110095. * @returns the object created for this animation. If range does not exist, it will return null
  110096. */
  110097. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  110098. /**
  110099. * Serialize animation ranges into a JSON compatible object
  110100. * @returns serialization object
  110101. */
  110102. serializeAnimationRanges(): any;
  110103. /**
  110104. * Computes the world matrix of the node
  110105. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  110106. * @returns the world matrix
  110107. */
  110108. computeWorldMatrix(force?: boolean): Matrix;
  110109. /**
  110110. * Releases resources associated with this node.
  110111. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  110112. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  110113. */
  110114. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  110115. /**
  110116. * Parse animation range data from a serialization object and store them into a given node
  110117. * @param node defines where to store the animation ranges
  110118. * @param parsedNode defines the serialization object to read data from
  110119. * @param scene defines the hosting scene
  110120. */
  110121. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  110122. /**
  110123. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  110124. * @param includeDescendants Include bounding info from descendants as well (true by default)
  110125. * @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
  110126. * @returns the new bounding vectors
  110127. */
  110128. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  110129. min: Vector3;
  110130. max: Vector3;
  110131. };
  110132. }
  110133. }
  110134. declare module BABYLON {
  110135. /**
  110136. * @hidden
  110137. */
  110138. export class _IAnimationState {
  110139. key: number;
  110140. repeatCount: number;
  110141. workValue?: any;
  110142. loopMode?: number;
  110143. offsetValue?: any;
  110144. highLimitValue?: any;
  110145. }
  110146. /**
  110147. * Class used to store any kind of animation
  110148. */
  110149. export class Animation {
  110150. /**Name of the animation */
  110151. name: string;
  110152. /**Property to animate */
  110153. targetProperty: string;
  110154. /**The frames per second of the animation */
  110155. framePerSecond: number;
  110156. /**The data type of the animation */
  110157. dataType: number;
  110158. /**The loop mode of the animation */
  110159. loopMode?: number | undefined;
  110160. /**Specifies if blending should be enabled */
  110161. enableBlending?: boolean | undefined;
  110162. /**
  110163. * Use matrix interpolation instead of using direct key value when animating matrices
  110164. */
  110165. static AllowMatricesInterpolation: boolean;
  110166. /**
  110167. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  110168. */
  110169. static AllowMatrixDecomposeForInterpolation: boolean;
  110170. /** Define the Url to load snippets */
  110171. static SnippetUrl: string;
  110172. /** Snippet ID if the animation was created from the snippet server */
  110173. snippetId: string;
  110174. /**
  110175. * Stores the key frames of the animation
  110176. */
  110177. private _keys;
  110178. /**
  110179. * Stores the easing function of the animation
  110180. */
  110181. private _easingFunction;
  110182. /**
  110183. * @hidden Internal use only
  110184. */
  110185. _runtimeAnimations: RuntimeAnimation[];
  110186. /**
  110187. * The set of event that will be linked to this animation
  110188. */
  110189. private _events;
  110190. /**
  110191. * Stores an array of target property paths
  110192. */
  110193. targetPropertyPath: string[];
  110194. /**
  110195. * Stores the blending speed of the animation
  110196. */
  110197. blendingSpeed: number;
  110198. /**
  110199. * Stores the animation ranges for the animation
  110200. */
  110201. private _ranges;
  110202. /**
  110203. * @hidden Internal use
  110204. */
  110205. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  110206. /**
  110207. * Sets up an animation
  110208. * @param property The property to animate
  110209. * @param animationType The animation type to apply
  110210. * @param framePerSecond The frames per second of the animation
  110211. * @param easingFunction The easing function used in the animation
  110212. * @returns The created animation
  110213. */
  110214. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  110215. /**
  110216. * Create and start an animation on a node
  110217. * @param name defines the name of the global animation that will be run on all nodes
  110218. * @param node defines the root node where the animation will take place
  110219. * @param targetProperty defines property to animate
  110220. * @param framePerSecond defines the number of frame per second yo use
  110221. * @param totalFrame defines the number of frames in total
  110222. * @param from defines the initial value
  110223. * @param to defines the final value
  110224. * @param loopMode defines which loop mode you want to use (off by default)
  110225. * @param easingFunction defines the easing function to use (linear by default)
  110226. * @param onAnimationEnd defines the callback to call when animation end
  110227. * @returns the animatable created for this animation
  110228. */
  110229. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  110230. /**
  110231. * Create and start an animation on a node and its descendants
  110232. * @param name defines the name of the global animation that will be run on all nodes
  110233. * @param node defines the root node where the animation will take place
  110234. * @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
  110235. * @param targetProperty defines property to animate
  110236. * @param framePerSecond defines the number of frame per second to use
  110237. * @param totalFrame defines the number of frames in total
  110238. * @param from defines the initial value
  110239. * @param to defines the final value
  110240. * @param loopMode defines which loop mode you want to use (off by default)
  110241. * @param easingFunction defines the easing function to use (linear by default)
  110242. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  110243. * @returns the list of animatables created for all nodes
  110244. * @example https://www.babylonjs-playground.com/#MH0VLI
  110245. */
  110246. 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[]>;
  110247. /**
  110248. * Creates a new animation, merges it with the existing animations and starts it
  110249. * @param name Name of the animation
  110250. * @param node Node which contains the scene that begins the animations
  110251. * @param targetProperty Specifies which property to animate
  110252. * @param framePerSecond The frames per second of the animation
  110253. * @param totalFrame The total number of frames
  110254. * @param from The frame at the beginning of the animation
  110255. * @param to The frame at the end of the animation
  110256. * @param loopMode Specifies the loop mode of the animation
  110257. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  110258. * @param onAnimationEnd Callback to run once the animation is complete
  110259. * @returns Nullable animation
  110260. */
  110261. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  110262. /**
  110263. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  110264. * @param sourceAnimation defines the Animation containing keyframes to convert
  110265. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  110266. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  110267. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  110268. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  110269. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  110270. */
  110271. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  110272. /**
  110273. * Transition property of an host to the target Value
  110274. * @param property The property to transition
  110275. * @param targetValue The target Value of the property
  110276. * @param host The object where the property to animate belongs
  110277. * @param scene Scene used to run the animation
  110278. * @param frameRate Framerate (in frame/s) to use
  110279. * @param transition The transition type we want to use
  110280. * @param duration The duration of the animation, in milliseconds
  110281. * @param onAnimationEnd Callback trigger at the end of the animation
  110282. * @returns Nullable animation
  110283. */
  110284. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  110285. /**
  110286. * Return the array of runtime animations currently using this animation
  110287. */
  110288. get runtimeAnimations(): RuntimeAnimation[];
  110289. /**
  110290. * Specifies if any of the runtime animations are currently running
  110291. */
  110292. get hasRunningRuntimeAnimations(): boolean;
  110293. /**
  110294. * Initializes the animation
  110295. * @param name Name of the animation
  110296. * @param targetProperty Property to animate
  110297. * @param framePerSecond The frames per second of the animation
  110298. * @param dataType The data type of the animation
  110299. * @param loopMode The loop mode of the animation
  110300. * @param enableBlending Specifies if blending should be enabled
  110301. */
  110302. constructor(
  110303. /**Name of the animation */
  110304. name: string,
  110305. /**Property to animate */
  110306. targetProperty: string,
  110307. /**The frames per second of the animation */
  110308. framePerSecond: number,
  110309. /**The data type of the animation */
  110310. dataType: number,
  110311. /**The loop mode of the animation */
  110312. loopMode?: number | undefined,
  110313. /**Specifies if blending should be enabled */
  110314. enableBlending?: boolean | undefined);
  110315. /**
  110316. * Converts the animation to a string
  110317. * @param fullDetails support for multiple levels of logging within scene loading
  110318. * @returns String form of the animation
  110319. */
  110320. toString(fullDetails?: boolean): string;
  110321. /**
  110322. * Add an event to this animation
  110323. * @param event Event to add
  110324. */
  110325. addEvent(event: AnimationEvent): void;
  110326. /**
  110327. * Remove all events found at the given frame
  110328. * @param frame The frame to remove events from
  110329. */
  110330. removeEvents(frame: number): void;
  110331. /**
  110332. * Retrieves all the events from the animation
  110333. * @returns Events from the animation
  110334. */
  110335. getEvents(): AnimationEvent[];
  110336. /**
  110337. * Creates an animation range
  110338. * @param name Name of the animation range
  110339. * @param from Starting frame of the animation range
  110340. * @param to Ending frame of the animation
  110341. */
  110342. createRange(name: string, from: number, to: number): void;
  110343. /**
  110344. * Deletes an animation range by name
  110345. * @param name Name of the animation range to delete
  110346. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  110347. */
  110348. deleteRange(name: string, deleteFrames?: boolean): void;
  110349. /**
  110350. * Gets the animation range by name, or null if not defined
  110351. * @param name Name of the animation range
  110352. * @returns Nullable animation range
  110353. */
  110354. getRange(name: string): Nullable<AnimationRange>;
  110355. /**
  110356. * Gets the key frames from the animation
  110357. * @returns The key frames of the animation
  110358. */
  110359. getKeys(): Array<IAnimationKey>;
  110360. /**
  110361. * Gets the highest frame rate of the animation
  110362. * @returns Highest frame rate of the animation
  110363. */
  110364. getHighestFrame(): number;
  110365. /**
  110366. * Gets the easing function of the animation
  110367. * @returns Easing function of the animation
  110368. */
  110369. getEasingFunction(): IEasingFunction;
  110370. /**
  110371. * Sets the easing function of the animation
  110372. * @param easingFunction A custom mathematical formula for animation
  110373. */
  110374. setEasingFunction(easingFunction: EasingFunction): void;
  110375. /**
  110376. * Interpolates a scalar linearly
  110377. * @param startValue Start value of the animation curve
  110378. * @param endValue End value of the animation curve
  110379. * @param gradient Scalar amount to interpolate
  110380. * @returns Interpolated scalar value
  110381. */
  110382. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  110383. /**
  110384. * Interpolates a scalar cubically
  110385. * @param startValue Start value of the animation curve
  110386. * @param outTangent End tangent of the animation
  110387. * @param endValue End value of the animation curve
  110388. * @param inTangent Start tangent of the animation curve
  110389. * @param gradient Scalar amount to interpolate
  110390. * @returns Interpolated scalar value
  110391. */
  110392. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  110393. /**
  110394. * Interpolates a quaternion using a spherical linear interpolation
  110395. * @param startValue Start value of the animation curve
  110396. * @param endValue End value of the animation curve
  110397. * @param gradient Scalar amount to interpolate
  110398. * @returns Interpolated quaternion value
  110399. */
  110400. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  110401. /**
  110402. * Interpolates a quaternion cubically
  110403. * @param startValue Start value of the animation curve
  110404. * @param outTangent End tangent of the animation curve
  110405. * @param endValue End value of the animation curve
  110406. * @param inTangent Start tangent of the animation curve
  110407. * @param gradient Scalar amount to interpolate
  110408. * @returns Interpolated quaternion value
  110409. */
  110410. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  110411. /**
  110412. * Interpolates a Vector3 linearl
  110413. * @param startValue Start value of the animation curve
  110414. * @param endValue End value of the animation curve
  110415. * @param gradient Scalar amount to interpolate
  110416. * @returns Interpolated scalar value
  110417. */
  110418. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  110419. /**
  110420. * Interpolates a Vector3 cubically
  110421. * @param startValue Start value of the animation curve
  110422. * @param outTangent End tangent of the animation
  110423. * @param endValue End value of the animation curve
  110424. * @param inTangent Start tangent of the animation curve
  110425. * @param gradient Scalar amount to interpolate
  110426. * @returns InterpolatedVector3 value
  110427. */
  110428. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  110429. /**
  110430. * Interpolates a Vector2 linearly
  110431. * @param startValue Start value of the animation curve
  110432. * @param endValue End value of the animation curve
  110433. * @param gradient Scalar amount to interpolate
  110434. * @returns Interpolated Vector2 value
  110435. */
  110436. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  110437. /**
  110438. * Interpolates a Vector2 cubically
  110439. * @param startValue Start value of the animation curve
  110440. * @param outTangent End tangent of the animation
  110441. * @param endValue End value of the animation curve
  110442. * @param inTangent Start tangent of the animation curve
  110443. * @param gradient Scalar amount to interpolate
  110444. * @returns Interpolated Vector2 value
  110445. */
  110446. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  110447. /**
  110448. * Interpolates a size linearly
  110449. * @param startValue Start value of the animation curve
  110450. * @param endValue End value of the animation curve
  110451. * @param gradient Scalar amount to interpolate
  110452. * @returns Interpolated Size value
  110453. */
  110454. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  110455. /**
  110456. * Interpolates a Color3 linearly
  110457. * @param startValue Start value of the animation curve
  110458. * @param endValue End value of the animation curve
  110459. * @param gradient Scalar amount to interpolate
  110460. * @returns Interpolated Color3 value
  110461. */
  110462. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  110463. /**
  110464. * Interpolates a Color4 linearly
  110465. * @param startValue Start value of the animation curve
  110466. * @param endValue End value of the animation curve
  110467. * @param gradient Scalar amount to interpolate
  110468. * @returns Interpolated Color3 value
  110469. */
  110470. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  110471. /**
  110472. * @hidden Internal use only
  110473. */
  110474. _getKeyValue(value: any): any;
  110475. /**
  110476. * @hidden Internal use only
  110477. */
  110478. _interpolate(currentFrame: number, state: _IAnimationState): any;
  110479. /**
  110480. * Defines the function to use to interpolate matrices
  110481. * @param startValue defines the start matrix
  110482. * @param endValue defines the end matrix
  110483. * @param gradient defines the gradient between both matrices
  110484. * @param result defines an optional target matrix where to store the interpolation
  110485. * @returns the interpolated matrix
  110486. */
  110487. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  110488. /**
  110489. * Makes a copy of the animation
  110490. * @returns Cloned animation
  110491. */
  110492. clone(): Animation;
  110493. /**
  110494. * Sets the key frames of the animation
  110495. * @param values The animation key frames to set
  110496. */
  110497. setKeys(values: Array<IAnimationKey>): void;
  110498. /**
  110499. * Serializes the animation to an object
  110500. * @returns Serialized object
  110501. */
  110502. serialize(): any;
  110503. /**
  110504. * Float animation type
  110505. */
  110506. static readonly ANIMATIONTYPE_FLOAT: number;
  110507. /**
  110508. * Vector3 animation type
  110509. */
  110510. static readonly ANIMATIONTYPE_VECTOR3: number;
  110511. /**
  110512. * Quaternion animation type
  110513. */
  110514. static readonly ANIMATIONTYPE_QUATERNION: number;
  110515. /**
  110516. * Matrix animation type
  110517. */
  110518. static readonly ANIMATIONTYPE_MATRIX: number;
  110519. /**
  110520. * Color3 animation type
  110521. */
  110522. static readonly ANIMATIONTYPE_COLOR3: number;
  110523. /**
  110524. * Color3 animation type
  110525. */
  110526. static readonly ANIMATIONTYPE_COLOR4: number;
  110527. /**
  110528. * Vector2 animation type
  110529. */
  110530. static readonly ANIMATIONTYPE_VECTOR2: number;
  110531. /**
  110532. * Size animation type
  110533. */
  110534. static readonly ANIMATIONTYPE_SIZE: number;
  110535. /**
  110536. * Relative Loop Mode
  110537. */
  110538. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  110539. /**
  110540. * Cycle Loop Mode
  110541. */
  110542. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  110543. /**
  110544. * Constant Loop Mode
  110545. */
  110546. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  110547. /** @hidden */
  110548. static _UniversalLerp(left: any, right: any, amount: number): any;
  110549. /**
  110550. * Parses an animation object and creates an animation
  110551. * @param parsedAnimation Parsed animation object
  110552. * @returns Animation object
  110553. */
  110554. static Parse(parsedAnimation: any): Animation;
  110555. /**
  110556. * Appends the serialized animations from the source animations
  110557. * @param source Source containing the animations
  110558. * @param destination Target to store the animations
  110559. */
  110560. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  110561. /**
  110562. * Creates a new animation or an array of animations from a snippet saved in a remote file
  110563. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  110564. * @param url defines the url to load from
  110565. * @returns a promise that will resolve to the new animation or an array of animations
  110566. */
  110567. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  110568. /**
  110569. * Creates an animation or an array of animations from a snippet saved by the Inspector
  110570. * @param snippetId defines the snippet to load
  110571. * @returns a promise that will resolve to the new animation or a new array of animations
  110572. */
  110573. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  110574. }
  110575. }
  110576. declare module BABYLON {
  110577. /**
  110578. * Interface containing an array of animations
  110579. */
  110580. export interface IAnimatable {
  110581. /**
  110582. * Array of animations
  110583. */
  110584. animations: Nullable<Array<Animation>>;
  110585. }
  110586. }
  110587. declare module BABYLON {
  110588. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  110589. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110590. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110591. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110592. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110593. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110594. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110595. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110596. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110597. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110598. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110599. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110600. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110601. /**
  110602. * Decorator used to define property that can be serialized as reference to a camera
  110603. * @param sourceName defines the name of the property to decorate
  110604. */
  110605. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  110606. /**
  110607. * Class used to help serialization objects
  110608. */
  110609. export class SerializationHelper {
  110610. /** @hidden */
  110611. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  110612. /** @hidden */
  110613. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  110614. /** @hidden */
  110615. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  110616. /** @hidden */
  110617. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  110618. /**
  110619. * Appends the serialized animations from the source animations
  110620. * @param source Source containing the animations
  110621. * @param destination Target to store the animations
  110622. */
  110623. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  110624. /**
  110625. * Static function used to serialized a specific entity
  110626. * @param entity defines the entity to serialize
  110627. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  110628. * @returns a JSON compatible object representing the serialization of the entity
  110629. */
  110630. static Serialize<T>(entity: T, serializationObject?: any): any;
  110631. /**
  110632. * Creates a new entity from a serialization data object
  110633. * @param creationFunction defines a function used to instanciated the new entity
  110634. * @param source defines the source serialization data
  110635. * @param scene defines the hosting scene
  110636. * @param rootUrl defines the root url for resources
  110637. * @returns a new entity
  110638. */
  110639. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  110640. /**
  110641. * Clones an object
  110642. * @param creationFunction defines the function used to instanciate the new object
  110643. * @param source defines the source object
  110644. * @returns the cloned object
  110645. */
  110646. static Clone<T>(creationFunction: () => T, source: T): T;
  110647. /**
  110648. * Instanciates a new object based on a source one (some data will be shared between both object)
  110649. * @param creationFunction defines the function used to instanciate the new object
  110650. * @param source defines the source object
  110651. * @returns the new object
  110652. */
  110653. static Instanciate<T>(creationFunction: () => T, source: T): T;
  110654. }
  110655. }
  110656. declare module BABYLON {
  110657. /**
  110658. * Base class of all the textures in babylon.
  110659. * It groups all the common properties the materials, post process, lights... might need
  110660. * in order to make a correct use of the texture.
  110661. */
  110662. export class BaseTexture implements IAnimatable {
  110663. /**
  110664. * Default anisotropic filtering level for the application.
  110665. * It is set to 4 as a good tradeoff between perf and quality.
  110666. */
  110667. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  110668. /**
  110669. * Gets or sets the unique id of the texture
  110670. */
  110671. uniqueId: number;
  110672. /**
  110673. * Define the name of the texture.
  110674. */
  110675. name: string;
  110676. /**
  110677. * Gets or sets an object used to store user defined information.
  110678. */
  110679. metadata: any;
  110680. /**
  110681. * For internal use only. Please do not use.
  110682. */
  110683. reservedDataStore: any;
  110684. private _hasAlpha;
  110685. /**
  110686. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  110687. */
  110688. set hasAlpha(value: boolean);
  110689. get hasAlpha(): boolean;
  110690. /**
  110691. * Defines if the alpha value should be determined via the rgb values.
  110692. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  110693. */
  110694. getAlphaFromRGB: boolean;
  110695. /**
  110696. * Intensity or strength of the texture.
  110697. * It is commonly used by materials to fine tune the intensity of the texture
  110698. */
  110699. level: number;
  110700. /**
  110701. * Define the UV chanel to use starting from 0 and defaulting to 0.
  110702. * This is part of the texture as textures usually maps to one uv set.
  110703. */
  110704. coordinatesIndex: number;
  110705. private _coordinatesMode;
  110706. /**
  110707. * How a texture is mapped.
  110708. *
  110709. * | Value | Type | Description |
  110710. * | ----- | ----------------------------------- | ----------- |
  110711. * | 0 | EXPLICIT_MODE | |
  110712. * | 1 | SPHERICAL_MODE | |
  110713. * | 2 | PLANAR_MODE | |
  110714. * | 3 | CUBIC_MODE | |
  110715. * | 4 | PROJECTION_MODE | |
  110716. * | 5 | SKYBOX_MODE | |
  110717. * | 6 | INVCUBIC_MODE | |
  110718. * | 7 | EQUIRECTANGULAR_MODE | |
  110719. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  110720. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  110721. */
  110722. set coordinatesMode(value: number);
  110723. get coordinatesMode(): number;
  110724. /**
  110725. * | Value | Type | Description |
  110726. * | ----- | ------------------ | ----------- |
  110727. * | 0 | CLAMP_ADDRESSMODE | |
  110728. * | 1 | WRAP_ADDRESSMODE | |
  110729. * | 2 | MIRROR_ADDRESSMODE | |
  110730. */
  110731. wrapU: number;
  110732. /**
  110733. * | Value | Type | Description |
  110734. * | ----- | ------------------ | ----------- |
  110735. * | 0 | CLAMP_ADDRESSMODE | |
  110736. * | 1 | WRAP_ADDRESSMODE | |
  110737. * | 2 | MIRROR_ADDRESSMODE | |
  110738. */
  110739. wrapV: number;
  110740. /**
  110741. * | Value | Type | Description |
  110742. * | ----- | ------------------ | ----------- |
  110743. * | 0 | CLAMP_ADDRESSMODE | |
  110744. * | 1 | WRAP_ADDRESSMODE | |
  110745. * | 2 | MIRROR_ADDRESSMODE | |
  110746. */
  110747. wrapR: number;
  110748. /**
  110749. * With compliant hardware and browser (supporting anisotropic filtering)
  110750. * this defines the level of anisotropic filtering in the texture.
  110751. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  110752. */
  110753. anisotropicFilteringLevel: number;
  110754. /**
  110755. * Define if the texture is a cube texture or if false a 2d texture.
  110756. */
  110757. get isCube(): boolean;
  110758. set isCube(value: boolean);
  110759. /**
  110760. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  110761. */
  110762. get is3D(): boolean;
  110763. set is3D(value: boolean);
  110764. /**
  110765. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  110766. */
  110767. get is2DArray(): boolean;
  110768. set is2DArray(value: boolean);
  110769. /**
  110770. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  110771. * HDR texture are usually stored in linear space.
  110772. * This only impacts the PBR and Background materials
  110773. */
  110774. gammaSpace: boolean;
  110775. /**
  110776. * Gets or sets whether or not the texture contains RGBD data.
  110777. */
  110778. get isRGBD(): boolean;
  110779. set isRGBD(value: boolean);
  110780. /**
  110781. * Is Z inverted in the texture (useful in a cube texture).
  110782. */
  110783. invertZ: boolean;
  110784. /**
  110785. * Are mip maps generated for this texture or not.
  110786. */
  110787. get noMipmap(): boolean;
  110788. /**
  110789. * @hidden
  110790. */
  110791. lodLevelInAlpha: boolean;
  110792. /**
  110793. * With prefiltered texture, defined the offset used during the prefiltering steps.
  110794. */
  110795. get lodGenerationOffset(): number;
  110796. set lodGenerationOffset(value: number);
  110797. /**
  110798. * With prefiltered texture, defined the scale used during the prefiltering steps.
  110799. */
  110800. get lodGenerationScale(): number;
  110801. set lodGenerationScale(value: number);
  110802. /**
  110803. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  110804. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  110805. * average roughness values.
  110806. */
  110807. get linearSpecularLOD(): boolean;
  110808. set linearSpecularLOD(value: boolean);
  110809. /**
  110810. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  110811. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  110812. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  110813. */
  110814. get irradianceTexture(): Nullable<BaseTexture>;
  110815. set irradianceTexture(value: Nullable<BaseTexture>);
  110816. /**
  110817. * Define if the texture is a render target.
  110818. */
  110819. isRenderTarget: boolean;
  110820. /**
  110821. * Define the unique id of the texture in the scene.
  110822. */
  110823. get uid(): string;
  110824. /** @hidden */
  110825. _prefiltered: boolean;
  110826. /**
  110827. * Return a string representation of the texture.
  110828. * @returns the texture as a string
  110829. */
  110830. toString(): string;
  110831. /**
  110832. * Get the class name of the texture.
  110833. * @returns "BaseTexture"
  110834. */
  110835. getClassName(): string;
  110836. /**
  110837. * Define the list of animation attached to the texture.
  110838. */
  110839. animations: Animation[];
  110840. /**
  110841. * An event triggered when the texture is disposed.
  110842. */
  110843. onDisposeObservable: Observable<BaseTexture>;
  110844. private _onDisposeObserver;
  110845. /**
  110846. * Callback triggered when the texture has been disposed.
  110847. * Kept for back compatibility, you can use the onDisposeObservable instead.
  110848. */
  110849. set onDispose(callback: () => void);
  110850. /**
  110851. * Define the current state of the loading sequence when in delayed load mode.
  110852. */
  110853. delayLoadState: number;
  110854. private _scene;
  110855. private _engine;
  110856. /** @hidden */
  110857. _texture: Nullable<InternalTexture>;
  110858. private _uid;
  110859. /**
  110860. * Define if the texture is preventinga material to render or not.
  110861. * If not and the texture is not ready, the engine will use a default black texture instead.
  110862. */
  110863. get isBlocking(): boolean;
  110864. /**
  110865. * Instantiates a new BaseTexture.
  110866. * Base class of all the textures in babylon.
  110867. * It groups all the common properties the materials, post process, lights... might need
  110868. * in order to make a correct use of the texture.
  110869. * @param sceneOrEngine Define the scene or engine the texture blongs to
  110870. */
  110871. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  110872. /**
  110873. * Get the scene the texture belongs to.
  110874. * @returns the scene or null if undefined
  110875. */
  110876. getScene(): Nullable<Scene>;
  110877. /** @hidden */
  110878. protected _getEngine(): Nullable<ThinEngine>;
  110879. /**
  110880. * Get the texture transform matrix used to offset tile the texture for istance.
  110881. * @returns the transformation matrix
  110882. */
  110883. getTextureMatrix(): Matrix;
  110884. /**
  110885. * Get the texture reflection matrix used to rotate/transform the reflection.
  110886. * @returns the reflection matrix
  110887. */
  110888. getReflectionTextureMatrix(): Matrix;
  110889. /**
  110890. * Get the underlying lower level texture from Babylon.
  110891. * @returns the insternal texture
  110892. */
  110893. getInternalTexture(): Nullable<InternalTexture>;
  110894. /**
  110895. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  110896. * @returns true if ready or not blocking
  110897. */
  110898. isReadyOrNotBlocking(): boolean;
  110899. /**
  110900. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  110901. * @returns true if fully ready
  110902. */
  110903. isReady(): boolean;
  110904. private _cachedSize;
  110905. /**
  110906. * Get the size of the texture.
  110907. * @returns the texture size.
  110908. */
  110909. getSize(): ISize;
  110910. /**
  110911. * Get the base size of the texture.
  110912. * It can be different from the size if the texture has been resized for POT for instance
  110913. * @returns the base size
  110914. */
  110915. getBaseSize(): ISize;
  110916. /**
  110917. * Update the sampling mode of the texture.
  110918. * Default is Trilinear mode.
  110919. *
  110920. * | Value | Type | Description |
  110921. * | ----- | ------------------ | ----------- |
  110922. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  110923. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  110924. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  110925. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  110926. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  110927. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  110928. * | 7 | NEAREST_LINEAR | |
  110929. * | 8 | NEAREST_NEAREST | |
  110930. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  110931. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  110932. * | 11 | LINEAR_LINEAR | |
  110933. * | 12 | LINEAR_NEAREST | |
  110934. *
  110935. * > _mag_: magnification filter (close to the viewer)
  110936. * > _min_: minification filter (far from the viewer)
  110937. * > _mip_: filter used between mip map levels
  110938. *@param samplingMode Define the new sampling mode of the texture
  110939. */
  110940. updateSamplingMode(samplingMode: number): void;
  110941. /**
  110942. * Scales the texture if is `canRescale()`
  110943. * @param ratio the resize factor we want to use to rescale
  110944. */
  110945. scale(ratio: number): void;
  110946. /**
  110947. * Get if the texture can rescale.
  110948. */
  110949. get canRescale(): boolean;
  110950. /** @hidden */
  110951. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  110952. /** @hidden */
  110953. _rebuild(): void;
  110954. /**
  110955. * Triggers the load sequence in delayed load mode.
  110956. */
  110957. delayLoad(): void;
  110958. /**
  110959. * Clones the texture.
  110960. * @returns the cloned texture
  110961. */
  110962. clone(): Nullable<BaseTexture>;
  110963. /**
  110964. * Get the texture underlying type (INT, FLOAT...)
  110965. */
  110966. get textureType(): number;
  110967. /**
  110968. * Get the texture underlying format (RGB, RGBA...)
  110969. */
  110970. get textureFormat(): number;
  110971. /**
  110972. * Indicates that textures need to be re-calculated for all materials
  110973. */
  110974. protected _markAllSubMeshesAsTexturesDirty(): void;
  110975. /**
  110976. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  110977. * This will returns an RGBA array buffer containing either in values (0-255) or
  110978. * float values (0-1) depending of the underlying buffer type.
  110979. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  110980. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  110981. * @param buffer defines a user defined buffer to fill with data (can be null)
  110982. * @returns The Array buffer containing the pixels data.
  110983. */
  110984. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  110985. /**
  110986. * Release and destroy the underlying lower level texture aka internalTexture.
  110987. */
  110988. releaseInternalTexture(): void;
  110989. /** @hidden */
  110990. get _lodTextureHigh(): Nullable<BaseTexture>;
  110991. /** @hidden */
  110992. get _lodTextureMid(): Nullable<BaseTexture>;
  110993. /** @hidden */
  110994. get _lodTextureLow(): Nullable<BaseTexture>;
  110995. /**
  110996. * Dispose the texture and release its associated resources.
  110997. */
  110998. dispose(): void;
  110999. /**
  111000. * Serialize the texture into a JSON representation that can be parsed later on.
  111001. * @returns the JSON representation of the texture
  111002. */
  111003. serialize(): any;
  111004. /**
  111005. * Helper function to be called back once a list of texture contains only ready textures.
  111006. * @param textures Define the list of textures to wait for
  111007. * @param callback Define the callback triggered once the entire list will be ready
  111008. */
  111009. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  111010. private static _isScene;
  111011. }
  111012. }
  111013. declare module BABYLON {
  111014. /**
  111015. * Options to be used when creating an effect.
  111016. */
  111017. export interface IEffectCreationOptions {
  111018. /**
  111019. * Atrributes that will be used in the shader.
  111020. */
  111021. attributes: string[];
  111022. /**
  111023. * Uniform varible names that will be set in the shader.
  111024. */
  111025. uniformsNames: string[];
  111026. /**
  111027. * Uniform buffer variable names that will be set in the shader.
  111028. */
  111029. uniformBuffersNames: string[];
  111030. /**
  111031. * Sampler texture variable names that will be set in the shader.
  111032. */
  111033. samplers: string[];
  111034. /**
  111035. * Define statements that will be set in the shader.
  111036. */
  111037. defines: any;
  111038. /**
  111039. * Possible fallbacks for this effect to improve performance when needed.
  111040. */
  111041. fallbacks: Nullable<IEffectFallbacks>;
  111042. /**
  111043. * Callback that will be called when the shader is compiled.
  111044. */
  111045. onCompiled: Nullable<(effect: Effect) => void>;
  111046. /**
  111047. * Callback that will be called if an error occurs during shader compilation.
  111048. */
  111049. onError: Nullable<(effect: Effect, errors: string) => void>;
  111050. /**
  111051. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  111052. */
  111053. indexParameters?: any;
  111054. /**
  111055. * Max number of lights that can be used in the shader.
  111056. */
  111057. maxSimultaneousLights?: number;
  111058. /**
  111059. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  111060. */
  111061. transformFeedbackVaryings?: Nullable<string[]>;
  111062. /**
  111063. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  111064. */
  111065. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  111066. }
  111067. /**
  111068. * Effect containing vertex and fragment shader that can be executed on an object.
  111069. */
  111070. export class Effect implements IDisposable {
  111071. /**
  111072. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  111073. */
  111074. static ShadersRepository: string;
  111075. /**
  111076. * Enable logging of the shader code when a compilation error occurs
  111077. */
  111078. static LogShaderCodeOnCompilationError: boolean;
  111079. /**
  111080. * Name of the effect.
  111081. */
  111082. name: any;
  111083. /**
  111084. * String container all the define statements that should be set on the shader.
  111085. */
  111086. defines: string;
  111087. /**
  111088. * Callback that will be called when the shader is compiled.
  111089. */
  111090. onCompiled: Nullable<(effect: Effect) => void>;
  111091. /**
  111092. * Callback that will be called if an error occurs during shader compilation.
  111093. */
  111094. onError: Nullable<(effect: Effect, errors: string) => void>;
  111095. /**
  111096. * Callback that will be called when effect is bound.
  111097. */
  111098. onBind: Nullable<(effect: Effect) => void>;
  111099. /**
  111100. * Unique ID of the effect.
  111101. */
  111102. uniqueId: number;
  111103. /**
  111104. * Observable that will be called when the shader is compiled.
  111105. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  111106. */
  111107. onCompileObservable: Observable<Effect>;
  111108. /**
  111109. * Observable that will be called if an error occurs during shader compilation.
  111110. */
  111111. onErrorObservable: Observable<Effect>;
  111112. /** @hidden */
  111113. _onBindObservable: Nullable<Observable<Effect>>;
  111114. /**
  111115. * @hidden
  111116. * Specifies if the effect was previously ready
  111117. */
  111118. _wasPreviouslyReady: boolean;
  111119. /**
  111120. * Observable that will be called when effect is bound.
  111121. */
  111122. get onBindObservable(): Observable<Effect>;
  111123. /** @hidden */
  111124. _bonesComputationForcedToCPU: boolean;
  111125. private static _uniqueIdSeed;
  111126. private _engine;
  111127. private _uniformBuffersNames;
  111128. private _uniformBuffersNamesList;
  111129. private _uniformsNames;
  111130. private _samplerList;
  111131. private _samplers;
  111132. private _isReady;
  111133. private _compilationError;
  111134. private _allFallbacksProcessed;
  111135. private _attributesNames;
  111136. private _attributes;
  111137. private _attributeLocationByName;
  111138. private _uniforms;
  111139. /**
  111140. * Key for the effect.
  111141. * @hidden
  111142. */
  111143. _key: string;
  111144. private _indexParameters;
  111145. private _fallbacks;
  111146. private _vertexSourceCode;
  111147. private _fragmentSourceCode;
  111148. private _vertexSourceCodeOverride;
  111149. private _fragmentSourceCodeOverride;
  111150. private _transformFeedbackVaryings;
  111151. /**
  111152. * Compiled shader to webGL program.
  111153. * @hidden
  111154. */
  111155. _pipelineContext: Nullable<IPipelineContext>;
  111156. private _valueCache;
  111157. private static _baseCache;
  111158. /**
  111159. * Instantiates an effect.
  111160. * An effect can be used to create/manage/execute vertex and fragment shaders.
  111161. * @param baseName Name of the effect.
  111162. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  111163. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  111164. * @param samplers List of sampler variables that will be passed to the shader.
  111165. * @param engine Engine to be used to render the effect
  111166. * @param defines Define statements to be added to the shader.
  111167. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  111168. * @param onCompiled Callback that will be called when the shader is compiled.
  111169. * @param onError Callback that will be called if an error occurs during shader compilation.
  111170. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  111171. */
  111172. 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);
  111173. private _useFinalCode;
  111174. /**
  111175. * Unique key for this effect
  111176. */
  111177. get key(): string;
  111178. /**
  111179. * If the effect has been compiled and prepared.
  111180. * @returns if the effect is compiled and prepared.
  111181. */
  111182. isReady(): boolean;
  111183. private _isReadyInternal;
  111184. /**
  111185. * The engine the effect was initialized with.
  111186. * @returns the engine.
  111187. */
  111188. getEngine(): Engine;
  111189. /**
  111190. * The pipeline context for this effect
  111191. * @returns the associated pipeline context
  111192. */
  111193. getPipelineContext(): Nullable<IPipelineContext>;
  111194. /**
  111195. * The set of names of attribute variables for the shader.
  111196. * @returns An array of attribute names.
  111197. */
  111198. getAttributesNames(): string[];
  111199. /**
  111200. * Returns the attribute at the given index.
  111201. * @param index The index of the attribute.
  111202. * @returns The location of the attribute.
  111203. */
  111204. getAttributeLocation(index: number): number;
  111205. /**
  111206. * Returns the attribute based on the name of the variable.
  111207. * @param name of the attribute to look up.
  111208. * @returns the attribute location.
  111209. */
  111210. getAttributeLocationByName(name: string): number;
  111211. /**
  111212. * The number of attributes.
  111213. * @returns the numnber of attributes.
  111214. */
  111215. getAttributesCount(): number;
  111216. /**
  111217. * Gets the index of a uniform variable.
  111218. * @param uniformName of the uniform to look up.
  111219. * @returns the index.
  111220. */
  111221. getUniformIndex(uniformName: string): number;
  111222. /**
  111223. * Returns the attribute based on the name of the variable.
  111224. * @param uniformName of the uniform to look up.
  111225. * @returns the location of the uniform.
  111226. */
  111227. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  111228. /**
  111229. * Returns an array of sampler variable names
  111230. * @returns The array of sampler variable names.
  111231. */
  111232. getSamplers(): string[];
  111233. /**
  111234. * Returns an array of uniform variable names
  111235. * @returns The array of uniform variable names.
  111236. */
  111237. getUniformNames(): string[];
  111238. /**
  111239. * Returns an array of uniform buffer variable names
  111240. * @returns The array of uniform buffer variable names.
  111241. */
  111242. getUniformBuffersNames(): string[];
  111243. /**
  111244. * Returns the index parameters used to create the effect
  111245. * @returns The index parameters object
  111246. */
  111247. getIndexParameters(): any;
  111248. /**
  111249. * The error from the last compilation.
  111250. * @returns the error string.
  111251. */
  111252. getCompilationError(): string;
  111253. /**
  111254. * Gets a boolean indicating that all fallbacks were used during compilation
  111255. * @returns true if all fallbacks were used
  111256. */
  111257. allFallbacksProcessed(): boolean;
  111258. /**
  111259. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  111260. * @param func The callback to be used.
  111261. */
  111262. executeWhenCompiled(func: (effect: Effect) => void): void;
  111263. private _checkIsReady;
  111264. private _loadShader;
  111265. /**
  111266. * Gets the vertex shader source code of this effect
  111267. */
  111268. get vertexSourceCode(): string;
  111269. /**
  111270. * Gets the fragment shader source code of this effect
  111271. */
  111272. get fragmentSourceCode(): string;
  111273. /**
  111274. * Recompiles the webGL program
  111275. * @param vertexSourceCode The source code for the vertex shader.
  111276. * @param fragmentSourceCode The source code for the fragment shader.
  111277. * @param onCompiled Callback called when completed.
  111278. * @param onError Callback called on error.
  111279. * @hidden
  111280. */
  111281. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  111282. /**
  111283. * Prepares the effect
  111284. * @hidden
  111285. */
  111286. _prepareEffect(): void;
  111287. private _getShaderCodeAndErrorLine;
  111288. private _processCompilationErrors;
  111289. /**
  111290. * Checks if the effect is supported. (Must be called after compilation)
  111291. */
  111292. get isSupported(): boolean;
  111293. /**
  111294. * Binds a texture to the engine to be used as output of the shader.
  111295. * @param channel Name of the output variable.
  111296. * @param texture Texture to bind.
  111297. * @hidden
  111298. */
  111299. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  111300. /**
  111301. * Sets a texture on the engine to be used in the shader.
  111302. * @param channel Name of the sampler variable.
  111303. * @param texture Texture to set.
  111304. */
  111305. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  111306. /**
  111307. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  111308. * @param channel Name of the sampler variable.
  111309. * @param texture Texture to set.
  111310. */
  111311. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  111312. /**
  111313. * Sets an array of textures on the engine to be used in the shader.
  111314. * @param channel Name of the variable.
  111315. * @param textures Textures to set.
  111316. */
  111317. setTextureArray(channel: string, textures: BaseTexture[]): void;
  111318. /**
  111319. * 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)
  111320. * @param channel Name of the sampler variable.
  111321. * @param postProcess Post process to get the input texture from.
  111322. */
  111323. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  111324. /**
  111325. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  111326. * 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)
  111327. * @param channel Name of the sampler variable.
  111328. * @param postProcess Post process to get the output texture from.
  111329. */
  111330. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  111331. /** @hidden */
  111332. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  111333. /** @hidden */
  111334. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  111335. /** @hidden */
  111336. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  111337. /** @hidden */
  111338. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  111339. /**
  111340. * Binds a buffer to a uniform.
  111341. * @param buffer Buffer to bind.
  111342. * @param name Name of the uniform variable to bind to.
  111343. */
  111344. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  111345. /**
  111346. * Binds block to a uniform.
  111347. * @param blockName Name of the block to bind.
  111348. * @param index Index to bind.
  111349. */
  111350. bindUniformBlock(blockName: string, index: number): void;
  111351. /**
  111352. * Sets an interger value on a uniform variable.
  111353. * @param uniformName Name of the variable.
  111354. * @param value Value to be set.
  111355. * @returns this effect.
  111356. */
  111357. setInt(uniformName: string, value: number): Effect;
  111358. /**
  111359. * Sets an int array on a uniform variable.
  111360. * @param uniformName Name of the variable.
  111361. * @param array array to be set.
  111362. * @returns this effect.
  111363. */
  111364. setIntArray(uniformName: string, array: Int32Array): Effect;
  111365. /**
  111366. * 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)
  111367. * @param uniformName Name of the variable.
  111368. * @param array array to be set.
  111369. * @returns this effect.
  111370. */
  111371. setIntArray2(uniformName: string, array: Int32Array): Effect;
  111372. /**
  111373. * 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)
  111374. * @param uniformName Name of the variable.
  111375. * @param array array to be set.
  111376. * @returns this effect.
  111377. */
  111378. setIntArray3(uniformName: string, array: Int32Array): Effect;
  111379. /**
  111380. * 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)
  111381. * @param uniformName Name of the variable.
  111382. * @param array array to be set.
  111383. * @returns this effect.
  111384. */
  111385. setIntArray4(uniformName: string, array: Int32Array): Effect;
  111386. /**
  111387. * Sets an float array on a uniform variable.
  111388. * @param uniformName Name of the variable.
  111389. * @param array array to be set.
  111390. * @returns this effect.
  111391. */
  111392. setFloatArray(uniformName: string, array: Float32Array): Effect;
  111393. /**
  111394. * 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)
  111395. * @param uniformName Name of the variable.
  111396. * @param array array to be set.
  111397. * @returns this effect.
  111398. */
  111399. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  111400. /**
  111401. * 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)
  111402. * @param uniformName Name of the variable.
  111403. * @param array array to be set.
  111404. * @returns this effect.
  111405. */
  111406. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  111407. /**
  111408. * 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)
  111409. * @param uniformName Name of the variable.
  111410. * @param array array to be set.
  111411. * @returns this effect.
  111412. */
  111413. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  111414. /**
  111415. * Sets an array on a uniform variable.
  111416. * @param uniformName Name of the variable.
  111417. * @param array array to be set.
  111418. * @returns this effect.
  111419. */
  111420. setArray(uniformName: string, array: number[]): Effect;
  111421. /**
  111422. * 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)
  111423. * @param uniformName Name of the variable.
  111424. * @param array array to be set.
  111425. * @returns this effect.
  111426. */
  111427. setArray2(uniformName: string, array: number[]): Effect;
  111428. /**
  111429. * 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)
  111430. * @param uniformName Name of the variable.
  111431. * @param array array to be set.
  111432. * @returns this effect.
  111433. */
  111434. setArray3(uniformName: string, array: number[]): Effect;
  111435. /**
  111436. * 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)
  111437. * @param uniformName Name of the variable.
  111438. * @param array array to be set.
  111439. * @returns this effect.
  111440. */
  111441. setArray4(uniformName: string, array: number[]): Effect;
  111442. /**
  111443. * Sets matrices on a uniform variable.
  111444. * @param uniformName Name of the variable.
  111445. * @param matrices matrices to be set.
  111446. * @returns this effect.
  111447. */
  111448. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  111449. /**
  111450. * Sets matrix on a uniform variable.
  111451. * @param uniformName Name of the variable.
  111452. * @param matrix matrix to be set.
  111453. * @returns this effect.
  111454. */
  111455. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  111456. /**
  111457. * 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)
  111458. * @param uniformName Name of the variable.
  111459. * @param matrix matrix to be set.
  111460. * @returns this effect.
  111461. */
  111462. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  111463. /**
  111464. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  111465. * @param uniformName Name of the variable.
  111466. * @param matrix matrix to be set.
  111467. * @returns this effect.
  111468. */
  111469. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  111470. /**
  111471. * Sets a float on a uniform variable.
  111472. * @param uniformName Name of the variable.
  111473. * @param value value to be set.
  111474. * @returns this effect.
  111475. */
  111476. setFloat(uniformName: string, value: number): Effect;
  111477. /**
  111478. * Sets a boolean on a uniform variable.
  111479. * @param uniformName Name of the variable.
  111480. * @param bool value to be set.
  111481. * @returns this effect.
  111482. */
  111483. setBool(uniformName: string, bool: boolean): Effect;
  111484. /**
  111485. * Sets a Vector2 on a uniform variable.
  111486. * @param uniformName Name of the variable.
  111487. * @param vector2 vector2 to be set.
  111488. * @returns this effect.
  111489. */
  111490. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  111491. /**
  111492. * Sets a float2 on a uniform variable.
  111493. * @param uniformName Name of the variable.
  111494. * @param x First float in float2.
  111495. * @param y Second float in float2.
  111496. * @returns this effect.
  111497. */
  111498. setFloat2(uniformName: string, x: number, y: number): Effect;
  111499. /**
  111500. * Sets a Vector3 on a uniform variable.
  111501. * @param uniformName Name of the variable.
  111502. * @param vector3 Value to be set.
  111503. * @returns this effect.
  111504. */
  111505. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  111506. /**
  111507. * Sets a float3 on a uniform variable.
  111508. * @param uniformName Name of the variable.
  111509. * @param x First float in float3.
  111510. * @param y Second float in float3.
  111511. * @param z Third float in float3.
  111512. * @returns this effect.
  111513. */
  111514. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  111515. /**
  111516. * Sets a Vector4 on a uniform variable.
  111517. * @param uniformName Name of the variable.
  111518. * @param vector4 Value to be set.
  111519. * @returns this effect.
  111520. */
  111521. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  111522. /**
  111523. * Sets a float4 on a uniform variable.
  111524. * @param uniformName Name of the variable.
  111525. * @param x First float in float4.
  111526. * @param y Second float in float4.
  111527. * @param z Third float in float4.
  111528. * @param w Fourth float in float4.
  111529. * @returns this effect.
  111530. */
  111531. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  111532. /**
  111533. * Sets a Color3 on a uniform variable.
  111534. * @param uniformName Name of the variable.
  111535. * @param color3 Value to be set.
  111536. * @returns this effect.
  111537. */
  111538. setColor3(uniformName: string, color3: IColor3Like): Effect;
  111539. /**
  111540. * Sets a Color4 on a uniform variable.
  111541. * @param uniformName Name of the variable.
  111542. * @param color3 Value to be set.
  111543. * @param alpha Alpha value to be set.
  111544. * @returns this effect.
  111545. */
  111546. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  111547. /**
  111548. * Sets a Color4 on a uniform variable
  111549. * @param uniformName defines the name of the variable
  111550. * @param color4 defines the value to be set
  111551. * @returns this effect.
  111552. */
  111553. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  111554. /** Release all associated resources */
  111555. dispose(): void;
  111556. /**
  111557. * This function will add a new shader to the shader store
  111558. * @param name the name of the shader
  111559. * @param pixelShader optional pixel shader content
  111560. * @param vertexShader optional vertex shader content
  111561. */
  111562. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  111563. /**
  111564. * Store of each shader (The can be looked up using effect.key)
  111565. */
  111566. static ShadersStore: {
  111567. [key: string]: string;
  111568. };
  111569. /**
  111570. * Store of each included file for a shader (The can be looked up using effect.key)
  111571. */
  111572. static IncludesShadersStore: {
  111573. [key: string]: string;
  111574. };
  111575. /**
  111576. * Resets the cache of effects.
  111577. */
  111578. static ResetCache(): void;
  111579. }
  111580. }
  111581. declare module BABYLON {
  111582. /**
  111583. * Interface used to describe the capabilities of the engine relatively to the current browser
  111584. */
  111585. export interface EngineCapabilities {
  111586. /** Maximum textures units per fragment shader */
  111587. maxTexturesImageUnits: number;
  111588. /** Maximum texture units per vertex shader */
  111589. maxVertexTextureImageUnits: number;
  111590. /** Maximum textures units in the entire pipeline */
  111591. maxCombinedTexturesImageUnits: number;
  111592. /** Maximum texture size */
  111593. maxTextureSize: number;
  111594. /** Maximum texture samples */
  111595. maxSamples?: number;
  111596. /** Maximum cube texture size */
  111597. maxCubemapTextureSize: number;
  111598. /** Maximum render texture size */
  111599. maxRenderTextureSize: number;
  111600. /** Maximum number of vertex attributes */
  111601. maxVertexAttribs: number;
  111602. /** Maximum number of varyings */
  111603. maxVaryingVectors: number;
  111604. /** Maximum number of uniforms per vertex shader */
  111605. maxVertexUniformVectors: number;
  111606. /** Maximum number of uniforms per fragment shader */
  111607. maxFragmentUniformVectors: number;
  111608. /** Defines if standard derivates (dx/dy) are supported */
  111609. standardDerivatives: boolean;
  111610. /** Defines if s3tc texture compression is supported */
  111611. s3tc?: WEBGL_compressed_texture_s3tc;
  111612. /** Defines if pvrtc texture compression is supported */
  111613. pvrtc: any;
  111614. /** Defines if etc1 texture compression is supported */
  111615. etc1: any;
  111616. /** Defines if etc2 texture compression is supported */
  111617. etc2: any;
  111618. /** Defines if astc texture compression is supported */
  111619. astc: any;
  111620. /** Defines if float textures are supported */
  111621. textureFloat: boolean;
  111622. /** Defines if vertex array objects are supported */
  111623. vertexArrayObject: boolean;
  111624. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  111625. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  111626. /** Gets the maximum level of anisotropy supported */
  111627. maxAnisotropy: number;
  111628. /** Defines if instancing is supported */
  111629. instancedArrays: boolean;
  111630. /** Defines if 32 bits indices are supported */
  111631. uintIndices: boolean;
  111632. /** Defines if high precision shaders are supported */
  111633. highPrecisionShaderSupported: boolean;
  111634. /** Defines if depth reading in the fragment shader is supported */
  111635. fragmentDepthSupported: boolean;
  111636. /** Defines if float texture linear filtering is supported*/
  111637. textureFloatLinearFiltering: boolean;
  111638. /** Defines if rendering to float textures is supported */
  111639. textureFloatRender: boolean;
  111640. /** Defines if half float textures are supported*/
  111641. textureHalfFloat: boolean;
  111642. /** Defines if half float texture linear filtering is supported*/
  111643. textureHalfFloatLinearFiltering: boolean;
  111644. /** Defines if rendering to half float textures is supported */
  111645. textureHalfFloatRender: boolean;
  111646. /** Defines if textureLOD shader command is supported */
  111647. textureLOD: boolean;
  111648. /** Defines if draw buffers extension is supported */
  111649. drawBuffersExtension: boolean;
  111650. /** Defines if depth textures are supported */
  111651. depthTextureExtension: boolean;
  111652. /** Defines if float color buffer are supported */
  111653. colorBufferFloat: boolean;
  111654. /** Gets disjoint timer query extension (null if not supported) */
  111655. timerQuery?: EXT_disjoint_timer_query;
  111656. /** Defines if timestamp can be used with timer query */
  111657. canUseTimestampForTimerQuery: boolean;
  111658. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  111659. multiview?: any;
  111660. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  111661. oculusMultiview?: any;
  111662. /** Function used to let the system compiles shaders in background */
  111663. parallelShaderCompile?: {
  111664. COMPLETION_STATUS_KHR: number;
  111665. };
  111666. /** Max number of texture samples for MSAA */
  111667. maxMSAASamples: number;
  111668. /** Defines if the blend min max extension is supported */
  111669. blendMinMax: boolean;
  111670. }
  111671. }
  111672. declare module BABYLON {
  111673. /**
  111674. * @hidden
  111675. **/
  111676. export class DepthCullingState {
  111677. private _isDepthTestDirty;
  111678. private _isDepthMaskDirty;
  111679. private _isDepthFuncDirty;
  111680. private _isCullFaceDirty;
  111681. private _isCullDirty;
  111682. private _isZOffsetDirty;
  111683. private _isFrontFaceDirty;
  111684. private _depthTest;
  111685. private _depthMask;
  111686. private _depthFunc;
  111687. private _cull;
  111688. private _cullFace;
  111689. private _zOffset;
  111690. private _frontFace;
  111691. /**
  111692. * Initializes the state.
  111693. */
  111694. constructor();
  111695. get isDirty(): boolean;
  111696. get zOffset(): number;
  111697. set zOffset(value: number);
  111698. get cullFace(): Nullable<number>;
  111699. set cullFace(value: Nullable<number>);
  111700. get cull(): Nullable<boolean>;
  111701. set cull(value: Nullable<boolean>);
  111702. get depthFunc(): Nullable<number>;
  111703. set depthFunc(value: Nullable<number>);
  111704. get depthMask(): boolean;
  111705. set depthMask(value: boolean);
  111706. get depthTest(): boolean;
  111707. set depthTest(value: boolean);
  111708. get frontFace(): Nullable<number>;
  111709. set frontFace(value: Nullable<number>);
  111710. reset(): void;
  111711. apply(gl: WebGLRenderingContext): void;
  111712. }
  111713. }
  111714. declare module BABYLON {
  111715. /**
  111716. * @hidden
  111717. **/
  111718. export class StencilState {
  111719. /** 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 */
  111720. static readonly ALWAYS: number;
  111721. /** Passed to stencilOperation to specify that stencil value must be kept */
  111722. static readonly KEEP: number;
  111723. /** Passed to stencilOperation to specify that stencil value must be replaced */
  111724. static readonly REPLACE: number;
  111725. private _isStencilTestDirty;
  111726. private _isStencilMaskDirty;
  111727. private _isStencilFuncDirty;
  111728. private _isStencilOpDirty;
  111729. private _stencilTest;
  111730. private _stencilMask;
  111731. private _stencilFunc;
  111732. private _stencilFuncRef;
  111733. private _stencilFuncMask;
  111734. private _stencilOpStencilFail;
  111735. private _stencilOpDepthFail;
  111736. private _stencilOpStencilDepthPass;
  111737. get isDirty(): boolean;
  111738. get stencilFunc(): number;
  111739. set stencilFunc(value: number);
  111740. get stencilFuncRef(): number;
  111741. set stencilFuncRef(value: number);
  111742. get stencilFuncMask(): number;
  111743. set stencilFuncMask(value: number);
  111744. get stencilOpStencilFail(): number;
  111745. set stencilOpStencilFail(value: number);
  111746. get stencilOpDepthFail(): number;
  111747. set stencilOpDepthFail(value: number);
  111748. get stencilOpStencilDepthPass(): number;
  111749. set stencilOpStencilDepthPass(value: number);
  111750. get stencilMask(): number;
  111751. set stencilMask(value: number);
  111752. get stencilTest(): boolean;
  111753. set stencilTest(value: boolean);
  111754. constructor();
  111755. reset(): void;
  111756. apply(gl: WebGLRenderingContext): void;
  111757. }
  111758. }
  111759. declare module BABYLON {
  111760. /**
  111761. * @hidden
  111762. **/
  111763. export class AlphaState {
  111764. private _isAlphaBlendDirty;
  111765. private _isBlendFunctionParametersDirty;
  111766. private _isBlendEquationParametersDirty;
  111767. private _isBlendConstantsDirty;
  111768. private _alphaBlend;
  111769. private _blendFunctionParameters;
  111770. private _blendEquationParameters;
  111771. private _blendConstants;
  111772. /**
  111773. * Initializes the state.
  111774. */
  111775. constructor();
  111776. get isDirty(): boolean;
  111777. get alphaBlend(): boolean;
  111778. set alphaBlend(value: boolean);
  111779. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  111780. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  111781. setAlphaEquationParameters(rgb: number, alpha: number): void;
  111782. reset(): void;
  111783. apply(gl: WebGLRenderingContext): void;
  111784. }
  111785. }
  111786. declare module BABYLON {
  111787. /** @hidden */
  111788. export class WebGL2ShaderProcessor implements IShaderProcessor {
  111789. attributeProcessor(attribute: string): string;
  111790. varyingProcessor(varying: string, isFragment: boolean): string;
  111791. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  111792. }
  111793. }
  111794. declare module BABYLON {
  111795. /**
  111796. * Interface for attribute information associated with buffer instanciation
  111797. */
  111798. export interface InstancingAttributeInfo {
  111799. /**
  111800. * Name of the GLSL attribute
  111801. * if attribute index is not specified, this is used to retrieve the index from the effect
  111802. */
  111803. attributeName: string;
  111804. /**
  111805. * Index/offset of the attribute in the vertex shader
  111806. * if not specified, this will be computes from the name.
  111807. */
  111808. index?: number;
  111809. /**
  111810. * size of the attribute, 1, 2, 3 or 4
  111811. */
  111812. attributeSize: number;
  111813. /**
  111814. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  111815. */
  111816. offset: number;
  111817. /**
  111818. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  111819. * default to 1
  111820. */
  111821. divisor?: number;
  111822. /**
  111823. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  111824. * default is FLOAT
  111825. */
  111826. attributeType?: number;
  111827. /**
  111828. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  111829. */
  111830. normalized?: boolean;
  111831. }
  111832. }
  111833. declare module BABYLON {
  111834. interface ThinEngine {
  111835. /**
  111836. * Update a video texture
  111837. * @param texture defines the texture to update
  111838. * @param video defines the video element to use
  111839. * @param invertY defines if data must be stored with Y axis inverted
  111840. */
  111841. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  111842. }
  111843. }
  111844. declare module BABYLON {
  111845. interface ThinEngine {
  111846. /**
  111847. * Creates a dynamic texture
  111848. * @param width defines the width of the texture
  111849. * @param height defines the height of the texture
  111850. * @param generateMipMaps defines if the engine should generate the mip levels
  111851. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  111852. * @returns the dynamic texture inside an InternalTexture
  111853. */
  111854. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  111855. /**
  111856. * Update the content of a dynamic texture
  111857. * @param texture defines the texture to update
  111858. * @param canvas defines the canvas containing the source
  111859. * @param invertY defines if data must be stored with Y axis inverted
  111860. * @param premulAlpha defines if alpha is stored as premultiplied
  111861. * @param format defines the format of the data
  111862. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  111863. */
  111864. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  111865. }
  111866. }
  111867. declare module BABYLON {
  111868. /**
  111869. * Settings for finer control over video usage
  111870. */
  111871. export interface VideoTextureSettings {
  111872. /**
  111873. * Applies `autoplay` to video, if specified
  111874. */
  111875. autoPlay?: boolean;
  111876. /**
  111877. * Applies `loop` to video, if specified
  111878. */
  111879. loop?: boolean;
  111880. /**
  111881. * Automatically updates internal texture from video at every frame in the render loop
  111882. */
  111883. autoUpdateTexture: boolean;
  111884. /**
  111885. * Image src displayed during the video loading or until the user interacts with the video.
  111886. */
  111887. poster?: string;
  111888. }
  111889. /**
  111890. * If you want to display a video in your scene, this is the special texture for that.
  111891. * This special texture works similar to other textures, with the exception of a few parameters.
  111892. * @see https://doc.babylonjs.com/how_to/video_texture
  111893. */
  111894. export class VideoTexture extends Texture {
  111895. /**
  111896. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  111897. */
  111898. readonly autoUpdateTexture: boolean;
  111899. /**
  111900. * The video instance used by the texture internally
  111901. */
  111902. readonly video: HTMLVideoElement;
  111903. private _onUserActionRequestedObservable;
  111904. /**
  111905. * Event triggerd when a dom action is required by the user to play the video.
  111906. * This happens due to recent changes in browser policies preventing video to auto start.
  111907. */
  111908. get onUserActionRequestedObservable(): Observable<Texture>;
  111909. private _generateMipMaps;
  111910. private _stillImageCaptured;
  111911. private _displayingPosterTexture;
  111912. private _settings;
  111913. private _createInternalTextureOnEvent;
  111914. private _frameId;
  111915. private _currentSrc;
  111916. /**
  111917. * Creates a video texture.
  111918. * If you want to display a video in your scene, this is the special texture for that.
  111919. * This special texture works similar to other textures, with the exception of a few parameters.
  111920. * @see https://doc.babylonjs.com/how_to/video_texture
  111921. * @param name optional name, will detect from video source, if not defined
  111922. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  111923. * @param scene is obviously the current scene.
  111924. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  111925. * @param invertY is false by default but can be used to invert video on Y axis
  111926. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  111927. * @param settings allows finer control over video usage
  111928. */
  111929. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  111930. private _getName;
  111931. private _getVideo;
  111932. private _createInternalTexture;
  111933. private reset;
  111934. /**
  111935. * @hidden Internal method to initiate `update`.
  111936. */
  111937. _rebuild(): void;
  111938. /**
  111939. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  111940. */
  111941. update(): void;
  111942. /**
  111943. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  111944. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  111945. */
  111946. updateTexture(isVisible: boolean): void;
  111947. protected _updateInternalTexture: () => void;
  111948. /**
  111949. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  111950. * @param url New url.
  111951. */
  111952. updateURL(url: string): void;
  111953. /**
  111954. * Clones the texture.
  111955. * @returns the cloned texture
  111956. */
  111957. clone(): VideoTexture;
  111958. /**
  111959. * Dispose the texture and release its associated resources.
  111960. */
  111961. dispose(): void;
  111962. /**
  111963. * Creates a video texture straight from a stream.
  111964. * @param scene Define the scene the texture should be created in
  111965. * @param stream Define the stream the texture should be created from
  111966. * @returns The created video texture as a promise
  111967. */
  111968. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  111969. /**
  111970. * Creates a video texture straight from your WebCam video feed.
  111971. * @param scene Define the scene the texture should be created in
  111972. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  111973. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  111974. * @returns The created video texture as a promise
  111975. */
  111976. static CreateFromWebCamAsync(scene: Scene, constraints: {
  111977. minWidth: number;
  111978. maxWidth: number;
  111979. minHeight: number;
  111980. maxHeight: number;
  111981. deviceId: string;
  111982. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  111983. /**
  111984. * Creates a video texture straight from your WebCam video feed.
  111985. * @param scene Define the scene the texture should be created in
  111986. * @param onReady Define a callback to triggered once the texture will be ready
  111987. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  111988. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  111989. */
  111990. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  111991. minWidth: number;
  111992. maxWidth: number;
  111993. minHeight: number;
  111994. maxHeight: number;
  111995. deviceId: string;
  111996. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  111997. }
  111998. }
  111999. declare module BABYLON {
  112000. /**
  112001. * Defines the interface used by objects working like Scene
  112002. * @hidden
  112003. */
  112004. export interface ISceneLike {
  112005. _addPendingData(data: any): void;
  112006. _removePendingData(data: any): void;
  112007. offlineProvider: IOfflineProvider;
  112008. }
  112009. /** Interface defining initialization parameters for Engine class */
  112010. export interface EngineOptions extends WebGLContextAttributes {
  112011. /**
  112012. * Defines if the engine should no exceed a specified device ratio
  112013. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  112014. */
  112015. limitDeviceRatio?: number;
  112016. /**
  112017. * Defines if webvr should be enabled automatically
  112018. * @see http://doc.babylonjs.com/how_to/webvr_camera
  112019. */
  112020. autoEnableWebVR?: boolean;
  112021. /**
  112022. * Defines if webgl2 should be turned off even if supported
  112023. * @see http://doc.babylonjs.com/features/webgl2
  112024. */
  112025. disableWebGL2Support?: boolean;
  112026. /**
  112027. * Defines if webaudio should be initialized as well
  112028. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  112029. */
  112030. audioEngine?: boolean;
  112031. /**
  112032. * Defines if animations should run using a deterministic lock step
  112033. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112034. */
  112035. deterministicLockstep?: boolean;
  112036. /** Defines the maximum steps to use with deterministic lock step mode */
  112037. lockstepMaxSteps?: number;
  112038. /** Defines the seconds between each deterministic lock step */
  112039. timeStep?: number;
  112040. /**
  112041. * Defines that engine should ignore context lost events
  112042. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  112043. */
  112044. doNotHandleContextLost?: boolean;
  112045. /**
  112046. * Defines that engine should ignore modifying touch action attribute and style
  112047. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  112048. */
  112049. doNotHandleTouchAction?: boolean;
  112050. /**
  112051. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  112052. */
  112053. useHighPrecisionFloats?: boolean;
  112054. /**
  112055. * Make the canvas XR Compatible for XR sessions
  112056. */
  112057. xrCompatible?: boolean;
  112058. }
  112059. /**
  112060. * The base engine class (root of all engines)
  112061. */
  112062. export class ThinEngine {
  112063. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  112064. static ExceptionList: ({
  112065. key: string;
  112066. capture: string;
  112067. captureConstraint: number;
  112068. targets: string[];
  112069. } | {
  112070. key: string;
  112071. capture: null;
  112072. captureConstraint: null;
  112073. targets: string[];
  112074. })[];
  112075. /** @hidden */
  112076. static _TextureLoaders: IInternalTextureLoader[];
  112077. /**
  112078. * Returns the current npm package of the sdk
  112079. */
  112080. static get NpmPackage(): string;
  112081. /**
  112082. * Returns the current version of the framework
  112083. */
  112084. static get Version(): string;
  112085. /**
  112086. * Returns a string describing the current engine
  112087. */
  112088. get description(): string;
  112089. /**
  112090. * Gets or sets the epsilon value used by collision engine
  112091. */
  112092. static CollisionsEpsilon: number;
  112093. /**
  112094. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  112095. */
  112096. static get ShadersRepository(): string;
  112097. static set ShadersRepository(value: string);
  112098. /** @hidden */
  112099. _shaderProcessor: IShaderProcessor;
  112100. /**
  112101. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  112102. */
  112103. forcePOTTextures: boolean;
  112104. /**
  112105. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  112106. */
  112107. isFullscreen: boolean;
  112108. /**
  112109. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  112110. */
  112111. cullBackFaces: boolean;
  112112. /**
  112113. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  112114. */
  112115. renderEvenInBackground: boolean;
  112116. /**
  112117. * Gets or sets a boolean indicating that cache can be kept between frames
  112118. */
  112119. preventCacheWipeBetweenFrames: boolean;
  112120. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  112121. validateShaderPrograms: boolean;
  112122. /**
  112123. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  112124. * This can provide greater z depth for distant objects.
  112125. */
  112126. useReverseDepthBuffer: boolean;
  112127. /**
  112128. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  112129. */
  112130. disableUniformBuffers: boolean;
  112131. /** @hidden */
  112132. _uniformBuffers: UniformBuffer[];
  112133. /**
  112134. * Gets a boolean indicating that the engine supports uniform buffers
  112135. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  112136. */
  112137. get supportsUniformBuffers(): boolean;
  112138. /** @hidden */
  112139. _gl: WebGLRenderingContext;
  112140. /** @hidden */
  112141. _webGLVersion: number;
  112142. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  112143. protected _windowIsBackground: boolean;
  112144. protected _creationOptions: EngineOptions;
  112145. protected _highPrecisionShadersAllowed: boolean;
  112146. /** @hidden */
  112147. get _shouldUseHighPrecisionShader(): boolean;
  112148. /**
  112149. * Gets a boolean indicating that only power of 2 textures are supported
  112150. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  112151. */
  112152. get needPOTTextures(): boolean;
  112153. /** @hidden */
  112154. _badOS: boolean;
  112155. /** @hidden */
  112156. _badDesktopOS: boolean;
  112157. private _hardwareScalingLevel;
  112158. /** @hidden */
  112159. _caps: EngineCapabilities;
  112160. private _isStencilEnable;
  112161. private _glVersion;
  112162. private _glRenderer;
  112163. private _glVendor;
  112164. /** @hidden */
  112165. _videoTextureSupported: boolean;
  112166. protected _renderingQueueLaunched: boolean;
  112167. protected _activeRenderLoops: (() => void)[];
  112168. /**
  112169. * Observable signaled when a context lost event is raised
  112170. */
  112171. onContextLostObservable: Observable<ThinEngine>;
  112172. /**
  112173. * Observable signaled when a context restored event is raised
  112174. */
  112175. onContextRestoredObservable: Observable<ThinEngine>;
  112176. private _onContextLost;
  112177. private _onContextRestored;
  112178. protected _contextWasLost: boolean;
  112179. /** @hidden */
  112180. _doNotHandleContextLost: boolean;
  112181. /**
  112182. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  112183. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  112184. */
  112185. get doNotHandleContextLost(): boolean;
  112186. set doNotHandleContextLost(value: boolean);
  112187. /**
  112188. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  112189. */
  112190. disableVertexArrayObjects: boolean;
  112191. /** @hidden */
  112192. protected _colorWrite: boolean;
  112193. /** @hidden */
  112194. protected _colorWriteChanged: boolean;
  112195. /** @hidden */
  112196. protected _depthCullingState: DepthCullingState;
  112197. /** @hidden */
  112198. protected _stencilState: StencilState;
  112199. /** @hidden */
  112200. _alphaState: AlphaState;
  112201. /** @hidden */
  112202. _alphaMode: number;
  112203. /** @hidden */
  112204. _alphaEquation: number;
  112205. /** @hidden */
  112206. _internalTexturesCache: InternalTexture[];
  112207. /** @hidden */
  112208. protected _activeChannel: number;
  112209. private _currentTextureChannel;
  112210. /** @hidden */
  112211. protected _boundTexturesCache: {
  112212. [key: string]: Nullable<InternalTexture>;
  112213. };
  112214. /** @hidden */
  112215. protected _currentEffect: Nullable<Effect>;
  112216. /** @hidden */
  112217. protected _currentProgram: Nullable<WebGLProgram>;
  112218. private _compiledEffects;
  112219. private _vertexAttribArraysEnabled;
  112220. /** @hidden */
  112221. protected _cachedViewport: Nullable<IViewportLike>;
  112222. private _cachedVertexArrayObject;
  112223. /** @hidden */
  112224. protected _cachedVertexBuffers: any;
  112225. /** @hidden */
  112226. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  112227. /** @hidden */
  112228. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  112229. /** @hidden */
  112230. _currentRenderTarget: Nullable<InternalTexture>;
  112231. private _uintIndicesCurrentlySet;
  112232. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  112233. /** @hidden */
  112234. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  112235. /** @hidden */
  112236. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  112237. private _currentBufferPointers;
  112238. private _currentInstanceLocations;
  112239. private _currentInstanceBuffers;
  112240. private _textureUnits;
  112241. /** @hidden */
  112242. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  112243. /** @hidden */
  112244. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  112245. /** @hidden */
  112246. _boundRenderFunction: any;
  112247. private _vaoRecordInProgress;
  112248. private _mustWipeVertexAttributes;
  112249. private _emptyTexture;
  112250. private _emptyCubeTexture;
  112251. private _emptyTexture3D;
  112252. private _emptyTexture2DArray;
  112253. /** @hidden */
  112254. _frameHandler: number;
  112255. private _nextFreeTextureSlots;
  112256. private _maxSimultaneousTextures;
  112257. private _activeRequests;
  112258. /** @hidden */
  112259. _transformTextureUrl: Nullable<(url: string) => string>;
  112260. protected get _supportsHardwareTextureRescaling(): boolean;
  112261. private _framebufferDimensionsObject;
  112262. /**
  112263. * sets the object from which width and height will be taken from when getting render width and height
  112264. * Will fallback to the gl object
  112265. * @param dimensions the framebuffer width and height that will be used.
  112266. */
  112267. set framebufferDimensionsObject(dimensions: Nullable<{
  112268. framebufferWidth: number;
  112269. framebufferHeight: number;
  112270. }>);
  112271. /**
  112272. * Gets the current viewport
  112273. */
  112274. get currentViewport(): Nullable<IViewportLike>;
  112275. /**
  112276. * Gets the default empty texture
  112277. */
  112278. get emptyTexture(): InternalTexture;
  112279. /**
  112280. * Gets the default empty 3D texture
  112281. */
  112282. get emptyTexture3D(): InternalTexture;
  112283. /**
  112284. * Gets the default empty 2D array texture
  112285. */
  112286. get emptyTexture2DArray(): InternalTexture;
  112287. /**
  112288. * Gets the default empty cube texture
  112289. */
  112290. get emptyCubeTexture(): InternalTexture;
  112291. /**
  112292. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  112293. */
  112294. readonly premultipliedAlpha: boolean;
  112295. /**
  112296. * Observable event triggered before each texture is initialized
  112297. */
  112298. onBeforeTextureInitObservable: Observable<Texture>;
  112299. /**
  112300. * Creates a new engine
  112301. * @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
  112302. * @param antialias defines enable antialiasing (default: false)
  112303. * @param options defines further options to be sent to the getContext() function
  112304. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  112305. */
  112306. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  112307. private _rebuildInternalTextures;
  112308. private _rebuildEffects;
  112309. /**
  112310. * Gets a boolean indicating if all created effects are ready
  112311. * @returns true if all effects are ready
  112312. */
  112313. areAllEffectsReady(): boolean;
  112314. protected _rebuildBuffers(): void;
  112315. protected _initGLContext(): void;
  112316. /**
  112317. * Gets version of the current webGL context
  112318. */
  112319. get webGLVersion(): number;
  112320. /**
  112321. * Gets a string idenfifying the name of the class
  112322. * @returns "Engine" string
  112323. */
  112324. getClassName(): string;
  112325. /**
  112326. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  112327. */
  112328. get isStencilEnable(): boolean;
  112329. /** @hidden */
  112330. _prepareWorkingCanvas(): void;
  112331. /**
  112332. * Reset the texture cache to empty state
  112333. */
  112334. resetTextureCache(): void;
  112335. /**
  112336. * Gets an object containing information about the current webGL context
  112337. * @returns an object containing the vender, the renderer and the version of the current webGL context
  112338. */
  112339. getGlInfo(): {
  112340. vendor: string;
  112341. renderer: string;
  112342. version: string;
  112343. };
  112344. /**
  112345. * Defines the hardware scaling level.
  112346. * By default the hardware scaling level is computed from the window device ratio.
  112347. * 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.
  112348. * @param level defines the level to use
  112349. */
  112350. setHardwareScalingLevel(level: number): void;
  112351. /**
  112352. * Gets the current hardware scaling level.
  112353. * By default the hardware scaling level is computed from the window device ratio.
  112354. * 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.
  112355. * @returns a number indicating the current hardware scaling level
  112356. */
  112357. getHardwareScalingLevel(): number;
  112358. /**
  112359. * Gets the list of loaded textures
  112360. * @returns an array containing all loaded textures
  112361. */
  112362. getLoadedTexturesCache(): InternalTexture[];
  112363. /**
  112364. * Gets the object containing all engine capabilities
  112365. * @returns the EngineCapabilities object
  112366. */
  112367. getCaps(): EngineCapabilities;
  112368. /**
  112369. * stop executing a render loop function and remove it from the execution array
  112370. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  112371. */
  112372. stopRenderLoop(renderFunction?: () => void): void;
  112373. /** @hidden */
  112374. _renderLoop(): void;
  112375. /**
  112376. * Gets the HTML canvas attached with the current webGL context
  112377. * @returns a HTML canvas
  112378. */
  112379. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  112380. /**
  112381. * Gets host window
  112382. * @returns the host window object
  112383. */
  112384. getHostWindow(): Nullable<Window>;
  112385. /**
  112386. * Gets the current render width
  112387. * @param useScreen defines if screen size must be used (or the current render target if any)
  112388. * @returns a number defining the current render width
  112389. */
  112390. getRenderWidth(useScreen?: boolean): number;
  112391. /**
  112392. * Gets the current render height
  112393. * @param useScreen defines if screen size must be used (or the current render target if any)
  112394. * @returns a number defining the current render height
  112395. */
  112396. getRenderHeight(useScreen?: boolean): number;
  112397. /**
  112398. * Can be used to override the current requestAnimationFrame requester.
  112399. * @hidden
  112400. */
  112401. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  112402. /**
  112403. * Register and execute a render loop. The engine can have more than one render function
  112404. * @param renderFunction defines the function to continuously execute
  112405. */
  112406. runRenderLoop(renderFunction: () => void): void;
  112407. /**
  112408. * Clear the current render buffer or the current render target (if any is set up)
  112409. * @param color defines the color to use
  112410. * @param backBuffer defines if the back buffer must be cleared
  112411. * @param depth defines if the depth buffer must be cleared
  112412. * @param stencil defines if the stencil buffer must be cleared
  112413. */
  112414. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  112415. private _viewportCached;
  112416. /** @hidden */
  112417. _viewport(x: number, y: number, width: number, height: number): void;
  112418. /**
  112419. * Set the WebGL's viewport
  112420. * @param viewport defines the viewport element to be used
  112421. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  112422. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  112423. */
  112424. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  112425. /**
  112426. * Begin a new frame
  112427. */
  112428. beginFrame(): void;
  112429. /**
  112430. * Enf the current frame
  112431. */
  112432. endFrame(): void;
  112433. /**
  112434. * Resize the view according to the canvas' size
  112435. */
  112436. resize(): void;
  112437. /**
  112438. * Force a specific size of the canvas
  112439. * @param width defines the new canvas' width
  112440. * @param height defines the new canvas' height
  112441. * @returns true if the size was changed
  112442. */
  112443. setSize(width: number, height: number): boolean;
  112444. /**
  112445. * Binds the frame buffer to the specified texture.
  112446. * @param texture The texture to render to or null for the default canvas
  112447. * @param faceIndex The face of the texture to render to in case of cube texture
  112448. * @param requiredWidth The width of the target to render to
  112449. * @param requiredHeight The height of the target to render to
  112450. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  112451. * @param lodLevel defines the lod level to bind to the frame buffer
  112452. * @param layer defines the 2d array index to bind to frame buffer to
  112453. */
  112454. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  112455. /** @hidden */
  112456. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  112457. /**
  112458. * Unbind the current render target texture from the webGL context
  112459. * @param texture defines the render target texture to unbind
  112460. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  112461. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  112462. */
  112463. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  112464. /**
  112465. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  112466. */
  112467. flushFramebuffer(): void;
  112468. /**
  112469. * Unbind the current render target and bind the default framebuffer
  112470. */
  112471. restoreDefaultFramebuffer(): void;
  112472. /** @hidden */
  112473. protected _resetVertexBufferBinding(): void;
  112474. /**
  112475. * Creates a vertex buffer
  112476. * @param data the data for the vertex buffer
  112477. * @returns the new WebGL static buffer
  112478. */
  112479. createVertexBuffer(data: DataArray): DataBuffer;
  112480. private _createVertexBuffer;
  112481. /**
  112482. * Creates a dynamic vertex buffer
  112483. * @param data the data for the dynamic vertex buffer
  112484. * @returns the new WebGL dynamic buffer
  112485. */
  112486. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  112487. protected _resetIndexBufferBinding(): void;
  112488. /**
  112489. * Creates a new index buffer
  112490. * @param indices defines the content of the index buffer
  112491. * @param updatable defines if the index buffer must be updatable
  112492. * @returns a new webGL buffer
  112493. */
  112494. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  112495. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  112496. /**
  112497. * Bind a webGL buffer to the webGL context
  112498. * @param buffer defines the buffer to bind
  112499. */
  112500. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  112501. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  112502. private bindBuffer;
  112503. /**
  112504. * update the bound buffer with the given data
  112505. * @param data defines the data to update
  112506. */
  112507. updateArrayBuffer(data: Float32Array): void;
  112508. private _vertexAttribPointer;
  112509. /** @hidden */
  112510. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  112511. private _bindVertexBuffersAttributes;
  112512. /**
  112513. * Records a vertex array object
  112514. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  112515. * @param vertexBuffers defines the list of vertex buffers to store
  112516. * @param indexBuffer defines the index buffer to store
  112517. * @param effect defines the effect to store
  112518. * @returns the new vertex array object
  112519. */
  112520. recordVertexArrayObject(vertexBuffers: {
  112521. [key: string]: VertexBuffer;
  112522. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  112523. /**
  112524. * Bind a specific vertex array object
  112525. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  112526. * @param vertexArrayObject defines the vertex array object to bind
  112527. * @param indexBuffer defines the index buffer to bind
  112528. */
  112529. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  112530. /**
  112531. * Bind webGl buffers directly to the webGL context
  112532. * @param vertexBuffer defines the vertex buffer to bind
  112533. * @param indexBuffer defines the index buffer to bind
  112534. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  112535. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  112536. * @param effect defines the effect associated with the vertex buffer
  112537. */
  112538. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  112539. private _unbindVertexArrayObject;
  112540. /**
  112541. * Bind a list of vertex buffers to the webGL context
  112542. * @param vertexBuffers defines the list of vertex buffers to bind
  112543. * @param indexBuffer defines the index buffer to bind
  112544. * @param effect defines the effect associated with the vertex buffers
  112545. */
  112546. bindBuffers(vertexBuffers: {
  112547. [key: string]: Nullable<VertexBuffer>;
  112548. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  112549. /**
  112550. * Unbind all instance attributes
  112551. */
  112552. unbindInstanceAttributes(): void;
  112553. /**
  112554. * Release and free the memory of a vertex array object
  112555. * @param vao defines the vertex array object to delete
  112556. */
  112557. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  112558. /** @hidden */
  112559. _releaseBuffer(buffer: DataBuffer): boolean;
  112560. protected _deleteBuffer(buffer: DataBuffer): void;
  112561. /**
  112562. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  112563. * @param instancesBuffer defines the webGL buffer to update and bind
  112564. * @param data defines the data to store in the buffer
  112565. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  112566. */
  112567. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  112568. /**
  112569. * Bind the content of a webGL buffer used with instantiation
  112570. * @param instancesBuffer defines the webGL buffer to bind
  112571. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  112572. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  112573. */
  112574. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  112575. /**
  112576. * Disable the instance attribute corresponding to the name in parameter
  112577. * @param name defines the name of the attribute to disable
  112578. */
  112579. disableInstanceAttributeByName(name: string): void;
  112580. /**
  112581. * Disable the instance attribute corresponding to the location in parameter
  112582. * @param attributeLocation defines the attribute location of the attribute to disable
  112583. */
  112584. disableInstanceAttribute(attributeLocation: number): void;
  112585. /**
  112586. * Disable the attribute corresponding to the location in parameter
  112587. * @param attributeLocation defines the attribute location of the attribute to disable
  112588. */
  112589. disableAttributeByIndex(attributeLocation: number): void;
  112590. /**
  112591. * Send a draw order
  112592. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  112593. * @param indexStart defines the starting index
  112594. * @param indexCount defines the number of index to draw
  112595. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112596. */
  112597. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  112598. /**
  112599. * Draw a list of points
  112600. * @param verticesStart defines the index of first vertex to draw
  112601. * @param verticesCount defines the count of vertices to draw
  112602. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112603. */
  112604. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  112605. /**
  112606. * Draw a list of unindexed primitives
  112607. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  112608. * @param verticesStart defines the index of first vertex to draw
  112609. * @param verticesCount defines the count of vertices to draw
  112610. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112611. */
  112612. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  112613. /**
  112614. * Draw a list of indexed primitives
  112615. * @param fillMode defines the primitive to use
  112616. * @param indexStart defines the starting index
  112617. * @param indexCount defines the number of index to draw
  112618. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112619. */
  112620. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  112621. /**
  112622. * Draw a list of unindexed primitives
  112623. * @param fillMode defines the primitive to use
  112624. * @param verticesStart defines the index of first vertex to draw
  112625. * @param verticesCount defines the count of vertices to draw
  112626. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112627. */
  112628. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  112629. private _drawMode;
  112630. /** @hidden */
  112631. protected _reportDrawCall(): void;
  112632. /** @hidden */
  112633. _releaseEffect(effect: Effect): void;
  112634. /** @hidden */
  112635. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  112636. /**
  112637. * Create a new effect (used to store vertex/fragment shaders)
  112638. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  112639. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  112640. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  112641. * @param samplers defines an array of string used to represent textures
  112642. * @param defines defines the string containing the defines to use to compile the shaders
  112643. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  112644. * @param onCompiled defines a function to call when the effect creation is successful
  112645. * @param onError defines a function to call when the effect creation has failed
  112646. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  112647. * @returns the new Effect
  112648. */
  112649. 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;
  112650. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  112651. private _compileShader;
  112652. private _compileRawShader;
  112653. /** @hidden */
  112654. _getShaderSource(shader: WebGLShader): Nullable<string>;
  112655. /**
  112656. * Directly creates a webGL program
  112657. * @param pipelineContext defines the pipeline context to attach to
  112658. * @param vertexCode defines the vertex shader code to use
  112659. * @param fragmentCode defines the fragment shader code to use
  112660. * @param context defines the webGL context to use (if not set, the current one will be used)
  112661. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  112662. * @returns the new webGL program
  112663. */
  112664. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  112665. /**
  112666. * Creates a webGL program
  112667. * @param pipelineContext defines the pipeline context to attach to
  112668. * @param vertexCode defines the vertex shader code to use
  112669. * @param fragmentCode defines the fragment shader code to use
  112670. * @param defines defines the string containing the defines to use to compile the shaders
  112671. * @param context defines the webGL context to use (if not set, the current one will be used)
  112672. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  112673. * @returns the new webGL program
  112674. */
  112675. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  112676. /**
  112677. * Creates a new pipeline context
  112678. * @returns the new pipeline
  112679. */
  112680. createPipelineContext(): IPipelineContext;
  112681. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  112682. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  112683. /** @hidden */
  112684. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  112685. /** @hidden */
  112686. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  112687. /** @hidden */
  112688. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  112689. /**
  112690. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  112691. * @param pipelineContext defines the pipeline context to use
  112692. * @param uniformsNames defines the list of uniform names
  112693. * @returns an array of webGL uniform locations
  112694. */
  112695. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  112696. /**
  112697. * Gets the lsit of active attributes for a given webGL program
  112698. * @param pipelineContext defines the pipeline context to use
  112699. * @param attributesNames defines the list of attribute names to get
  112700. * @returns an array of indices indicating the offset of each attribute
  112701. */
  112702. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  112703. /**
  112704. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  112705. * @param effect defines the effect to activate
  112706. */
  112707. enableEffect(effect: Nullable<Effect>): void;
  112708. /**
  112709. * Set the value of an uniform to a number (int)
  112710. * @param uniform defines the webGL uniform location where to store the value
  112711. * @param value defines the int number to store
  112712. */
  112713. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  112714. /**
  112715. * Set the value of an uniform to an array of int32
  112716. * @param uniform defines the webGL uniform location where to store the value
  112717. * @param array defines the array of int32 to store
  112718. */
  112719. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  112720. /**
  112721. * Set the value of an uniform to an array of int32 (stored as vec2)
  112722. * @param uniform defines the webGL uniform location where to store the value
  112723. * @param array defines the array of int32 to store
  112724. */
  112725. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  112726. /**
  112727. * Set the value of an uniform to an array of int32 (stored as vec3)
  112728. * @param uniform defines the webGL uniform location where to store the value
  112729. * @param array defines the array of int32 to store
  112730. */
  112731. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  112732. /**
  112733. * Set the value of an uniform to an array of int32 (stored as vec4)
  112734. * @param uniform defines the webGL uniform location where to store the value
  112735. * @param array defines the array of int32 to store
  112736. */
  112737. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  112738. /**
  112739. * Set the value of an uniform to an array of number
  112740. * @param uniform defines the webGL uniform location where to store the value
  112741. * @param array defines the array of number to store
  112742. */
  112743. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  112744. /**
  112745. * Set the value of an uniform to an array of number (stored as vec2)
  112746. * @param uniform defines the webGL uniform location where to store the value
  112747. * @param array defines the array of number to store
  112748. */
  112749. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  112750. /**
  112751. * Set the value of an uniform to an array of number (stored as vec3)
  112752. * @param uniform defines the webGL uniform location where to store the value
  112753. * @param array defines the array of number to store
  112754. */
  112755. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  112756. /**
  112757. * Set the value of an uniform to an array of number (stored as vec4)
  112758. * @param uniform defines the webGL uniform location where to store the value
  112759. * @param array defines the array of number to store
  112760. */
  112761. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  112762. /**
  112763. * Set the value of an uniform to an array of float32 (stored as matrices)
  112764. * @param uniform defines the webGL uniform location where to store the value
  112765. * @param matrices defines the array of float32 to store
  112766. */
  112767. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  112768. /**
  112769. * Set the value of an uniform to a matrix (3x3)
  112770. * @param uniform defines the webGL uniform location where to store the value
  112771. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  112772. */
  112773. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  112774. /**
  112775. * Set the value of an uniform to a matrix (2x2)
  112776. * @param uniform defines the webGL uniform location where to store the value
  112777. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  112778. */
  112779. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  112780. /**
  112781. * Set the value of an uniform to a number (float)
  112782. * @param uniform defines the webGL uniform location where to store the value
  112783. * @param value defines the float number to store
  112784. */
  112785. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  112786. /**
  112787. * Set the value of an uniform to a vec2
  112788. * @param uniform defines the webGL uniform location where to store the value
  112789. * @param x defines the 1st component of the value
  112790. * @param y defines the 2nd component of the value
  112791. */
  112792. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  112793. /**
  112794. * Set the value of an uniform to a vec3
  112795. * @param uniform defines the webGL uniform location where to store the value
  112796. * @param x defines the 1st component of the value
  112797. * @param y defines the 2nd component of the value
  112798. * @param z defines the 3rd component of the value
  112799. */
  112800. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  112801. /**
  112802. * Set the value of an uniform to a vec4
  112803. * @param uniform defines the webGL uniform location where to store the value
  112804. * @param x defines the 1st component of the value
  112805. * @param y defines the 2nd component of the value
  112806. * @param z defines the 3rd component of the value
  112807. * @param w defines the 4th component of the value
  112808. */
  112809. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  112810. /**
  112811. * Apply all cached states (depth, culling, stencil and alpha)
  112812. */
  112813. applyStates(): void;
  112814. /**
  112815. * Enable or disable color writing
  112816. * @param enable defines the state to set
  112817. */
  112818. setColorWrite(enable: boolean): void;
  112819. /**
  112820. * Gets a boolean indicating if color writing is enabled
  112821. * @returns the current color writing state
  112822. */
  112823. getColorWrite(): boolean;
  112824. /**
  112825. * Gets the depth culling state manager
  112826. */
  112827. get depthCullingState(): DepthCullingState;
  112828. /**
  112829. * Gets the alpha state manager
  112830. */
  112831. get alphaState(): AlphaState;
  112832. /**
  112833. * Gets the stencil state manager
  112834. */
  112835. get stencilState(): StencilState;
  112836. /**
  112837. * Clears the list of texture accessible through engine.
  112838. * This can help preventing texture load conflict due to name collision.
  112839. */
  112840. clearInternalTexturesCache(): void;
  112841. /**
  112842. * Force the entire cache to be cleared
  112843. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  112844. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  112845. */
  112846. wipeCaches(bruteForce?: boolean): void;
  112847. /** @hidden */
  112848. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  112849. min: number;
  112850. mag: number;
  112851. };
  112852. /** @hidden */
  112853. _createTexture(): WebGLTexture;
  112854. /**
  112855. * Usually called from Texture.ts.
  112856. * Passed information to create a WebGLTexture
  112857. * @param url defines a value which contains one of the following:
  112858. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  112859. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  112860. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  112861. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  112862. * @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)
  112863. * @param scene needed for loading to the correct scene
  112864. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  112865. * @param onLoad optional callback to be called upon successful completion
  112866. * @param onError optional callback to be called upon failure
  112867. * @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
  112868. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  112869. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  112870. * @param forcedExtension defines the extension to use to pick the right loader
  112871. * @param mimeType defines an optional mime type
  112872. * @returns a InternalTexture for assignment back into BABYLON.Texture
  112873. */
  112874. createTexture(url: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string): InternalTexture;
  112875. /**
  112876. * Loads an image as an HTMLImageElement.
  112877. * @param input url string, ArrayBuffer, or Blob to load
  112878. * @param onLoad callback called when the image successfully loads
  112879. * @param onError callback called when the image fails to load
  112880. * @param offlineProvider offline provider for caching
  112881. * @param mimeType optional mime type
  112882. * @returns the HTMLImageElement of the loaded image
  112883. * @hidden
  112884. */
  112885. static _FileToolsLoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  112886. /**
  112887. * @hidden
  112888. */
  112889. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  112890. private _unpackFlipYCached;
  112891. /**
  112892. * In case you are sharing the context with other applications, it might
  112893. * be interested to not cache the unpack flip y state to ensure a consistent
  112894. * value would be set.
  112895. */
  112896. enableUnpackFlipYCached: boolean;
  112897. /** @hidden */
  112898. _unpackFlipY(value: boolean): void;
  112899. /** @hidden */
  112900. _getUnpackAlignement(): number;
  112901. private _getTextureTarget;
  112902. /**
  112903. * Update the sampling mode of a given texture
  112904. * @param samplingMode defines the required sampling mode
  112905. * @param texture defines the texture to update
  112906. * @param generateMipMaps defines whether to generate mipmaps for the texture
  112907. */
  112908. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  112909. /**
  112910. * Update the sampling mode of a given texture
  112911. * @param texture defines the texture to update
  112912. * @param wrapU defines the texture wrap mode of the u coordinates
  112913. * @param wrapV defines the texture wrap mode of the v coordinates
  112914. * @param wrapR defines the texture wrap mode of the r coordinates
  112915. */
  112916. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  112917. /** @hidden */
  112918. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  112919. width: number;
  112920. height: number;
  112921. layers?: number;
  112922. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  112923. /** @hidden */
  112924. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112925. /** @hidden */
  112926. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  112927. /**
  112928. * Update a portion of an internal texture
  112929. * @param texture defines the texture to update
  112930. * @param imageData defines the data to store into the texture
  112931. * @param xOffset defines the x coordinates of the update rectangle
  112932. * @param yOffset defines the y coordinates of the update rectangle
  112933. * @param width defines the width of the update rectangle
  112934. * @param height defines the height of the update rectangle
  112935. * @param faceIndex defines the face index if texture is a cube (0 by default)
  112936. * @param lod defines the lod level to update (0 by default)
  112937. */
  112938. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  112939. /** @hidden */
  112940. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112941. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  112942. private _prepareWebGLTexture;
  112943. /** @hidden */
  112944. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  112945. private _getDepthStencilBuffer;
  112946. /** @hidden */
  112947. _releaseFramebufferObjects(texture: InternalTexture): void;
  112948. /** @hidden */
  112949. _releaseTexture(texture: InternalTexture): void;
  112950. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  112951. protected _setProgram(program: WebGLProgram): void;
  112952. protected _boundUniforms: {
  112953. [key: number]: WebGLUniformLocation;
  112954. };
  112955. /**
  112956. * Binds an effect to the webGL context
  112957. * @param effect defines the effect to bind
  112958. */
  112959. bindSamplers(effect: Effect): void;
  112960. private _activateCurrentTexture;
  112961. /** @hidden */
  112962. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  112963. /** @hidden */
  112964. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  112965. /**
  112966. * Unbind all textures from the webGL context
  112967. */
  112968. unbindAllTextures(): void;
  112969. /**
  112970. * Sets a texture to the according uniform.
  112971. * @param channel The texture channel
  112972. * @param uniform The uniform to set
  112973. * @param texture The texture to apply
  112974. */
  112975. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  112976. private _bindSamplerUniformToChannel;
  112977. private _getTextureWrapMode;
  112978. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  112979. /**
  112980. * Sets an array of texture to the webGL context
  112981. * @param channel defines the channel where the texture array must be set
  112982. * @param uniform defines the associated uniform location
  112983. * @param textures defines the array of textures to bind
  112984. */
  112985. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  112986. /** @hidden */
  112987. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  112988. private _setTextureParameterFloat;
  112989. private _setTextureParameterInteger;
  112990. /**
  112991. * Unbind all vertex attributes from the webGL context
  112992. */
  112993. unbindAllAttributes(): void;
  112994. /**
  112995. * 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
  112996. */
  112997. releaseEffects(): void;
  112998. /**
  112999. * Dispose and release all associated resources
  113000. */
  113001. dispose(): void;
  113002. /**
  113003. * Attach a new callback raised when context lost event is fired
  113004. * @param callback defines the callback to call
  113005. */
  113006. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  113007. /**
  113008. * Attach a new callback raised when context restored event is fired
  113009. * @param callback defines the callback to call
  113010. */
  113011. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  113012. /**
  113013. * Get the current error code of the webGL context
  113014. * @returns the error code
  113015. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  113016. */
  113017. getError(): number;
  113018. private _canRenderToFloatFramebuffer;
  113019. private _canRenderToHalfFloatFramebuffer;
  113020. private _canRenderToFramebuffer;
  113021. /** @hidden */
  113022. _getWebGLTextureType(type: number): number;
  113023. /** @hidden */
  113024. _getInternalFormat(format: number): number;
  113025. /** @hidden */
  113026. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  113027. /** @hidden */
  113028. _getRGBAMultiSampleBufferFormat(type: number): number;
  113029. /** @hidden */
  113030. _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;
  113031. /**
  113032. * Loads a file from a url
  113033. * @param url url to load
  113034. * @param onSuccess callback called when the file successfully loads
  113035. * @param onProgress callback called while file is loading (if the server supports this mode)
  113036. * @param offlineProvider defines the offline provider for caching
  113037. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  113038. * @param onError callback called when the file fails to load
  113039. * @returns a file request object
  113040. * @hidden
  113041. */
  113042. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  113043. /**
  113044. * Reads pixels from the current frame buffer. Please note that this function can be slow
  113045. * @param x defines the x coordinate of the rectangle where pixels must be read
  113046. * @param y defines the y coordinate of the rectangle where pixels must be read
  113047. * @param width defines the width of the rectangle where pixels must be read
  113048. * @param height defines the height of the rectangle where pixels must be read
  113049. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  113050. * @returns a Uint8Array containing RGBA colors
  113051. */
  113052. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  113053. private static _isSupported;
  113054. /**
  113055. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  113056. * @returns true if the engine can be created
  113057. * @ignorenaming
  113058. */
  113059. static isSupported(): boolean;
  113060. /**
  113061. * Find the next highest power of two.
  113062. * @param x Number to start search from.
  113063. * @return Next highest power of two.
  113064. */
  113065. static CeilingPOT(x: number): number;
  113066. /**
  113067. * Find the next lowest power of two.
  113068. * @param x Number to start search from.
  113069. * @return Next lowest power of two.
  113070. */
  113071. static FloorPOT(x: number): number;
  113072. /**
  113073. * Find the nearest power of two.
  113074. * @param x Number to start search from.
  113075. * @return Next nearest power of two.
  113076. */
  113077. static NearestPOT(x: number): number;
  113078. /**
  113079. * Get the closest exponent of two
  113080. * @param value defines the value to approximate
  113081. * @param max defines the maximum value to return
  113082. * @param mode defines how to define the closest value
  113083. * @returns closest exponent of two of the given value
  113084. */
  113085. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  113086. /**
  113087. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  113088. * @param func - the function to be called
  113089. * @param requester - the object that will request the next frame. Falls back to window.
  113090. * @returns frame number
  113091. */
  113092. static QueueNewFrame(func: () => void, requester?: any): number;
  113093. /**
  113094. * Gets host document
  113095. * @returns the host document object
  113096. */
  113097. getHostDocument(): Nullable<Document>;
  113098. }
  113099. }
  113100. declare module BABYLON {
  113101. /**
  113102. * Class representing spherical harmonics coefficients to the 3rd degree
  113103. */
  113104. export class SphericalHarmonics {
  113105. /**
  113106. * Defines whether or not the harmonics have been prescaled for rendering.
  113107. */
  113108. preScaled: boolean;
  113109. /**
  113110. * The l0,0 coefficients of the spherical harmonics
  113111. */
  113112. l00: Vector3;
  113113. /**
  113114. * The l1,-1 coefficients of the spherical harmonics
  113115. */
  113116. l1_1: Vector3;
  113117. /**
  113118. * The l1,0 coefficients of the spherical harmonics
  113119. */
  113120. l10: Vector3;
  113121. /**
  113122. * The l1,1 coefficients of the spherical harmonics
  113123. */
  113124. l11: Vector3;
  113125. /**
  113126. * The l2,-2 coefficients of the spherical harmonics
  113127. */
  113128. l2_2: Vector3;
  113129. /**
  113130. * The l2,-1 coefficients of the spherical harmonics
  113131. */
  113132. l2_1: Vector3;
  113133. /**
  113134. * The l2,0 coefficients of the spherical harmonics
  113135. */
  113136. l20: Vector3;
  113137. /**
  113138. * The l2,1 coefficients of the spherical harmonics
  113139. */
  113140. l21: Vector3;
  113141. /**
  113142. * The l2,2 coefficients of the spherical harmonics
  113143. */
  113144. l22: Vector3;
  113145. /**
  113146. * Adds a light to the spherical harmonics
  113147. * @param direction the direction of the light
  113148. * @param color the color of the light
  113149. * @param deltaSolidAngle the delta solid angle of the light
  113150. */
  113151. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  113152. /**
  113153. * Scales the spherical harmonics by the given amount
  113154. * @param scale the amount to scale
  113155. */
  113156. scaleInPlace(scale: number): void;
  113157. /**
  113158. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  113159. *
  113160. * ```
  113161. * E_lm = A_l * L_lm
  113162. * ```
  113163. *
  113164. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  113165. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  113166. * the scaling factors are given in equation 9.
  113167. */
  113168. convertIncidentRadianceToIrradiance(): void;
  113169. /**
  113170. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  113171. *
  113172. * ```
  113173. * L = (1/pi) * E * rho
  113174. * ```
  113175. *
  113176. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  113177. */
  113178. convertIrradianceToLambertianRadiance(): void;
  113179. /**
  113180. * Integrates the reconstruction coefficients directly in to the SH preventing further
  113181. * required operations at run time.
  113182. *
  113183. * This is simply done by scaling back the SH with Ylm constants parameter.
  113184. * The trigonometric part being applied by the shader at run time.
  113185. */
  113186. preScaleForRendering(): void;
  113187. /**
  113188. * Constructs a spherical harmonics from an array.
  113189. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  113190. * @returns the spherical harmonics
  113191. */
  113192. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  113193. /**
  113194. * Gets the spherical harmonics from polynomial
  113195. * @param polynomial the spherical polynomial
  113196. * @returns the spherical harmonics
  113197. */
  113198. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  113199. }
  113200. /**
  113201. * Class representing spherical polynomial coefficients to the 3rd degree
  113202. */
  113203. export class SphericalPolynomial {
  113204. private _harmonics;
  113205. /**
  113206. * The spherical harmonics used to create the polynomials.
  113207. */
  113208. get preScaledHarmonics(): SphericalHarmonics;
  113209. /**
  113210. * The x coefficients of the spherical polynomial
  113211. */
  113212. x: Vector3;
  113213. /**
  113214. * The y coefficients of the spherical polynomial
  113215. */
  113216. y: Vector3;
  113217. /**
  113218. * The z coefficients of the spherical polynomial
  113219. */
  113220. z: Vector3;
  113221. /**
  113222. * The xx coefficients of the spherical polynomial
  113223. */
  113224. xx: Vector3;
  113225. /**
  113226. * The yy coefficients of the spherical polynomial
  113227. */
  113228. yy: Vector3;
  113229. /**
  113230. * The zz coefficients of the spherical polynomial
  113231. */
  113232. zz: Vector3;
  113233. /**
  113234. * The xy coefficients of the spherical polynomial
  113235. */
  113236. xy: Vector3;
  113237. /**
  113238. * The yz coefficients of the spherical polynomial
  113239. */
  113240. yz: Vector3;
  113241. /**
  113242. * The zx coefficients of the spherical polynomial
  113243. */
  113244. zx: Vector3;
  113245. /**
  113246. * Adds an ambient color to the spherical polynomial
  113247. * @param color the color to add
  113248. */
  113249. addAmbient(color: Color3): void;
  113250. /**
  113251. * Scales the spherical polynomial by the given amount
  113252. * @param scale the amount to scale
  113253. */
  113254. scaleInPlace(scale: number): void;
  113255. /**
  113256. * Gets the spherical polynomial from harmonics
  113257. * @param harmonics the spherical harmonics
  113258. * @returns the spherical polynomial
  113259. */
  113260. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  113261. /**
  113262. * Constructs a spherical polynomial from an array.
  113263. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  113264. * @returns the spherical polynomial
  113265. */
  113266. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  113267. }
  113268. }
  113269. declare module BABYLON {
  113270. /**
  113271. * Defines the source of the internal texture
  113272. */
  113273. export enum InternalTextureSource {
  113274. /**
  113275. * The source of the texture data is unknown
  113276. */
  113277. Unknown = 0,
  113278. /**
  113279. * Texture data comes from an URL
  113280. */
  113281. Url = 1,
  113282. /**
  113283. * Texture data is only used for temporary storage
  113284. */
  113285. Temp = 2,
  113286. /**
  113287. * Texture data comes from raw data (ArrayBuffer)
  113288. */
  113289. Raw = 3,
  113290. /**
  113291. * Texture content is dynamic (video or dynamic texture)
  113292. */
  113293. Dynamic = 4,
  113294. /**
  113295. * Texture content is generated by rendering to it
  113296. */
  113297. RenderTarget = 5,
  113298. /**
  113299. * Texture content is part of a multi render target process
  113300. */
  113301. MultiRenderTarget = 6,
  113302. /**
  113303. * Texture data comes from a cube data file
  113304. */
  113305. Cube = 7,
  113306. /**
  113307. * Texture data comes from a raw cube data
  113308. */
  113309. CubeRaw = 8,
  113310. /**
  113311. * Texture data come from a prefiltered cube data file
  113312. */
  113313. CubePrefiltered = 9,
  113314. /**
  113315. * Texture content is raw 3D data
  113316. */
  113317. Raw3D = 10,
  113318. /**
  113319. * Texture content is raw 2D array data
  113320. */
  113321. Raw2DArray = 11,
  113322. /**
  113323. * Texture content is a depth texture
  113324. */
  113325. Depth = 12,
  113326. /**
  113327. * Texture data comes from a raw cube data encoded with RGBD
  113328. */
  113329. CubeRawRGBD = 13
  113330. }
  113331. /**
  113332. * Class used to store data associated with WebGL texture data for the engine
  113333. * This class should not be used directly
  113334. */
  113335. export class InternalTexture {
  113336. /** @hidden */
  113337. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  113338. /**
  113339. * Defines if the texture is ready
  113340. */
  113341. isReady: boolean;
  113342. /**
  113343. * Defines if the texture is a cube texture
  113344. */
  113345. isCube: boolean;
  113346. /**
  113347. * Defines if the texture contains 3D data
  113348. */
  113349. is3D: boolean;
  113350. /**
  113351. * Defines if the texture contains 2D array data
  113352. */
  113353. is2DArray: boolean;
  113354. /**
  113355. * Defines if the texture contains multiview data
  113356. */
  113357. isMultiview: boolean;
  113358. /**
  113359. * Gets the URL used to load this texture
  113360. */
  113361. url: string;
  113362. /**
  113363. * Gets the sampling mode of the texture
  113364. */
  113365. samplingMode: number;
  113366. /**
  113367. * Gets a boolean indicating if the texture needs mipmaps generation
  113368. */
  113369. generateMipMaps: boolean;
  113370. /**
  113371. * Gets the number of samples used by the texture (WebGL2+ only)
  113372. */
  113373. samples: number;
  113374. /**
  113375. * Gets the type of the texture (int, float...)
  113376. */
  113377. type: number;
  113378. /**
  113379. * Gets the format of the texture (RGB, RGBA...)
  113380. */
  113381. format: number;
  113382. /**
  113383. * Observable called when the texture is loaded
  113384. */
  113385. onLoadedObservable: Observable<InternalTexture>;
  113386. /**
  113387. * Gets the width of the texture
  113388. */
  113389. width: number;
  113390. /**
  113391. * Gets the height of the texture
  113392. */
  113393. height: number;
  113394. /**
  113395. * Gets the depth of the texture
  113396. */
  113397. depth: number;
  113398. /**
  113399. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  113400. */
  113401. baseWidth: number;
  113402. /**
  113403. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  113404. */
  113405. baseHeight: number;
  113406. /**
  113407. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  113408. */
  113409. baseDepth: number;
  113410. /**
  113411. * Gets a boolean indicating if the texture is inverted on Y axis
  113412. */
  113413. invertY: boolean;
  113414. /** @hidden */
  113415. _invertVScale: boolean;
  113416. /** @hidden */
  113417. _associatedChannel: number;
  113418. /** @hidden */
  113419. _source: InternalTextureSource;
  113420. /** @hidden */
  113421. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  113422. /** @hidden */
  113423. _bufferView: Nullable<ArrayBufferView>;
  113424. /** @hidden */
  113425. _bufferViewArray: Nullable<ArrayBufferView[]>;
  113426. /** @hidden */
  113427. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  113428. /** @hidden */
  113429. _size: number;
  113430. /** @hidden */
  113431. _extension: string;
  113432. /** @hidden */
  113433. _files: Nullable<string[]>;
  113434. /** @hidden */
  113435. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  113436. /** @hidden */
  113437. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  113438. /** @hidden */
  113439. _framebuffer: Nullable<WebGLFramebuffer>;
  113440. /** @hidden */
  113441. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  113442. /** @hidden */
  113443. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  113444. /** @hidden */
  113445. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  113446. /** @hidden */
  113447. _attachments: Nullable<number[]>;
  113448. /** @hidden */
  113449. _cachedCoordinatesMode: Nullable<number>;
  113450. /** @hidden */
  113451. _cachedWrapU: Nullable<number>;
  113452. /** @hidden */
  113453. _cachedWrapV: Nullable<number>;
  113454. /** @hidden */
  113455. _cachedWrapR: Nullable<number>;
  113456. /** @hidden */
  113457. _cachedAnisotropicFilteringLevel: Nullable<number>;
  113458. /** @hidden */
  113459. _isDisabled: boolean;
  113460. /** @hidden */
  113461. _compression: Nullable<string>;
  113462. /** @hidden */
  113463. _generateStencilBuffer: boolean;
  113464. /** @hidden */
  113465. _generateDepthBuffer: boolean;
  113466. /** @hidden */
  113467. _comparisonFunction: number;
  113468. /** @hidden */
  113469. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  113470. /** @hidden */
  113471. _lodGenerationScale: number;
  113472. /** @hidden */
  113473. _lodGenerationOffset: number;
  113474. /** @hidden */
  113475. _depthStencilTexture: Nullable<InternalTexture>;
  113476. /** @hidden */
  113477. _colorTextureArray: Nullable<WebGLTexture>;
  113478. /** @hidden */
  113479. _depthStencilTextureArray: Nullable<WebGLTexture>;
  113480. /** @hidden */
  113481. _lodTextureHigh: Nullable<BaseTexture>;
  113482. /** @hidden */
  113483. _lodTextureMid: Nullable<BaseTexture>;
  113484. /** @hidden */
  113485. _lodTextureLow: Nullable<BaseTexture>;
  113486. /** @hidden */
  113487. _isRGBD: boolean;
  113488. /** @hidden */
  113489. _linearSpecularLOD: boolean;
  113490. /** @hidden */
  113491. _irradianceTexture: Nullable<BaseTexture>;
  113492. /** @hidden */
  113493. _webGLTexture: Nullable<WebGLTexture>;
  113494. /** @hidden */
  113495. _references: number;
  113496. private _engine;
  113497. /**
  113498. * Gets the Engine the texture belongs to.
  113499. * @returns The babylon engine
  113500. */
  113501. getEngine(): ThinEngine;
  113502. /**
  113503. * Gets the data source type of the texture
  113504. */
  113505. get source(): InternalTextureSource;
  113506. /**
  113507. * Creates a new InternalTexture
  113508. * @param engine defines the engine to use
  113509. * @param source defines the type of data that will be used
  113510. * @param delayAllocation if the texture allocation should be delayed (default: false)
  113511. */
  113512. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  113513. /**
  113514. * Increments the number of references (ie. the number of Texture that point to it)
  113515. */
  113516. incrementReferences(): void;
  113517. /**
  113518. * Change the size of the texture (not the size of the content)
  113519. * @param width defines the new width
  113520. * @param height defines the new height
  113521. * @param depth defines the new depth (1 by default)
  113522. */
  113523. updateSize(width: int, height: int, depth?: int): void;
  113524. /** @hidden */
  113525. _rebuild(): void;
  113526. /** @hidden */
  113527. _swapAndDie(target: InternalTexture): void;
  113528. /**
  113529. * Dispose the current allocated resources
  113530. */
  113531. dispose(): void;
  113532. }
  113533. }
  113534. declare module BABYLON {
  113535. /**
  113536. * Class used to work with sound analyzer using fast fourier transform (FFT)
  113537. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  113538. */
  113539. export class Analyser {
  113540. /**
  113541. * Gets or sets the smoothing
  113542. * @ignorenaming
  113543. */
  113544. SMOOTHING: number;
  113545. /**
  113546. * Gets or sets the FFT table size
  113547. * @ignorenaming
  113548. */
  113549. FFT_SIZE: number;
  113550. /**
  113551. * Gets or sets the bar graph amplitude
  113552. * @ignorenaming
  113553. */
  113554. BARGRAPHAMPLITUDE: number;
  113555. /**
  113556. * Gets or sets the position of the debug canvas
  113557. * @ignorenaming
  113558. */
  113559. DEBUGCANVASPOS: {
  113560. x: number;
  113561. y: number;
  113562. };
  113563. /**
  113564. * Gets or sets the debug canvas size
  113565. * @ignorenaming
  113566. */
  113567. DEBUGCANVASSIZE: {
  113568. width: number;
  113569. height: number;
  113570. };
  113571. private _byteFreqs;
  113572. private _byteTime;
  113573. private _floatFreqs;
  113574. private _webAudioAnalyser;
  113575. private _debugCanvas;
  113576. private _debugCanvasContext;
  113577. private _scene;
  113578. private _registerFunc;
  113579. private _audioEngine;
  113580. /**
  113581. * Creates a new analyser
  113582. * @param scene defines hosting scene
  113583. */
  113584. constructor(scene: Scene);
  113585. /**
  113586. * Get the number of data values you will have to play with for the visualization
  113587. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  113588. * @returns a number
  113589. */
  113590. getFrequencyBinCount(): number;
  113591. /**
  113592. * Gets the current frequency data as a byte array
  113593. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  113594. * @returns a Uint8Array
  113595. */
  113596. getByteFrequencyData(): Uint8Array;
  113597. /**
  113598. * Gets the current waveform as a byte array
  113599. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  113600. * @returns a Uint8Array
  113601. */
  113602. getByteTimeDomainData(): Uint8Array;
  113603. /**
  113604. * Gets the current frequency data as a float array
  113605. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  113606. * @returns a Float32Array
  113607. */
  113608. getFloatFrequencyData(): Float32Array;
  113609. /**
  113610. * Renders the debug canvas
  113611. */
  113612. drawDebugCanvas(): void;
  113613. /**
  113614. * Stops rendering the debug canvas and removes it
  113615. */
  113616. stopDebugCanvas(): void;
  113617. /**
  113618. * Connects two audio nodes
  113619. * @param inputAudioNode defines first node to connect
  113620. * @param outputAudioNode defines second node to connect
  113621. */
  113622. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  113623. /**
  113624. * Releases all associated resources
  113625. */
  113626. dispose(): void;
  113627. }
  113628. }
  113629. declare module BABYLON {
  113630. /**
  113631. * This represents an audio engine and it is responsible
  113632. * to play, synchronize and analyse sounds throughout the application.
  113633. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  113634. */
  113635. export interface IAudioEngine extends IDisposable {
  113636. /**
  113637. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  113638. */
  113639. readonly canUseWebAudio: boolean;
  113640. /**
  113641. * Gets the current AudioContext if available.
  113642. */
  113643. readonly audioContext: Nullable<AudioContext>;
  113644. /**
  113645. * The master gain node defines the global audio volume of your audio engine.
  113646. */
  113647. readonly masterGain: GainNode;
  113648. /**
  113649. * Gets whether or not mp3 are supported by your browser.
  113650. */
  113651. readonly isMP3supported: boolean;
  113652. /**
  113653. * Gets whether or not ogg are supported by your browser.
  113654. */
  113655. readonly isOGGsupported: boolean;
  113656. /**
  113657. * Defines if Babylon should emit a warning if WebAudio is not supported.
  113658. * @ignoreNaming
  113659. */
  113660. WarnedWebAudioUnsupported: boolean;
  113661. /**
  113662. * Defines if the audio engine relies on a custom unlocked button.
  113663. * In this case, the embedded button will not be displayed.
  113664. */
  113665. useCustomUnlockedButton: boolean;
  113666. /**
  113667. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  113668. */
  113669. readonly unlocked: boolean;
  113670. /**
  113671. * Event raised when audio has been unlocked on the browser.
  113672. */
  113673. onAudioUnlockedObservable: Observable<AudioEngine>;
  113674. /**
  113675. * Event raised when audio has been locked on the browser.
  113676. */
  113677. onAudioLockedObservable: Observable<AudioEngine>;
  113678. /**
  113679. * Flags the audio engine in Locked state.
  113680. * This happens due to new browser policies preventing audio to autoplay.
  113681. */
  113682. lock(): void;
  113683. /**
  113684. * Unlocks the audio engine once a user action has been done on the dom.
  113685. * This is helpful to resume play once browser policies have been satisfied.
  113686. */
  113687. unlock(): void;
  113688. /**
  113689. * Gets the global volume sets on the master gain.
  113690. * @returns the global volume if set or -1 otherwise
  113691. */
  113692. getGlobalVolume(): number;
  113693. /**
  113694. * Sets the global volume of your experience (sets on the master gain).
  113695. * @param newVolume Defines the new global volume of the application
  113696. */
  113697. setGlobalVolume(newVolume: number): void;
  113698. /**
  113699. * Connect the audio engine to an audio analyser allowing some amazing
  113700. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  113701. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  113702. * @param analyser The analyser to connect to the engine
  113703. */
  113704. connectToAnalyser(analyser: Analyser): void;
  113705. }
  113706. /**
  113707. * This represents the default audio engine used in babylon.
  113708. * It is responsible to play, synchronize and analyse sounds throughout the application.
  113709. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  113710. */
  113711. export class AudioEngine implements IAudioEngine {
  113712. private _audioContext;
  113713. private _audioContextInitialized;
  113714. private _muteButton;
  113715. private _hostElement;
  113716. /**
  113717. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  113718. */
  113719. canUseWebAudio: boolean;
  113720. /**
  113721. * The master gain node defines the global audio volume of your audio engine.
  113722. */
  113723. masterGain: GainNode;
  113724. /**
  113725. * Defines if Babylon should emit a warning if WebAudio is not supported.
  113726. * @ignoreNaming
  113727. */
  113728. WarnedWebAudioUnsupported: boolean;
  113729. /**
  113730. * Gets whether or not mp3 are supported by your browser.
  113731. */
  113732. isMP3supported: boolean;
  113733. /**
  113734. * Gets whether or not ogg are supported by your browser.
  113735. */
  113736. isOGGsupported: boolean;
  113737. /**
  113738. * Gets whether audio has been unlocked on the device.
  113739. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  113740. * a user interaction has happened.
  113741. */
  113742. unlocked: boolean;
  113743. /**
  113744. * Defines if the audio engine relies on a custom unlocked button.
  113745. * In this case, the embedded button will not be displayed.
  113746. */
  113747. useCustomUnlockedButton: boolean;
  113748. /**
  113749. * Event raised when audio has been unlocked on the browser.
  113750. */
  113751. onAudioUnlockedObservable: Observable<AudioEngine>;
  113752. /**
  113753. * Event raised when audio has been locked on the browser.
  113754. */
  113755. onAudioLockedObservable: Observable<AudioEngine>;
  113756. /**
  113757. * Gets the current AudioContext if available.
  113758. */
  113759. get audioContext(): Nullable<AudioContext>;
  113760. private _connectedAnalyser;
  113761. /**
  113762. * Instantiates a new audio engine.
  113763. *
  113764. * There should be only one per page as some browsers restrict the number
  113765. * of audio contexts you can create.
  113766. * @param hostElement defines the host element where to display the mute icon if necessary
  113767. */
  113768. constructor(hostElement?: Nullable<HTMLElement>);
  113769. /**
  113770. * Flags the audio engine in Locked state.
  113771. * This happens due to new browser policies preventing audio to autoplay.
  113772. */
  113773. lock(): void;
  113774. /**
  113775. * Unlocks the audio engine once a user action has been done on the dom.
  113776. * This is helpful to resume play once browser policies have been satisfied.
  113777. */
  113778. unlock(): void;
  113779. private _resumeAudioContext;
  113780. private _initializeAudioContext;
  113781. private _tryToRun;
  113782. private _triggerRunningState;
  113783. private _triggerSuspendedState;
  113784. private _displayMuteButton;
  113785. private _moveButtonToTopLeft;
  113786. private _onResize;
  113787. private _hideMuteButton;
  113788. /**
  113789. * Destroy and release the resources associated with the audio ccontext.
  113790. */
  113791. dispose(): void;
  113792. /**
  113793. * Gets the global volume sets on the master gain.
  113794. * @returns the global volume if set or -1 otherwise
  113795. */
  113796. getGlobalVolume(): number;
  113797. /**
  113798. * Sets the global volume of your experience (sets on the master gain).
  113799. * @param newVolume Defines the new global volume of the application
  113800. */
  113801. setGlobalVolume(newVolume: number): void;
  113802. /**
  113803. * Connect the audio engine to an audio analyser allowing some amazing
  113804. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  113805. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  113806. * @param analyser The analyser to connect to the engine
  113807. */
  113808. connectToAnalyser(analyser: Analyser): void;
  113809. }
  113810. }
  113811. declare module BABYLON {
  113812. /**
  113813. * Interface used to present a loading screen while loading a scene
  113814. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  113815. */
  113816. export interface ILoadingScreen {
  113817. /**
  113818. * Function called to display the loading screen
  113819. */
  113820. displayLoadingUI: () => void;
  113821. /**
  113822. * Function called to hide the loading screen
  113823. */
  113824. hideLoadingUI: () => void;
  113825. /**
  113826. * Gets or sets the color to use for the background
  113827. */
  113828. loadingUIBackgroundColor: string;
  113829. /**
  113830. * Gets or sets the text to display while loading
  113831. */
  113832. loadingUIText: string;
  113833. }
  113834. /**
  113835. * Class used for the default loading screen
  113836. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  113837. */
  113838. export class DefaultLoadingScreen implements ILoadingScreen {
  113839. private _renderingCanvas;
  113840. private _loadingText;
  113841. private _loadingDivBackgroundColor;
  113842. private _loadingDiv;
  113843. private _loadingTextDiv;
  113844. /** Gets or sets the logo url to use for the default loading screen */
  113845. static DefaultLogoUrl: string;
  113846. /** Gets or sets the spinner url to use for the default loading screen */
  113847. static DefaultSpinnerUrl: string;
  113848. /**
  113849. * Creates a new default loading screen
  113850. * @param _renderingCanvas defines the canvas used to render the scene
  113851. * @param _loadingText defines the default text to display
  113852. * @param _loadingDivBackgroundColor defines the default background color
  113853. */
  113854. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  113855. /**
  113856. * Function called to display the loading screen
  113857. */
  113858. displayLoadingUI(): void;
  113859. /**
  113860. * Function called to hide the loading screen
  113861. */
  113862. hideLoadingUI(): void;
  113863. /**
  113864. * Gets or sets the text to display while loading
  113865. */
  113866. set loadingUIText(text: string);
  113867. get loadingUIText(): string;
  113868. /**
  113869. * Gets or sets the color to use for the background
  113870. */
  113871. get loadingUIBackgroundColor(): string;
  113872. set loadingUIBackgroundColor(color: string);
  113873. private _resizeLoadingUI;
  113874. }
  113875. }
  113876. declare module BABYLON {
  113877. /**
  113878. * Interface for any object that can request an animation frame
  113879. */
  113880. export interface ICustomAnimationFrameRequester {
  113881. /**
  113882. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  113883. */
  113884. renderFunction?: Function;
  113885. /**
  113886. * Called to request the next frame to render to
  113887. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  113888. */
  113889. requestAnimationFrame: Function;
  113890. /**
  113891. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  113892. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  113893. */
  113894. requestID?: number;
  113895. }
  113896. }
  113897. declare module BABYLON {
  113898. /**
  113899. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  113900. */
  113901. export class PerformanceMonitor {
  113902. private _enabled;
  113903. private _rollingFrameTime;
  113904. private _lastFrameTimeMs;
  113905. /**
  113906. * constructor
  113907. * @param frameSampleSize The number of samples required to saturate the sliding window
  113908. */
  113909. constructor(frameSampleSize?: number);
  113910. /**
  113911. * Samples current frame
  113912. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  113913. */
  113914. sampleFrame(timeMs?: number): void;
  113915. /**
  113916. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  113917. */
  113918. get averageFrameTime(): number;
  113919. /**
  113920. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  113921. */
  113922. get averageFrameTimeVariance(): number;
  113923. /**
  113924. * Returns the frame time of the most recent frame
  113925. */
  113926. get instantaneousFrameTime(): number;
  113927. /**
  113928. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  113929. */
  113930. get averageFPS(): number;
  113931. /**
  113932. * Returns the average framerate in frames per second using the most recent frame time
  113933. */
  113934. get instantaneousFPS(): number;
  113935. /**
  113936. * Returns true if enough samples have been taken to completely fill the sliding window
  113937. */
  113938. get isSaturated(): boolean;
  113939. /**
  113940. * Enables contributions to the sliding window sample set
  113941. */
  113942. enable(): void;
  113943. /**
  113944. * Disables contributions to the sliding window sample set
  113945. * Samples will not be interpolated over the disabled period
  113946. */
  113947. disable(): void;
  113948. /**
  113949. * Returns true if sampling is enabled
  113950. */
  113951. get isEnabled(): boolean;
  113952. /**
  113953. * Resets performance monitor
  113954. */
  113955. reset(): void;
  113956. }
  113957. /**
  113958. * RollingAverage
  113959. *
  113960. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  113961. */
  113962. export class RollingAverage {
  113963. /**
  113964. * Current average
  113965. */
  113966. average: number;
  113967. /**
  113968. * Current variance
  113969. */
  113970. variance: number;
  113971. protected _samples: Array<number>;
  113972. protected _sampleCount: number;
  113973. protected _pos: number;
  113974. protected _m2: number;
  113975. /**
  113976. * constructor
  113977. * @param length The number of samples required to saturate the sliding window
  113978. */
  113979. constructor(length: number);
  113980. /**
  113981. * Adds a sample to the sample set
  113982. * @param v The sample value
  113983. */
  113984. add(v: number): void;
  113985. /**
  113986. * Returns previously added values or null if outside of history or outside the sliding window domain
  113987. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  113988. * @return Value previously recorded with add() or null if outside of range
  113989. */
  113990. history(i: number): number;
  113991. /**
  113992. * Returns true if enough samples have been taken to completely fill the sliding window
  113993. * @return true if sample-set saturated
  113994. */
  113995. isSaturated(): boolean;
  113996. /**
  113997. * Resets the rolling average (equivalent to 0 samples taken so far)
  113998. */
  113999. reset(): void;
  114000. /**
  114001. * Wraps a value around the sample range boundaries
  114002. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  114003. * @return Wrapped position in sample range
  114004. */
  114005. protected _wrapPosition(i: number): number;
  114006. }
  114007. }
  114008. declare module BABYLON {
  114009. /**
  114010. * This class is used to track a performance counter which is number based.
  114011. * The user has access to many properties which give statistics of different nature.
  114012. *
  114013. * The implementer can track two kinds of Performance Counter: time and count.
  114014. * 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.
  114015. * 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.
  114016. */
  114017. export class PerfCounter {
  114018. /**
  114019. * Gets or sets a global boolean to turn on and off all the counters
  114020. */
  114021. static Enabled: boolean;
  114022. /**
  114023. * Returns the smallest value ever
  114024. */
  114025. get min(): number;
  114026. /**
  114027. * Returns the biggest value ever
  114028. */
  114029. get max(): number;
  114030. /**
  114031. * Returns the average value since the performance counter is running
  114032. */
  114033. get average(): number;
  114034. /**
  114035. * Returns the average value of the last second the counter was monitored
  114036. */
  114037. get lastSecAverage(): number;
  114038. /**
  114039. * Returns the current value
  114040. */
  114041. get current(): number;
  114042. /**
  114043. * Gets the accumulated total
  114044. */
  114045. get total(): number;
  114046. /**
  114047. * Gets the total value count
  114048. */
  114049. get count(): number;
  114050. /**
  114051. * Creates a new counter
  114052. */
  114053. constructor();
  114054. /**
  114055. * Call this method to start monitoring a new frame.
  114056. * 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.
  114057. */
  114058. fetchNewFrame(): void;
  114059. /**
  114060. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  114061. * @param newCount the count value to add to the monitored count
  114062. * @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.
  114063. */
  114064. addCount(newCount: number, fetchResult: boolean): void;
  114065. /**
  114066. * Start monitoring this performance counter
  114067. */
  114068. beginMonitoring(): void;
  114069. /**
  114070. * Compute the time lapsed since the previous beginMonitoring() call.
  114071. * @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
  114072. */
  114073. endMonitoring(newFrame?: boolean): void;
  114074. private _fetchResult;
  114075. private _startMonitoringTime;
  114076. private _min;
  114077. private _max;
  114078. private _average;
  114079. private _current;
  114080. private _totalValueCount;
  114081. private _totalAccumulated;
  114082. private _lastSecAverage;
  114083. private _lastSecAccumulated;
  114084. private _lastSecTime;
  114085. private _lastSecValueCount;
  114086. }
  114087. }
  114088. declare module BABYLON {
  114089. interface ThinEngine {
  114090. /**
  114091. * Sets alpha constants used by some alpha blending modes
  114092. * @param r defines the red component
  114093. * @param g defines the green component
  114094. * @param b defines the blue component
  114095. * @param a defines the alpha component
  114096. */
  114097. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  114098. /**
  114099. * Sets the current alpha mode
  114100. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  114101. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  114102. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  114103. */
  114104. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  114105. /**
  114106. * Gets the current alpha mode
  114107. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  114108. * @returns the current alpha mode
  114109. */
  114110. getAlphaMode(): number;
  114111. /**
  114112. * Sets the current alpha equation
  114113. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  114114. */
  114115. setAlphaEquation(equation: number): void;
  114116. /**
  114117. * Gets the current alpha equation.
  114118. * @returns the current alpha equation
  114119. */
  114120. getAlphaEquation(): number;
  114121. }
  114122. }
  114123. declare module BABYLON {
  114124. interface ThinEngine {
  114125. /** @hidden */
  114126. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  114127. }
  114128. }
  114129. declare module BABYLON {
  114130. /**
  114131. * Defines the interface used by display changed events
  114132. */
  114133. export interface IDisplayChangedEventArgs {
  114134. /** Gets the vrDisplay object (if any) */
  114135. vrDisplay: Nullable<any>;
  114136. /** Gets a boolean indicating if webVR is supported */
  114137. vrSupported: boolean;
  114138. }
  114139. /**
  114140. * Defines the interface used by objects containing a viewport (like a camera)
  114141. */
  114142. interface IViewportOwnerLike {
  114143. /**
  114144. * Gets or sets the viewport
  114145. */
  114146. viewport: IViewportLike;
  114147. }
  114148. /**
  114149. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  114150. */
  114151. export class Engine extends ThinEngine {
  114152. /** Defines that alpha blending is disabled */
  114153. static readonly ALPHA_DISABLE: number;
  114154. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  114155. static readonly ALPHA_ADD: number;
  114156. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  114157. static readonly ALPHA_COMBINE: number;
  114158. /** Defines that alpha blending to DEST - SRC * DEST */
  114159. static readonly ALPHA_SUBTRACT: number;
  114160. /** Defines that alpha blending to SRC * DEST */
  114161. static readonly ALPHA_MULTIPLY: number;
  114162. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  114163. static readonly ALPHA_MAXIMIZED: number;
  114164. /** Defines that alpha blending to SRC + DEST */
  114165. static readonly ALPHA_ONEONE: number;
  114166. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  114167. static readonly ALPHA_PREMULTIPLIED: number;
  114168. /**
  114169. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  114170. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  114171. */
  114172. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  114173. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  114174. static readonly ALPHA_INTERPOLATE: number;
  114175. /**
  114176. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  114177. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  114178. */
  114179. static readonly ALPHA_SCREENMODE: number;
  114180. /** Defines that the ressource is not delayed*/
  114181. static readonly DELAYLOADSTATE_NONE: number;
  114182. /** Defines that the ressource was successfully delay loaded */
  114183. static readonly DELAYLOADSTATE_LOADED: number;
  114184. /** Defines that the ressource is currently delay loading */
  114185. static readonly DELAYLOADSTATE_LOADING: number;
  114186. /** Defines that the ressource is delayed and has not started loading */
  114187. static readonly DELAYLOADSTATE_NOTLOADED: number;
  114188. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  114189. static readonly NEVER: number;
  114190. /** 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 */
  114191. static readonly ALWAYS: number;
  114192. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  114193. static readonly LESS: number;
  114194. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  114195. static readonly EQUAL: number;
  114196. /** 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 */
  114197. static readonly LEQUAL: number;
  114198. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  114199. static readonly GREATER: number;
  114200. /** 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 */
  114201. static readonly GEQUAL: number;
  114202. /** 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 */
  114203. static readonly NOTEQUAL: number;
  114204. /** Passed to stencilOperation to specify that stencil value must be kept */
  114205. static readonly KEEP: number;
  114206. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114207. static readonly REPLACE: number;
  114208. /** Passed to stencilOperation to specify that stencil value must be incremented */
  114209. static readonly INCR: number;
  114210. /** Passed to stencilOperation to specify that stencil value must be decremented */
  114211. static readonly DECR: number;
  114212. /** Passed to stencilOperation to specify that stencil value must be inverted */
  114213. static readonly INVERT: number;
  114214. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  114215. static readonly INCR_WRAP: number;
  114216. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  114217. static readonly DECR_WRAP: number;
  114218. /** Texture is not repeating outside of 0..1 UVs */
  114219. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  114220. /** Texture is repeating outside of 0..1 UVs */
  114221. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  114222. /** Texture is repeating and mirrored */
  114223. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  114224. /** ALPHA */
  114225. static readonly TEXTUREFORMAT_ALPHA: number;
  114226. /** LUMINANCE */
  114227. static readonly TEXTUREFORMAT_LUMINANCE: number;
  114228. /** LUMINANCE_ALPHA */
  114229. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  114230. /** RGB */
  114231. static readonly TEXTUREFORMAT_RGB: number;
  114232. /** RGBA */
  114233. static readonly TEXTUREFORMAT_RGBA: number;
  114234. /** RED */
  114235. static readonly TEXTUREFORMAT_RED: number;
  114236. /** RED (2nd reference) */
  114237. static readonly TEXTUREFORMAT_R: number;
  114238. /** RG */
  114239. static readonly TEXTUREFORMAT_RG: number;
  114240. /** RED_INTEGER */
  114241. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  114242. /** RED_INTEGER (2nd reference) */
  114243. static readonly TEXTUREFORMAT_R_INTEGER: number;
  114244. /** RG_INTEGER */
  114245. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  114246. /** RGB_INTEGER */
  114247. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  114248. /** RGBA_INTEGER */
  114249. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  114250. /** UNSIGNED_BYTE */
  114251. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  114252. /** UNSIGNED_BYTE (2nd reference) */
  114253. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  114254. /** FLOAT */
  114255. static readonly TEXTURETYPE_FLOAT: number;
  114256. /** HALF_FLOAT */
  114257. static readonly TEXTURETYPE_HALF_FLOAT: number;
  114258. /** BYTE */
  114259. static readonly TEXTURETYPE_BYTE: number;
  114260. /** SHORT */
  114261. static readonly TEXTURETYPE_SHORT: number;
  114262. /** UNSIGNED_SHORT */
  114263. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  114264. /** INT */
  114265. static readonly TEXTURETYPE_INT: number;
  114266. /** UNSIGNED_INT */
  114267. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  114268. /** UNSIGNED_SHORT_4_4_4_4 */
  114269. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  114270. /** UNSIGNED_SHORT_5_5_5_1 */
  114271. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  114272. /** UNSIGNED_SHORT_5_6_5 */
  114273. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  114274. /** UNSIGNED_INT_2_10_10_10_REV */
  114275. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  114276. /** UNSIGNED_INT_24_8 */
  114277. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  114278. /** UNSIGNED_INT_10F_11F_11F_REV */
  114279. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  114280. /** UNSIGNED_INT_5_9_9_9_REV */
  114281. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  114282. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  114283. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  114284. /** nearest is mag = nearest and min = nearest and mip = linear */
  114285. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  114286. /** Bilinear is mag = linear and min = linear and mip = nearest */
  114287. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  114288. /** Trilinear is mag = linear and min = linear and mip = linear */
  114289. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  114290. /** nearest is mag = nearest and min = nearest and mip = linear */
  114291. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  114292. /** Bilinear is mag = linear and min = linear and mip = nearest */
  114293. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  114294. /** Trilinear is mag = linear and min = linear and mip = linear */
  114295. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  114296. /** mag = nearest and min = nearest and mip = nearest */
  114297. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  114298. /** mag = nearest and min = linear and mip = nearest */
  114299. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  114300. /** mag = nearest and min = linear and mip = linear */
  114301. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  114302. /** mag = nearest and min = linear and mip = none */
  114303. static readonly TEXTURE_NEAREST_LINEAR: number;
  114304. /** mag = nearest and min = nearest and mip = none */
  114305. static readonly TEXTURE_NEAREST_NEAREST: number;
  114306. /** mag = linear and min = nearest and mip = nearest */
  114307. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  114308. /** mag = linear and min = nearest and mip = linear */
  114309. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  114310. /** mag = linear and min = linear and mip = none */
  114311. static readonly TEXTURE_LINEAR_LINEAR: number;
  114312. /** mag = linear and min = nearest and mip = none */
  114313. static readonly TEXTURE_LINEAR_NEAREST: number;
  114314. /** Explicit coordinates mode */
  114315. static readonly TEXTURE_EXPLICIT_MODE: number;
  114316. /** Spherical coordinates mode */
  114317. static readonly TEXTURE_SPHERICAL_MODE: number;
  114318. /** Planar coordinates mode */
  114319. static readonly TEXTURE_PLANAR_MODE: number;
  114320. /** Cubic coordinates mode */
  114321. static readonly TEXTURE_CUBIC_MODE: number;
  114322. /** Projection coordinates mode */
  114323. static readonly TEXTURE_PROJECTION_MODE: number;
  114324. /** Skybox coordinates mode */
  114325. static readonly TEXTURE_SKYBOX_MODE: number;
  114326. /** Inverse Cubic coordinates mode */
  114327. static readonly TEXTURE_INVCUBIC_MODE: number;
  114328. /** Equirectangular coordinates mode */
  114329. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  114330. /** Equirectangular Fixed coordinates mode */
  114331. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  114332. /** Equirectangular Fixed Mirrored coordinates mode */
  114333. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  114334. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  114335. static readonly SCALEMODE_FLOOR: number;
  114336. /** Defines that texture rescaling will look for the nearest power of 2 size */
  114337. static readonly SCALEMODE_NEAREST: number;
  114338. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  114339. static readonly SCALEMODE_CEILING: number;
  114340. /**
  114341. * Returns the current npm package of the sdk
  114342. */
  114343. static get NpmPackage(): string;
  114344. /**
  114345. * Returns the current version of the framework
  114346. */
  114347. static get Version(): string;
  114348. /** Gets the list of created engines */
  114349. static get Instances(): Engine[];
  114350. /**
  114351. * Gets the latest created engine
  114352. */
  114353. static get LastCreatedEngine(): Nullable<Engine>;
  114354. /**
  114355. * Gets the latest created scene
  114356. */
  114357. static get LastCreatedScene(): Nullable<Scene>;
  114358. /**
  114359. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  114360. * @param flag defines which part of the materials must be marked as dirty
  114361. * @param predicate defines a predicate used to filter which materials should be affected
  114362. */
  114363. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  114364. /**
  114365. * Method called to create the default loading screen.
  114366. * This can be overriden in your own app.
  114367. * @param canvas The rendering canvas element
  114368. * @returns The loading screen
  114369. */
  114370. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  114371. /**
  114372. * Method called to create the default rescale post process on each engine.
  114373. */
  114374. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  114375. /**
  114376. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  114377. **/
  114378. enableOfflineSupport: boolean;
  114379. /**
  114380. * 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)
  114381. **/
  114382. disableManifestCheck: boolean;
  114383. /**
  114384. * Gets the list of created scenes
  114385. */
  114386. scenes: Scene[];
  114387. /**
  114388. * Event raised when a new scene is created
  114389. */
  114390. onNewSceneAddedObservable: Observable<Scene>;
  114391. /**
  114392. * Gets the list of created postprocesses
  114393. */
  114394. postProcesses: PostProcess[];
  114395. /**
  114396. * Gets a boolean indicating if the pointer is currently locked
  114397. */
  114398. isPointerLock: boolean;
  114399. /**
  114400. * Observable event triggered each time the rendering canvas is resized
  114401. */
  114402. onResizeObservable: Observable<Engine>;
  114403. /**
  114404. * Observable event triggered each time the canvas loses focus
  114405. */
  114406. onCanvasBlurObservable: Observable<Engine>;
  114407. /**
  114408. * Observable event triggered each time the canvas gains focus
  114409. */
  114410. onCanvasFocusObservable: Observable<Engine>;
  114411. /**
  114412. * Observable event triggered each time the canvas receives pointerout event
  114413. */
  114414. onCanvasPointerOutObservable: Observable<PointerEvent>;
  114415. /**
  114416. * Observable raised when the engine begins a new frame
  114417. */
  114418. onBeginFrameObservable: Observable<Engine>;
  114419. /**
  114420. * If set, will be used to request the next animation frame for the render loop
  114421. */
  114422. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  114423. /**
  114424. * Observable raised when the engine ends the current frame
  114425. */
  114426. onEndFrameObservable: Observable<Engine>;
  114427. /**
  114428. * Observable raised when the engine is about to compile a shader
  114429. */
  114430. onBeforeShaderCompilationObservable: Observable<Engine>;
  114431. /**
  114432. * Observable raised when the engine has jsut compiled a shader
  114433. */
  114434. onAfterShaderCompilationObservable: Observable<Engine>;
  114435. /**
  114436. * Gets the audio engine
  114437. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  114438. * @ignorenaming
  114439. */
  114440. static audioEngine: IAudioEngine;
  114441. /**
  114442. * Default AudioEngine factory responsible of creating the Audio Engine.
  114443. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  114444. */
  114445. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  114446. /**
  114447. * Default offline support factory responsible of creating a tool used to store data locally.
  114448. * By default, this will create a Database object if the workload has been embedded.
  114449. */
  114450. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  114451. private _loadingScreen;
  114452. private _pointerLockRequested;
  114453. private _rescalePostProcess;
  114454. private _deterministicLockstep;
  114455. private _lockstepMaxSteps;
  114456. private _timeStep;
  114457. protected get _supportsHardwareTextureRescaling(): boolean;
  114458. private _fps;
  114459. private _deltaTime;
  114460. /** @hidden */
  114461. _drawCalls: PerfCounter;
  114462. /** Gets or sets the tab index to set to the rendering canvas. 1 is the minimum value to set to be able to capture keyboard events */
  114463. canvasTabIndex: number;
  114464. /**
  114465. * Turn this value on if you want to pause FPS computation when in background
  114466. */
  114467. disablePerformanceMonitorInBackground: boolean;
  114468. private _performanceMonitor;
  114469. /**
  114470. * Gets the performance monitor attached to this engine
  114471. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  114472. */
  114473. get performanceMonitor(): PerformanceMonitor;
  114474. private _onFocus;
  114475. private _onBlur;
  114476. private _onCanvasPointerOut;
  114477. private _onCanvasBlur;
  114478. private _onCanvasFocus;
  114479. private _onFullscreenChange;
  114480. private _onPointerLockChange;
  114481. /**
  114482. * Gets the HTML element used to attach event listeners
  114483. * @returns a HTML element
  114484. */
  114485. getInputElement(): Nullable<HTMLElement>;
  114486. /**
  114487. * Creates a new engine
  114488. * @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
  114489. * @param antialias defines enable antialiasing (default: false)
  114490. * @param options defines further options to be sent to the getContext() function
  114491. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  114492. */
  114493. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  114494. /**
  114495. * Gets current aspect ratio
  114496. * @param viewportOwner defines the camera to use to get the aspect ratio
  114497. * @param useScreen defines if screen size must be used (or the current render target if any)
  114498. * @returns a number defining the aspect ratio
  114499. */
  114500. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  114501. /**
  114502. * Gets current screen aspect ratio
  114503. * @returns a number defining the aspect ratio
  114504. */
  114505. getScreenAspectRatio(): number;
  114506. /**
  114507. * Gets the client rect of the HTML canvas attached with the current webGL context
  114508. * @returns a client rectanglee
  114509. */
  114510. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  114511. /**
  114512. * Gets the client rect of the HTML element used for events
  114513. * @returns a client rectanglee
  114514. */
  114515. getInputElementClientRect(): Nullable<ClientRect>;
  114516. /**
  114517. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  114518. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114519. * @returns true if engine is in deterministic lock step mode
  114520. */
  114521. isDeterministicLockStep(): boolean;
  114522. /**
  114523. * Gets the max steps when engine is running in deterministic lock step
  114524. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114525. * @returns the max steps
  114526. */
  114527. getLockstepMaxSteps(): number;
  114528. /**
  114529. * Returns the time in ms between steps when using deterministic lock step.
  114530. * @returns time step in (ms)
  114531. */
  114532. getTimeStep(): number;
  114533. /**
  114534. * Force the mipmap generation for the given render target texture
  114535. * @param texture defines the render target texture to use
  114536. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  114537. */
  114538. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  114539. /** States */
  114540. /**
  114541. * Set various states to the webGL context
  114542. * @param culling defines backface culling state
  114543. * @param zOffset defines the value to apply to zOffset (0 by default)
  114544. * @param force defines if states must be applied even if cache is up to date
  114545. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  114546. */
  114547. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  114548. /**
  114549. * Set the z offset to apply to current rendering
  114550. * @param value defines the offset to apply
  114551. */
  114552. setZOffset(value: number): void;
  114553. /**
  114554. * Gets the current value of the zOffset
  114555. * @returns the current zOffset state
  114556. */
  114557. getZOffset(): number;
  114558. /**
  114559. * Enable or disable depth buffering
  114560. * @param enable defines the state to set
  114561. */
  114562. setDepthBuffer(enable: boolean): void;
  114563. /**
  114564. * Gets a boolean indicating if depth writing is enabled
  114565. * @returns the current depth writing state
  114566. */
  114567. getDepthWrite(): boolean;
  114568. /**
  114569. * Enable or disable depth writing
  114570. * @param enable defines the state to set
  114571. */
  114572. setDepthWrite(enable: boolean): void;
  114573. /**
  114574. * Gets a boolean indicating if stencil buffer is enabled
  114575. * @returns the current stencil buffer state
  114576. */
  114577. getStencilBuffer(): boolean;
  114578. /**
  114579. * Enable or disable the stencil buffer
  114580. * @param enable defines if the stencil buffer must be enabled or disabled
  114581. */
  114582. setStencilBuffer(enable: boolean): void;
  114583. /**
  114584. * Gets the current stencil mask
  114585. * @returns a number defining the new stencil mask to use
  114586. */
  114587. getStencilMask(): number;
  114588. /**
  114589. * Sets the current stencil mask
  114590. * @param mask defines the new stencil mask to use
  114591. */
  114592. setStencilMask(mask: number): void;
  114593. /**
  114594. * Gets the current stencil function
  114595. * @returns a number defining the stencil function to use
  114596. */
  114597. getStencilFunction(): number;
  114598. /**
  114599. * Gets the current stencil reference value
  114600. * @returns a number defining the stencil reference value to use
  114601. */
  114602. getStencilFunctionReference(): number;
  114603. /**
  114604. * Gets the current stencil mask
  114605. * @returns a number defining the stencil mask to use
  114606. */
  114607. getStencilFunctionMask(): number;
  114608. /**
  114609. * Sets the current stencil function
  114610. * @param stencilFunc defines the new stencil function to use
  114611. */
  114612. setStencilFunction(stencilFunc: number): void;
  114613. /**
  114614. * Sets the current stencil reference
  114615. * @param reference defines the new stencil reference to use
  114616. */
  114617. setStencilFunctionReference(reference: number): void;
  114618. /**
  114619. * Sets the current stencil mask
  114620. * @param mask defines the new stencil mask to use
  114621. */
  114622. setStencilFunctionMask(mask: number): void;
  114623. /**
  114624. * Gets the current stencil operation when stencil fails
  114625. * @returns a number defining stencil operation to use when stencil fails
  114626. */
  114627. getStencilOperationFail(): number;
  114628. /**
  114629. * Gets the current stencil operation when depth fails
  114630. * @returns a number defining stencil operation to use when depth fails
  114631. */
  114632. getStencilOperationDepthFail(): number;
  114633. /**
  114634. * Gets the current stencil operation when stencil passes
  114635. * @returns a number defining stencil operation to use when stencil passes
  114636. */
  114637. getStencilOperationPass(): number;
  114638. /**
  114639. * Sets the stencil operation to use when stencil fails
  114640. * @param operation defines the stencil operation to use when stencil fails
  114641. */
  114642. setStencilOperationFail(operation: number): void;
  114643. /**
  114644. * Sets the stencil operation to use when depth fails
  114645. * @param operation defines the stencil operation to use when depth fails
  114646. */
  114647. setStencilOperationDepthFail(operation: number): void;
  114648. /**
  114649. * Sets the stencil operation to use when stencil passes
  114650. * @param operation defines the stencil operation to use when stencil passes
  114651. */
  114652. setStencilOperationPass(operation: number): void;
  114653. /**
  114654. * Sets a boolean indicating if the dithering state is enabled or disabled
  114655. * @param value defines the dithering state
  114656. */
  114657. setDitheringState(value: boolean): void;
  114658. /**
  114659. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  114660. * @param value defines the rasterizer state
  114661. */
  114662. setRasterizerState(value: boolean): void;
  114663. /**
  114664. * Gets the current depth function
  114665. * @returns a number defining the depth function
  114666. */
  114667. getDepthFunction(): Nullable<number>;
  114668. /**
  114669. * Sets the current depth function
  114670. * @param depthFunc defines the function to use
  114671. */
  114672. setDepthFunction(depthFunc: number): void;
  114673. /**
  114674. * Sets the current depth function to GREATER
  114675. */
  114676. setDepthFunctionToGreater(): void;
  114677. /**
  114678. * Sets the current depth function to GEQUAL
  114679. */
  114680. setDepthFunctionToGreaterOrEqual(): void;
  114681. /**
  114682. * Sets the current depth function to LESS
  114683. */
  114684. setDepthFunctionToLess(): void;
  114685. /**
  114686. * Sets the current depth function to LEQUAL
  114687. */
  114688. setDepthFunctionToLessOrEqual(): void;
  114689. private _cachedStencilBuffer;
  114690. private _cachedStencilFunction;
  114691. private _cachedStencilMask;
  114692. private _cachedStencilOperationPass;
  114693. private _cachedStencilOperationFail;
  114694. private _cachedStencilOperationDepthFail;
  114695. private _cachedStencilReference;
  114696. /**
  114697. * Caches the the state of the stencil buffer
  114698. */
  114699. cacheStencilState(): void;
  114700. /**
  114701. * Restores the state of the stencil buffer
  114702. */
  114703. restoreStencilState(): void;
  114704. /**
  114705. * Directly set the WebGL Viewport
  114706. * @param x defines the x coordinate of the viewport (in screen space)
  114707. * @param y defines the y coordinate of the viewport (in screen space)
  114708. * @param width defines the width of the viewport (in screen space)
  114709. * @param height defines the height of the viewport (in screen space)
  114710. * @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
  114711. */
  114712. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  114713. /**
  114714. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  114715. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  114716. * @param y defines the y-coordinate of the corner of the clear rectangle
  114717. * @param width defines the width of the clear rectangle
  114718. * @param height defines the height of the clear rectangle
  114719. * @param clearColor defines the clear color
  114720. */
  114721. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  114722. /**
  114723. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  114724. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  114725. * @param y defines the y-coordinate of the corner of the clear rectangle
  114726. * @param width defines the width of the clear rectangle
  114727. * @param height defines the height of the clear rectangle
  114728. */
  114729. enableScissor(x: number, y: number, width: number, height: number): void;
  114730. /**
  114731. * Disable previously set scissor test rectangle
  114732. */
  114733. disableScissor(): void;
  114734. protected _reportDrawCall(): void;
  114735. /**
  114736. * Initializes a webVR display and starts listening to display change events
  114737. * The onVRDisplayChangedObservable will be notified upon these changes
  114738. * @returns The onVRDisplayChangedObservable
  114739. */
  114740. initWebVR(): Observable<IDisplayChangedEventArgs>;
  114741. /** @hidden */
  114742. _prepareVRComponent(): void;
  114743. /** @hidden */
  114744. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  114745. /** @hidden */
  114746. _submitVRFrame(): void;
  114747. /**
  114748. * Call this function to leave webVR mode
  114749. * Will do nothing if webVR is not supported or if there is no webVR device
  114750. * @see http://doc.babylonjs.com/how_to/webvr_camera
  114751. */
  114752. disableVR(): void;
  114753. /**
  114754. * Gets a boolean indicating that the system is in VR mode and is presenting
  114755. * @returns true if VR mode is engaged
  114756. */
  114757. isVRPresenting(): boolean;
  114758. /** @hidden */
  114759. _requestVRFrame(): void;
  114760. /** @hidden */
  114761. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  114762. /**
  114763. * Gets the source code of the vertex shader associated with a specific webGL program
  114764. * @param program defines the program to use
  114765. * @returns a string containing the source code of the vertex shader associated with the program
  114766. */
  114767. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  114768. /**
  114769. * Gets the source code of the fragment shader associated with a specific webGL program
  114770. * @param program defines the program to use
  114771. * @returns a string containing the source code of the fragment shader associated with the program
  114772. */
  114773. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  114774. /**
  114775. * Sets a depth stencil texture from a render target to the according uniform.
  114776. * @param channel The texture channel
  114777. * @param uniform The uniform to set
  114778. * @param texture The render target texture containing the depth stencil texture to apply
  114779. */
  114780. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  114781. /**
  114782. * Sets a texture to the webGL context from a postprocess
  114783. * @param channel defines the channel to use
  114784. * @param postProcess defines the source postprocess
  114785. */
  114786. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  114787. /**
  114788. * Binds the output of the passed in post process to the texture channel specified
  114789. * @param channel The channel the texture should be bound to
  114790. * @param postProcess The post process which's output should be bound
  114791. */
  114792. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  114793. protected _rebuildBuffers(): void;
  114794. /** @hidden */
  114795. _renderFrame(): void;
  114796. _renderLoop(): void;
  114797. /** @hidden */
  114798. _renderViews(): boolean;
  114799. /**
  114800. * Toggle full screen mode
  114801. * @param requestPointerLock defines if a pointer lock should be requested from the user
  114802. */
  114803. switchFullscreen(requestPointerLock: boolean): void;
  114804. /**
  114805. * Enters full screen mode
  114806. * @param requestPointerLock defines if a pointer lock should be requested from the user
  114807. */
  114808. enterFullscreen(requestPointerLock: boolean): void;
  114809. /**
  114810. * Exits full screen mode
  114811. */
  114812. exitFullscreen(): void;
  114813. /**
  114814. * Enters Pointerlock mode
  114815. */
  114816. enterPointerlock(): void;
  114817. /**
  114818. * Exits Pointerlock mode
  114819. */
  114820. exitPointerlock(): void;
  114821. /**
  114822. * Begin a new frame
  114823. */
  114824. beginFrame(): void;
  114825. /**
  114826. * Enf the current frame
  114827. */
  114828. endFrame(): void;
  114829. resize(): void;
  114830. /**
  114831. * Force a specific size of the canvas
  114832. * @param width defines the new canvas' width
  114833. * @param height defines the new canvas' height
  114834. * @returns true if the size was changed
  114835. */
  114836. setSize(width: number, height: number): boolean;
  114837. /**
  114838. * Updates a dynamic vertex buffer.
  114839. * @param vertexBuffer the vertex buffer to update
  114840. * @param data the data used to update the vertex buffer
  114841. * @param byteOffset the byte offset of the data
  114842. * @param byteLength the byte length of the data
  114843. */
  114844. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  114845. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  114846. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  114847. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  114848. _releaseTexture(texture: InternalTexture): void;
  114849. /**
  114850. * @hidden
  114851. * Rescales a texture
  114852. * @param source input texutre
  114853. * @param destination destination texture
  114854. * @param scene scene to use to render the resize
  114855. * @param internalFormat format to use when resizing
  114856. * @param onComplete callback to be called when resize has completed
  114857. */
  114858. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  114859. /**
  114860. * Gets the current framerate
  114861. * @returns a number representing the framerate
  114862. */
  114863. getFps(): number;
  114864. /**
  114865. * Gets the time spent between current and previous frame
  114866. * @returns a number representing the delta time in ms
  114867. */
  114868. getDeltaTime(): number;
  114869. private _measureFps;
  114870. /** @hidden */
  114871. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  114872. /**
  114873. * Update a dynamic index buffer
  114874. * @param indexBuffer defines the target index buffer
  114875. * @param indices defines the data to update
  114876. * @param offset defines the offset in the target index buffer where update should start
  114877. */
  114878. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  114879. /**
  114880. * Updates the sample count of a render target texture
  114881. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  114882. * @param texture defines the texture to update
  114883. * @param samples defines the sample count to set
  114884. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  114885. */
  114886. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  114887. /**
  114888. * Updates a depth texture Comparison Mode and Function.
  114889. * If the comparison Function is equal to 0, the mode will be set to none.
  114890. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  114891. * @param texture The texture to set the comparison function for
  114892. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  114893. */
  114894. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  114895. /**
  114896. * Creates a webGL buffer to use with instanciation
  114897. * @param capacity defines the size of the buffer
  114898. * @returns the webGL buffer
  114899. */
  114900. createInstancesBuffer(capacity: number): DataBuffer;
  114901. /**
  114902. * Delete a webGL buffer used with instanciation
  114903. * @param buffer defines the webGL buffer to delete
  114904. */
  114905. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  114906. private _clientWaitAsync;
  114907. /** @hidden */
  114908. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  114909. dispose(): void;
  114910. private _disableTouchAction;
  114911. /**
  114912. * Display the loading screen
  114913. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  114914. */
  114915. displayLoadingUI(): void;
  114916. /**
  114917. * Hide the loading screen
  114918. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  114919. */
  114920. hideLoadingUI(): void;
  114921. /**
  114922. * Gets the current loading screen object
  114923. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  114924. */
  114925. get loadingScreen(): ILoadingScreen;
  114926. /**
  114927. * Sets the current loading screen object
  114928. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  114929. */
  114930. set loadingScreen(loadingScreen: ILoadingScreen);
  114931. /**
  114932. * Sets the current loading screen text
  114933. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  114934. */
  114935. set loadingUIText(text: string);
  114936. /**
  114937. * Sets the current loading screen background color
  114938. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  114939. */
  114940. set loadingUIBackgroundColor(color: string);
  114941. /** Pointerlock and fullscreen */
  114942. /**
  114943. * Ask the browser to promote the current element to pointerlock mode
  114944. * @param element defines the DOM element to promote
  114945. */
  114946. static _RequestPointerlock(element: HTMLElement): void;
  114947. /**
  114948. * Asks the browser to exit pointerlock mode
  114949. */
  114950. static _ExitPointerlock(): void;
  114951. /**
  114952. * Ask the browser to promote the current element to fullscreen rendering mode
  114953. * @param element defines the DOM element to promote
  114954. */
  114955. static _RequestFullscreen(element: HTMLElement): void;
  114956. /**
  114957. * Asks the browser to exit fullscreen mode
  114958. */
  114959. static _ExitFullscreen(): void;
  114960. }
  114961. }
  114962. declare module BABYLON {
  114963. /**
  114964. * The engine store class is responsible to hold all the instances of Engine and Scene created
  114965. * during the life time of the application.
  114966. */
  114967. export class EngineStore {
  114968. /** Gets the list of created engines */
  114969. static Instances: Engine[];
  114970. /** @hidden */
  114971. static _LastCreatedScene: Nullable<Scene>;
  114972. /**
  114973. * Gets the latest created engine
  114974. */
  114975. static get LastCreatedEngine(): Nullable<Engine>;
  114976. /**
  114977. * Gets the latest created scene
  114978. */
  114979. static get LastCreatedScene(): Nullable<Scene>;
  114980. /**
  114981. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  114982. * @ignorenaming
  114983. */
  114984. static UseFallbackTexture: boolean;
  114985. /**
  114986. * Texture content used if a texture cannot loaded
  114987. * @ignorenaming
  114988. */
  114989. static FallbackTexture: string;
  114990. }
  114991. }
  114992. declare module BABYLON {
  114993. /**
  114994. * Helper class that provides a small promise polyfill
  114995. */
  114996. export class PromisePolyfill {
  114997. /**
  114998. * Static function used to check if the polyfill is required
  114999. * If this is the case then the function will inject the polyfill to window.Promise
  115000. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  115001. */
  115002. static Apply(force?: boolean): void;
  115003. }
  115004. }
  115005. declare module BABYLON {
  115006. /**
  115007. * Interface for screenshot methods with describe argument called `size` as object with options
  115008. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  115009. */
  115010. export interface IScreenshotSize {
  115011. /**
  115012. * number in pixels for canvas height
  115013. */
  115014. height?: number;
  115015. /**
  115016. * multiplier allowing render at a higher or lower resolution
  115017. * If value is defined then height and width will be ignored and taken from camera
  115018. */
  115019. precision?: number;
  115020. /**
  115021. * number in pixels for canvas width
  115022. */
  115023. width?: number;
  115024. }
  115025. }
  115026. declare module BABYLON {
  115027. interface IColor4Like {
  115028. r: float;
  115029. g: float;
  115030. b: float;
  115031. a: float;
  115032. }
  115033. /**
  115034. * Class containing a set of static utilities functions
  115035. */
  115036. export class Tools {
  115037. /**
  115038. * Gets or sets the base URL to use to load assets
  115039. */
  115040. static get BaseUrl(): string;
  115041. static set BaseUrl(value: string);
  115042. /**
  115043. * Enable/Disable Custom HTTP Request Headers globally.
  115044. * default = false
  115045. * @see CustomRequestHeaders
  115046. */
  115047. static UseCustomRequestHeaders: boolean;
  115048. /**
  115049. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  115050. * i.e. when loading files, where the server/service expects an Authorization header
  115051. */
  115052. static CustomRequestHeaders: {
  115053. [key: string]: string;
  115054. };
  115055. /**
  115056. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  115057. */
  115058. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  115059. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  115060. /**
  115061. * Default behaviour for cors in the application.
  115062. * It can be a string if the expected behavior is identical in the entire app.
  115063. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  115064. */
  115065. static get CorsBehavior(): string | ((url: string | string[]) => string);
  115066. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  115067. /**
  115068. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  115069. * @ignorenaming
  115070. */
  115071. static get UseFallbackTexture(): boolean;
  115072. static set UseFallbackTexture(value: boolean);
  115073. /**
  115074. * Use this object to register external classes like custom textures or material
  115075. * to allow the laoders to instantiate them
  115076. */
  115077. static get RegisteredExternalClasses(): {
  115078. [key: string]: Object;
  115079. };
  115080. static set RegisteredExternalClasses(classes: {
  115081. [key: string]: Object;
  115082. });
  115083. /**
  115084. * Texture content used if a texture cannot loaded
  115085. * @ignorenaming
  115086. */
  115087. static get fallbackTexture(): string;
  115088. static set fallbackTexture(value: string);
  115089. /**
  115090. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  115091. * @param u defines the coordinate on X axis
  115092. * @param v defines the coordinate on Y axis
  115093. * @param width defines the width of the source data
  115094. * @param height defines the height of the source data
  115095. * @param pixels defines the source byte array
  115096. * @param color defines the output color
  115097. */
  115098. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  115099. /**
  115100. * Interpolates between a and b via alpha
  115101. * @param a The lower value (returned when alpha = 0)
  115102. * @param b The upper value (returned when alpha = 1)
  115103. * @param alpha The interpolation-factor
  115104. * @return The mixed value
  115105. */
  115106. static Mix(a: number, b: number, alpha: number): number;
  115107. /**
  115108. * Tries to instantiate a new object from a given class name
  115109. * @param className defines the class name to instantiate
  115110. * @returns the new object or null if the system was not able to do the instantiation
  115111. */
  115112. static Instantiate(className: string): any;
  115113. /**
  115114. * Provides a slice function that will work even on IE
  115115. * @param data defines the array to slice
  115116. * @param start defines the start of the data (optional)
  115117. * @param end defines the end of the data (optional)
  115118. * @returns the new sliced array
  115119. */
  115120. static Slice<T>(data: T, start?: number, end?: number): T;
  115121. /**
  115122. * Polyfill for setImmediate
  115123. * @param action defines the action to execute after the current execution block
  115124. */
  115125. static SetImmediate(action: () => void): void;
  115126. /**
  115127. * Function indicating if a number is an exponent of 2
  115128. * @param value defines the value to test
  115129. * @returns true if the value is an exponent of 2
  115130. */
  115131. static IsExponentOfTwo(value: number): boolean;
  115132. private static _tmpFloatArray;
  115133. /**
  115134. * Returns the nearest 32-bit single precision float representation of a Number
  115135. * @param value A Number. If the parameter is of a different type, it will get converted
  115136. * to a number or to NaN if it cannot be converted
  115137. * @returns number
  115138. */
  115139. static FloatRound(value: number): number;
  115140. /**
  115141. * Extracts the filename from a path
  115142. * @param path defines the path to use
  115143. * @returns the filename
  115144. */
  115145. static GetFilename(path: string): string;
  115146. /**
  115147. * Extracts the "folder" part of a path (everything before the filename).
  115148. * @param uri The URI to extract the info from
  115149. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  115150. * @returns The "folder" part of the path
  115151. */
  115152. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  115153. /**
  115154. * Extracts text content from a DOM element hierarchy
  115155. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  115156. */
  115157. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  115158. /**
  115159. * Convert an angle in radians to degrees
  115160. * @param angle defines the angle to convert
  115161. * @returns the angle in degrees
  115162. */
  115163. static ToDegrees(angle: number): number;
  115164. /**
  115165. * Convert an angle in degrees to radians
  115166. * @param angle defines the angle to convert
  115167. * @returns the angle in radians
  115168. */
  115169. static ToRadians(angle: number): number;
  115170. /**
  115171. * Returns an array if obj is not an array
  115172. * @param obj defines the object to evaluate as an array
  115173. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  115174. * @returns either obj directly if obj is an array or a new array containing obj
  115175. */
  115176. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  115177. /**
  115178. * Gets the pointer prefix to use
  115179. * @param engine defines the engine we are finding the prefix for
  115180. * @returns "pointer" if touch is enabled. Else returns "mouse"
  115181. */
  115182. static GetPointerPrefix(engine: Engine): string;
  115183. /**
  115184. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  115185. * @param url define the url we are trying
  115186. * @param element define the dom element where to configure the cors policy
  115187. */
  115188. static SetCorsBehavior(url: string | string[], element: {
  115189. crossOrigin: string | null;
  115190. }): void;
  115191. /**
  115192. * Removes unwanted characters from an url
  115193. * @param url defines the url to clean
  115194. * @returns the cleaned url
  115195. */
  115196. static CleanUrl(url: string): string;
  115197. /**
  115198. * Gets or sets a function used to pre-process url before using them to load assets
  115199. */
  115200. static get PreprocessUrl(): (url: string) => string;
  115201. static set PreprocessUrl(processor: (url: string) => string);
  115202. /**
  115203. * Loads an image as an HTMLImageElement.
  115204. * @param input url string, ArrayBuffer, or Blob to load
  115205. * @param onLoad callback called when the image successfully loads
  115206. * @param onError callback called when the image fails to load
  115207. * @param offlineProvider offline provider for caching
  115208. * @param mimeType optional mime type
  115209. * @returns the HTMLImageElement of the loaded image
  115210. */
  115211. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  115212. /**
  115213. * Loads a file from a url
  115214. * @param url url string, ArrayBuffer, or Blob to load
  115215. * @param onSuccess callback called when the file successfully loads
  115216. * @param onProgress callback called while file is loading (if the server supports this mode)
  115217. * @param offlineProvider defines the offline provider for caching
  115218. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115219. * @param onError callback called when the file fails to load
  115220. * @returns a file request object
  115221. */
  115222. 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;
  115223. /**
  115224. * Loads a file from a url
  115225. * @param url the file url to load
  115226. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115227. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  115228. */
  115229. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  115230. /**
  115231. * Load a script (identified by an url). When the url returns, the
  115232. * content of this file is added into a new script element, attached to the DOM (body element)
  115233. * @param scriptUrl defines the url of the script to laod
  115234. * @param onSuccess defines the callback called when the script is loaded
  115235. * @param onError defines the callback to call if an error occurs
  115236. * @param scriptId defines the id of the script element
  115237. */
  115238. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  115239. /**
  115240. * Load an asynchronous script (identified by an url). When the url returns, the
  115241. * content of this file is added into a new script element, attached to the DOM (body element)
  115242. * @param scriptUrl defines the url of the script to laod
  115243. * @param scriptId defines the id of the script element
  115244. * @returns a promise request object
  115245. */
  115246. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  115247. /**
  115248. * Loads a file from a blob
  115249. * @param fileToLoad defines the blob to use
  115250. * @param callback defines the callback to call when data is loaded
  115251. * @param progressCallback defines the callback to call during loading process
  115252. * @returns a file request object
  115253. */
  115254. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  115255. /**
  115256. * Reads a file from a File object
  115257. * @param file defines the file to load
  115258. * @param onSuccess defines the callback to call when data is loaded
  115259. * @param onProgress defines the callback to call during loading process
  115260. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  115261. * @param onError defines the callback to call when an error occurs
  115262. * @returns a file request object
  115263. */
  115264. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  115265. /**
  115266. * Creates a data url from a given string content
  115267. * @param content defines the content to convert
  115268. * @returns the new data url link
  115269. */
  115270. static FileAsURL(content: string): string;
  115271. /**
  115272. * Format the given number to a specific decimal format
  115273. * @param value defines the number to format
  115274. * @param decimals defines the number of decimals to use
  115275. * @returns the formatted string
  115276. */
  115277. static Format(value: number, decimals?: number): string;
  115278. /**
  115279. * Tries to copy an object by duplicating every property
  115280. * @param source defines the source object
  115281. * @param destination defines the target object
  115282. * @param doNotCopyList defines a list of properties to avoid
  115283. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  115284. */
  115285. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  115286. /**
  115287. * Gets a boolean indicating if the given object has no own property
  115288. * @param obj defines the object to test
  115289. * @returns true if object has no own property
  115290. */
  115291. static IsEmpty(obj: any): boolean;
  115292. /**
  115293. * Function used to register events at window level
  115294. * @param windowElement defines the Window object to use
  115295. * @param events defines the events to register
  115296. */
  115297. static RegisterTopRootEvents(windowElement: Window, events: {
  115298. name: string;
  115299. handler: Nullable<(e: FocusEvent) => any>;
  115300. }[]): void;
  115301. /**
  115302. * Function used to unregister events from window level
  115303. * @param windowElement defines the Window object to use
  115304. * @param events defines the events to unregister
  115305. */
  115306. static UnregisterTopRootEvents(windowElement: Window, events: {
  115307. name: string;
  115308. handler: Nullable<(e: FocusEvent) => any>;
  115309. }[]): void;
  115310. /**
  115311. * @ignore
  115312. */
  115313. static _ScreenshotCanvas: HTMLCanvasElement;
  115314. /**
  115315. * Dumps the current bound framebuffer
  115316. * @param width defines the rendering width
  115317. * @param height defines the rendering height
  115318. * @param engine defines the hosting engine
  115319. * @param successCallback defines the callback triggered once the data are available
  115320. * @param mimeType defines the mime type of the result
  115321. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  115322. */
  115323. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  115324. /**
  115325. * Converts the canvas data to blob.
  115326. * This acts as a polyfill for browsers not supporting the to blob function.
  115327. * @param canvas Defines the canvas to extract the data from
  115328. * @param successCallback Defines the callback triggered once the data are available
  115329. * @param mimeType Defines the mime type of the result
  115330. */
  115331. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  115332. /**
  115333. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  115334. * @param successCallback defines the callback triggered once the data are available
  115335. * @param mimeType defines the mime type of the result
  115336. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  115337. */
  115338. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  115339. /**
  115340. * Downloads a blob in the browser
  115341. * @param blob defines the blob to download
  115342. * @param fileName defines the name of the downloaded file
  115343. */
  115344. static Download(blob: Blob, fileName: string): void;
  115345. /**
  115346. * Captures a screenshot of the current rendering
  115347. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  115348. * @param engine defines the rendering engine
  115349. * @param camera defines the source camera
  115350. * @param size This parameter can be set to a single number or to an object with the
  115351. * following (optional) properties: precision, width, height. If a single number is passed,
  115352. * it will be used for both width and height. If an object is passed, the screenshot size
  115353. * will be derived from the parameters. The precision property is a multiplier allowing
  115354. * rendering at a higher or lower resolution
  115355. * @param successCallback defines the callback receives a single parameter which contains the
  115356. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  115357. * src parameter of an <img> to display it
  115358. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  115359. * Check your browser for supported MIME types
  115360. */
  115361. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  115362. /**
  115363. * Captures a screenshot of the current rendering
  115364. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  115365. * @param engine defines the rendering engine
  115366. * @param camera defines the source camera
  115367. * @param size This parameter can be set to a single number or to an object with the
  115368. * following (optional) properties: precision, width, height. If a single number is passed,
  115369. * it will be used for both width and height. If an object is passed, the screenshot size
  115370. * will be derived from the parameters. The precision property is a multiplier allowing
  115371. * rendering at a higher or lower resolution
  115372. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  115373. * Check your browser for supported MIME types
  115374. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  115375. * to the src parameter of an <img> to display it
  115376. */
  115377. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  115378. /**
  115379. * Generates an image screenshot from the specified camera.
  115380. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  115381. * @param engine The engine to use for rendering
  115382. * @param camera The camera to use for rendering
  115383. * @param size This parameter can be set to a single number or to an object with the
  115384. * following (optional) properties: precision, width, height. If a single number is passed,
  115385. * it will be used for both width and height. If an object is passed, the screenshot size
  115386. * will be derived from the parameters. The precision property is a multiplier allowing
  115387. * rendering at a higher or lower resolution
  115388. * @param successCallback The callback receives a single parameter which contains the
  115389. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  115390. * src parameter of an <img> to display it
  115391. * @param mimeType The MIME type of the screenshot image (default: image/png).
  115392. * Check your browser for supported MIME types
  115393. * @param samples Texture samples (default: 1)
  115394. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  115395. * @param fileName A name for for the downloaded file.
  115396. */
  115397. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  115398. /**
  115399. * Generates an image screenshot from the specified camera.
  115400. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  115401. * @param engine The engine to use for rendering
  115402. * @param camera The camera to use for rendering
  115403. * @param size This parameter can be set to a single number or to an object with the
  115404. * following (optional) properties: precision, width, height. If a single number is passed,
  115405. * it will be used for both width and height. If an object is passed, the screenshot size
  115406. * will be derived from the parameters. The precision property is a multiplier allowing
  115407. * rendering at a higher or lower resolution
  115408. * @param mimeType The MIME type of the screenshot image (default: image/png).
  115409. * Check your browser for supported MIME types
  115410. * @param samples Texture samples (default: 1)
  115411. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  115412. * @param fileName A name for for the downloaded file.
  115413. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  115414. * to the src parameter of an <img> to display it
  115415. */
  115416. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  115417. /**
  115418. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  115419. * Be aware Math.random() could cause collisions, but:
  115420. * "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"
  115421. * @returns a pseudo random id
  115422. */
  115423. static RandomId(): string;
  115424. /**
  115425. * Test if the given uri is a base64 string
  115426. * @param uri The uri to test
  115427. * @return True if the uri is a base64 string or false otherwise
  115428. */
  115429. static IsBase64(uri: string): boolean;
  115430. /**
  115431. * Decode the given base64 uri.
  115432. * @param uri The uri to decode
  115433. * @return The decoded base64 data.
  115434. */
  115435. static DecodeBase64(uri: string): ArrayBuffer;
  115436. /**
  115437. * Gets the absolute url.
  115438. * @param url the input url
  115439. * @return the absolute url
  115440. */
  115441. static GetAbsoluteUrl(url: string): string;
  115442. /**
  115443. * No log
  115444. */
  115445. static readonly NoneLogLevel: number;
  115446. /**
  115447. * Only message logs
  115448. */
  115449. static readonly MessageLogLevel: number;
  115450. /**
  115451. * Only warning logs
  115452. */
  115453. static readonly WarningLogLevel: number;
  115454. /**
  115455. * Only error logs
  115456. */
  115457. static readonly ErrorLogLevel: number;
  115458. /**
  115459. * All logs
  115460. */
  115461. static readonly AllLogLevel: number;
  115462. /**
  115463. * Gets a value indicating the number of loading errors
  115464. * @ignorenaming
  115465. */
  115466. static get errorsCount(): number;
  115467. /**
  115468. * Callback called when a new log is added
  115469. */
  115470. static OnNewCacheEntry: (entry: string) => void;
  115471. /**
  115472. * Log a message to the console
  115473. * @param message defines the message to log
  115474. */
  115475. static Log(message: string): void;
  115476. /**
  115477. * Write a warning message to the console
  115478. * @param message defines the message to log
  115479. */
  115480. static Warn(message: string): void;
  115481. /**
  115482. * Write an error message to the console
  115483. * @param message defines the message to log
  115484. */
  115485. static Error(message: string): void;
  115486. /**
  115487. * Gets current log cache (list of logs)
  115488. */
  115489. static get LogCache(): string;
  115490. /**
  115491. * Clears the log cache
  115492. */
  115493. static ClearLogCache(): void;
  115494. /**
  115495. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  115496. */
  115497. static set LogLevels(level: number);
  115498. /**
  115499. * Checks if the window object exists
  115500. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  115501. */
  115502. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  115503. /**
  115504. * No performance log
  115505. */
  115506. static readonly PerformanceNoneLogLevel: number;
  115507. /**
  115508. * Use user marks to log performance
  115509. */
  115510. static readonly PerformanceUserMarkLogLevel: number;
  115511. /**
  115512. * Log performance to the console
  115513. */
  115514. static readonly PerformanceConsoleLogLevel: number;
  115515. private static _performance;
  115516. /**
  115517. * Sets the current performance log level
  115518. */
  115519. static set PerformanceLogLevel(level: number);
  115520. private static _StartPerformanceCounterDisabled;
  115521. private static _EndPerformanceCounterDisabled;
  115522. private static _StartUserMark;
  115523. private static _EndUserMark;
  115524. private static _StartPerformanceConsole;
  115525. private static _EndPerformanceConsole;
  115526. /**
  115527. * Starts a performance counter
  115528. */
  115529. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  115530. /**
  115531. * Ends a specific performance coutner
  115532. */
  115533. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  115534. /**
  115535. * Gets either window.performance.now() if supported or Date.now() else
  115536. */
  115537. static get Now(): number;
  115538. /**
  115539. * This method will return the name of the class used to create the instance of the given object.
  115540. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  115541. * @param object the object to get the class name from
  115542. * @param isType defines if the object is actually a type
  115543. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  115544. */
  115545. static GetClassName(object: any, isType?: boolean): string;
  115546. /**
  115547. * Gets the first element of an array satisfying a given predicate
  115548. * @param array defines the array to browse
  115549. * @param predicate defines the predicate to use
  115550. * @returns null if not found or the element
  115551. */
  115552. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  115553. /**
  115554. * This method will return the name of the full name of the class, including its owning module (if any).
  115555. * 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).
  115556. * @param object the object to get the class name from
  115557. * @param isType defines if the object is actually a type
  115558. * @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.
  115559. * @ignorenaming
  115560. */
  115561. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  115562. /**
  115563. * Returns a promise that resolves after the given amount of time.
  115564. * @param delay Number of milliseconds to delay
  115565. * @returns Promise that resolves after the given amount of time
  115566. */
  115567. static DelayAsync(delay: number): Promise<void>;
  115568. /**
  115569. * Utility function to detect if the current user agent is Safari
  115570. * @returns whether or not the current user agent is safari
  115571. */
  115572. static IsSafari(): boolean;
  115573. }
  115574. /**
  115575. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  115576. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  115577. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  115578. * @param name The name of the class, case should be preserved
  115579. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  115580. */
  115581. export function className(name: string, module?: string): (target: Object) => void;
  115582. /**
  115583. * An implementation of a loop for asynchronous functions.
  115584. */
  115585. export class AsyncLoop {
  115586. /**
  115587. * Defines the number of iterations for the loop
  115588. */
  115589. iterations: number;
  115590. /**
  115591. * Defines the current index of the loop.
  115592. */
  115593. index: number;
  115594. private _done;
  115595. private _fn;
  115596. private _successCallback;
  115597. /**
  115598. * Constructor.
  115599. * @param iterations the number of iterations.
  115600. * @param func the function to run each iteration
  115601. * @param successCallback the callback that will be called upon succesful execution
  115602. * @param offset starting offset.
  115603. */
  115604. constructor(
  115605. /**
  115606. * Defines the number of iterations for the loop
  115607. */
  115608. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  115609. /**
  115610. * Execute the next iteration. Must be called after the last iteration was finished.
  115611. */
  115612. executeNext(): void;
  115613. /**
  115614. * Break the loop and run the success callback.
  115615. */
  115616. breakLoop(): void;
  115617. /**
  115618. * Create and run an async loop.
  115619. * @param iterations the number of iterations.
  115620. * @param fn the function to run each iteration
  115621. * @param successCallback the callback that will be called upon succesful execution
  115622. * @param offset starting offset.
  115623. * @returns the created async loop object
  115624. */
  115625. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  115626. /**
  115627. * A for-loop that will run a given number of iterations synchronous and the rest async.
  115628. * @param iterations total number of iterations
  115629. * @param syncedIterations number of synchronous iterations in each async iteration.
  115630. * @param fn the function to call each iteration.
  115631. * @param callback a success call back that will be called when iterating stops.
  115632. * @param breakFunction a break condition (optional)
  115633. * @param timeout timeout settings for the setTimeout function. default - 0.
  115634. * @returns the created async loop object
  115635. */
  115636. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  115637. }
  115638. }
  115639. declare module BABYLON {
  115640. /**
  115641. * This class implement a typical dictionary using a string as key and the generic type T as value.
  115642. * The underlying implementation relies on an associative array to ensure the best performances.
  115643. * The value can be anything including 'null' but except 'undefined'
  115644. */
  115645. export class StringDictionary<T> {
  115646. /**
  115647. * This will clear this dictionary and copy the content from the 'source' one.
  115648. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  115649. * @param source the dictionary to take the content from and copy to this dictionary
  115650. */
  115651. copyFrom(source: StringDictionary<T>): void;
  115652. /**
  115653. * Get a value based from its key
  115654. * @param key the given key to get the matching value from
  115655. * @return the value if found, otherwise undefined is returned
  115656. */
  115657. get(key: string): T | undefined;
  115658. /**
  115659. * Get a value from its key or add it if it doesn't exist.
  115660. * This method will ensure you that a given key/data will be present in the dictionary.
  115661. * @param key the given key to get the matching value from
  115662. * @param factory the factory that will create the value if the key is not present in the dictionary.
  115663. * The factory will only be invoked if there's no data for the given key.
  115664. * @return the value corresponding to the key.
  115665. */
  115666. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  115667. /**
  115668. * Get a value from its key if present in the dictionary otherwise add it
  115669. * @param key the key to get the value from
  115670. * @param val if there's no such key/value pair in the dictionary add it with this value
  115671. * @return the value corresponding to the key
  115672. */
  115673. getOrAdd(key: string, val: T): T;
  115674. /**
  115675. * Check if there's a given key in the dictionary
  115676. * @param key the key to check for
  115677. * @return true if the key is present, false otherwise
  115678. */
  115679. contains(key: string): boolean;
  115680. /**
  115681. * Add a new key and its corresponding value
  115682. * @param key the key to add
  115683. * @param value the value corresponding to the key
  115684. * @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
  115685. */
  115686. add(key: string, value: T): boolean;
  115687. /**
  115688. * Update a specific value associated to a key
  115689. * @param key defines the key to use
  115690. * @param value defines the value to store
  115691. * @returns true if the value was updated (or false if the key was not found)
  115692. */
  115693. set(key: string, value: T): boolean;
  115694. /**
  115695. * Get the element of the given key and remove it from the dictionary
  115696. * @param key defines the key to search
  115697. * @returns the value associated with the key or null if not found
  115698. */
  115699. getAndRemove(key: string): Nullable<T>;
  115700. /**
  115701. * Remove a key/value from the dictionary.
  115702. * @param key the key to remove
  115703. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  115704. */
  115705. remove(key: string): boolean;
  115706. /**
  115707. * Clear the whole content of the dictionary
  115708. */
  115709. clear(): void;
  115710. /**
  115711. * Gets the current count
  115712. */
  115713. get count(): number;
  115714. /**
  115715. * Execute a callback on each key/val of the dictionary.
  115716. * Note that you can remove any element in this dictionary in the callback implementation
  115717. * @param callback the callback to execute on a given key/value pair
  115718. */
  115719. forEach(callback: (key: string, val: T) => void): void;
  115720. /**
  115721. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  115722. * If the callback returns null or undefined the method will iterate to the next key/value pair
  115723. * Note that you can remove any element in this dictionary in the callback implementation
  115724. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  115725. * @returns the first item
  115726. */
  115727. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  115728. private _count;
  115729. private _data;
  115730. }
  115731. }
  115732. declare module BABYLON {
  115733. /** @hidden */
  115734. export interface ICollisionCoordinator {
  115735. createCollider(): Collider;
  115736. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  115737. init(scene: Scene): void;
  115738. }
  115739. /** @hidden */
  115740. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  115741. private _scene;
  115742. private _scaledPosition;
  115743. private _scaledVelocity;
  115744. private _finalPosition;
  115745. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  115746. createCollider(): Collider;
  115747. init(scene: Scene): void;
  115748. private _collideWithWorld;
  115749. }
  115750. }
  115751. declare module BABYLON {
  115752. /**
  115753. * Class used to manage all inputs for the scene.
  115754. */
  115755. export class InputManager {
  115756. /** The distance in pixel that you have to move to prevent some events */
  115757. static DragMovementThreshold: number;
  115758. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  115759. static LongPressDelay: number;
  115760. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  115761. static DoubleClickDelay: number;
  115762. /** If you need to check double click without raising a single click at first click, enable this flag */
  115763. static ExclusiveDoubleClickMode: boolean;
  115764. private _wheelEventName;
  115765. private _onPointerMove;
  115766. private _onPointerDown;
  115767. private _onPointerUp;
  115768. private _initClickEvent;
  115769. private _initActionManager;
  115770. private _delayedSimpleClick;
  115771. private _delayedSimpleClickTimeout;
  115772. private _previousDelayedSimpleClickTimeout;
  115773. private _meshPickProceed;
  115774. private _previousButtonPressed;
  115775. private _currentPickResult;
  115776. private _previousPickResult;
  115777. private _totalPointersPressed;
  115778. private _doubleClickOccured;
  115779. private _pointerOverMesh;
  115780. private _pickedDownMesh;
  115781. private _pickedUpMesh;
  115782. private _pointerX;
  115783. private _pointerY;
  115784. private _unTranslatedPointerX;
  115785. private _unTranslatedPointerY;
  115786. private _startingPointerPosition;
  115787. private _previousStartingPointerPosition;
  115788. private _startingPointerTime;
  115789. private _previousStartingPointerTime;
  115790. private _pointerCaptures;
  115791. private _onKeyDown;
  115792. private _onKeyUp;
  115793. private _onCanvasFocusObserver;
  115794. private _onCanvasBlurObserver;
  115795. private _scene;
  115796. /**
  115797. * Creates a new InputManager
  115798. * @param scene defines the hosting scene
  115799. */
  115800. constructor(scene: Scene);
  115801. /**
  115802. * Gets the mesh that is currently under the pointer
  115803. */
  115804. get meshUnderPointer(): Nullable<AbstractMesh>;
  115805. /**
  115806. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  115807. */
  115808. get unTranslatedPointer(): Vector2;
  115809. /**
  115810. * Gets or sets the current on-screen X position of the pointer
  115811. */
  115812. get pointerX(): number;
  115813. set pointerX(value: number);
  115814. /**
  115815. * Gets or sets the current on-screen Y position of the pointer
  115816. */
  115817. get pointerY(): number;
  115818. set pointerY(value: number);
  115819. private _updatePointerPosition;
  115820. private _processPointerMove;
  115821. private _setRayOnPointerInfo;
  115822. private _checkPrePointerObservable;
  115823. /**
  115824. * Use this method to simulate a pointer move on a mesh
  115825. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  115826. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  115827. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  115828. */
  115829. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  115830. /**
  115831. * Use this method to simulate a pointer down on a mesh
  115832. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  115833. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  115834. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  115835. */
  115836. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  115837. private _processPointerDown;
  115838. /** @hidden */
  115839. _isPointerSwiping(): boolean;
  115840. /**
  115841. * Use this method to simulate a pointer up on a mesh
  115842. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  115843. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  115844. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  115845. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  115846. */
  115847. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  115848. private _processPointerUp;
  115849. /**
  115850. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  115851. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  115852. * @returns true if the pointer was captured
  115853. */
  115854. isPointerCaptured(pointerId?: number): boolean;
  115855. /**
  115856. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  115857. * @param attachUp defines if you want to attach events to pointerup
  115858. * @param attachDown defines if you want to attach events to pointerdown
  115859. * @param attachMove defines if you want to attach events to pointermove
  115860. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  115861. */
  115862. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  115863. /**
  115864. * Detaches all event handlers
  115865. */
  115866. detachControl(): void;
  115867. /**
  115868. * Force the value of meshUnderPointer
  115869. * @param mesh defines the mesh to use
  115870. */
  115871. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  115872. /**
  115873. * Gets the mesh under the pointer
  115874. * @returns a Mesh or null if no mesh is under the pointer
  115875. */
  115876. getPointerOverMesh(): Nullable<AbstractMesh>;
  115877. }
  115878. }
  115879. declare module BABYLON {
  115880. /**
  115881. * This class defines the direct association between an animation and a target
  115882. */
  115883. export class TargetedAnimation {
  115884. /**
  115885. * Animation to perform
  115886. */
  115887. animation: Animation;
  115888. /**
  115889. * Target to animate
  115890. */
  115891. target: any;
  115892. /**
  115893. * Returns the string "TargetedAnimation"
  115894. * @returns "TargetedAnimation"
  115895. */
  115896. getClassName(): string;
  115897. /**
  115898. * Serialize the object
  115899. * @returns the JSON object representing the current entity
  115900. */
  115901. serialize(): any;
  115902. }
  115903. /**
  115904. * Use this class to create coordinated animations on multiple targets
  115905. */
  115906. export class AnimationGroup implements IDisposable {
  115907. /** The name of the animation group */
  115908. name: string;
  115909. private _scene;
  115910. private _targetedAnimations;
  115911. private _animatables;
  115912. private _from;
  115913. private _to;
  115914. private _isStarted;
  115915. private _isPaused;
  115916. private _speedRatio;
  115917. private _loopAnimation;
  115918. private _isAdditive;
  115919. /**
  115920. * Gets or sets the unique id of the node
  115921. */
  115922. uniqueId: number;
  115923. /**
  115924. * This observable will notify when one animation have ended
  115925. */
  115926. onAnimationEndObservable: Observable<TargetedAnimation>;
  115927. /**
  115928. * Observer raised when one animation loops
  115929. */
  115930. onAnimationLoopObservable: Observable<TargetedAnimation>;
  115931. /**
  115932. * Observer raised when all animations have looped
  115933. */
  115934. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  115935. /**
  115936. * This observable will notify when all animations have ended.
  115937. */
  115938. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  115939. /**
  115940. * This observable will notify when all animations have paused.
  115941. */
  115942. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  115943. /**
  115944. * This observable will notify when all animations are playing.
  115945. */
  115946. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  115947. /**
  115948. * Gets the first frame
  115949. */
  115950. get from(): number;
  115951. /**
  115952. * Gets the last frame
  115953. */
  115954. get to(): number;
  115955. /**
  115956. * Define if the animations are started
  115957. */
  115958. get isStarted(): boolean;
  115959. /**
  115960. * Gets a value indicating that the current group is playing
  115961. */
  115962. get isPlaying(): boolean;
  115963. /**
  115964. * Gets or sets the speed ratio to use for all animations
  115965. */
  115966. get speedRatio(): number;
  115967. /**
  115968. * Gets or sets the speed ratio to use for all animations
  115969. */
  115970. set speedRatio(value: number);
  115971. /**
  115972. * Gets or sets if all animations should loop or not
  115973. */
  115974. get loopAnimation(): boolean;
  115975. set loopAnimation(value: boolean);
  115976. /**
  115977. * Gets or sets if all animations should be evaluated additively
  115978. */
  115979. get isAdditive(): boolean;
  115980. set isAdditive(value: boolean);
  115981. /**
  115982. * Gets the targeted animations for this animation group
  115983. */
  115984. get targetedAnimations(): Array<TargetedAnimation>;
  115985. /**
  115986. * returning the list of animatables controlled by this animation group.
  115987. */
  115988. get animatables(): Array<Animatable>;
  115989. /**
  115990. * Gets the list of target animations
  115991. */
  115992. get children(): TargetedAnimation[];
  115993. /**
  115994. * Instantiates a new Animation Group.
  115995. * This helps managing several animations at once.
  115996. * @see http://doc.babylonjs.com/how_to/group
  115997. * @param name Defines the name of the group
  115998. * @param scene Defines the scene the group belongs to
  115999. */
  116000. constructor(
  116001. /** The name of the animation group */
  116002. name: string, scene?: Nullable<Scene>);
  116003. /**
  116004. * Add an animation (with its target) in the group
  116005. * @param animation defines the animation we want to add
  116006. * @param target defines the target of the animation
  116007. * @returns the TargetedAnimation object
  116008. */
  116009. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  116010. /**
  116011. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  116012. * It can add constant keys at begin or end
  116013. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  116014. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  116015. * @returns the animation group
  116016. */
  116017. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  116018. private _animationLoopCount;
  116019. private _animationLoopFlags;
  116020. private _processLoop;
  116021. /**
  116022. * Start all animations on given targets
  116023. * @param loop defines if animations must loop
  116024. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  116025. * @param from defines the from key (optional)
  116026. * @param to defines the to key (optional)
  116027. * @param isAdditive defines the additive state for the resulting animatables (optional)
  116028. * @returns the current animation group
  116029. */
  116030. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  116031. /**
  116032. * Pause all animations
  116033. * @returns the animation group
  116034. */
  116035. pause(): AnimationGroup;
  116036. /**
  116037. * Play all animations to initial state
  116038. * This function will start() the animations if they were not started or will restart() them if they were paused
  116039. * @param loop defines if animations must loop
  116040. * @returns the animation group
  116041. */
  116042. play(loop?: boolean): AnimationGroup;
  116043. /**
  116044. * Reset all animations to initial state
  116045. * @returns the animation group
  116046. */
  116047. reset(): AnimationGroup;
  116048. /**
  116049. * Restart animations from key 0
  116050. * @returns the animation group
  116051. */
  116052. restart(): AnimationGroup;
  116053. /**
  116054. * Stop all animations
  116055. * @returns the animation group
  116056. */
  116057. stop(): AnimationGroup;
  116058. /**
  116059. * Set animation weight for all animatables
  116060. * @param weight defines the weight to use
  116061. * @return the animationGroup
  116062. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  116063. */
  116064. setWeightForAllAnimatables(weight: number): AnimationGroup;
  116065. /**
  116066. * Synchronize and normalize all animatables with a source animatable
  116067. * @param root defines the root animatable to synchronize with
  116068. * @return the animationGroup
  116069. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  116070. */
  116071. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  116072. /**
  116073. * Goes to a specific frame in this animation group
  116074. * @param frame the frame number to go to
  116075. * @return the animationGroup
  116076. */
  116077. goToFrame(frame: number): AnimationGroup;
  116078. /**
  116079. * Dispose all associated resources
  116080. */
  116081. dispose(): void;
  116082. private _checkAnimationGroupEnded;
  116083. /**
  116084. * Clone the current animation group and returns a copy
  116085. * @param newName defines the name of the new group
  116086. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  116087. * @returns the new aniamtion group
  116088. */
  116089. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  116090. /**
  116091. * Serializes the animationGroup to an object
  116092. * @returns Serialized object
  116093. */
  116094. serialize(): any;
  116095. /**
  116096. * Returns a new AnimationGroup object parsed from the source provided.
  116097. * @param parsedAnimationGroup defines the source
  116098. * @param scene defines the scene that will receive the animationGroup
  116099. * @returns a new AnimationGroup
  116100. */
  116101. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  116102. /**
  116103. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  116104. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  116105. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  116106. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  116107. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  116108. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  116109. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  116110. */
  116111. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  116112. /**
  116113. * Returns the string "AnimationGroup"
  116114. * @returns "AnimationGroup"
  116115. */
  116116. getClassName(): string;
  116117. /**
  116118. * Creates a detailled string about the object
  116119. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  116120. * @returns a string representing the object
  116121. */
  116122. toString(fullDetails?: boolean): string;
  116123. }
  116124. }
  116125. declare module BABYLON {
  116126. /**
  116127. * Define an interface for all classes that will hold resources
  116128. */
  116129. export interface IDisposable {
  116130. /**
  116131. * Releases all held resources
  116132. */
  116133. dispose(): void;
  116134. }
  116135. /** Interface defining initialization parameters for Scene class */
  116136. export interface SceneOptions {
  116137. /**
  116138. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  116139. * It will improve performance when the number of geometries becomes important.
  116140. */
  116141. useGeometryUniqueIdsMap?: boolean;
  116142. /**
  116143. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  116144. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  116145. */
  116146. useMaterialMeshMap?: boolean;
  116147. /**
  116148. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  116149. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  116150. */
  116151. useClonedMeshMap?: boolean;
  116152. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  116153. virtual?: boolean;
  116154. }
  116155. /**
  116156. * Represents a scene to be rendered by the engine.
  116157. * @see http://doc.babylonjs.com/features/scene
  116158. */
  116159. export class Scene extends AbstractScene implements IAnimatable {
  116160. /** The fog is deactivated */
  116161. static readonly FOGMODE_NONE: number;
  116162. /** The fog density is following an exponential function */
  116163. static readonly FOGMODE_EXP: number;
  116164. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  116165. static readonly FOGMODE_EXP2: number;
  116166. /** The fog density is following a linear function. */
  116167. static readonly FOGMODE_LINEAR: number;
  116168. /**
  116169. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  116170. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  116171. */
  116172. static MinDeltaTime: number;
  116173. /**
  116174. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  116175. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  116176. */
  116177. static MaxDeltaTime: number;
  116178. /**
  116179. * Factory used to create the default material.
  116180. * @param name The name of the material to create
  116181. * @param scene The scene to create the material for
  116182. * @returns The default material
  116183. */
  116184. static DefaultMaterialFactory(scene: Scene): Material;
  116185. /**
  116186. * Factory used to create the a collision coordinator.
  116187. * @returns The collision coordinator
  116188. */
  116189. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  116190. /** @hidden */
  116191. _inputManager: InputManager;
  116192. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  116193. cameraToUseForPointers: Nullable<Camera>;
  116194. /** @hidden */
  116195. readonly _isScene: boolean;
  116196. /** @hidden */
  116197. _blockEntityCollection: boolean;
  116198. /**
  116199. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  116200. */
  116201. autoClear: boolean;
  116202. /**
  116203. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  116204. */
  116205. autoClearDepthAndStencil: boolean;
  116206. /**
  116207. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  116208. */
  116209. clearColor: Color4;
  116210. /**
  116211. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  116212. */
  116213. ambientColor: Color3;
  116214. /**
  116215. * This is use to store the default BRDF lookup for PBR materials in your scene.
  116216. * It should only be one of the following (if not the default embedded one):
  116217. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  116218. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  116219. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  116220. * The material properties need to be setup according to the type of texture in use.
  116221. */
  116222. environmentBRDFTexture: BaseTexture;
  116223. /** @hidden */
  116224. protected _environmentTexture: Nullable<BaseTexture>;
  116225. /**
  116226. * Texture used in all pbr material as the reflection texture.
  116227. * As in the majority of the scene they are the same (exception for multi room and so on),
  116228. * this is easier to reference from here than from all the materials.
  116229. */
  116230. get environmentTexture(): Nullable<BaseTexture>;
  116231. /**
  116232. * Texture used in all pbr material as the reflection texture.
  116233. * As in the majority of the scene they are the same (exception for multi room and so on),
  116234. * this is easier to set here than in all the materials.
  116235. */
  116236. set environmentTexture(value: Nullable<BaseTexture>);
  116237. /** @hidden */
  116238. protected _environmentIntensity: number;
  116239. /**
  116240. * Intensity of the environment in all pbr material.
  116241. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  116242. * As in the majority of the scene they are the same (exception for multi room and so on),
  116243. * this is easier to reference from here than from all the materials.
  116244. */
  116245. get environmentIntensity(): number;
  116246. /**
  116247. * Intensity of the environment in all pbr material.
  116248. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  116249. * As in the majority of the scene they are the same (exception for multi room and so on),
  116250. * this is easier to set here than in all the materials.
  116251. */
  116252. set environmentIntensity(value: number);
  116253. /** @hidden */
  116254. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  116255. /**
  116256. * Default image processing configuration used either in the rendering
  116257. * Forward main pass or through the imageProcessingPostProcess if present.
  116258. * As in the majority of the scene they are the same (exception for multi camera),
  116259. * this is easier to reference from here than from all the materials and post process.
  116260. *
  116261. * No setter as we it is a shared configuration, you can set the values instead.
  116262. */
  116263. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  116264. private _forceWireframe;
  116265. /**
  116266. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  116267. */
  116268. set forceWireframe(value: boolean);
  116269. get forceWireframe(): boolean;
  116270. private _skipFrustumClipping;
  116271. /**
  116272. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  116273. */
  116274. set skipFrustumClipping(value: boolean);
  116275. get skipFrustumClipping(): boolean;
  116276. private _forcePointsCloud;
  116277. /**
  116278. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  116279. */
  116280. set forcePointsCloud(value: boolean);
  116281. get forcePointsCloud(): boolean;
  116282. /**
  116283. * Gets or sets the active clipplane 1
  116284. */
  116285. clipPlane: Nullable<Plane>;
  116286. /**
  116287. * Gets or sets the active clipplane 2
  116288. */
  116289. clipPlane2: Nullable<Plane>;
  116290. /**
  116291. * Gets or sets the active clipplane 3
  116292. */
  116293. clipPlane3: Nullable<Plane>;
  116294. /**
  116295. * Gets or sets the active clipplane 4
  116296. */
  116297. clipPlane4: Nullable<Plane>;
  116298. /**
  116299. * Gets or sets the active clipplane 5
  116300. */
  116301. clipPlane5: Nullable<Plane>;
  116302. /**
  116303. * Gets or sets the active clipplane 6
  116304. */
  116305. clipPlane6: Nullable<Plane>;
  116306. /**
  116307. * Gets or sets a boolean indicating if animations are enabled
  116308. */
  116309. animationsEnabled: boolean;
  116310. private _animationPropertiesOverride;
  116311. /**
  116312. * Gets or sets the animation properties override
  116313. */
  116314. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  116315. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  116316. /**
  116317. * Gets or sets a boolean indicating if a constant deltatime has to be used
  116318. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  116319. */
  116320. useConstantAnimationDeltaTime: boolean;
  116321. /**
  116322. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  116323. * Please note that it requires to run a ray cast through the scene on every frame
  116324. */
  116325. constantlyUpdateMeshUnderPointer: boolean;
  116326. /**
  116327. * Defines the HTML cursor to use when hovering over interactive elements
  116328. */
  116329. hoverCursor: string;
  116330. /**
  116331. * Defines the HTML default cursor to use (empty by default)
  116332. */
  116333. defaultCursor: string;
  116334. /**
  116335. * Defines whether cursors are handled by the scene.
  116336. */
  116337. doNotHandleCursors: boolean;
  116338. /**
  116339. * This is used to call preventDefault() on pointer down
  116340. * in order to block unwanted artifacts like system double clicks
  116341. */
  116342. preventDefaultOnPointerDown: boolean;
  116343. /**
  116344. * This is used to call preventDefault() on pointer up
  116345. * in order to block unwanted artifacts like system double clicks
  116346. */
  116347. preventDefaultOnPointerUp: boolean;
  116348. /**
  116349. * Gets or sets user defined metadata
  116350. */
  116351. metadata: any;
  116352. /**
  116353. * For internal use only. Please do not use.
  116354. */
  116355. reservedDataStore: any;
  116356. /**
  116357. * Gets the name of the plugin used to load this scene (null by default)
  116358. */
  116359. loadingPluginName: string;
  116360. /**
  116361. * Use this array to add regular expressions used to disable offline support for specific urls
  116362. */
  116363. disableOfflineSupportExceptionRules: RegExp[];
  116364. /**
  116365. * An event triggered when the scene is disposed.
  116366. */
  116367. onDisposeObservable: Observable<Scene>;
  116368. private _onDisposeObserver;
  116369. /** Sets a function to be executed when this scene is disposed. */
  116370. set onDispose(callback: () => void);
  116371. /**
  116372. * An event triggered before rendering the scene (right after animations and physics)
  116373. */
  116374. onBeforeRenderObservable: Observable<Scene>;
  116375. private _onBeforeRenderObserver;
  116376. /** Sets a function to be executed before rendering this scene */
  116377. set beforeRender(callback: Nullable<() => void>);
  116378. /**
  116379. * An event triggered after rendering the scene
  116380. */
  116381. onAfterRenderObservable: Observable<Scene>;
  116382. /**
  116383. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  116384. */
  116385. onAfterRenderCameraObservable: Observable<Camera>;
  116386. private _onAfterRenderObserver;
  116387. /** Sets a function to be executed after rendering this scene */
  116388. set afterRender(callback: Nullable<() => void>);
  116389. /**
  116390. * An event triggered before animating the scene
  116391. */
  116392. onBeforeAnimationsObservable: Observable<Scene>;
  116393. /**
  116394. * An event triggered after animations processing
  116395. */
  116396. onAfterAnimationsObservable: Observable<Scene>;
  116397. /**
  116398. * An event triggered before draw calls are ready to be sent
  116399. */
  116400. onBeforeDrawPhaseObservable: Observable<Scene>;
  116401. /**
  116402. * An event triggered after draw calls have been sent
  116403. */
  116404. onAfterDrawPhaseObservable: Observable<Scene>;
  116405. /**
  116406. * An event triggered when the scene is ready
  116407. */
  116408. onReadyObservable: Observable<Scene>;
  116409. /**
  116410. * An event triggered before rendering a camera
  116411. */
  116412. onBeforeCameraRenderObservable: Observable<Camera>;
  116413. private _onBeforeCameraRenderObserver;
  116414. /** Sets a function to be executed before rendering a camera*/
  116415. set beforeCameraRender(callback: () => void);
  116416. /**
  116417. * An event triggered after rendering a camera
  116418. */
  116419. onAfterCameraRenderObservable: Observable<Camera>;
  116420. private _onAfterCameraRenderObserver;
  116421. /** Sets a function to be executed after rendering a camera*/
  116422. set afterCameraRender(callback: () => void);
  116423. /**
  116424. * An event triggered when active meshes evaluation is about to start
  116425. */
  116426. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  116427. /**
  116428. * An event triggered when active meshes evaluation is done
  116429. */
  116430. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  116431. /**
  116432. * An event triggered when particles rendering is about to start
  116433. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  116434. */
  116435. onBeforeParticlesRenderingObservable: Observable<Scene>;
  116436. /**
  116437. * An event triggered when particles rendering is done
  116438. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  116439. */
  116440. onAfterParticlesRenderingObservable: Observable<Scene>;
  116441. /**
  116442. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  116443. */
  116444. onDataLoadedObservable: Observable<Scene>;
  116445. /**
  116446. * An event triggered when a camera is created
  116447. */
  116448. onNewCameraAddedObservable: Observable<Camera>;
  116449. /**
  116450. * An event triggered when a camera is removed
  116451. */
  116452. onCameraRemovedObservable: Observable<Camera>;
  116453. /**
  116454. * An event triggered when a light is created
  116455. */
  116456. onNewLightAddedObservable: Observable<Light>;
  116457. /**
  116458. * An event triggered when a light is removed
  116459. */
  116460. onLightRemovedObservable: Observable<Light>;
  116461. /**
  116462. * An event triggered when a geometry is created
  116463. */
  116464. onNewGeometryAddedObservable: Observable<Geometry>;
  116465. /**
  116466. * An event triggered when a geometry is removed
  116467. */
  116468. onGeometryRemovedObservable: Observable<Geometry>;
  116469. /**
  116470. * An event triggered when a transform node is created
  116471. */
  116472. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  116473. /**
  116474. * An event triggered when a transform node is removed
  116475. */
  116476. onTransformNodeRemovedObservable: Observable<TransformNode>;
  116477. /**
  116478. * An event triggered when a mesh is created
  116479. */
  116480. onNewMeshAddedObservable: Observable<AbstractMesh>;
  116481. /**
  116482. * An event triggered when a mesh is removed
  116483. */
  116484. onMeshRemovedObservable: Observable<AbstractMesh>;
  116485. /**
  116486. * An event triggered when a skeleton is created
  116487. */
  116488. onNewSkeletonAddedObservable: Observable<Skeleton>;
  116489. /**
  116490. * An event triggered when a skeleton is removed
  116491. */
  116492. onSkeletonRemovedObservable: Observable<Skeleton>;
  116493. /**
  116494. * An event triggered when a material is created
  116495. */
  116496. onNewMaterialAddedObservable: Observable<Material>;
  116497. /**
  116498. * An event triggered when a material is removed
  116499. */
  116500. onMaterialRemovedObservable: Observable<Material>;
  116501. /**
  116502. * An event triggered when a texture is created
  116503. */
  116504. onNewTextureAddedObservable: Observable<BaseTexture>;
  116505. /**
  116506. * An event triggered when a texture is removed
  116507. */
  116508. onTextureRemovedObservable: Observable<BaseTexture>;
  116509. /**
  116510. * An event triggered when render targets are about to be rendered
  116511. * Can happen multiple times per frame.
  116512. */
  116513. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  116514. /**
  116515. * An event triggered when render targets were rendered.
  116516. * Can happen multiple times per frame.
  116517. */
  116518. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  116519. /**
  116520. * An event triggered before calculating deterministic simulation step
  116521. */
  116522. onBeforeStepObservable: Observable<Scene>;
  116523. /**
  116524. * An event triggered after calculating deterministic simulation step
  116525. */
  116526. onAfterStepObservable: Observable<Scene>;
  116527. /**
  116528. * An event triggered when the activeCamera property is updated
  116529. */
  116530. onActiveCameraChanged: Observable<Scene>;
  116531. /**
  116532. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  116533. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  116534. * 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)
  116535. */
  116536. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  116537. /**
  116538. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  116539. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  116540. * 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)
  116541. */
  116542. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  116543. /**
  116544. * This Observable will when a mesh has been imported into the scene.
  116545. */
  116546. onMeshImportedObservable: Observable<AbstractMesh>;
  116547. /**
  116548. * This Observable will when an animation file has been imported into the scene.
  116549. */
  116550. onAnimationFileImportedObservable: Observable<Scene>;
  116551. /**
  116552. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  116553. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  116554. */
  116555. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  116556. /** @hidden */
  116557. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  116558. /**
  116559. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  116560. */
  116561. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  116562. /**
  116563. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  116564. */
  116565. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  116566. /**
  116567. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  116568. */
  116569. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  116570. /** Callback called when a pointer move is detected */
  116571. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  116572. /** Callback called when a pointer down is detected */
  116573. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  116574. /** Callback called when a pointer up is detected */
  116575. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  116576. /** Callback called when a pointer pick is detected */
  116577. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  116578. /**
  116579. * 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).
  116580. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  116581. */
  116582. onPrePointerObservable: Observable<PointerInfoPre>;
  116583. /**
  116584. * Observable event triggered each time an input event is received from the rendering canvas
  116585. */
  116586. onPointerObservable: Observable<PointerInfo>;
  116587. /**
  116588. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  116589. */
  116590. get unTranslatedPointer(): Vector2;
  116591. /**
  116592. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  116593. */
  116594. static get DragMovementThreshold(): number;
  116595. static set DragMovementThreshold(value: number);
  116596. /**
  116597. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  116598. */
  116599. static get LongPressDelay(): number;
  116600. static set LongPressDelay(value: number);
  116601. /**
  116602. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  116603. */
  116604. static get DoubleClickDelay(): number;
  116605. static set DoubleClickDelay(value: number);
  116606. /** If you need to check double click without raising a single click at first click, enable this flag */
  116607. static get ExclusiveDoubleClickMode(): boolean;
  116608. static set ExclusiveDoubleClickMode(value: boolean);
  116609. /** @hidden */
  116610. _mirroredCameraPosition: Nullable<Vector3>;
  116611. /**
  116612. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  116613. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  116614. */
  116615. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  116616. /**
  116617. * Observable event triggered each time an keyboard event is received from the hosting window
  116618. */
  116619. onKeyboardObservable: Observable<KeyboardInfo>;
  116620. private _useRightHandedSystem;
  116621. /**
  116622. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  116623. */
  116624. set useRightHandedSystem(value: boolean);
  116625. get useRightHandedSystem(): boolean;
  116626. private _timeAccumulator;
  116627. private _currentStepId;
  116628. private _currentInternalStep;
  116629. /**
  116630. * Sets the step Id used by deterministic lock step
  116631. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  116632. * @param newStepId defines the step Id
  116633. */
  116634. setStepId(newStepId: number): void;
  116635. /**
  116636. * Gets the step Id used by deterministic lock step
  116637. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  116638. * @returns the step Id
  116639. */
  116640. getStepId(): number;
  116641. /**
  116642. * Gets the internal step used by deterministic lock step
  116643. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  116644. * @returns the internal step
  116645. */
  116646. getInternalStep(): number;
  116647. private _fogEnabled;
  116648. /**
  116649. * Gets or sets a boolean indicating if fog is enabled on this scene
  116650. * @see http://doc.babylonjs.com/babylon101/environment#fog
  116651. * (Default is true)
  116652. */
  116653. set fogEnabled(value: boolean);
  116654. get fogEnabled(): boolean;
  116655. private _fogMode;
  116656. /**
  116657. * Gets or sets the fog mode to use
  116658. * @see http://doc.babylonjs.com/babylon101/environment#fog
  116659. * | mode | value |
  116660. * | --- | --- |
  116661. * | FOGMODE_NONE | 0 |
  116662. * | FOGMODE_EXP | 1 |
  116663. * | FOGMODE_EXP2 | 2 |
  116664. * | FOGMODE_LINEAR | 3 |
  116665. */
  116666. set fogMode(value: number);
  116667. get fogMode(): number;
  116668. /**
  116669. * Gets or sets the fog color to use
  116670. * @see http://doc.babylonjs.com/babylon101/environment#fog
  116671. * (Default is Color3(0.2, 0.2, 0.3))
  116672. */
  116673. fogColor: Color3;
  116674. /**
  116675. * Gets or sets the fog density to use
  116676. * @see http://doc.babylonjs.com/babylon101/environment#fog
  116677. * (Default is 0.1)
  116678. */
  116679. fogDensity: number;
  116680. /**
  116681. * Gets or sets the fog start distance to use
  116682. * @see http://doc.babylonjs.com/babylon101/environment#fog
  116683. * (Default is 0)
  116684. */
  116685. fogStart: number;
  116686. /**
  116687. * Gets or sets the fog end distance to use
  116688. * @see http://doc.babylonjs.com/babylon101/environment#fog
  116689. * (Default is 1000)
  116690. */
  116691. fogEnd: number;
  116692. private _shadowsEnabled;
  116693. /**
  116694. * Gets or sets a boolean indicating if shadows are enabled on this scene
  116695. */
  116696. set shadowsEnabled(value: boolean);
  116697. get shadowsEnabled(): boolean;
  116698. private _lightsEnabled;
  116699. /**
  116700. * Gets or sets a boolean indicating if lights are enabled on this scene
  116701. */
  116702. set lightsEnabled(value: boolean);
  116703. get lightsEnabled(): boolean;
  116704. /** All of the active cameras added to this scene. */
  116705. activeCameras: Camera[];
  116706. /** @hidden */
  116707. _activeCamera: Nullable<Camera>;
  116708. /** Gets or sets the current active camera */
  116709. get activeCamera(): Nullable<Camera>;
  116710. set activeCamera(value: Nullable<Camera>);
  116711. private _defaultMaterial;
  116712. /** The default material used on meshes when no material is affected */
  116713. get defaultMaterial(): Material;
  116714. /** The default material used on meshes when no material is affected */
  116715. set defaultMaterial(value: Material);
  116716. private _texturesEnabled;
  116717. /**
  116718. * Gets or sets a boolean indicating if textures are enabled on this scene
  116719. */
  116720. set texturesEnabled(value: boolean);
  116721. get texturesEnabled(): boolean;
  116722. /**
  116723. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  116724. */
  116725. physicsEnabled: boolean;
  116726. /**
  116727. * Gets or sets a boolean indicating if particles are enabled on this scene
  116728. */
  116729. particlesEnabled: boolean;
  116730. /**
  116731. * Gets or sets a boolean indicating if sprites are enabled on this scene
  116732. */
  116733. spritesEnabled: boolean;
  116734. private _skeletonsEnabled;
  116735. /**
  116736. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  116737. */
  116738. set skeletonsEnabled(value: boolean);
  116739. get skeletonsEnabled(): boolean;
  116740. /**
  116741. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  116742. */
  116743. lensFlaresEnabled: boolean;
  116744. /**
  116745. * Gets or sets a boolean indicating if collisions are enabled on this scene
  116746. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  116747. */
  116748. collisionsEnabled: boolean;
  116749. private _collisionCoordinator;
  116750. /** @hidden */
  116751. get collisionCoordinator(): ICollisionCoordinator;
  116752. /**
  116753. * Defines the gravity applied to this scene (used only for collisions)
  116754. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  116755. */
  116756. gravity: Vector3;
  116757. /**
  116758. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  116759. */
  116760. postProcessesEnabled: boolean;
  116761. /**
  116762. * The list of postprocesses added to the scene
  116763. */
  116764. postProcesses: PostProcess[];
  116765. /**
  116766. * Gets the current postprocess manager
  116767. */
  116768. postProcessManager: PostProcessManager;
  116769. /**
  116770. * Gets or sets a boolean indicating if render targets are enabled on this scene
  116771. */
  116772. renderTargetsEnabled: boolean;
  116773. /**
  116774. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  116775. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  116776. */
  116777. dumpNextRenderTargets: boolean;
  116778. /**
  116779. * The list of user defined render targets added to the scene
  116780. */
  116781. customRenderTargets: RenderTargetTexture[];
  116782. /**
  116783. * Defines if texture loading must be delayed
  116784. * If true, textures will only be loaded when they need to be rendered
  116785. */
  116786. useDelayedTextureLoading: boolean;
  116787. /**
  116788. * Gets the list of meshes imported to the scene through SceneLoader
  116789. */
  116790. importedMeshesFiles: String[];
  116791. /**
  116792. * Gets or sets a boolean indicating if probes are enabled on this scene
  116793. */
  116794. probesEnabled: boolean;
  116795. /**
  116796. * Gets or sets the current offline provider to use to store scene data
  116797. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  116798. */
  116799. offlineProvider: IOfflineProvider;
  116800. /**
  116801. * Gets or sets the action manager associated with the scene
  116802. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  116803. */
  116804. actionManager: AbstractActionManager;
  116805. private _meshesForIntersections;
  116806. /**
  116807. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  116808. */
  116809. proceduralTexturesEnabled: boolean;
  116810. private _engine;
  116811. private _totalVertices;
  116812. /** @hidden */
  116813. _activeIndices: PerfCounter;
  116814. /** @hidden */
  116815. _activeParticles: PerfCounter;
  116816. /** @hidden */
  116817. _activeBones: PerfCounter;
  116818. private _animationRatio;
  116819. /** @hidden */
  116820. _animationTimeLast: number;
  116821. /** @hidden */
  116822. _animationTime: number;
  116823. /**
  116824. * Gets or sets a general scale for animation speed
  116825. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  116826. */
  116827. animationTimeScale: number;
  116828. /** @hidden */
  116829. _cachedMaterial: Nullable<Material>;
  116830. /** @hidden */
  116831. _cachedEffect: Nullable<Effect>;
  116832. /** @hidden */
  116833. _cachedVisibility: Nullable<number>;
  116834. private _renderId;
  116835. private _frameId;
  116836. private _executeWhenReadyTimeoutId;
  116837. private _intermediateRendering;
  116838. private _viewUpdateFlag;
  116839. private _projectionUpdateFlag;
  116840. /** @hidden */
  116841. _toBeDisposed: Nullable<IDisposable>[];
  116842. private _activeRequests;
  116843. /** @hidden */
  116844. _pendingData: any[];
  116845. private _isDisposed;
  116846. /**
  116847. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  116848. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  116849. */
  116850. dispatchAllSubMeshesOfActiveMeshes: boolean;
  116851. private _activeMeshes;
  116852. private _processedMaterials;
  116853. private _renderTargets;
  116854. /** @hidden */
  116855. _activeParticleSystems: SmartArray<IParticleSystem>;
  116856. private _activeSkeletons;
  116857. private _softwareSkinnedMeshes;
  116858. private _renderingManager;
  116859. /** @hidden */
  116860. _activeAnimatables: Animatable[];
  116861. private _transformMatrix;
  116862. private _sceneUbo;
  116863. /** @hidden */
  116864. _viewMatrix: Matrix;
  116865. private _projectionMatrix;
  116866. /** @hidden */
  116867. _forcedViewPosition: Nullable<Vector3>;
  116868. /** @hidden */
  116869. _frustumPlanes: Plane[];
  116870. /**
  116871. * Gets the list of frustum planes (built from the active camera)
  116872. */
  116873. get frustumPlanes(): Plane[];
  116874. /**
  116875. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  116876. * This is useful if there are more lights that the maximum simulteanous authorized
  116877. */
  116878. requireLightSorting: boolean;
  116879. /** @hidden */
  116880. readonly useMaterialMeshMap: boolean;
  116881. /** @hidden */
  116882. readonly useClonedMeshMap: boolean;
  116883. private _externalData;
  116884. private _uid;
  116885. /**
  116886. * @hidden
  116887. * Backing store of defined scene components.
  116888. */
  116889. _components: ISceneComponent[];
  116890. /**
  116891. * @hidden
  116892. * Backing store of defined scene components.
  116893. */
  116894. _serializableComponents: ISceneSerializableComponent[];
  116895. /**
  116896. * List of components to register on the next registration step.
  116897. */
  116898. private _transientComponents;
  116899. /**
  116900. * Registers the transient components if needed.
  116901. */
  116902. private _registerTransientComponents;
  116903. /**
  116904. * @hidden
  116905. * Add a component to the scene.
  116906. * Note that the ccomponent could be registered on th next frame if this is called after
  116907. * the register component stage.
  116908. * @param component Defines the component to add to the scene
  116909. */
  116910. _addComponent(component: ISceneComponent): void;
  116911. /**
  116912. * @hidden
  116913. * Gets a component from the scene.
  116914. * @param name defines the name of the component to retrieve
  116915. * @returns the component or null if not present
  116916. */
  116917. _getComponent(name: string): Nullable<ISceneComponent>;
  116918. /**
  116919. * @hidden
  116920. * Defines the actions happening before camera updates.
  116921. */
  116922. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  116923. /**
  116924. * @hidden
  116925. * Defines the actions happening before clear the canvas.
  116926. */
  116927. _beforeClearStage: Stage<SimpleStageAction>;
  116928. /**
  116929. * @hidden
  116930. * Defines the actions when collecting render targets for the frame.
  116931. */
  116932. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  116933. /**
  116934. * @hidden
  116935. * Defines the actions happening for one camera in the frame.
  116936. */
  116937. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  116938. /**
  116939. * @hidden
  116940. * Defines the actions happening during the per mesh ready checks.
  116941. */
  116942. _isReadyForMeshStage: Stage<MeshStageAction>;
  116943. /**
  116944. * @hidden
  116945. * Defines the actions happening before evaluate active mesh checks.
  116946. */
  116947. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  116948. /**
  116949. * @hidden
  116950. * Defines the actions happening during the evaluate sub mesh checks.
  116951. */
  116952. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  116953. /**
  116954. * @hidden
  116955. * Defines the actions happening during the active mesh stage.
  116956. */
  116957. _activeMeshStage: Stage<ActiveMeshStageAction>;
  116958. /**
  116959. * @hidden
  116960. * Defines the actions happening during the per camera render target step.
  116961. */
  116962. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  116963. /**
  116964. * @hidden
  116965. * Defines the actions happening just before the active camera is drawing.
  116966. */
  116967. _beforeCameraDrawStage: Stage<CameraStageAction>;
  116968. /**
  116969. * @hidden
  116970. * Defines the actions happening just before a render target is drawing.
  116971. */
  116972. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  116973. /**
  116974. * @hidden
  116975. * Defines the actions happening just before a rendering group is drawing.
  116976. */
  116977. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  116978. /**
  116979. * @hidden
  116980. * Defines the actions happening just before a mesh is drawing.
  116981. */
  116982. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  116983. /**
  116984. * @hidden
  116985. * Defines the actions happening just after a mesh has been drawn.
  116986. */
  116987. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  116988. /**
  116989. * @hidden
  116990. * Defines the actions happening just after a rendering group has been drawn.
  116991. */
  116992. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  116993. /**
  116994. * @hidden
  116995. * Defines the actions happening just after the active camera has been drawn.
  116996. */
  116997. _afterCameraDrawStage: Stage<CameraStageAction>;
  116998. /**
  116999. * @hidden
  117000. * Defines the actions happening just after a render target has been drawn.
  117001. */
  117002. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  117003. /**
  117004. * @hidden
  117005. * Defines the actions happening just after rendering all cameras and computing intersections.
  117006. */
  117007. _afterRenderStage: Stage<SimpleStageAction>;
  117008. /**
  117009. * @hidden
  117010. * Defines the actions happening when a pointer move event happens.
  117011. */
  117012. _pointerMoveStage: Stage<PointerMoveStageAction>;
  117013. /**
  117014. * @hidden
  117015. * Defines the actions happening when a pointer down event happens.
  117016. */
  117017. _pointerDownStage: Stage<PointerUpDownStageAction>;
  117018. /**
  117019. * @hidden
  117020. * Defines the actions happening when a pointer up event happens.
  117021. */
  117022. _pointerUpStage: Stage<PointerUpDownStageAction>;
  117023. /**
  117024. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  117025. */
  117026. private geometriesByUniqueId;
  117027. /**
  117028. * Creates a new Scene
  117029. * @param engine defines the engine to use to render this scene
  117030. * @param options defines the scene options
  117031. */
  117032. constructor(engine: Engine, options?: SceneOptions);
  117033. /**
  117034. * Gets a string idenfifying the name of the class
  117035. * @returns "Scene" string
  117036. */
  117037. getClassName(): string;
  117038. private _defaultMeshCandidates;
  117039. /**
  117040. * @hidden
  117041. */
  117042. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  117043. private _defaultSubMeshCandidates;
  117044. /**
  117045. * @hidden
  117046. */
  117047. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  117048. /**
  117049. * Sets the default candidate providers for the scene.
  117050. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  117051. * and getCollidingSubMeshCandidates to their default function
  117052. */
  117053. setDefaultCandidateProviders(): void;
  117054. /**
  117055. * Gets the mesh that is currently under the pointer
  117056. */
  117057. get meshUnderPointer(): Nullable<AbstractMesh>;
  117058. /**
  117059. * Gets or sets the current on-screen X position of the pointer
  117060. */
  117061. get pointerX(): number;
  117062. set pointerX(value: number);
  117063. /**
  117064. * Gets or sets the current on-screen Y position of the pointer
  117065. */
  117066. get pointerY(): number;
  117067. set pointerY(value: number);
  117068. /**
  117069. * Gets the cached material (ie. the latest rendered one)
  117070. * @returns the cached material
  117071. */
  117072. getCachedMaterial(): Nullable<Material>;
  117073. /**
  117074. * Gets the cached effect (ie. the latest rendered one)
  117075. * @returns the cached effect
  117076. */
  117077. getCachedEffect(): Nullable<Effect>;
  117078. /**
  117079. * Gets the cached visibility state (ie. the latest rendered one)
  117080. * @returns the cached visibility state
  117081. */
  117082. getCachedVisibility(): Nullable<number>;
  117083. /**
  117084. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  117085. * @param material defines the current material
  117086. * @param effect defines the current effect
  117087. * @param visibility defines the current visibility state
  117088. * @returns true if one parameter is not cached
  117089. */
  117090. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  117091. /**
  117092. * Gets the engine associated with the scene
  117093. * @returns an Engine
  117094. */
  117095. getEngine(): Engine;
  117096. /**
  117097. * Gets the total number of vertices rendered per frame
  117098. * @returns the total number of vertices rendered per frame
  117099. */
  117100. getTotalVertices(): number;
  117101. /**
  117102. * Gets the performance counter for total vertices
  117103. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  117104. */
  117105. get totalVerticesPerfCounter(): PerfCounter;
  117106. /**
  117107. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  117108. * @returns the total number of active indices rendered per frame
  117109. */
  117110. getActiveIndices(): number;
  117111. /**
  117112. * Gets the performance counter for active indices
  117113. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  117114. */
  117115. get totalActiveIndicesPerfCounter(): PerfCounter;
  117116. /**
  117117. * Gets the total number of active particles rendered per frame
  117118. * @returns the total number of active particles rendered per frame
  117119. */
  117120. getActiveParticles(): number;
  117121. /**
  117122. * Gets the performance counter for active particles
  117123. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  117124. */
  117125. get activeParticlesPerfCounter(): PerfCounter;
  117126. /**
  117127. * Gets the total number of active bones rendered per frame
  117128. * @returns the total number of active bones rendered per frame
  117129. */
  117130. getActiveBones(): number;
  117131. /**
  117132. * Gets the performance counter for active bones
  117133. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  117134. */
  117135. get activeBonesPerfCounter(): PerfCounter;
  117136. /**
  117137. * Gets the array of active meshes
  117138. * @returns an array of AbstractMesh
  117139. */
  117140. getActiveMeshes(): SmartArray<AbstractMesh>;
  117141. /**
  117142. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  117143. * @returns a number
  117144. */
  117145. getAnimationRatio(): number;
  117146. /**
  117147. * Gets an unique Id for the current render phase
  117148. * @returns a number
  117149. */
  117150. getRenderId(): number;
  117151. /**
  117152. * Gets an unique Id for the current frame
  117153. * @returns a number
  117154. */
  117155. getFrameId(): number;
  117156. /** Call this function if you want to manually increment the render Id*/
  117157. incrementRenderId(): void;
  117158. private _createUbo;
  117159. /**
  117160. * Use this method to simulate a pointer move on a mesh
  117161. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  117162. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  117163. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  117164. * @returns the current scene
  117165. */
  117166. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  117167. /**
  117168. * Use this method to simulate a pointer down on a mesh
  117169. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  117170. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  117171. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  117172. * @returns the current scene
  117173. */
  117174. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  117175. /**
  117176. * Use this method to simulate a pointer up on a mesh
  117177. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  117178. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  117179. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  117180. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  117181. * @returns the current scene
  117182. */
  117183. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  117184. /**
  117185. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  117186. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  117187. * @returns true if the pointer was captured
  117188. */
  117189. isPointerCaptured(pointerId?: number): boolean;
  117190. /**
  117191. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  117192. * @param attachUp defines if you want to attach events to pointerup
  117193. * @param attachDown defines if you want to attach events to pointerdown
  117194. * @param attachMove defines if you want to attach events to pointermove
  117195. */
  117196. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  117197. /** Detaches all event handlers*/
  117198. detachControl(): void;
  117199. /**
  117200. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  117201. * Delay loaded resources are not taking in account
  117202. * @return true if all required resources are ready
  117203. */
  117204. isReady(): boolean;
  117205. /** Resets all cached information relative to material (including effect and visibility) */
  117206. resetCachedMaterial(): void;
  117207. /**
  117208. * Registers a function to be called before every frame render
  117209. * @param func defines the function to register
  117210. */
  117211. registerBeforeRender(func: () => void): void;
  117212. /**
  117213. * Unregisters a function called before every frame render
  117214. * @param func defines the function to unregister
  117215. */
  117216. unregisterBeforeRender(func: () => void): void;
  117217. /**
  117218. * Registers a function to be called after every frame render
  117219. * @param func defines the function to register
  117220. */
  117221. registerAfterRender(func: () => void): void;
  117222. /**
  117223. * Unregisters a function called after every frame render
  117224. * @param func defines the function to unregister
  117225. */
  117226. unregisterAfterRender(func: () => void): void;
  117227. private _executeOnceBeforeRender;
  117228. /**
  117229. * The provided function will run before render once and will be disposed afterwards.
  117230. * A timeout delay can be provided so that the function will be executed in N ms.
  117231. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  117232. * @param func The function to be executed.
  117233. * @param timeout optional delay in ms
  117234. */
  117235. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  117236. /** @hidden */
  117237. _addPendingData(data: any): void;
  117238. /** @hidden */
  117239. _removePendingData(data: any): void;
  117240. /**
  117241. * Returns the number of items waiting to be loaded
  117242. * @returns the number of items waiting to be loaded
  117243. */
  117244. getWaitingItemsCount(): number;
  117245. /**
  117246. * Returns a boolean indicating if the scene is still loading data
  117247. */
  117248. get isLoading(): boolean;
  117249. /**
  117250. * Registers a function to be executed when the scene is ready
  117251. * @param {Function} func - the function to be executed
  117252. */
  117253. executeWhenReady(func: () => void): void;
  117254. /**
  117255. * Returns a promise that resolves when the scene is ready
  117256. * @returns A promise that resolves when the scene is ready
  117257. */
  117258. whenReadyAsync(): Promise<void>;
  117259. /** @hidden */
  117260. _checkIsReady(): void;
  117261. /**
  117262. * Gets all animatable attached to the scene
  117263. */
  117264. get animatables(): Animatable[];
  117265. /**
  117266. * Resets the last animation time frame.
  117267. * Useful to override when animations start running when loading a scene for the first time.
  117268. */
  117269. resetLastAnimationTimeFrame(): void;
  117270. /**
  117271. * Gets the current view matrix
  117272. * @returns a Matrix
  117273. */
  117274. getViewMatrix(): Matrix;
  117275. /**
  117276. * Gets the current projection matrix
  117277. * @returns a Matrix
  117278. */
  117279. getProjectionMatrix(): Matrix;
  117280. /**
  117281. * Gets the current transform matrix
  117282. * @returns a Matrix made of View * Projection
  117283. */
  117284. getTransformMatrix(): Matrix;
  117285. /**
  117286. * Sets the current transform matrix
  117287. * @param viewL defines the View matrix to use
  117288. * @param projectionL defines the Projection matrix to use
  117289. * @param viewR defines the right View matrix to use (if provided)
  117290. * @param projectionR defines the right Projection matrix to use (if provided)
  117291. */
  117292. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  117293. /**
  117294. * Gets the uniform buffer used to store scene data
  117295. * @returns a UniformBuffer
  117296. */
  117297. getSceneUniformBuffer(): UniformBuffer;
  117298. /**
  117299. * Gets an unique (relatively to the current scene) Id
  117300. * @returns an unique number for the scene
  117301. */
  117302. getUniqueId(): number;
  117303. /**
  117304. * Add a mesh to the list of scene's meshes
  117305. * @param newMesh defines the mesh to add
  117306. * @param recursive if all child meshes should also be added to the scene
  117307. */
  117308. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  117309. /**
  117310. * Remove a mesh for the list of scene's meshes
  117311. * @param toRemove defines the mesh to remove
  117312. * @param recursive if all child meshes should also be removed from the scene
  117313. * @returns the index where the mesh was in the mesh list
  117314. */
  117315. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  117316. /**
  117317. * Add a transform node to the list of scene's transform nodes
  117318. * @param newTransformNode defines the transform node to add
  117319. */
  117320. addTransformNode(newTransformNode: TransformNode): void;
  117321. /**
  117322. * Remove a transform node for the list of scene's transform nodes
  117323. * @param toRemove defines the transform node to remove
  117324. * @returns the index where the transform node was in the transform node list
  117325. */
  117326. removeTransformNode(toRemove: TransformNode): number;
  117327. /**
  117328. * Remove a skeleton for the list of scene's skeletons
  117329. * @param toRemove defines the skeleton to remove
  117330. * @returns the index where the skeleton was in the skeleton list
  117331. */
  117332. removeSkeleton(toRemove: Skeleton): number;
  117333. /**
  117334. * Remove a morph target for the list of scene's morph targets
  117335. * @param toRemove defines the morph target to remove
  117336. * @returns the index where the morph target was in the morph target list
  117337. */
  117338. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  117339. /**
  117340. * Remove a light for the list of scene's lights
  117341. * @param toRemove defines the light to remove
  117342. * @returns the index where the light was in the light list
  117343. */
  117344. removeLight(toRemove: Light): number;
  117345. /**
  117346. * Remove a camera for the list of scene's cameras
  117347. * @param toRemove defines the camera to remove
  117348. * @returns the index where the camera was in the camera list
  117349. */
  117350. removeCamera(toRemove: Camera): number;
  117351. /**
  117352. * Remove a particle system for the list of scene's particle systems
  117353. * @param toRemove defines the particle system to remove
  117354. * @returns the index where the particle system was in the particle system list
  117355. */
  117356. removeParticleSystem(toRemove: IParticleSystem): number;
  117357. /**
  117358. * Remove a animation for the list of scene's animations
  117359. * @param toRemove defines the animation to remove
  117360. * @returns the index where the animation was in the animation list
  117361. */
  117362. removeAnimation(toRemove: Animation): number;
  117363. /**
  117364. * Will stop the animation of the given target
  117365. * @param target - the target
  117366. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  117367. * @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)
  117368. */
  117369. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  117370. /**
  117371. * Removes the given animation group from this scene.
  117372. * @param toRemove The animation group to remove
  117373. * @returns The index of the removed animation group
  117374. */
  117375. removeAnimationGroup(toRemove: AnimationGroup): number;
  117376. /**
  117377. * Removes the given multi-material from this scene.
  117378. * @param toRemove The multi-material to remove
  117379. * @returns The index of the removed multi-material
  117380. */
  117381. removeMultiMaterial(toRemove: MultiMaterial): number;
  117382. /**
  117383. * Removes the given material from this scene.
  117384. * @param toRemove The material to remove
  117385. * @returns The index of the removed material
  117386. */
  117387. removeMaterial(toRemove: Material): number;
  117388. /**
  117389. * Removes the given action manager from this scene.
  117390. * @param toRemove The action manager to remove
  117391. * @returns The index of the removed action manager
  117392. */
  117393. removeActionManager(toRemove: AbstractActionManager): number;
  117394. /**
  117395. * Removes the given texture from this scene.
  117396. * @param toRemove The texture to remove
  117397. * @returns The index of the removed texture
  117398. */
  117399. removeTexture(toRemove: BaseTexture): number;
  117400. /**
  117401. * Adds the given light to this scene
  117402. * @param newLight The light to add
  117403. */
  117404. addLight(newLight: Light): void;
  117405. /**
  117406. * Sorts the list list based on light priorities
  117407. */
  117408. sortLightsByPriority(): void;
  117409. /**
  117410. * Adds the given camera to this scene
  117411. * @param newCamera The camera to add
  117412. */
  117413. addCamera(newCamera: Camera): void;
  117414. /**
  117415. * Adds the given skeleton to this scene
  117416. * @param newSkeleton The skeleton to add
  117417. */
  117418. addSkeleton(newSkeleton: Skeleton): void;
  117419. /**
  117420. * Adds the given particle system to this scene
  117421. * @param newParticleSystem The particle system to add
  117422. */
  117423. addParticleSystem(newParticleSystem: IParticleSystem): void;
  117424. /**
  117425. * Adds the given animation to this scene
  117426. * @param newAnimation The animation to add
  117427. */
  117428. addAnimation(newAnimation: Animation): void;
  117429. /**
  117430. * Adds the given animation group to this scene.
  117431. * @param newAnimationGroup The animation group to add
  117432. */
  117433. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  117434. /**
  117435. * Adds the given multi-material to this scene
  117436. * @param newMultiMaterial The multi-material to add
  117437. */
  117438. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  117439. /**
  117440. * Adds the given material to this scene
  117441. * @param newMaterial The material to add
  117442. */
  117443. addMaterial(newMaterial: Material): void;
  117444. /**
  117445. * Adds the given morph target to this scene
  117446. * @param newMorphTargetManager The morph target to add
  117447. */
  117448. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  117449. /**
  117450. * Adds the given geometry to this scene
  117451. * @param newGeometry The geometry to add
  117452. */
  117453. addGeometry(newGeometry: Geometry): void;
  117454. /**
  117455. * Adds the given action manager to this scene
  117456. * @param newActionManager The action manager to add
  117457. */
  117458. addActionManager(newActionManager: AbstractActionManager): void;
  117459. /**
  117460. * Adds the given texture to this scene.
  117461. * @param newTexture The texture to add
  117462. */
  117463. addTexture(newTexture: BaseTexture): void;
  117464. /**
  117465. * Switch active camera
  117466. * @param newCamera defines the new active camera
  117467. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  117468. */
  117469. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  117470. /**
  117471. * sets the active camera of the scene using its ID
  117472. * @param id defines the camera's ID
  117473. * @return the new active camera or null if none found.
  117474. */
  117475. setActiveCameraByID(id: string): Nullable<Camera>;
  117476. /**
  117477. * sets the active camera of the scene using its name
  117478. * @param name defines the camera's name
  117479. * @returns the new active camera or null if none found.
  117480. */
  117481. setActiveCameraByName(name: string): Nullable<Camera>;
  117482. /**
  117483. * get an animation group using its name
  117484. * @param name defines the material's name
  117485. * @return the animation group or null if none found.
  117486. */
  117487. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  117488. /**
  117489. * Get a material using its unique id
  117490. * @param uniqueId defines the material's unique id
  117491. * @return the material or null if none found.
  117492. */
  117493. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  117494. /**
  117495. * get a material using its id
  117496. * @param id defines the material's ID
  117497. * @return the material or null if none found.
  117498. */
  117499. getMaterialByID(id: string): Nullable<Material>;
  117500. /**
  117501. * Gets a the last added material using a given id
  117502. * @param id defines the material's ID
  117503. * @return the last material with the given id or null if none found.
  117504. */
  117505. getLastMaterialByID(id: string): Nullable<Material>;
  117506. /**
  117507. * Gets a material using its name
  117508. * @param name defines the material's name
  117509. * @return the material or null if none found.
  117510. */
  117511. getMaterialByName(name: string): Nullable<Material>;
  117512. /**
  117513. * Get a texture using its unique id
  117514. * @param uniqueId defines the texture's unique id
  117515. * @return the texture or null if none found.
  117516. */
  117517. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  117518. /**
  117519. * Gets a camera using its id
  117520. * @param id defines the id to look for
  117521. * @returns the camera or null if not found
  117522. */
  117523. getCameraByID(id: string): Nullable<Camera>;
  117524. /**
  117525. * Gets a camera using its unique id
  117526. * @param uniqueId defines the unique id to look for
  117527. * @returns the camera or null if not found
  117528. */
  117529. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  117530. /**
  117531. * Gets a camera using its name
  117532. * @param name defines the camera's name
  117533. * @return the camera or null if none found.
  117534. */
  117535. getCameraByName(name: string): Nullable<Camera>;
  117536. /**
  117537. * Gets a bone using its id
  117538. * @param id defines the bone's id
  117539. * @return the bone or null if not found
  117540. */
  117541. getBoneByID(id: string): Nullable<Bone>;
  117542. /**
  117543. * Gets a bone using its id
  117544. * @param name defines the bone's name
  117545. * @return the bone or null if not found
  117546. */
  117547. getBoneByName(name: string): Nullable<Bone>;
  117548. /**
  117549. * Gets a light node using its name
  117550. * @param name defines the the light's name
  117551. * @return the light or null if none found.
  117552. */
  117553. getLightByName(name: string): Nullable<Light>;
  117554. /**
  117555. * Gets a light node using its id
  117556. * @param id defines the light's id
  117557. * @return the light or null if none found.
  117558. */
  117559. getLightByID(id: string): Nullable<Light>;
  117560. /**
  117561. * Gets a light node using its scene-generated unique ID
  117562. * @param uniqueId defines the light's unique id
  117563. * @return the light or null if none found.
  117564. */
  117565. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  117566. /**
  117567. * Gets a particle system by id
  117568. * @param id defines the particle system id
  117569. * @return the corresponding system or null if none found
  117570. */
  117571. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  117572. /**
  117573. * Gets a geometry using its ID
  117574. * @param id defines the geometry's id
  117575. * @return the geometry or null if none found.
  117576. */
  117577. getGeometryByID(id: string): Nullable<Geometry>;
  117578. private _getGeometryByUniqueID;
  117579. /**
  117580. * Add a new geometry to this scene
  117581. * @param geometry defines the geometry to be added to the scene.
  117582. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  117583. * @return a boolean defining if the geometry was added or not
  117584. */
  117585. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  117586. /**
  117587. * Removes an existing geometry
  117588. * @param geometry defines the geometry to be removed from the scene
  117589. * @return a boolean defining if the geometry was removed or not
  117590. */
  117591. removeGeometry(geometry: Geometry): boolean;
  117592. /**
  117593. * Gets the list of geometries attached to the scene
  117594. * @returns an array of Geometry
  117595. */
  117596. getGeometries(): Geometry[];
  117597. /**
  117598. * Gets the first added mesh found of a given ID
  117599. * @param id defines the id to search for
  117600. * @return the mesh found or null if not found at all
  117601. */
  117602. getMeshByID(id: string): Nullable<AbstractMesh>;
  117603. /**
  117604. * Gets a list of meshes using their id
  117605. * @param id defines the id to search for
  117606. * @returns a list of meshes
  117607. */
  117608. getMeshesByID(id: string): Array<AbstractMesh>;
  117609. /**
  117610. * Gets the first added transform node found of a given ID
  117611. * @param id defines the id to search for
  117612. * @return the found transform node or null if not found at all.
  117613. */
  117614. getTransformNodeByID(id: string): Nullable<TransformNode>;
  117615. /**
  117616. * Gets a transform node with its auto-generated unique id
  117617. * @param uniqueId efines the unique id to search for
  117618. * @return the found transform node or null if not found at all.
  117619. */
  117620. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  117621. /**
  117622. * Gets a list of transform nodes using their id
  117623. * @param id defines the id to search for
  117624. * @returns a list of transform nodes
  117625. */
  117626. getTransformNodesByID(id: string): Array<TransformNode>;
  117627. /**
  117628. * Gets a mesh with its auto-generated unique id
  117629. * @param uniqueId defines the unique id to search for
  117630. * @return the found mesh or null if not found at all.
  117631. */
  117632. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  117633. /**
  117634. * Gets a the last added mesh using a given id
  117635. * @param id defines the id to search for
  117636. * @return the found mesh or null if not found at all.
  117637. */
  117638. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  117639. /**
  117640. * Gets a the last added node (Mesh, Camera, Light) using a given id
  117641. * @param id defines the id to search for
  117642. * @return the found node or null if not found at all
  117643. */
  117644. getLastEntryByID(id: string): Nullable<Node>;
  117645. /**
  117646. * Gets a node (Mesh, Camera, Light) using a given id
  117647. * @param id defines the id to search for
  117648. * @return the found node or null if not found at all
  117649. */
  117650. getNodeByID(id: string): Nullable<Node>;
  117651. /**
  117652. * Gets a node (Mesh, Camera, Light) using a given name
  117653. * @param name defines the name to search for
  117654. * @return the found node or null if not found at all.
  117655. */
  117656. getNodeByName(name: string): Nullable<Node>;
  117657. /**
  117658. * Gets a mesh using a given name
  117659. * @param name defines the name to search for
  117660. * @return the found mesh or null if not found at all.
  117661. */
  117662. getMeshByName(name: string): Nullable<AbstractMesh>;
  117663. /**
  117664. * Gets a transform node using a given name
  117665. * @param name defines the name to search for
  117666. * @return the found transform node or null if not found at all.
  117667. */
  117668. getTransformNodeByName(name: string): Nullable<TransformNode>;
  117669. /**
  117670. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  117671. * @param id defines the id to search for
  117672. * @return the found skeleton or null if not found at all.
  117673. */
  117674. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  117675. /**
  117676. * Gets a skeleton using a given auto generated unique id
  117677. * @param uniqueId defines the unique id to search for
  117678. * @return the found skeleton or null if not found at all.
  117679. */
  117680. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  117681. /**
  117682. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  117683. * @param id defines the id to search for
  117684. * @return the found skeleton or null if not found at all.
  117685. */
  117686. getSkeletonById(id: string): Nullable<Skeleton>;
  117687. /**
  117688. * Gets a skeleton using a given name
  117689. * @param name defines the name to search for
  117690. * @return the found skeleton or null if not found at all.
  117691. */
  117692. getSkeletonByName(name: string): Nullable<Skeleton>;
  117693. /**
  117694. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  117695. * @param id defines the id to search for
  117696. * @return the found morph target manager or null if not found at all.
  117697. */
  117698. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  117699. /**
  117700. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  117701. * @param id defines the id to search for
  117702. * @return the found morph target or null if not found at all.
  117703. */
  117704. getMorphTargetById(id: string): Nullable<MorphTarget>;
  117705. /**
  117706. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  117707. * @param name defines the name to search for
  117708. * @return the found morph target or null if not found at all.
  117709. */
  117710. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  117711. /**
  117712. * Gets a boolean indicating if the given mesh is active
  117713. * @param mesh defines the mesh to look for
  117714. * @returns true if the mesh is in the active list
  117715. */
  117716. isActiveMesh(mesh: AbstractMesh): boolean;
  117717. /**
  117718. * Return a unique id as a string which can serve as an identifier for the scene
  117719. */
  117720. get uid(): string;
  117721. /**
  117722. * Add an externaly attached data from its key.
  117723. * This method call will fail and return false, if such key already exists.
  117724. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  117725. * @param key the unique key that identifies the data
  117726. * @param data the data object to associate to the key for this Engine instance
  117727. * @return true if no such key were already present and the data was added successfully, false otherwise
  117728. */
  117729. addExternalData<T>(key: string, data: T): boolean;
  117730. /**
  117731. * Get an externaly attached data from its key
  117732. * @param key the unique key that identifies the data
  117733. * @return the associated data, if present (can be null), or undefined if not present
  117734. */
  117735. getExternalData<T>(key: string): Nullable<T>;
  117736. /**
  117737. * Get an externaly attached data from its key, create it using a factory if it's not already present
  117738. * @param key the unique key that identifies the data
  117739. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  117740. * @return the associated data, can be null if the factory returned null.
  117741. */
  117742. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  117743. /**
  117744. * Remove an externaly attached data from the Engine instance
  117745. * @param key the unique key that identifies the data
  117746. * @return true if the data was successfully removed, false if it doesn't exist
  117747. */
  117748. removeExternalData(key: string): boolean;
  117749. private _evaluateSubMesh;
  117750. /**
  117751. * Clear the processed materials smart array preventing retention point in material dispose.
  117752. */
  117753. freeProcessedMaterials(): void;
  117754. private _preventFreeActiveMeshesAndRenderingGroups;
  117755. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  117756. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  117757. * when disposing several meshes in a row or a hierarchy of meshes.
  117758. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  117759. */
  117760. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  117761. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  117762. /**
  117763. * Clear the active meshes smart array preventing retention point in mesh dispose.
  117764. */
  117765. freeActiveMeshes(): void;
  117766. /**
  117767. * Clear the info related to rendering groups preventing retention points during dispose.
  117768. */
  117769. freeRenderingGroups(): void;
  117770. /** @hidden */
  117771. _isInIntermediateRendering(): boolean;
  117772. /**
  117773. * Lambda returning the list of potentially active meshes.
  117774. */
  117775. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  117776. /**
  117777. * Lambda returning the list of potentially active sub meshes.
  117778. */
  117779. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  117780. /**
  117781. * Lambda returning the list of potentially intersecting sub meshes.
  117782. */
  117783. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  117784. /**
  117785. * Lambda returning the list of potentially colliding sub meshes.
  117786. */
  117787. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  117788. private _activeMeshesFrozen;
  117789. private _skipEvaluateActiveMeshesCompletely;
  117790. /**
  117791. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  117792. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  117793. * @returns the current scene
  117794. */
  117795. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  117796. /**
  117797. * Use this function to restart evaluating active meshes on every frame
  117798. * @returns the current scene
  117799. */
  117800. unfreezeActiveMeshes(): Scene;
  117801. private _evaluateActiveMeshes;
  117802. private _activeMesh;
  117803. /**
  117804. * Update the transform matrix to update from the current active camera
  117805. * @param force defines a boolean used to force the update even if cache is up to date
  117806. */
  117807. updateTransformMatrix(force?: boolean): void;
  117808. private _bindFrameBuffer;
  117809. /** @hidden */
  117810. _allowPostProcessClearColor: boolean;
  117811. /** @hidden */
  117812. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  117813. private _processSubCameras;
  117814. private _checkIntersections;
  117815. /** @hidden */
  117816. _advancePhysicsEngineStep(step: number): void;
  117817. /**
  117818. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  117819. */
  117820. getDeterministicFrameTime: () => number;
  117821. /** @hidden */
  117822. _animate(): void;
  117823. /** Execute all animations (for a frame) */
  117824. animate(): void;
  117825. /**
  117826. * Render the scene
  117827. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  117828. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  117829. */
  117830. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  117831. /**
  117832. * Freeze all materials
  117833. * A frozen material will not be updatable but should be faster to render
  117834. */
  117835. freezeMaterials(): void;
  117836. /**
  117837. * Unfreeze all materials
  117838. * A frozen material will not be updatable but should be faster to render
  117839. */
  117840. unfreezeMaterials(): void;
  117841. /**
  117842. * Releases all held ressources
  117843. */
  117844. dispose(): void;
  117845. /**
  117846. * Gets if the scene is already disposed
  117847. */
  117848. get isDisposed(): boolean;
  117849. /**
  117850. * Call this function to reduce memory footprint of the scene.
  117851. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  117852. */
  117853. clearCachedVertexData(): void;
  117854. /**
  117855. * This function will remove the local cached buffer data from texture.
  117856. * It will save memory but will prevent the texture from being rebuilt
  117857. */
  117858. cleanCachedTextureBuffer(): void;
  117859. /**
  117860. * Get the world extend vectors with an optional filter
  117861. *
  117862. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  117863. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  117864. */
  117865. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  117866. min: Vector3;
  117867. max: Vector3;
  117868. };
  117869. /**
  117870. * Creates a ray that can be used to pick in the scene
  117871. * @param x defines the x coordinate of the origin (on-screen)
  117872. * @param y defines the y coordinate of the origin (on-screen)
  117873. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  117874. * @param camera defines the camera to use for the picking
  117875. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  117876. * @returns a Ray
  117877. */
  117878. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  117879. /**
  117880. * Creates a ray that can be used to pick in the scene
  117881. * @param x defines the x coordinate of the origin (on-screen)
  117882. * @param y defines the y coordinate of the origin (on-screen)
  117883. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  117884. * @param result defines the ray where to store the picking ray
  117885. * @param camera defines the camera to use for the picking
  117886. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  117887. * @returns the current scene
  117888. */
  117889. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  117890. /**
  117891. * Creates a ray that can be used to pick in the scene
  117892. * @param x defines the x coordinate of the origin (on-screen)
  117893. * @param y defines the y coordinate of the origin (on-screen)
  117894. * @param camera defines the camera to use for the picking
  117895. * @returns a Ray
  117896. */
  117897. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  117898. /**
  117899. * Creates a ray that can be used to pick in the scene
  117900. * @param x defines the x coordinate of the origin (on-screen)
  117901. * @param y defines the y coordinate of the origin (on-screen)
  117902. * @param result defines the ray where to store the picking ray
  117903. * @param camera defines the camera to use for the picking
  117904. * @returns the current scene
  117905. */
  117906. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  117907. /** Launch a ray to try to pick a mesh in the scene
  117908. * @param x position on screen
  117909. * @param y position on screen
  117910. * @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
  117911. * @param fastCheck defines if the first intersection will be used (and not the closest)
  117912. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  117913. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  117914. * @returns a PickingInfo
  117915. */
  117916. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  117917. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  117918. * @param x position on screen
  117919. * @param y position on screen
  117920. * @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
  117921. * @param fastCheck defines if the first intersection will be used (and not the closest)
  117922. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  117923. * @returns a PickingInfo (Please note that some info will not be set like distance, bv, bu and everything that cannot be capture by only using bounding infos)
  117924. */
  117925. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  117926. /** Use the given ray to pick a mesh in the scene
  117927. * @param ray The ray to use to pick meshes
  117928. * @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
  117929. * @param fastCheck defines if the first intersection will be used (and not the closest)
  117930. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  117931. * @returns a PickingInfo
  117932. */
  117933. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  117934. /**
  117935. * Launch a ray to try to pick a mesh in the scene
  117936. * @param x X position on screen
  117937. * @param y Y position on screen
  117938. * @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
  117939. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  117940. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  117941. * @returns an array of PickingInfo
  117942. */
  117943. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  117944. /**
  117945. * Launch a ray to try to pick a mesh in the scene
  117946. * @param ray Ray to use
  117947. * @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
  117948. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  117949. * @returns an array of PickingInfo
  117950. */
  117951. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  117952. /**
  117953. * Force the value of meshUnderPointer
  117954. * @param mesh defines the mesh to use
  117955. */
  117956. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  117957. /**
  117958. * Gets the mesh under the pointer
  117959. * @returns a Mesh or null if no mesh is under the pointer
  117960. */
  117961. getPointerOverMesh(): Nullable<AbstractMesh>;
  117962. /** @hidden */
  117963. _rebuildGeometries(): void;
  117964. /** @hidden */
  117965. _rebuildTextures(): void;
  117966. private _getByTags;
  117967. /**
  117968. * Get a list of meshes by tags
  117969. * @param tagsQuery defines the tags query to use
  117970. * @param forEach defines a predicate used to filter results
  117971. * @returns an array of Mesh
  117972. */
  117973. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  117974. /**
  117975. * Get a list of cameras by tags
  117976. * @param tagsQuery defines the tags query to use
  117977. * @param forEach defines a predicate used to filter results
  117978. * @returns an array of Camera
  117979. */
  117980. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  117981. /**
  117982. * Get a list of lights by tags
  117983. * @param tagsQuery defines the tags query to use
  117984. * @param forEach defines a predicate used to filter results
  117985. * @returns an array of Light
  117986. */
  117987. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  117988. /**
  117989. * Get a list of materials by tags
  117990. * @param tagsQuery defines the tags query to use
  117991. * @param forEach defines a predicate used to filter results
  117992. * @returns an array of Material
  117993. */
  117994. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  117995. /**
  117996. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  117997. * This allowed control for front to back rendering or reversly depending of the special needs.
  117998. *
  117999. * @param renderingGroupId The rendering group id corresponding to its index
  118000. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  118001. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  118002. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  118003. */
  118004. 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;
  118005. /**
  118006. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  118007. *
  118008. * @param renderingGroupId The rendering group id corresponding to its index
  118009. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  118010. * @param depth Automatically clears depth between groups if true and autoClear is true.
  118011. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  118012. */
  118013. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  118014. /**
  118015. * Gets the current auto clear configuration for one rendering group of the rendering
  118016. * manager.
  118017. * @param index the rendering group index to get the information for
  118018. * @returns The auto clear setup for the requested rendering group
  118019. */
  118020. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  118021. private _blockMaterialDirtyMechanism;
  118022. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  118023. get blockMaterialDirtyMechanism(): boolean;
  118024. set blockMaterialDirtyMechanism(value: boolean);
  118025. /**
  118026. * Will flag all materials as dirty to trigger new shader compilation
  118027. * @param flag defines the flag used to specify which material part must be marked as dirty
  118028. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  118029. */
  118030. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  118031. /** @hidden */
  118032. _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;
  118033. /** @hidden */
  118034. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  118035. /** @hidden */
  118036. _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;
  118037. /** @hidden */
  118038. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  118039. /** @hidden */
  118040. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118041. /** @hidden */
  118042. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  118043. }
  118044. }
  118045. declare module BABYLON {
  118046. /**
  118047. * Set of assets to keep when moving a scene into an asset container.
  118048. */
  118049. export class KeepAssets extends AbstractScene {
  118050. }
  118051. /**
  118052. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  118053. */
  118054. export class InstantiatedEntries {
  118055. /**
  118056. * List of new root nodes (eg. nodes with no parent)
  118057. */
  118058. rootNodes: TransformNode[];
  118059. /**
  118060. * List of new skeletons
  118061. */
  118062. skeletons: Skeleton[];
  118063. /**
  118064. * List of new animation groups
  118065. */
  118066. animationGroups: AnimationGroup[];
  118067. }
  118068. /**
  118069. * Container with a set of assets that can be added or removed from a scene.
  118070. */
  118071. export class AssetContainer extends AbstractScene {
  118072. private _wasAddedToScene;
  118073. /**
  118074. * The scene the AssetContainer belongs to.
  118075. */
  118076. scene: Scene;
  118077. /**
  118078. * Instantiates an AssetContainer.
  118079. * @param scene The scene the AssetContainer belongs to.
  118080. */
  118081. constructor(scene: Scene);
  118082. /**
  118083. * Instantiate or clone all meshes and add the new ones to the scene.
  118084. * Skeletons and animation groups will all be cloned
  118085. * @param nameFunction defines an optional function used to get new names for clones
  118086. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  118087. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  118088. */
  118089. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  118090. /**
  118091. * Adds all the assets from the container to the scene.
  118092. */
  118093. addAllToScene(): void;
  118094. /**
  118095. * Removes all the assets in the container from the scene
  118096. */
  118097. removeAllFromScene(): void;
  118098. /**
  118099. * Disposes all the assets in the container
  118100. */
  118101. dispose(): void;
  118102. private _moveAssets;
  118103. /**
  118104. * Removes all the assets contained in the scene and adds them to the container.
  118105. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  118106. */
  118107. moveAllFromScene(keepAssets?: KeepAssets): void;
  118108. /**
  118109. * 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.
  118110. * @returns the root mesh
  118111. */
  118112. createRootMesh(): Mesh;
  118113. /**
  118114. * Merge animations (direct and animation groups) from this asset container into a scene
  118115. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  118116. * @param animatables set of animatables to retarget to a node from the scene
  118117. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  118118. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  118119. */
  118120. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  118121. }
  118122. }
  118123. declare module BABYLON {
  118124. /**
  118125. * Defines how the parser contract is defined.
  118126. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  118127. */
  118128. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  118129. /**
  118130. * Defines how the individual parser contract is defined.
  118131. * These parser can parse an individual asset
  118132. */
  118133. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  118134. /**
  118135. * Base class of the scene acting as a container for the different elements composing a scene.
  118136. * This class is dynamically extended by the different components of the scene increasing
  118137. * flexibility and reducing coupling
  118138. */
  118139. export abstract class AbstractScene {
  118140. /**
  118141. * Stores the list of available parsers in the application.
  118142. */
  118143. private static _BabylonFileParsers;
  118144. /**
  118145. * Stores the list of available individual parsers in the application.
  118146. */
  118147. private static _IndividualBabylonFileParsers;
  118148. /**
  118149. * Adds a parser in the list of available ones
  118150. * @param name Defines the name of the parser
  118151. * @param parser Defines the parser to add
  118152. */
  118153. static AddParser(name: string, parser: BabylonFileParser): void;
  118154. /**
  118155. * Gets a general parser from the list of avaialble ones
  118156. * @param name Defines the name of the parser
  118157. * @returns the requested parser or null
  118158. */
  118159. static GetParser(name: string): Nullable<BabylonFileParser>;
  118160. /**
  118161. * Adds n individual parser in the list of available ones
  118162. * @param name Defines the name of the parser
  118163. * @param parser Defines the parser to add
  118164. */
  118165. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  118166. /**
  118167. * Gets an individual parser from the list of avaialble ones
  118168. * @param name Defines the name of the parser
  118169. * @returns the requested parser or null
  118170. */
  118171. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  118172. /**
  118173. * Parser json data and populate both a scene and its associated container object
  118174. * @param jsonData Defines the data to parse
  118175. * @param scene Defines the scene to parse the data for
  118176. * @param container Defines the container attached to the parsing sequence
  118177. * @param rootUrl Defines the root url of the data
  118178. */
  118179. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  118180. /**
  118181. * Gets the list of root nodes (ie. nodes with no parent)
  118182. */
  118183. rootNodes: Node[];
  118184. /** All of the cameras added to this scene
  118185. * @see http://doc.babylonjs.com/babylon101/cameras
  118186. */
  118187. cameras: Camera[];
  118188. /**
  118189. * All of the lights added to this scene
  118190. * @see http://doc.babylonjs.com/babylon101/lights
  118191. */
  118192. lights: Light[];
  118193. /**
  118194. * All of the (abstract) meshes added to this scene
  118195. */
  118196. meshes: AbstractMesh[];
  118197. /**
  118198. * The list of skeletons added to the scene
  118199. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  118200. */
  118201. skeletons: Skeleton[];
  118202. /**
  118203. * All of the particle systems added to this scene
  118204. * @see http://doc.babylonjs.com/babylon101/particles
  118205. */
  118206. particleSystems: IParticleSystem[];
  118207. /**
  118208. * Gets a list of Animations associated with the scene
  118209. */
  118210. animations: Animation[];
  118211. /**
  118212. * All of the animation groups added to this scene
  118213. * @see http://doc.babylonjs.com/how_to/group
  118214. */
  118215. animationGroups: AnimationGroup[];
  118216. /**
  118217. * All of the multi-materials added to this scene
  118218. * @see http://doc.babylonjs.com/how_to/multi_materials
  118219. */
  118220. multiMaterials: MultiMaterial[];
  118221. /**
  118222. * All of the materials added to this scene
  118223. * In the context of a Scene, it is not supposed to be modified manually.
  118224. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  118225. * Note also that the order of the Material within the array is not significant and might change.
  118226. * @see http://doc.babylonjs.com/babylon101/materials
  118227. */
  118228. materials: Material[];
  118229. /**
  118230. * The list of morph target managers added to the scene
  118231. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  118232. */
  118233. morphTargetManagers: MorphTargetManager[];
  118234. /**
  118235. * The list of geometries used in the scene.
  118236. */
  118237. geometries: Geometry[];
  118238. /**
  118239. * All of the tranform nodes added to this scene
  118240. * In the context of a Scene, it is not supposed to be modified manually.
  118241. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  118242. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  118243. * @see http://doc.babylonjs.com/how_to/transformnode
  118244. */
  118245. transformNodes: TransformNode[];
  118246. /**
  118247. * ActionManagers available on the scene.
  118248. */
  118249. actionManagers: AbstractActionManager[];
  118250. /**
  118251. * Textures to keep.
  118252. */
  118253. textures: BaseTexture[];
  118254. /**
  118255. * Environment texture for the scene
  118256. */
  118257. environmentTexture: Nullable<BaseTexture>;
  118258. /**
  118259. * @returns all meshes, lights, cameras, transformNodes and bones
  118260. */
  118261. getNodes(): Array<Node>;
  118262. }
  118263. }
  118264. declare module BABYLON {
  118265. /**
  118266. * Interface used to define options for Sound class
  118267. */
  118268. export interface ISoundOptions {
  118269. /**
  118270. * Does the sound autoplay once loaded.
  118271. */
  118272. autoplay?: boolean;
  118273. /**
  118274. * Does the sound loop after it finishes playing once.
  118275. */
  118276. loop?: boolean;
  118277. /**
  118278. * Sound's volume
  118279. */
  118280. volume?: number;
  118281. /**
  118282. * Is it a spatial sound?
  118283. */
  118284. spatialSound?: boolean;
  118285. /**
  118286. * Maximum distance to hear that sound
  118287. */
  118288. maxDistance?: number;
  118289. /**
  118290. * Uses user defined attenuation function
  118291. */
  118292. useCustomAttenuation?: boolean;
  118293. /**
  118294. * Define the roll off factor of spatial sounds.
  118295. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118296. */
  118297. rolloffFactor?: number;
  118298. /**
  118299. * Define the reference distance the sound should be heard perfectly.
  118300. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118301. */
  118302. refDistance?: number;
  118303. /**
  118304. * Define the distance attenuation model the sound will follow.
  118305. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118306. */
  118307. distanceModel?: string;
  118308. /**
  118309. * Defines the playback speed (1 by default)
  118310. */
  118311. playbackRate?: number;
  118312. /**
  118313. * Defines if the sound is from a streaming source
  118314. */
  118315. streaming?: boolean;
  118316. /**
  118317. * Defines an optional length (in seconds) inside the sound file
  118318. */
  118319. length?: number;
  118320. /**
  118321. * Defines an optional offset (in seconds) inside the sound file
  118322. */
  118323. offset?: number;
  118324. /**
  118325. * If true, URLs will not be required to state the audio file codec to use.
  118326. */
  118327. skipCodecCheck?: boolean;
  118328. }
  118329. /**
  118330. * Defines a sound that can be played in the application.
  118331. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  118332. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  118333. */
  118334. export class Sound {
  118335. /**
  118336. * The name of the sound in the scene.
  118337. */
  118338. name: string;
  118339. /**
  118340. * Does the sound autoplay once loaded.
  118341. */
  118342. autoplay: boolean;
  118343. /**
  118344. * Does the sound loop after it finishes playing once.
  118345. */
  118346. loop: boolean;
  118347. /**
  118348. * Does the sound use a custom attenuation curve to simulate the falloff
  118349. * happening when the source gets further away from the camera.
  118350. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  118351. */
  118352. useCustomAttenuation: boolean;
  118353. /**
  118354. * The sound track id this sound belongs to.
  118355. */
  118356. soundTrackId: number;
  118357. /**
  118358. * Is this sound currently played.
  118359. */
  118360. isPlaying: boolean;
  118361. /**
  118362. * Is this sound currently paused.
  118363. */
  118364. isPaused: boolean;
  118365. /**
  118366. * Does this sound enables spatial sound.
  118367. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118368. */
  118369. spatialSound: boolean;
  118370. /**
  118371. * Define the reference distance the sound should be heard perfectly.
  118372. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118373. */
  118374. refDistance: number;
  118375. /**
  118376. * Define the roll off factor of spatial sounds.
  118377. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118378. */
  118379. rolloffFactor: number;
  118380. /**
  118381. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  118382. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118383. */
  118384. maxDistance: number;
  118385. /**
  118386. * Define the distance attenuation model the sound will follow.
  118387. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118388. */
  118389. distanceModel: string;
  118390. /**
  118391. * @hidden
  118392. * Back Compat
  118393. **/
  118394. onended: () => any;
  118395. /**
  118396. * Gets or sets an object used to store user defined information for the sound.
  118397. */
  118398. metadata: any;
  118399. /**
  118400. * Observable event when the current playing sound finishes.
  118401. */
  118402. onEndedObservable: Observable<Sound>;
  118403. private _panningModel;
  118404. private _playbackRate;
  118405. private _streaming;
  118406. private _startTime;
  118407. private _startOffset;
  118408. private _position;
  118409. /** @hidden */
  118410. _positionInEmitterSpace: boolean;
  118411. private _localDirection;
  118412. private _volume;
  118413. private _isReadyToPlay;
  118414. private _isDirectional;
  118415. private _readyToPlayCallback;
  118416. private _audioBuffer;
  118417. private _soundSource;
  118418. private _streamingSource;
  118419. private _soundPanner;
  118420. private _soundGain;
  118421. private _inputAudioNode;
  118422. private _outputAudioNode;
  118423. private _coneInnerAngle;
  118424. private _coneOuterAngle;
  118425. private _coneOuterGain;
  118426. private _scene;
  118427. private _connectedTransformNode;
  118428. private _customAttenuationFunction;
  118429. private _registerFunc;
  118430. private _isOutputConnected;
  118431. private _htmlAudioElement;
  118432. private _urlType;
  118433. private _length?;
  118434. private _offset?;
  118435. /** @hidden */
  118436. static _SceneComponentInitialization: (scene: Scene) => void;
  118437. /**
  118438. * Create a sound and attach it to a scene
  118439. * @param name Name of your sound
  118440. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  118441. * @param scene defines the scene the sound belongs to
  118442. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  118443. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  118444. */
  118445. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  118446. /**
  118447. * Release the sound and its associated resources
  118448. */
  118449. dispose(): void;
  118450. /**
  118451. * Gets if the sounds is ready to be played or not.
  118452. * @returns true if ready, otherwise false
  118453. */
  118454. isReady(): boolean;
  118455. private _soundLoaded;
  118456. /**
  118457. * Sets the data of the sound from an audiobuffer
  118458. * @param audioBuffer The audioBuffer containing the data
  118459. */
  118460. setAudioBuffer(audioBuffer: AudioBuffer): void;
  118461. /**
  118462. * Updates the current sounds options such as maxdistance, loop...
  118463. * @param options A JSON object containing values named as the object properties
  118464. */
  118465. updateOptions(options: ISoundOptions): void;
  118466. private _createSpatialParameters;
  118467. private _updateSpatialParameters;
  118468. /**
  118469. * Switch the panning model to HRTF:
  118470. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  118471. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118472. */
  118473. switchPanningModelToHRTF(): void;
  118474. /**
  118475. * Switch the panning model to Equal Power:
  118476. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  118477. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118478. */
  118479. switchPanningModelToEqualPower(): void;
  118480. private _switchPanningModel;
  118481. /**
  118482. * Connect this sound to a sound track audio node like gain...
  118483. * @param soundTrackAudioNode the sound track audio node to connect to
  118484. */
  118485. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  118486. /**
  118487. * Transform this sound into a directional source
  118488. * @param coneInnerAngle Size of the inner cone in degree
  118489. * @param coneOuterAngle Size of the outer cone in degree
  118490. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  118491. */
  118492. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  118493. /**
  118494. * Gets or sets the inner angle for the directional cone.
  118495. */
  118496. get directionalConeInnerAngle(): number;
  118497. /**
  118498. * Gets or sets the inner angle for the directional cone.
  118499. */
  118500. set directionalConeInnerAngle(value: number);
  118501. /**
  118502. * Gets or sets the outer angle for the directional cone.
  118503. */
  118504. get directionalConeOuterAngle(): number;
  118505. /**
  118506. * Gets or sets the outer angle for the directional cone.
  118507. */
  118508. set directionalConeOuterAngle(value: number);
  118509. /**
  118510. * Sets the position of the emitter if spatial sound is enabled
  118511. * @param newPosition Defines the new posisiton
  118512. */
  118513. setPosition(newPosition: Vector3): void;
  118514. /**
  118515. * Sets the local direction of the emitter if spatial sound is enabled
  118516. * @param newLocalDirection Defines the new local direction
  118517. */
  118518. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  118519. private _updateDirection;
  118520. /** @hidden */
  118521. updateDistanceFromListener(): void;
  118522. /**
  118523. * Sets a new custom attenuation function for the sound.
  118524. * @param callback Defines the function used for the attenuation
  118525. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  118526. */
  118527. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  118528. /**
  118529. * Play the sound
  118530. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  118531. * @param offset (optional) Start the sound at a specific time in seconds
  118532. * @param length (optional) Sound duration (in seconds)
  118533. */
  118534. play(time?: number, offset?: number, length?: number): void;
  118535. private _onended;
  118536. /**
  118537. * Stop the sound
  118538. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  118539. */
  118540. stop(time?: number): void;
  118541. /**
  118542. * Put the sound in pause
  118543. */
  118544. pause(): void;
  118545. /**
  118546. * Sets a dedicated volume for this sounds
  118547. * @param newVolume Define the new volume of the sound
  118548. * @param time Define time for gradual change to new volume
  118549. */
  118550. setVolume(newVolume: number, time?: number): void;
  118551. /**
  118552. * Set the sound play back rate
  118553. * @param newPlaybackRate Define the playback rate the sound should be played at
  118554. */
  118555. setPlaybackRate(newPlaybackRate: number): void;
  118556. /**
  118557. * Gets the volume of the sound.
  118558. * @returns the volume of the sound
  118559. */
  118560. getVolume(): number;
  118561. /**
  118562. * Attach the sound to a dedicated mesh
  118563. * @param transformNode The transform node to connect the sound with
  118564. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  118565. */
  118566. attachToMesh(transformNode: TransformNode): void;
  118567. /**
  118568. * Detach the sound from the previously attached mesh
  118569. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  118570. */
  118571. detachFromMesh(): void;
  118572. private _onRegisterAfterWorldMatrixUpdate;
  118573. /**
  118574. * Clone the current sound in the scene.
  118575. * @returns the new sound clone
  118576. */
  118577. clone(): Nullable<Sound>;
  118578. /**
  118579. * Gets the current underlying audio buffer containing the data
  118580. * @returns the audio buffer
  118581. */
  118582. getAudioBuffer(): Nullable<AudioBuffer>;
  118583. /**
  118584. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  118585. * @returns the source node
  118586. */
  118587. getSoundSource(): Nullable<AudioBufferSourceNode>;
  118588. /**
  118589. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  118590. * @returns the gain node
  118591. */
  118592. getSoundGain(): Nullable<GainNode>;
  118593. /**
  118594. * Serializes the Sound in a JSON representation
  118595. * @returns the JSON representation of the sound
  118596. */
  118597. serialize(): any;
  118598. /**
  118599. * Parse a JSON representation of a sound to innstantiate in a given scene
  118600. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  118601. * @param scene Define the scene the new parsed sound should be created in
  118602. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  118603. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  118604. * @returns the newly parsed sound
  118605. */
  118606. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  118607. }
  118608. }
  118609. declare module BABYLON {
  118610. /**
  118611. * This defines an action helpful to play a defined sound on a triggered action.
  118612. */
  118613. export class PlaySoundAction extends Action {
  118614. private _sound;
  118615. /**
  118616. * Instantiate the action
  118617. * @param triggerOptions defines the trigger options
  118618. * @param sound defines the sound to play
  118619. * @param condition defines the trigger related conditions
  118620. */
  118621. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  118622. /** @hidden */
  118623. _prepare(): void;
  118624. /**
  118625. * Execute the action and play the sound.
  118626. */
  118627. execute(): void;
  118628. /**
  118629. * Serializes the actions and its related information.
  118630. * @param parent defines the object to serialize in
  118631. * @returns the serialized object
  118632. */
  118633. serialize(parent: any): any;
  118634. }
  118635. /**
  118636. * This defines an action helpful to stop a defined sound on a triggered action.
  118637. */
  118638. export class StopSoundAction extends Action {
  118639. private _sound;
  118640. /**
  118641. * Instantiate the action
  118642. * @param triggerOptions defines the trigger options
  118643. * @param sound defines the sound to stop
  118644. * @param condition defines the trigger related conditions
  118645. */
  118646. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  118647. /** @hidden */
  118648. _prepare(): void;
  118649. /**
  118650. * Execute the action and stop the sound.
  118651. */
  118652. execute(): void;
  118653. /**
  118654. * Serializes the actions and its related information.
  118655. * @param parent defines the object to serialize in
  118656. * @returns the serialized object
  118657. */
  118658. serialize(parent: any): any;
  118659. }
  118660. }
  118661. declare module BABYLON {
  118662. /**
  118663. * This defines an action responsible to change the value of a property
  118664. * by interpolating between its current value and the newly set one once triggered.
  118665. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  118666. */
  118667. export class InterpolateValueAction extends Action {
  118668. /**
  118669. * Defines the path of the property where the value should be interpolated
  118670. */
  118671. propertyPath: string;
  118672. /**
  118673. * Defines the target value at the end of the interpolation.
  118674. */
  118675. value: any;
  118676. /**
  118677. * Defines the time it will take for the property to interpolate to the value.
  118678. */
  118679. duration: number;
  118680. /**
  118681. * Defines if the other scene animations should be stopped when the action has been triggered
  118682. */
  118683. stopOtherAnimations?: boolean;
  118684. /**
  118685. * Defines a callback raised once the interpolation animation has been done.
  118686. */
  118687. onInterpolationDone?: () => void;
  118688. /**
  118689. * Observable triggered once the interpolation animation has been done.
  118690. */
  118691. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  118692. private _target;
  118693. private _effectiveTarget;
  118694. private _property;
  118695. /**
  118696. * Instantiate the action
  118697. * @param triggerOptions defines the trigger options
  118698. * @param target defines the object containing the value to interpolate
  118699. * @param propertyPath defines the path to the property in the target object
  118700. * @param value defines the target value at the end of the interpolation
  118701. * @param duration deines the time it will take for the property to interpolate to the value.
  118702. * @param condition defines the trigger related conditions
  118703. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  118704. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  118705. */
  118706. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  118707. /** @hidden */
  118708. _prepare(): void;
  118709. /**
  118710. * Execute the action starts the value interpolation.
  118711. */
  118712. execute(): void;
  118713. /**
  118714. * Serializes the actions and its related information.
  118715. * @param parent defines the object to serialize in
  118716. * @returns the serialized object
  118717. */
  118718. serialize(parent: any): any;
  118719. }
  118720. }
  118721. declare module BABYLON {
  118722. /**
  118723. * Options allowed during the creation of a sound track.
  118724. */
  118725. export interface ISoundTrackOptions {
  118726. /**
  118727. * The volume the sound track should take during creation
  118728. */
  118729. volume?: number;
  118730. /**
  118731. * Define if the sound track is the main sound track of the scene
  118732. */
  118733. mainTrack?: boolean;
  118734. }
  118735. /**
  118736. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  118737. * It will be also used in a future release to apply effects on a specific track.
  118738. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  118739. */
  118740. export class SoundTrack {
  118741. /**
  118742. * The unique identifier of the sound track in the scene.
  118743. */
  118744. id: number;
  118745. /**
  118746. * The list of sounds included in the sound track.
  118747. */
  118748. soundCollection: Array<Sound>;
  118749. private _outputAudioNode;
  118750. private _scene;
  118751. private _connectedAnalyser;
  118752. private _options;
  118753. private _isInitialized;
  118754. /**
  118755. * Creates a new sound track.
  118756. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  118757. * @param scene Define the scene the sound track belongs to
  118758. * @param options
  118759. */
  118760. constructor(scene: Scene, options?: ISoundTrackOptions);
  118761. private _initializeSoundTrackAudioGraph;
  118762. /**
  118763. * Release the sound track and its associated resources
  118764. */
  118765. dispose(): void;
  118766. /**
  118767. * Adds a sound to this sound track
  118768. * @param sound define the cound to add
  118769. * @ignoreNaming
  118770. */
  118771. AddSound(sound: Sound): void;
  118772. /**
  118773. * Removes a sound to this sound track
  118774. * @param sound define the cound to remove
  118775. * @ignoreNaming
  118776. */
  118777. RemoveSound(sound: Sound): void;
  118778. /**
  118779. * Set a global volume for the full sound track.
  118780. * @param newVolume Define the new volume of the sound track
  118781. */
  118782. setVolume(newVolume: number): void;
  118783. /**
  118784. * Switch the panning model to HRTF:
  118785. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  118786. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118787. */
  118788. switchPanningModelToHRTF(): void;
  118789. /**
  118790. * Switch the panning model to Equal Power:
  118791. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  118792. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  118793. */
  118794. switchPanningModelToEqualPower(): void;
  118795. /**
  118796. * Connect the sound track to an audio analyser allowing some amazing
  118797. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  118798. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  118799. * @param analyser The analyser to connect to the engine
  118800. */
  118801. connectToAnalyser(analyser: Analyser): void;
  118802. }
  118803. }
  118804. declare module BABYLON {
  118805. interface AbstractScene {
  118806. /**
  118807. * The list of sounds used in the scene.
  118808. */
  118809. sounds: Nullable<Array<Sound>>;
  118810. }
  118811. interface Scene {
  118812. /**
  118813. * @hidden
  118814. * Backing field
  118815. */
  118816. _mainSoundTrack: SoundTrack;
  118817. /**
  118818. * The main sound track played by the scene.
  118819. * It cotains your primary collection of sounds.
  118820. */
  118821. mainSoundTrack: SoundTrack;
  118822. /**
  118823. * The list of sound tracks added to the scene
  118824. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  118825. */
  118826. soundTracks: Nullable<Array<SoundTrack>>;
  118827. /**
  118828. * Gets a sound using a given name
  118829. * @param name defines the name to search for
  118830. * @return the found sound or null if not found at all.
  118831. */
  118832. getSoundByName(name: string): Nullable<Sound>;
  118833. /**
  118834. * Gets or sets if audio support is enabled
  118835. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  118836. */
  118837. audioEnabled: boolean;
  118838. /**
  118839. * Gets or sets if audio will be output to headphones
  118840. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  118841. */
  118842. headphone: boolean;
  118843. /**
  118844. * Gets or sets custom audio listener position provider
  118845. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  118846. */
  118847. audioListenerPositionProvider: Nullable<() => Vector3>;
  118848. /**
  118849. * Gets or sets a refresh rate when using 3D audio positioning
  118850. */
  118851. audioPositioningRefreshRate: number;
  118852. }
  118853. /**
  118854. * Defines the sound scene component responsible to manage any sounds
  118855. * in a given scene.
  118856. */
  118857. export class AudioSceneComponent implements ISceneSerializableComponent {
  118858. /**
  118859. * The component name helpfull to identify the component in the list of scene components.
  118860. */
  118861. readonly name: string;
  118862. /**
  118863. * The scene the component belongs to.
  118864. */
  118865. scene: Scene;
  118866. private _audioEnabled;
  118867. /**
  118868. * Gets whether audio is enabled or not.
  118869. * Please use related enable/disable method to switch state.
  118870. */
  118871. get audioEnabled(): boolean;
  118872. private _headphone;
  118873. /**
  118874. * Gets whether audio is outputing to headphone or not.
  118875. * Please use the according Switch methods to change output.
  118876. */
  118877. get headphone(): boolean;
  118878. /**
  118879. * Gets or sets a refresh rate when using 3D audio positioning
  118880. */
  118881. audioPositioningRefreshRate: number;
  118882. private _audioListenerPositionProvider;
  118883. /**
  118884. * Gets the current audio listener position provider
  118885. */
  118886. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  118887. /**
  118888. * Sets a custom listener position for all sounds in the scene
  118889. * By default, this is the position of the first active camera
  118890. */
  118891. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  118892. /**
  118893. * Creates a new instance of the component for the given scene
  118894. * @param scene Defines the scene to register the component in
  118895. */
  118896. constructor(scene: Scene);
  118897. /**
  118898. * Registers the component in a given scene
  118899. */
  118900. register(): void;
  118901. /**
  118902. * Rebuilds the elements related to this component in case of
  118903. * context lost for instance.
  118904. */
  118905. rebuild(): void;
  118906. /**
  118907. * Serializes the component data to the specified json object
  118908. * @param serializationObject The object to serialize to
  118909. */
  118910. serialize(serializationObject: any): void;
  118911. /**
  118912. * Adds all the elements from the container to the scene
  118913. * @param container the container holding the elements
  118914. */
  118915. addFromContainer(container: AbstractScene): void;
  118916. /**
  118917. * Removes all the elements in the container from the scene
  118918. * @param container contains the elements to remove
  118919. * @param dispose if the removed element should be disposed (default: false)
  118920. */
  118921. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118922. /**
  118923. * Disposes the component and the associated ressources.
  118924. */
  118925. dispose(): void;
  118926. /**
  118927. * Disables audio in the associated scene.
  118928. */
  118929. disableAudio(): void;
  118930. /**
  118931. * Enables audio in the associated scene.
  118932. */
  118933. enableAudio(): void;
  118934. /**
  118935. * Switch audio to headphone output.
  118936. */
  118937. switchAudioModeForHeadphones(): void;
  118938. /**
  118939. * Switch audio to normal speakers.
  118940. */
  118941. switchAudioModeForNormalSpeakers(): void;
  118942. private _cachedCameraDirection;
  118943. private _cachedCameraPosition;
  118944. private _lastCheck;
  118945. private _afterRender;
  118946. }
  118947. }
  118948. declare module BABYLON {
  118949. /**
  118950. * Wraps one or more Sound objects and selects one with random weight for playback.
  118951. */
  118952. export class WeightedSound {
  118953. /** When true a Sound will be selected and played when the current playing Sound completes. */
  118954. loop: boolean;
  118955. private _coneInnerAngle;
  118956. private _coneOuterAngle;
  118957. private _volume;
  118958. /** A Sound is currently playing. */
  118959. isPlaying: boolean;
  118960. /** A Sound is currently paused. */
  118961. isPaused: boolean;
  118962. private _sounds;
  118963. private _weights;
  118964. private _currentIndex?;
  118965. /**
  118966. * Creates a new WeightedSound from the list of sounds given.
  118967. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  118968. * @param sounds Array of Sounds that will be selected from.
  118969. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  118970. */
  118971. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  118972. /**
  118973. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  118974. */
  118975. get directionalConeInnerAngle(): number;
  118976. /**
  118977. * The size of cone in degress for a directional sound in which there will be no attenuation.
  118978. */
  118979. set directionalConeInnerAngle(value: number);
  118980. /**
  118981. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  118982. * Listener angles between innerAngle and outerAngle will falloff linearly.
  118983. */
  118984. get directionalConeOuterAngle(): number;
  118985. /**
  118986. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  118987. * Listener angles between innerAngle and outerAngle will falloff linearly.
  118988. */
  118989. set directionalConeOuterAngle(value: number);
  118990. /**
  118991. * Playback volume.
  118992. */
  118993. get volume(): number;
  118994. /**
  118995. * Playback volume.
  118996. */
  118997. set volume(value: number);
  118998. private _onended;
  118999. /**
  119000. * Suspend playback
  119001. */
  119002. pause(): void;
  119003. /**
  119004. * Stop playback
  119005. */
  119006. stop(): void;
  119007. /**
  119008. * Start playback.
  119009. * @param startOffset Position the clip head at a specific time in seconds.
  119010. */
  119011. play(startOffset?: number): void;
  119012. }
  119013. }
  119014. declare module BABYLON {
  119015. /**
  119016. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  119017. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  119018. */
  119019. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  119020. /**
  119021. * Gets the name of the behavior.
  119022. */
  119023. get name(): string;
  119024. /**
  119025. * The easing function used by animations
  119026. */
  119027. static EasingFunction: BackEase;
  119028. /**
  119029. * The easing mode used by animations
  119030. */
  119031. static EasingMode: number;
  119032. /**
  119033. * The duration of the animation, in milliseconds
  119034. */
  119035. transitionDuration: number;
  119036. /**
  119037. * Length of the distance animated by the transition when lower radius is reached
  119038. */
  119039. lowerRadiusTransitionRange: number;
  119040. /**
  119041. * Length of the distance animated by the transition when upper radius is reached
  119042. */
  119043. upperRadiusTransitionRange: number;
  119044. private _autoTransitionRange;
  119045. /**
  119046. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  119047. */
  119048. get autoTransitionRange(): boolean;
  119049. /**
  119050. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  119051. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  119052. */
  119053. set autoTransitionRange(value: boolean);
  119054. private _attachedCamera;
  119055. private _onAfterCheckInputsObserver;
  119056. private _onMeshTargetChangedObserver;
  119057. /**
  119058. * Initializes the behavior.
  119059. */
  119060. init(): void;
  119061. /**
  119062. * Attaches the behavior to its arc rotate camera.
  119063. * @param camera Defines the camera to attach the behavior to
  119064. */
  119065. attach(camera: ArcRotateCamera): void;
  119066. /**
  119067. * Detaches the behavior from its current arc rotate camera.
  119068. */
  119069. detach(): void;
  119070. private _radiusIsAnimating;
  119071. private _radiusBounceTransition;
  119072. private _animatables;
  119073. private _cachedWheelPrecision;
  119074. /**
  119075. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  119076. * @param radiusLimit The limit to check against.
  119077. * @return Bool to indicate if at limit.
  119078. */
  119079. private _isRadiusAtLimit;
  119080. /**
  119081. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  119082. * @param radiusDelta The delta by which to animate to. Can be negative.
  119083. */
  119084. private _applyBoundRadiusAnimation;
  119085. /**
  119086. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  119087. */
  119088. protected _clearAnimationLocks(): void;
  119089. /**
  119090. * Stops and removes all animations that have been applied to the camera
  119091. */
  119092. stopAllAnimations(): void;
  119093. }
  119094. }
  119095. declare module BABYLON {
  119096. /**
  119097. * 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.
  119098. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  119099. */
  119100. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  119101. /**
  119102. * Gets the name of the behavior.
  119103. */
  119104. get name(): string;
  119105. private _mode;
  119106. private _radiusScale;
  119107. private _positionScale;
  119108. private _defaultElevation;
  119109. private _elevationReturnTime;
  119110. private _elevationReturnWaitTime;
  119111. private _zoomStopsAnimation;
  119112. private _framingTime;
  119113. /**
  119114. * The easing function used by animations
  119115. */
  119116. static EasingFunction: ExponentialEase;
  119117. /**
  119118. * The easing mode used by animations
  119119. */
  119120. static EasingMode: number;
  119121. /**
  119122. * Sets the current mode used by the behavior
  119123. */
  119124. set mode(mode: number);
  119125. /**
  119126. * Gets current mode used by the behavior.
  119127. */
  119128. get mode(): number;
  119129. /**
  119130. * Sets the scale applied to the radius (1 by default)
  119131. */
  119132. set radiusScale(radius: number);
  119133. /**
  119134. * Gets the scale applied to the radius
  119135. */
  119136. get radiusScale(): number;
  119137. /**
  119138. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  119139. */
  119140. set positionScale(scale: number);
  119141. /**
  119142. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  119143. */
  119144. get positionScale(): number;
  119145. /**
  119146. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  119147. * behaviour is triggered, in radians.
  119148. */
  119149. set defaultElevation(elevation: number);
  119150. /**
  119151. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  119152. * behaviour is triggered, in radians.
  119153. */
  119154. get defaultElevation(): number;
  119155. /**
  119156. * Sets the time (in milliseconds) taken to return to the default beta position.
  119157. * Negative value indicates camera should not return to default.
  119158. */
  119159. set elevationReturnTime(speed: number);
  119160. /**
  119161. * Gets the time (in milliseconds) taken to return to the default beta position.
  119162. * Negative value indicates camera should not return to default.
  119163. */
  119164. get elevationReturnTime(): number;
  119165. /**
  119166. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  119167. */
  119168. set elevationReturnWaitTime(time: number);
  119169. /**
  119170. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  119171. */
  119172. get elevationReturnWaitTime(): number;
  119173. /**
  119174. * Sets the flag that indicates if user zooming should stop animation.
  119175. */
  119176. set zoomStopsAnimation(flag: boolean);
  119177. /**
  119178. * Gets the flag that indicates if user zooming should stop animation.
  119179. */
  119180. get zoomStopsAnimation(): boolean;
  119181. /**
  119182. * Sets the transition time when framing the mesh, in milliseconds
  119183. */
  119184. set framingTime(time: number);
  119185. /**
  119186. * Gets the transition time when framing the mesh, in milliseconds
  119187. */
  119188. get framingTime(): number;
  119189. /**
  119190. * Define if the behavior should automatically change the configured
  119191. * camera limits and sensibilities.
  119192. */
  119193. autoCorrectCameraLimitsAndSensibility: boolean;
  119194. private _onPrePointerObservableObserver;
  119195. private _onAfterCheckInputsObserver;
  119196. private _onMeshTargetChangedObserver;
  119197. private _attachedCamera;
  119198. private _isPointerDown;
  119199. private _lastInteractionTime;
  119200. /**
  119201. * Initializes the behavior.
  119202. */
  119203. init(): void;
  119204. /**
  119205. * Attaches the behavior to its arc rotate camera.
  119206. * @param camera Defines the camera to attach the behavior to
  119207. */
  119208. attach(camera: ArcRotateCamera): void;
  119209. /**
  119210. * Detaches the behavior from its current arc rotate camera.
  119211. */
  119212. detach(): void;
  119213. private _animatables;
  119214. private _betaIsAnimating;
  119215. private _betaTransition;
  119216. private _radiusTransition;
  119217. private _vectorTransition;
  119218. /**
  119219. * Targets the given mesh and updates zoom level accordingly.
  119220. * @param mesh The mesh to target.
  119221. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  119222. * @param onAnimationEnd Callback triggered at the end of the framing animation
  119223. */
  119224. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  119225. /**
  119226. * Targets the given mesh with its children and updates zoom level accordingly.
  119227. * @param mesh The mesh to target.
  119228. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  119229. * @param onAnimationEnd Callback triggered at the end of the framing animation
  119230. */
  119231. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  119232. /**
  119233. * Targets the given meshes with their children and updates zoom level accordingly.
  119234. * @param meshes The mesh to target.
  119235. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  119236. * @param onAnimationEnd Callback triggered at the end of the framing animation
  119237. */
  119238. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  119239. /**
  119240. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  119241. * @param minimumWorld Determines the smaller position of the bounding box extend
  119242. * @param maximumWorld Determines the bigger position of the bounding box extend
  119243. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  119244. * @param onAnimationEnd Callback triggered at the end of the framing animation
  119245. */
  119246. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  119247. /**
  119248. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  119249. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  119250. * frustum width.
  119251. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  119252. * to fully enclose the mesh in the viewing frustum.
  119253. */
  119254. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  119255. /**
  119256. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  119257. * is automatically returned to its default position (expected to be above ground plane).
  119258. */
  119259. private _maintainCameraAboveGround;
  119260. /**
  119261. * Returns the frustum slope based on the canvas ratio and camera FOV
  119262. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  119263. */
  119264. private _getFrustumSlope;
  119265. /**
  119266. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  119267. */
  119268. private _clearAnimationLocks;
  119269. /**
  119270. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  119271. */
  119272. private _applyUserInteraction;
  119273. /**
  119274. * Stops and removes all animations that have been applied to the camera
  119275. */
  119276. stopAllAnimations(): void;
  119277. /**
  119278. * Gets a value indicating if the user is moving the camera
  119279. */
  119280. get isUserIsMoving(): boolean;
  119281. /**
  119282. * The camera can move all the way towards the mesh.
  119283. */
  119284. static IgnoreBoundsSizeMode: number;
  119285. /**
  119286. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  119287. */
  119288. static FitFrustumSidesMode: number;
  119289. }
  119290. }
  119291. declare module BABYLON {
  119292. /**
  119293. * Base class for Camera Pointer Inputs.
  119294. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  119295. * for example usage.
  119296. */
  119297. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  119298. /**
  119299. * Defines the camera the input is attached to.
  119300. */
  119301. abstract camera: Camera;
  119302. /**
  119303. * Whether keyboard modifier keys are pressed at time of last mouse event.
  119304. */
  119305. protected _altKey: boolean;
  119306. protected _ctrlKey: boolean;
  119307. protected _metaKey: boolean;
  119308. protected _shiftKey: boolean;
  119309. /**
  119310. * Which mouse buttons were pressed at time of last mouse event.
  119311. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  119312. */
  119313. protected _buttonsPressed: number;
  119314. /**
  119315. * Defines the buttons associated with the input to handle camera move.
  119316. */
  119317. buttons: number[];
  119318. /**
  119319. * Attach the input controls to a specific dom element to get the input from.
  119320. * @param element Defines the element the controls should be listened from
  119321. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  119322. */
  119323. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  119324. /**
  119325. * Detach the current controls from the specified dom element.
  119326. * @param element Defines the element to stop listening the inputs from
  119327. */
  119328. detachControl(element: Nullable<HTMLElement>): void;
  119329. /**
  119330. * Gets the class name of the current input.
  119331. * @returns the class name
  119332. */
  119333. getClassName(): string;
  119334. /**
  119335. * Get the friendly name associated with the input class.
  119336. * @returns the input friendly name
  119337. */
  119338. getSimpleName(): string;
  119339. /**
  119340. * Called on pointer POINTERDOUBLETAP event.
  119341. * Override this method to provide functionality on POINTERDOUBLETAP event.
  119342. */
  119343. protected onDoubleTap(type: string): void;
  119344. /**
  119345. * Called on pointer POINTERMOVE event if only a single touch is active.
  119346. * Override this method to provide functionality.
  119347. */
  119348. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  119349. /**
  119350. * Called on pointer POINTERMOVE event if multiple touches are active.
  119351. * Override this method to provide functionality.
  119352. */
  119353. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  119354. /**
  119355. * Called on JS contextmenu event.
  119356. * Override this method to provide functionality.
  119357. */
  119358. protected onContextMenu(evt: PointerEvent): void;
  119359. /**
  119360. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  119361. * press.
  119362. * Override this method to provide functionality.
  119363. */
  119364. protected onButtonDown(evt: PointerEvent): void;
  119365. /**
  119366. * Called each time a new POINTERUP event occurs. Ie, for each button
  119367. * release.
  119368. * Override this method to provide functionality.
  119369. */
  119370. protected onButtonUp(evt: PointerEvent): void;
  119371. /**
  119372. * Called when window becomes inactive.
  119373. * Override this method to provide functionality.
  119374. */
  119375. protected onLostFocus(): void;
  119376. private _pointerInput;
  119377. private _observer;
  119378. private _onLostFocus;
  119379. private pointA;
  119380. private pointB;
  119381. }
  119382. }
  119383. declare module BABYLON {
  119384. /**
  119385. * Manage the pointers inputs to control an arc rotate camera.
  119386. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  119387. */
  119388. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  119389. /**
  119390. * Defines the camera the input is attached to.
  119391. */
  119392. camera: ArcRotateCamera;
  119393. /**
  119394. * Gets the class name of the current input.
  119395. * @returns the class name
  119396. */
  119397. getClassName(): string;
  119398. /**
  119399. * Defines the buttons associated with the input to handle camera move.
  119400. */
  119401. buttons: number[];
  119402. /**
  119403. * Defines the pointer angular sensibility along the X axis or how fast is
  119404. * the camera rotating.
  119405. */
  119406. angularSensibilityX: number;
  119407. /**
  119408. * Defines the pointer angular sensibility along the Y axis or how fast is
  119409. * the camera rotating.
  119410. */
  119411. angularSensibilityY: number;
  119412. /**
  119413. * Defines the pointer pinch precision or how fast is the camera zooming.
  119414. */
  119415. pinchPrecision: number;
  119416. /**
  119417. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  119418. * from 0.
  119419. * It defines the percentage of current camera.radius to use as delta when
  119420. * pinch zoom is used.
  119421. */
  119422. pinchDeltaPercentage: number;
  119423. /**
  119424. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  119425. * that any object in the plane at the camera's target point will scale
  119426. * perfectly with finger motion.
  119427. * Overrides pinchDeltaPercentage and pinchPrecision.
  119428. */
  119429. useNaturalPinchZoom: boolean;
  119430. /**
  119431. * Defines the pointer panning sensibility or how fast is the camera moving.
  119432. */
  119433. panningSensibility: number;
  119434. /**
  119435. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  119436. */
  119437. multiTouchPanning: boolean;
  119438. /**
  119439. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  119440. * zoom (pinch) through multitouch.
  119441. */
  119442. multiTouchPanAndZoom: boolean;
  119443. /**
  119444. * Revers pinch action direction.
  119445. */
  119446. pinchInwards: boolean;
  119447. private _isPanClick;
  119448. private _twoFingerActivityCount;
  119449. private _isPinching;
  119450. /**
  119451. * Called on pointer POINTERMOVE event if only a single touch is active.
  119452. */
  119453. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  119454. /**
  119455. * Called on pointer POINTERDOUBLETAP event.
  119456. */
  119457. protected onDoubleTap(type: string): void;
  119458. /**
  119459. * Called on pointer POINTERMOVE event if multiple touches are active.
  119460. */
  119461. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  119462. /**
  119463. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  119464. * press.
  119465. */
  119466. protected onButtonDown(evt: PointerEvent): void;
  119467. /**
  119468. * Called each time a new POINTERUP event occurs. Ie, for each button
  119469. * release.
  119470. */
  119471. protected onButtonUp(evt: PointerEvent): void;
  119472. /**
  119473. * Called when window becomes inactive.
  119474. */
  119475. protected onLostFocus(): void;
  119476. }
  119477. }
  119478. declare module BABYLON {
  119479. /**
  119480. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  119481. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  119482. */
  119483. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  119484. /**
  119485. * Defines the camera the input is attached to.
  119486. */
  119487. camera: ArcRotateCamera;
  119488. /**
  119489. * Defines the list of key codes associated with the up action (increase alpha)
  119490. */
  119491. keysUp: number[];
  119492. /**
  119493. * Defines the list of key codes associated with the down action (decrease alpha)
  119494. */
  119495. keysDown: number[];
  119496. /**
  119497. * Defines the list of key codes associated with the left action (increase beta)
  119498. */
  119499. keysLeft: number[];
  119500. /**
  119501. * Defines the list of key codes associated with the right action (decrease beta)
  119502. */
  119503. keysRight: number[];
  119504. /**
  119505. * Defines the list of key codes associated with the reset action.
  119506. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  119507. */
  119508. keysReset: number[];
  119509. /**
  119510. * Defines the panning sensibility of the inputs.
  119511. * (How fast is the camera panning)
  119512. */
  119513. panningSensibility: number;
  119514. /**
  119515. * Defines the zooming sensibility of the inputs.
  119516. * (How fast is the camera zooming)
  119517. */
  119518. zoomingSensibility: number;
  119519. /**
  119520. * Defines whether maintaining the alt key down switch the movement mode from
  119521. * orientation to zoom.
  119522. */
  119523. useAltToZoom: boolean;
  119524. /**
  119525. * Rotation speed of the camera
  119526. */
  119527. angularSpeed: number;
  119528. private _keys;
  119529. private _ctrlPressed;
  119530. private _altPressed;
  119531. private _onCanvasBlurObserver;
  119532. private _onKeyboardObserver;
  119533. private _engine;
  119534. private _scene;
  119535. /**
  119536. * Attach the input controls to a specific dom element to get the input from.
  119537. * @param element Defines the element the controls should be listened from
  119538. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  119539. */
  119540. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  119541. /**
  119542. * Detach the current controls from the specified dom element.
  119543. * @param element Defines the element to stop listening the inputs from
  119544. */
  119545. detachControl(element: Nullable<HTMLElement>): void;
  119546. /**
  119547. * Update the current camera state depending on the inputs that have been used this frame.
  119548. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  119549. */
  119550. checkInputs(): void;
  119551. /**
  119552. * Gets the class name of the current intput.
  119553. * @returns the class name
  119554. */
  119555. getClassName(): string;
  119556. /**
  119557. * Get the friendly name associated with the input class.
  119558. * @returns the input friendly name
  119559. */
  119560. getSimpleName(): string;
  119561. }
  119562. }
  119563. declare module BABYLON {
  119564. /**
  119565. * Manage the mouse wheel inputs to control an arc rotate camera.
  119566. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  119567. */
  119568. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  119569. /**
  119570. * Defines the camera the input is attached to.
  119571. */
  119572. camera: ArcRotateCamera;
  119573. /**
  119574. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  119575. */
  119576. wheelPrecision: number;
  119577. /**
  119578. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  119579. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  119580. */
  119581. wheelDeltaPercentage: number;
  119582. private _wheel;
  119583. private _observer;
  119584. private computeDeltaFromMouseWheelLegacyEvent;
  119585. /**
  119586. * Attach the input controls to a specific dom element to get the input from.
  119587. * @param element Defines the element the controls should be listened from
  119588. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  119589. */
  119590. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  119591. /**
  119592. * Detach the current controls from the specified dom element.
  119593. * @param element Defines the element to stop listening the inputs from
  119594. */
  119595. detachControl(element: Nullable<HTMLElement>): void;
  119596. /**
  119597. * Gets the class name of the current intput.
  119598. * @returns the class name
  119599. */
  119600. getClassName(): string;
  119601. /**
  119602. * Get the friendly name associated with the input class.
  119603. * @returns the input friendly name
  119604. */
  119605. getSimpleName(): string;
  119606. }
  119607. }
  119608. declare module BABYLON {
  119609. /**
  119610. * Default Inputs manager for the ArcRotateCamera.
  119611. * It groups all the default supported inputs for ease of use.
  119612. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  119613. */
  119614. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  119615. /**
  119616. * Instantiates a new ArcRotateCameraInputsManager.
  119617. * @param camera Defines the camera the inputs belong to
  119618. */
  119619. constructor(camera: ArcRotateCamera);
  119620. /**
  119621. * Add mouse wheel input support to the input manager.
  119622. * @returns the current input manager
  119623. */
  119624. addMouseWheel(): ArcRotateCameraInputsManager;
  119625. /**
  119626. * Add pointers input support to the input manager.
  119627. * @returns the current input manager
  119628. */
  119629. addPointers(): ArcRotateCameraInputsManager;
  119630. /**
  119631. * Add keyboard input support to the input manager.
  119632. * @returns the current input manager
  119633. */
  119634. addKeyboard(): ArcRotateCameraInputsManager;
  119635. }
  119636. }
  119637. declare module BABYLON {
  119638. /**
  119639. * This represents an orbital type of camera.
  119640. *
  119641. * 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.
  119642. * 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.
  119643. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  119644. */
  119645. export class ArcRotateCamera extends TargetCamera {
  119646. /**
  119647. * Defines the rotation angle of the camera along the longitudinal axis.
  119648. */
  119649. alpha: number;
  119650. /**
  119651. * Defines the rotation angle of the camera along the latitudinal axis.
  119652. */
  119653. beta: number;
  119654. /**
  119655. * Defines the radius of the camera from it s target point.
  119656. */
  119657. radius: number;
  119658. protected _target: Vector3;
  119659. protected _targetHost: Nullable<AbstractMesh>;
  119660. /**
  119661. * Defines the target point of the camera.
  119662. * The camera looks towards it form the radius distance.
  119663. */
  119664. get target(): Vector3;
  119665. set target(value: Vector3);
  119666. /**
  119667. * Define the current local position of the camera in the scene
  119668. */
  119669. get position(): Vector3;
  119670. set position(newPosition: Vector3);
  119671. protected _upVector: Vector3;
  119672. protected _upToYMatrix: Matrix;
  119673. protected _YToUpMatrix: Matrix;
  119674. /**
  119675. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  119676. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  119677. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  119678. */
  119679. set upVector(vec: Vector3);
  119680. get upVector(): Vector3;
  119681. /**
  119682. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  119683. */
  119684. setMatUp(): void;
  119685. /**
  119686. * Current inertia value on the longitudinal axis.
  119687. * The bigger this number the longer it will take for the camera to stop.
  119688. */
  119689. inertialAlphaOffset: number;
  119690. /**
  119691. * Current inertia value on the latitudinal axis.
  119692. * The bigger this number the longer it will take for the camera to stop.
  119693. */
  119694. inertialBetaOffset: number;
  119695. /**
  119696. * Current inertia value on the radius axis.
  119697. * The bigger this number the longer it will take for the camera to stop.
  119698. */
  119699. inertialRadiusOffset: number;
  119700. /**
  119701. * Minimum allowed angle on the longitudinal axis.
  119702. * This can help limiting how the Camera is able to move in the scene.
  119703. */
  119704. lowerAlphaLimit: Nullable<number>;
  119705. /**
  119706. * Maximum allowed angle on the longitudinal axis.
  119707. * This can help limiting how the Camera is able to move in the scene.
  119708. */
  119709. upperAlphaLimit: Nullable<number>;
  119710. /**
  119711. * Minimum allowed angle on the latitudinal axis.
  119712. * This can help limiting how the Camera is able to move in the scene.
  119713. */
  119714. lowerBetaLimit: number;
  119715. /**
  119716. * Maximum allowed angle on the latitudinal axis.
  119717. * This can help limiting how the Camera is able to move in the scene.
  119718. */
  119719. upperBetaLimit: number;
  119720. /**
  119721. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  119722. * This can help limiting how the Camera is able to move in the scene.
  119723. */
  119724. lowerRadiusLimit: Nullable<number>;
  119725. /**
  119726. * Maximum allowed distance of the camera to the target (The camera can not get further).
  119727. * This can help limiting how the Camera is able to move in the scene.
  119728. */
  119729. upperRadiusLimit: Nullable<number>;
  119730. /**
  119731. * Defines the current inertia value used during panning of the camera along the X axis.
  119732. */
  119733. inertialPanningX: number;
  119734. /**
  119735. * Defines the current inertia value used during panning of the camera along the Y axis.
  119736. */
  119737. inertialPanningY: number;
  119738. /**
  119739. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  119740. * Basically if your fingers moves away from more than this distance you will be considered
  119741. * in pinch mode.
  119742. */
  119743. pinchToPanMaxDistance: number;
  119744. /**
  119745. * Defines the maximum distance the camera can pan.
  119746. * This could help keeping the cammera always in your scene.
  119747. */
  119748. panningDistanceLimit: Nullable<number>;
  119749. /**
  119750. * Defines the target of the camera before paning.
  119751. */
  119752. panningOriginTarget: Vector3;
  119753. /**
  119754. * Defines the value of the inertia used during panning.
  119755. * 0 would mean stop inertia and one would mean no decelleration at all.
  119756. */
  119757. panningInertia: number;
  119758. /**
  119759. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  119760. */
  119761. get angularSensibilityX(): number;
  119762. set angularSensibilityX(value: number);
  119763. /**
  119764. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  119765. */
  119766. get angularSensibilityY(): number;
  119767. set angularSensibilityY(value: number);
  119768. /**
  119769. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  119770. */
  119771. get pinchPrecision(): number;
  119772. set pinchPrecision(value: number);
  119773. /**
  119774. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  119775. * It will be used instead of pinchDeltaPrecision if different from 0.
  119776. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  119777. */
  119778. get pinchDeltaPercentage(): number;
  119779. set pinchDeltaPercentage(value: number);
  119780. /**
  119781. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  119782. * and pinch delta percentage.
  119783. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  119784. * that any object in the plane at the camera's target point will scale
  119785. * perfectly with finger motion.
  119786. */
  119787. get useNaturalPinchZoom(): boolean;
  119788. set useNaturalPinchZoom(value: boolean);
  119789. /**
  119790. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  119791. */
  119792. get panningSensibility(): number;
  119793. set panningSensibility(value: number);
  119794. /**
  119795. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  119796. */
  119797. get keysUp(): number[];
  119798. set keysUp(value: number[]);
  119799. /**
  119800. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  119801. */
  119802. get keysDown(): number[];
  119803. set keysDown(value: number[]);
  119804. /**
  119805. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  119806. */
  119807. get keysLeft(): number[];
  119808. set keysLeft(value: number[]);
  119809. /**
  119810. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  119811. */
  119812. get keysRight(): number[];
  119813. set keysRight(value: number[]);
  119814. /**
  119815. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  119816. */
  119817. get wheelPrecision(): number;
  119818. set wheelPrecision(value: number);
  119819. /**
  119820. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  119821. * It will be used instead of pinchDeltaPrecision if different from 0.
  119822. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  119823. */
  119824. get wheelDeltaPercentage(): number;
  119825. set wheelDeltaPercentage(value: number);
  119826. /**
  119827. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  119828. */
  119829. zoomOnFactor: number;
  119830. /**
  119831. * Defines a screen offset for the camera position.
  119832. */
  119833. targetScreenOffset: Vector2;
  119834. /**
  119835. * Allows the camera to be completely reversed.
  119836. * If false the camera can not arrive upside down.
  119837. */
  119838. allowUpsideDown: boolean;
  119839. /**
  119840. * Define if double tap/click is used to restore the previously saved state of the camera.
  119841. */
  119842. useInputToRestoreState: boolean;
  119843. /** @hidden */
  119844. _viewMatrix: Matrix;
  119845. /** @hidden */
  119846. _useCtrlForPanning: boolean;
  119847. /** @hidden */
  119848. _panningMouseButton: number;
  119849. /**
  119850. * Defines the input associated to the camera.
  119851. */
  119852. inputs: ArcRotateCameraInputsManager;
  119853. /** @hidden */
  119854. _reset: () => void;
  119855. /**
  119856. * Defines the allowed panning axis.
  119857. */
  119858. panningAxis: Vector3;
  119859. protected _localDirection: Vector3;
  119860. protected _transformedDirection: Vector3;
  119861. private _bouncingBehavior;
  119862. /**
  119863. * Gets the bouncing behavior of the camera if it has been enabled.
  119864. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  119865. */
  119866. get bouncingBehavior(): Nullable<BouncingBehavior>;
  119867. /**
  119868. * Defines if the bouncing behavior of the camera is enabled on the camera.
  119869. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  119870. */
  119871. get useBouncingBehavior(): boolean;
  119872. set useBouncingBehavior(value: boolean);
  119873. private _framingBehavior;
  119874. /**
  119875. * Gets the framing behavior of the camera if it has been enabled.
  119876. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  119877. */
  119878. get framingBehavior(): Nullable<FramingBehavior>;
  119879. /**
  119880. * Defines if the framing behavior of the camera is enabled on the camera.
  119881. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  119882. */
  119883. get useFramingBehavior(): boolean;
  119884. set useFramingBehavior(value: boolean);
  119885. private _autoRotationBehavior;
  119886. /**
  119887. * Gets the auto rotation behavior of the camera if it has been enabled.
  119888. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  119889. */
  119890. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  119891. /**
  119892. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  119893. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  119894. */
  119895. get useAutoRotationBehavior(): boolean;
  119896. set useAutoRotationBehavior(value: boolean);
  119897. /**
  119898. * Observable triggered when the mesh target has been changed on the camera.
  119899. */
  119900. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  119901. /**
  119902. * Event raised when the camera is colliding with a mesh.
  119903. */
  119904. onCollide: (collidedMesh: AbstractMesh) => void;
  119905. /**
  119906. * Defines whether the camera should check collision with the objects oh the scene.
  119907. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  119908. */
  119909. checkCollisions: boolean;
  119910. /**
  119911. * Defines the collision radius of the camera.
  119912. * This simulates a sphere around the camera.
  119913. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  119914. */
  119915. collisionRadius: Vector3;
  119916. protected _collider: Collider;
  119917. protected _previousPosition: Vector3;
  119918. protected _collisionVelocity: Vector3;
  119919. protected _newPosition: Vector3;
  119920. protected _previousAlpha: number;
  119921. protected _previousBeta: number;
  119922. protected _previousRadius: number;
  119923. protected _collisionTriggered: boolean;
  119924. protected _targetBoundingCenter: Nullable<Vector3>;
  119925. private _computationVector;
  119926. /**
  119927. * Instantiates a new ArcRotateCamera in a given scene
  119928. * @param name Defines the name of the camera
  119929. * @param alpha Defines the camera rotation along the logitudinal axis
  119930. * @param beta Defines the camera rotation along the latitudinal axis
  119931. * @param radius Defines the camera distance from its target
  119932. * @param target Defines the camera target
  119933. * @param scene Defines the scene the camera belongs to
  119934. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  119935. */
  119936. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  119937. /** @hidden */
  119938. _initCache(): void;
  119939. /** @hidden */
  119940. _updateCache(ignoreParentClass?: boolean): void;
  119941. protected _getTargetPosition(): Vector3;
  119942. private _storedAlpha;
  119943. private _storedBeta;
  119944. private _storedRadius;
  119945. private _storedTarget;
  119946. private _storedTargetScreenOffset;
  119947. /**
  119948. * Stores the current state of the camera (alpha, beta, radius and target)
  119949. * @returns the camera itself
  119950. */
  119951. storeState(): Camera;
  119952. /**
  119953. * @hidden
  119954. * Restored camera state. You must call storeState() first
  119955. */
  119956. _restoreStateValues(): boolean;
  119957. /** @hidden */
  119958. _isSynchronizedViewMatrix(): boolean;
  119959. /**
  119960. * Attached controls to the current camera.
  119961. * @param element Defines the element the controls should be listened from
  119962. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  119963. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  119964. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  119965. */
  119966. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  119967. /**
  119968. * Detach the current controls from the camera.
  119969. * The camera will stop reacting to inputs.
  119970. * @param element Defines the element to stop listening the inputs from
  119971. */
  119972. detachControl(element: HTMLElement): void;
  119973. /** @hidden */
  119974. _checkInputs(): void;
  119975. protected _checkLimits(): void;
  119976. /**
  119977. * Rebuilds angles (alpha, beta) and radius from the give position and target
  119978. */
  119979. rebuildAnglesAndRadius(): void;
  119980. /**
  119981. * Use a position to define the current camera related information like alpha, beta and radius
  119982. * @param position Defines the position to set the camera at
  119983. */
  119984. setPosition(position: Vector3): void;
  119985. /**
  119986. * Defines the target the camera should look at.
  119987. * This will automatically adapt alpha beta and radius to fit within the new target.
  119988. * @param target Defines the new target as a Vector or a mesh
  119989. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  119990. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  119991. */
  119992. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  119993. /** @hidden */
  119994. _getViewMatrix(): Matrix;
  119995. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  119996. /**
  119997. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  119998. * @param meshes Defines the mesh to zoom on
  119999. * @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)
  120000. */
  120001. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  120002. /**
  120003. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  120004. * The target will be changed but the radius
  120005. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  120006. * @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)
  120007. */
  120008. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  120009. min: Vector3;
  120010. max: Vector3;
  120011. distance: number;
  120012. }, doNotUpdateMaxZ?: boolean): void;
  120013. /**
  120014. * @override
  120015. * Override Camera.createRigCamera
  120016. */
  120017. createRigCamera(name: string, cameraIndex: number): Camera;
  120018. /**
  120019. * @hidden
  120020. * @override
  120021. * Override Camera._updateRigCameras
  120022. */
  120023. _updateRigCameras(): void;
  120024. /**
  120025. * Destroy the camera and release the current resources hold by it.
  120026. */
  120027. dispose(): void;
  120028. /**
  120029. * Gets the current object class name.
  120030. * @return the class name
  120031. */
  120032. getClassName(): string;
  120033. }
  120034. }
  120035. declare module BABYLON {
  120036. /**
  120037. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  120038. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  120039. */
  120040. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  120041. /**
  120042. * Gets the name of the behavior.
  120043. */
  120044. get name(): string;
  120045. private _zoomStopsAnimation;
  120046. private _idleRotationSpeed;
  120047. private _idleRotationWaitTime;
  120048. private _idleRotationSpinupTime;
  120049. /**
  120050. * Sets the flag that indicates if user zooming should stop animation.
  120051. */
  120052. set zoomStopsAnimation(flag: boolean);
  120053. /**
  120054. * Gets the flag that indicates if user zooming should stop animation.
  120055. */
  120056. get zoomStopsAnimation(): boolean;
  120057. /**
  120058. * Sets the default speed at which the camera rotates around the model.
  120059. */
  120060. set idleRotationSpeed(speed: number);
  120061. /**
  120062. * Gets the default speed at which the camera rotates around the model.
  120063. */
  120064. get idleRotationSpeed(): number;
  120065. /**
  120066. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  120067. */
  120068. set idleRotationWaitTime(time: number);
  120069. /**
  120070. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  120071. */
  120072. get idleRotationWaitTime(): number;
  120073. /**
  120074. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  120075. */
  120076. set idleRotationSpinupTime(time: number);
  120077. /**
  120078. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  120079. */
  120080. get idleRotationSpinupTime(): number;
  120081. /**
  120082. * Gets a value indicating if the camera is currently rotating because of this behavior
  120083. */
  120084. get rotationInProgress(): boolean;
  120085. private _onPrePointerObservableObserver;
  120086. private _onAfterCheckInputsObserver;
  120087. private _attachedCamera;
  120088. private _isPointerDown;
  120089. private _lastFrameTime;
  120090. private _lastInteractionTime;
  120091. private _cameraRotationSpeed;
  120092. /**
  120093. * Initializes the behavior.
  120094. */
  120095. init(): void;
  120096. /**
  120097. * Attaches the behavior to its arc rotate camera.
  120098. * @param camera Defines the camera to attach the behavior to
  120099. */
  120100. attach(camera: ArcRotateCamera): void;
  120101. /**
  120102. * Detaches the behavior from its current arc rotate camera.
  120103. */
  120104. detach(): void;
  120105. /**
  120106. * Returns true if user is scrolling.
  120107. * @return true if user is scrolling.
  120108. */
  120109. private _userIsZooming;
  120110. private _lastFrameRadius;
  120111. private _shouldAnimationStopForInteraction;
  120112. /**
  120113. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  120114. */
  120115. private _applyUserInteraction;
  120116. private _userIsMoving;
  120117. }
  120118. }
  120119. declare module BABYLON {
  120120. /**
  120121. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  120122. */
  120123. export class AttachToBoxBehavior implements Behavior<Mesh> {
  120124. private ui;
  120125. /**
  120126. * The name of the behavior
  120127. */
  120128. name: string;
  120129. /**
  120130. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  120131. */
  120132. distanceAwayFromFace: number;
  120133. /**
  120134. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  120135. */
  120136. distanceAwayFromBottomOfFace: number;
  120137. private _faceVectors;
  120138. private _target;
  120139. private _scene;
  120140. private _onRenderObserver;
  120141. private _tmpMatrix;
  120142. private _tmpVector;
  120143. /**
  120144. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  120145. * @param ui The transform node that should be attched to the mesh
  120146. */
  120147. constructor(ui: TransformNode);
  120148. /**
  120149. * Initializes the behavior
  120150. */
  120151. init(): void;
  120152. private _closestFace;
  120153. private _zeroVector;
  120154. private _lookAtTmpMatrix;
  120155. private _lookAtToRef;
  120156. /**
  120157. * Attaches the AttachToBoxBehavior to the passed in mesh
  120158. * @param target The mesh that the specified node will be attached to
  120159. */
  120160. attach(target: Mesh): void;
  120161. /**
  120162. * Detaches the behavior from the mesh
  120163. */
  120164. detach(): void;
  120165. }
  120166. }
  120167. declare module BABYLON {
  120168. /**
  120169. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  120170. */
  120171. export class FadeInOutBehavior implements Behavior<Mesh> {
  120172. /**
  120173. * Time in milliseconds to delay before fading in (Default: 0)
  120174. */
  120175. delay: number;
  120176. /**
  120177. * Time in milliseconds for the mesh to fade in (Default: 300)
  120178. */
  120179. fadeInTime: number;
  120180. private _millisecondsPerFrame;
  120181. private _hovered;
  120182. private _hoverValue;
  120183. private _ownerNode;
  120184. /**
  120185. * Instatiates the FadeInOutBehavior
  120186. */
  120187. constructor();
  120188. /**
  120189. * The name of the behavior
  120190. */
  120191. get name(): string;
  120192. /**
  120193. * Initializes the behavior
  120194. */
  120195. init(): void;
  120196. /**
  120197. * Attaches the fade behavior on the passed in mesh
  120198. * @param ownerNode The mesh that will be faded in/out once attached
  120199. */
  120200. attach(ownerNode: Mesh): void;
  120201. /**
  120202. * Detaches the behavior from the mesh
  120203. */
  120204. detach(): void;
  120205. /**
  120206. * Triggers the mesh to begin fading in or out
  120207. * @param value if the object should fade in or out (true to fade in)
  120208. */
  120209. fadeIn(value: boolean): void;
  120210. private _update;
  120211. private _setAllVisibility;
  120212. }
  120213. }
  120214. declare module BABYLON {
  120215. /**
  120216. * Class containing a set of static utilities functions for managing Pivots
  120217. * @hidden
  120218. */
  120219. export class PivotTools {
  120220. private static _PivotCached;
  120221. private static _OldPivotPoint;
  120222. private static _PivotTranslation;
  120223. private static _PivotTmpVector;
  120224. /** @hidden */
  120225. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  120226. /** @hidden */
  120227. static _RestorePivotPoint(mesh: AbstractMesh): void;
  120228. }
  120229. }
  120230. declare module BABYLON {
  120231. /**
  120232. * Class containing static functions to help procedurally build meshes
  120233. */
  120234. export class PlaneBuilder {
  120235. /**
  120236. * Creates a plane mesh
  120237. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  120238. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  120239. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  120240. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120241. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120242. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120243. * @param name defines the name of the mesh
  120244. * @param options defines the options used to create the mesh
  120245. * @param scene defines the hosting scene
  120246. * @returns the plane mesh
  120247. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  120248. */
  120249. static CreatePlane(name: string, options: {
  120250. size?: number;
  120251. width?: number;
  120252. height?: number;
  120253. sideOrientation?: number;
  120254. frontUVs?: Vector4;
  120255. backUVs?: Vector4;
  120256. updatable?: boolean;
  120257. sourcePlane?: Plane;
  120258. }, scene?: Nullable<Scene>): Mesh;
  120259. }
  120260. }
  120261. declare module BABYLON {
  120262. /**
  120263. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  120264. */
  120265. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  120266. private static _AnyMouseID;
  120267. /**
  120268. * Abstract mesh the behavior is set on
  120269. */
  120270. attachedNode: AbstractMesh;
  120271. private _dragPlane;
  120272. private _scene;
  120273. private _pointerObserver;
  120274. private _beforeRenderObserver;
  120275. private static _planeScene;
  120276. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  120277. /**
  120278. * 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)
  120279. */
  120280. maxDragAngle: number;
  120281. /**
  120282. * @hidden
  120283. */
  120284. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  120285. /**
  120286. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  120287. */
  120288. currentDraggingPointerID: number;
  120289. /**
  120290. * The last position where the pointer hit the drag plane in world space
  120291. */
  120292. lastDragPosition: Vector3;
  120293. /**
  120294. * If the behavior is currently in a dragging state
  120295. */
  120296. dragging: boolean;
  120297. /**
  120298. * 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)
  120299. */
  120300. dragDeltaRatio: number;
  120301. /**
  120302. * If the drag plane orientation should be updated during the dragging (Default: true)
  120303. */
  120304. updateDragPlane: boolean;
  120305. private _debugMode;
  120306. private _moving;
  120307. /**
  120308. * Fires each time the attached mesh is dragged with the pointer
  120309. * * delta between last drag position and current drag position in world space
  120310. * * dragDistance along the drag axis
  120311. * * dragPlaneNormal normal of the current drag plane used during the drag
  120312. * * dragPlanePoint in world space where the drag intersects the drag plane
  120313. */
  120314. onDragObservable: Observable<{
  120315. delta: Vector3;
  120316. dragPlanePoint: Vector3;
  120317. dragPlaneNormal: Vector3;
  120318. dragDistance: number;
  120319. pointerId: number;
  120320. }>;
  120321. /**
  120322. * Fires each time a drag begins (eg. mouse down on mesh)
  120323. */
  120324. onDragStartObservable: Observable<{
  120325. dragPlanePoint: Vector3;
  120326. pointerId: number;
  120327. }>;
  120328. /**
  120329. * Fires each time a drag ends (eg. mouse release after drag)
  120330. */
  120331. onDragEndObservable: Observable<{
  120332. dragPlanePoint: Vector3;
  120333. pointerId: number;
  120334. }>;
  120335. /**
  120336. * If the attached mesh should be moved when dragged
  120337. */
  120338. moveAttached: boolean;
  120339. /**
  120340. * If the drag behavior will react to drag events (Default: true)
  120341. */
  120342. enabled: boolean;
  120343. /**
  120344. * If pointer events should start and release the drag (Default: true)
  120345. */
  120346. startAndReleaseDragOnPointerEvents: boolean;
  120347. /**
  120348. * If camera controls should be detached during the drag
  120349. */
  120350. detachCameraControls: boolean;
  120351. /**
  120352. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  120353. */
  120354. useObjectOrientationForDragging: boolean;
  120355. private _options;
  120356. /**
  120357. * Gets the options used by the behavior
  120358. */
  120359. get options(): {
  120360. dragAxis?: Vector3;
  120361. dragPlaneNormal?: Vector3;
  120362. };
  120363. /**
  120364. * Sets the options used by the behavior
  120365. */
  120366. set options(options: {
  120367. dragAxis?: Vector3;
  120368. dragPlaneNormal?: Vector3;
  120369. });
  120370. /**
  120371. * Creates a pointer drag behavior that can be attached to a mesh
  120372. * @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)
  120373. */
  120374. constructor(options?: {
  120375. dragAxis?: Vector3;
  120376. dragPlaneNormal?: Vector3;
  120377. });
  120378. /**
  120379. * Predicate to determine if it is valid to move the object to a new position when it is moved
  120380. */
  120381. validateDrag: (targetPosition: Vector3) => boolean;
  120382. /**
  120383. * The name of the behavior
  120384. */
  120385. get name(): string;
  120386. /**
  120387. * Initializes the behavior
  120388. */
  120389. init(): void;
  120390. private _tmpVector;
  120391. private _alternatePickedPoint;
  120392. private _worldDragAxis;
  120393. private _targetPosition;
  120394. private _attachedElement;
  120395. /**
  120396. * Attaches the drag behavior the passed in mesh
  120397. * @param ownerNode The mesh that will be dragged around once attached
  120398. * @param predicate Predicate to use for pick filtering
  120399. */
  120400. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  120401. /**
  120402. * Force relase the drag action by code.
  120403. */
  120404. releaseDrag(): void;
  120405. private _startDragRay;
  120406. private _lastPointerRay;
  120407. /**
  120408. * Simulates the start of a pointer drag event on the behavior
  120409. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  120410. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  120411. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  120412. */
  120413. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  120414. private _startDrag;
  120415. private _dragDelta;
  120416. private _moveDrag;
  120417. private _pickWithRayOnDragPlane;
  120418. private _pointA;
  120419. private _pointB;
  120420. private _pointC;
  120421. private _lineA;
  120422. private _lineB;
  120423. private _localAxis;
  120424. private _lookAt;
  120425. private _updateDragPlanePosition;
  120426. /**
  120427. * Detaches the behavior from the mesh
  120428. */
  120429. detach(): void;
  120430. }
  120431. }
  120432. declare module BABYLON {
  120433. /**
  120434. * A behavior that when attached to a mesh will allow the mesh to be scaled
  120435. */
  120436. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  120437. private _dragBehaviorA;
  120438. private _dragBehaviorB;
  120439. private _startDistance;
  120440. private _initialScale;
  120441. private _targetScale;
  120442. private _ownerNode;
  120443. private _sceneRenderObserver;
  120444. /**
  120445. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  120446. */
  120447. constructor();
  120448. /**
  120449. * The name of the behavior
  120450. */
  120451. get name(): string;
  120452. /**
  120453. * Initializes the behavior
  120454. */
  120455. init(): void;
  120456. private _getCurrentDistance;
  120457. /**
  120458. * Attaches the scale behavior the passed in mesh
  120459. * @param ownerNode The mesh that will be scaled around once attached
  120460. */
  120461. attach(ownerNode: Mesh): void;
  120462. /**
  120463. * Detaches the behavior from the mesh
  120464. */
  120465. detach(): void;
  120466. }
  120467. }
  120468. declare module BABYLON {
  120469. /**
  120470. * 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
  120471. */
  120472. export class SixDofDragBehavior implements Behavior<Mesh> {
  120473. private static _virtualScene;
  120474. private _ownerNode;
  120475. private _sceneRenderObserver;
  120476. private _scene;
  120477. private _targetPosition;
  120478. private _virtualOriginMesh;
  120479. private _virtualDragMesh;
  120480. private _pointerObserver;
  120481. private _moving;
  120482. private _startingOrientation;
  120483. private _attachedElement;
  120484. /**
  120485. * 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)
  120486. */
  120487. private zDragFactor;
  120488. /**
  120489. * If the object should rotate to face the drag origin
  120490. */
  120491. rotateDraggedObject: boolean;
  120492. /**
  120493. * If the behavior is currently in a dragging state
  120494. */
  120495. dragging: boolean;
  120496. /**
  120497. * 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)
  120498. */
  120499. dragDeltaRatio: number;
  120500. /**
  120501. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  120502. */
  120503. currentDraggingPointerID: number;
  120504. /**
  120505. * If camera controls should be detached during the drag
  120506. */
  120507. detachCameraControls: boolean;
  120508. /**
  120509. * Fires each time a drag starts
  120510. */
  120511. onDragStartObservable: Observable<{}>;
  120512. /**
  120513. * Fires each time a drag ends (eg. mouse release after drag)
  120514. */
  120515. onDragEndObservable: Observable<{}>;
  120516. /**
  120517. * 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
  120518. */
  120519. constructor();
  120520. /**
  120521. * The name of the behavior
  120522. */
  120523. get name(): string;
  120524. /**
  120525. * Initializes the behavior
  120526. */
  120527. init(): void;
  120528. /**
  120529. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  120530. */
  120531. private get _pointerCamera();
  120532. /**
  120533. * Attaches the scale behavior the passed in mesh
  120534. * @param ownerNode The mesh that will be scaled around once attached
  120535. */
  120536. attach(ownerNode: Mesh): void;
  120537. /**
  120538. * Detaches the behavior from the mesh
  120539. */
  120540. detach(): void;
  120541. }
  120542. }
  120543. declare module BABYLON {
  120544. /**
  120545. * Class used to apply inverse kinematics to bones
  120546. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  120547. */
  120548. export class BoneIKController {
  120549. private static _tmpVecs;
  120550. private static _tmpQuat;
  120551. private static _tmpMats;
  120552. /**
  120553. * Gets or sets the target mesh
  120554. */
  120555. targetMesh: AbstractMesh;
  120556. /** Gets or sets the mesh used as pole */
  120557. poleTargetMesh: AbstractMesh;
  120558. /**
  120559. * Gets or sets the bone used as pole
  120560. */
  120561. poleTargetBone: Nullable<Bone>;
  120562. /**
  120563. * Gets or sets the target position
  120564. */
  120565. targetPosition: Vector3;
  120566. /**
  120567. * Gets or sets the pole target position
  120568. */
  120569. poleTargetPosition: Vector3;
  120570. /**
  120571. * Gets or sets the pole target local offset
  120572. */
  120573. poleTargetLocalOffset: Vector3;
  120574. /**
  120575. * Gets or sets the pole angle
  120576. */
  120577. poleAngle: number;
  120578. /**
  120579. * Gets or sets the mesh associated with the controller
  120580. */
  120581. mesh: AbstractMesh;
  120582. /**
  120583. * 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)
  120584. */
  120585. slerpAmount: number;
  120586. private _bone1Quat;
  120587. private _bone1Mat;
  120588. private _bone2Ang;
  120589. private _bone1;
  120590. private _bone2;
  120591. private _bone1Length;
  120592. private _bone2Length;
  120593. private _maxAngle;
  120594. private _maxReach;
  120595. private _rightHandedSystem;
  120596. private _bendAxis;
  120597. private _slerping;
  120598. private _adjustRoll;
  120599. /**
  120600. * Gets or sets maximum allowed angle
  120601. */
  120602. get maxAngle(): number;
  120603. set maxAngle(value: number);
  120604. /**
  120605. * Creates a new BoneIKController
  120606. * @param mesh defines the mesh to control
  120607. * @param bone defines the bone to control
  120608. * @param options defines options to set up the controller
  120609. */
  120610. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  120611. targetMesh?: AbstractMesh;
  120612. poleTargetMesh?: AbstractMesh;
  120613. poleTargetBone?: Bone;
  120614. poleTargetLocalOffset?: Vector3;
  120615. poleAngle?: number;
  120616. bendAxis?: Vector3;
  120617. maxAngle?: number;
  120618. slerpAmount?: number;
  120619. });
  120620. private _setMaxAngle;
  120621. /**
  120622. * Force the controller to update the bones
  120623. */
  120624. update(): void;
  120625. }
  120626. }
  120627. declare module BABYLON {
  120628. /**
  120629. * Class used to make a bone look toward a point in space
  120630. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  120631. */
  120632. export class BoneLookController {
  120633. private static _tmpVecs;
  120634. private static _tmpQuat;
  120635. private static _tmpMats;
  120636. /**
  120637. * The target Vector3 that the bone will look at
  120638. */
  120639. target: Vector3;
  120640. /**
  120641. * The mesh that the bone is attached to
  120642. */
  120643. mesh: AbstractMesh;
  120644. /**
  120645. * The bone that will be looking to the target
  120646. */
  120647. bone: Bone;
  120648. /**
  120649. * The up axis of the coordinate system that is used when the bone is rotated
  120650. */
  120651. upAxis: Vector3;
  120652. /**
  120653. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  120654. */
  120655. upAxisSpace: Space;
  120656. /**
  120657. * Used to make an adjustment to the yaw of the bone
  120658. */
  120659. adjustYaw: number;
  120660. /**
  120661. * Used to make an adjustment to the pitch of the bone
  120662. */
  120663. adjustPitch: number;
  120664. /**
  120665. * Used to make an adjustment to the roll of the bone
  120666. */
  120667. adjustRoll: number;
  120668. /**
  120669. * 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)
  120670. */
  120671. slerpAmount: number;
  120672. private _minYaw;
  120673. private _maxYaw;
  120674. private _minPitch;
  120675. private _maxPitch;
  120676. private _minYawSin;
  120677. private _minYawCos;
  120678. private _maxYawSin;
  120679. private _maxYawCos;
  120680. private _midYawConstraint;
  120681. private _minPitchTan;
  120682. private _maxPitchTan;
  120683. private _boneQuat;
  120684. private _slerping;
  120685. private _transformYawPitch;
  120686. private _transformYawPitchInv;
  120687. private _firstFrameSkipped;
  120688. private _yawRange;
  120689. private _fowardAxis;
  120690. /**
  120691. * Gets or sets the minimum yaw angle that the bone can look to
  120692. */
  120693. get minYaw(): number;
  120694. set minYaw(value: number);
  120695. /**
  120696. * Gets or sets the maximum yaw angle that the bone can look to
  120697. */
  120698. get maxYaw(): number;
  120699. set maxYaw(value: number);
  120700. /**
  120701. * Gets or sets the minimum pitch angle that the bone can look to
  120702. */
  120703. get minPitch(): number;
  120704. set minPitch(value: number);
  120705. /**
  120706. * Gets or sets the maximum pitch angle that the bone can look to
  120707. */
  120708. get maxPitch(): number;
  120709. set maxPitch(value: number);
  120710. /**
  120711. * Create a BoneLookController
  120712. * @param mesh the mesh that the bone belongs to
  120713. * @param bone the bone that will be looking to the target
  120714. * @param target the target Vector3 to look at
  120715. * @param options optional settings:
  120716. * * maxYaw: the maximum angle the bone will yaw to
  120717. * * minYaw: the minimum angle the bone will yaw to
  120718. * * maxPitch: the maximum angle the bone will pitch to
  120719. * * minPitch: the minimum angle the bone will yaw to
  120720. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  120721. * * upAxis: the up axis of the coordinate system
  120722. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  120723. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  120724. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  120725. * * adjustYaw: used to make an adjustment to the yaw of the bone
  120726. * * adjustPitch: used to make an adjustment to the pitch of the bone
  120727. * * adjustRoll: used to make an adjustment to the roll of the bone
  120728. **/
  120729. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  120730. maxYaw?: number;
  120731. minYaw?: number;
  120732. maxPitch?: number;
  120733. minPitch?: number;
  120734. slerpAmount?: number;
  120735. upAxis?: Vector3;
  120736. upAxisSpace?: Space;
  120737. yawAxis?: Vector3;
  120738. pitchAxis?: Vector3;
  120739. adjustYaw?: number;
  120740. adjustPitch?: number;
  120741. adjustRoll?: number;
  120742. });
  120743. /**
  120744. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  120745. */
  120746. update(): void;
  120747. private _getAngleDiff;
  120748. private _getAngleBetween;
  120749. private _isAngleBetween;
  120750. }
  120751. }
  120752. declare module BABYLON {
  120753. /**
  120754. * Manage the gamepad inputs to control an arc rotate camera.
  120755. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  120756. */
  120757. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  120758. /**
  120759. * Defines the camera the input is attached to.
  120760. */
  120761. camera: ArcRotateCamera;
  120762. /**
  120763. * Defines the gamepad the input is gathering event from.
  120764. */
  120765. gamepad: Nullable<Gamepad>;
  120766. /**
  120767. * Defines the gamepad rotation sensiblity.
  120768. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  120769. */
  120770. gamepadRotationSensibility: number;
  120771. /**
  120772. * Defines the gamepad move sensiblity.
  120773. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  120774. */
  120775. gamepadMoveSensibility: number;
  120776. private _yAxisScale;
  120777. /**
  120778. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  120779. */
  120780. get invertYAxis(): boolean;
  120781. set invertYAxis(value: boolean);
  120782. private _onGamepadConnectedObserver;
  120783. private _onGamepadDisconnectedObserver;
  120784. /**
  120785. * Attach the input controls to a specific dom element to get the input from.
  120786. * @param element Defines the element the controls should be listened from
  120787. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  120788. */
  120789. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  120790. /**
  120791. * Detach the current controls from the specified dom element.
  120792. * @param element Defines the element to stop listening the inputs from
  120793. */
  120794. detachControl(element: Nullable<HTMLElement>): void;
  120795. /**
  120796. * Update the current camera state depending on the inputs that have been used this frame.
  120797. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  120798. */
  120799. checkInputs(): void;
  120800. /**
  120801. * Gets the class name of the current intput.
  120802. * @returns the class name
  120803. */
  120804. getClassName(): string;
  120805. /**
  120806. * Get the friendly name associated with the input class.
  120807. * @returns the input friendly name
  120808. */
  120809. getSimpleName(): string;
  120810. }
  120811. }
  120812. declare module BABYLON {
  120813. interface ArcRotateCameraInputsManager {
  120814. /**
  120815. * Add orientation input support to the input manager.
  120816. * @returns the current input manager
  120817. */
  120818. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  120819. }
  120820. /**
  120821. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  120822. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  120823. */
  120824. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  120825. /**
  120826. * Defines the camera the input is attached to.
  120827. */
  120828. camera: ArcRotateCamera;
  120829. /**
  120830. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  120831. */
  120832. alphaCorrection: number;
  120833. /**
  120834. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  120835. */
  120836. gammaCorrection: number;
  120837. private _alpha;
  120838. private _gamma;
  120839. private _dirty;
  120840. private _deviceOrientationHandler;
  120841. /**
  120842. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  120843. */
  120844. constructor();
  120845. /**
  120846. * Attach the input controls to a specific dom element to get the input from.
  120847. * @param element Defines the element the controls should be listened from
  120848. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  120849. */
  120850. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  120851. /** @hidden */
  120852. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  120853. /**
  120854. * Update the current camera state depending on the inputs that have been used this frame.
  120855. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  120856. */
  120857. checkInputs(): void;
  120858. /**
  120859. * Detach the current controls from the specified dom element.
  120860. * @param element Defines the element to stop listening the inputs from
  120861. */
  120862. detachControl(element: Nullable<HTMLElement>): void;
  120863. /**
  120864. * Gets the class name of the current intput.
  120865. * @returns the class name
  120866. */
  120867. getClassName(): string;
  120868. /**
  120869. * Get the friendly name associated with the input class.
  120870. * @returns the input friendly name
  120871. */
  120872. getSimpleName(): string;
  120873. }
  120874. }
  120875. declare module BABYLON {
  120876. /**
  120877. * Listen to mouse events to control the camera.
  120878. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  120879. */
  120880. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  120881. /**
  120882. * Defines the camera the input is attached to.
  120883. */
  120884. camera: FlyCamera;
  120885. /**
  120886. * Defines if touch is enabled. (Default is true.)
  120887. */
  120888. touchEnabled: boolean;
  120889. /**
  120890. * Defines the buttons associated with the input to handle camera rotation.
  120891. */
  120892. buttons: number[];
  120893. /**
  120894. * Assign buttons for Yaw control.
  120895. */
  120896. buttonsYaw: number[];
  120897. /**
  120898. * Assign buttons for Pitch control.
  120899. */
  120900. buttonsPitch: number[];
  120901. /**
  120902. * Assign buttons for Roll control.
  120903. */
  120904. buttonsRoll: number[];
  120905. /**
  120906. * Detect if any button is being pressed while mouse is moved.
  120907. * -1 = Mouse locked.
  120908. * 0 = Left button.
  120909. * 1 = Middle Button.
  120910. * 2 = Right Button.
  120911. */
  120912. activeButton: number;
  120913. /**
  120914. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  120915. * Higher values reduce its sensitivity.
  120916. */
  120917. angularSensibility: number;
  120918. private _mousemoveCallback;
  120919. private _observer;
  120920. private _rollObserver;
  120921. private previousPosition;
  120922. private noPreventDefault;
  120923. private element;
  120924. /**
  120925. * Listen to mouse events to control the camera.
  120926. * @param touchEnabled Define if touch is enabled. (Default is true.)
  120927. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  120928. */
  120929. constructor(touchEnabled?: boolean);
  120930. /**
  120931. * Attach the mouse control to the HTML DOM element.
  120932. * @param element Defines the element that listens to the input events.
  120933. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  120934. */
  120935. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  120936. /**
  120937. * Detach the current controls from the specified dom element.
  120938. * @param element Defines the element to stop listening the inputs from
  120939. */
  120940. detachControl(element: Nullable<HTMLElement>): void;
  120941. /**
  120942. * Gets the class name of the current input.
  120943. * @returns the class name.
  120944. */
  120945. getClassName(): string;
  120946. /**
  120947. * Get the friendly name associated with the input class.
  120948. * @returns the input's friendly name.
  120949. */
  120950. getSimpleName(): string;
  120951. private _pointerInput;
  120952. private _onMouseMove;
  120953. /**
  120954. * Rotate camera by mouse offset.
  120955. */
  120956. private rotateCamera;
  120957. }
  120958. }
  120959. declare module BABYLON {
  120960. /**
  120961. * Default Inputs manager for the FlyCamera.
  120962. * It groups all the default supported inputs for ease of use.
  120963. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  120964. */
  120965. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  120966. /**
  120967. * Instantiates a new FlyCameraInputsManager.
  120968. * @param camera Defines the camera the inputs belong to.
  120969. */
  120970. constructor(camera: FlyCamera);
  120971. /**
  120972. * Add keyboard input support to the input manager.
  120973. * @returns the new FlyCameraKeyboardMoveInput().
  120974. */
  120975. addKeyboard(): FlyCameraInputsManager;
  120976. /**
  120977. * Add mouse input support to the input manager.
  120978. * @param touchEnabled Enable touch screen support.
  120979. * @returns the new FlyCameraMouseInput().
  120980. */
  120981. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  120982. }
  120983. }
  120984. declare module BABYLON {
  120985. /**
  120986. * This is a flying camera, designed for 3D movement and rotation in all directions,
  120987. * such as in a 3D Space Shooter or a Flight Simulator.
  120988. */
  120989. export class FlyCamera extends TargetCamera {
  120990. /**
  120991. * Define the collision ellipsoid of the camera.
  120992. * This is helpful for simulating a camera body, like a player's body.
  120993. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  120994. */
  120995. ellipsoid: Vector3;
  120996. /**
  120997. * Define an offset for the position of the ellipsoid around the camera.
  120998. * This can be helpful if the camera is attached away from the player's body center,
  120999. * such as at its head.
  121000. */
  121001. ellipsoidOffset: Vector3;
  121002. /**
  121003. * Enable or disable collisions of the camera with the rest of the scene objects.
  121004. */
  121005. checkCollisions: boolean;
  121006. /**
  121007. * Enable or disable gravity on the camera.
  121008. */
  121009. applyGravity: boolean;
  121010. /**
  121011. * Define the current direction the camera is moving to.
  121012. */
  121013. cameraDirection: Vector3;
  121014. /**
  121015. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  121016. * This overrides and empties cameraRotation.
  121017. */
  121018. rotationQuaternion: Quaternion;
  121019. /**
  121020. * Track Roll to maintain the wanted Rolling when looking around.
  121021. */
  121022. _trackRoll: number;
  121023. /**
  121024. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  121025. */
  121026. rollCorrect: number;
  121027. /**
  121028. * Mimic a banked turn, Rolling the camera when Yawing.
  121029. * It's recommended to use rollCorrect = 10 for faster banking correction.
  121030. */
  121031. bankedTurn: boolean;
  121032. /**
  121033. * Limit in radians for how much Roll banking will add. (Default: 90°)
  121034. */
  121035. bankedTurnLimit: number;
  121036. /**
  121037. * Value of 0 disables the banked Roll.
  121038. * Value of 1 is equal to the Yaw angle in radians.
  121039. */
  121040. bankedTurnMultiplier: number;
  121041. /**
  121042. * The inputs manager loads all the input sources, such as keyboard and mouse.
  121043. */
  121044. inputs: FlyCameraInputsManager;
  121045. /**
  121046. * Gets the input sensibility for mouse input.
  121047. * Higher values reduce sensitivity.
  121048. */
  121049. get angularSensibility(): number;
  121050. /**
  121051. * Sets the input sensibility for a mouse input.
  121052. * Higher values reduce sensitivity.
  121053. */
  121054. set angularSensibility(value: number);
  121055. /**
  121056. * Get the keys for camera movement forward.
  121057. */
  121058. get keysForward(): number[];
  121059. /**
  121060. * Set the keys for camera movement forward.
  121061. */
  121062. set keysForward(value: number[]);
  121063. /**
  121064. * Get the keys for camera movement backward.
  121065. */
  121066. get keysBackward(): number[];
  121067. set keysBackward(value: number[]);
  121068. /**
  121069. * Get the keys for camera movement up.
  121070. */
  121071. get keysUp(): number[];
  121072. /**
  121073. * Set the keys for camera movement up.
  121074. */
  121075. set keysUp(value: number[]);
  121076. /**
  121077. * Get the keys for camera movement down.
  121078. */
  121079. get keysDown(): number[];
  121080. /**
  121081. * Set the keys for camera movement down.
  121082. */
  121083. set keysDown(value: number[]);
  121084. /**
  121085. * Get the keys for camera movement left.
  121086. */
  121087. get keysLeft(): number[];
  121088. /**
  121089. * Set the keys for camera movement left.
  121090. */
  121091. set keysLeft(value: number[]);
  121092. /**
  121093. * Set the keys for camera movement right.
  121094. */
  121095. get keysRight(): number[];
  121096. /**
  121097. * Set the keys for camera movement right.
  121098. */
  121099. set keysRight(value: number[]);
  121100. /**
  121101. * Event raised when the camera collides with a mesh in the scene.
  121102. */
  121103. onCollide: (collidedMesh: AbstractMesh) => void;
  121104. private _collider;
  121105. private _needMoveForGravity;
  121106. private _oldPosition;
  121107. private _diffPosition;
  121108. private _newPosition;
  121109. /** @hidden */
  121110. _localDirection: Vector3;
  121111. /** @hidden */
  121112. _transformedDirection: Vector3;
  121113. /**
  121114. * Instantiates a FlyCamera.
  121115. * This is a flying camera, designed for 3D movement and rotation in all directions,
  121116. * such as in a 3D Space Shooter or a Flight Simulator.
  121117. * @param name Define the name of the camera in the scene.
  121118. * @param position Define the starting position of the camera in the scene.
  121119. * @param scene Define the scene the camera belongs to.
  121120. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  121121. */
  121122. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  121123. /**
  121124. * Attach a control to the HTML DOM element.
  121125. * @param element Defines the element that listens to the input events.
  121126. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  121127. */
  121128. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121129. /**
  121130. * Detach a control from the HTML DOM element.
  121131. * The camera will stop reacting to that input.
  121132. * @param element Defines the element that listens to the input events.
  121133. */
  121134. detachControl(element: HTMLElement): void;
  121135. private _collisionMask;
  121136. /**
  121137. * Get the mask that the camera ignores in collision events.
  121138. */
  121139. get collisionMask(): number;
  121140. /**
  121141. * Set the mask that the camera ignores in collision events.
  121142. */
  121143. set collisionMask(mask: number);
  121144. /** @hidden */
  121145. _collideWithWorld(displacement: Vector3): void;
  121146. /** @hidden */
  121147. private _onCollisionPositionChange;
  121148. /** @hidden */
  121149. _checkInputs(): void;
  121150. /** @hidden */
  121151. _decideIfNeedsToMove(): boolean;
  121152. /** @hidden */
  121153. _updatePosition(): void;
  121154. /**
  121155. * Restore the Roll to its target value at the rate specified.
  121156. * @param rate - Higher means slower restoring.
  121157. * @hidden
  121158. */
  121159. restoreRoll(rate: number): void;
  121160. /**
  121161. * Destroy the camera and release the current resources held by it.
  121162. */
  121163. dispose(): void;
  121164. /**
  121165. * Get the current object class name.
  121166. * @returns the class name.
  121167. */
  121168. getClassName(): string;
  121169. }
  121170. }
  121171. declare module BABYLON {
  121172. /**
  121173. * Listen to keyboard events to control the camera.
  121174. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  121175. */
  121176. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  121177. /**
  121178. * Defines the camera the input is attached to.
  121179. */
  121180. camera: FlyCamera;
  121181. /**
  121182. * The list of keyboard keys used to control the forward move of the camera.
  121183. */
  121184. keysForward: number[];
  121185. /**
  121186. * The list of keyboard keys used to control the backward move of the camera.
  121187. */
  121188. keysBackward: number[];
  121189. /**
  121190. * The list of keyboard keys used to control the forward move of the camera.
  121191. */
  121192. keysUp: number[];
  121193. /**
  121194. * The list of keyboard keys used to control the backward move of the camera.
  121195. */
  121196. keysDown: number[];
  121197. /**
  121198. * The list of keyboard keys used to control the right strafe move of the camera.
  121199. */
  121200. keysRight: number[];
  121201. /**
  121202. * The list of keyboard keys used to control the left strafe move of the camera.
  121203. */
  121204. keysLeft: number[];
  121205. private _keys;
  121206. private _onCanvasBlurObserver;
  121207. private _onKeyboardObserver;
  121208. private _engine;
  121209. private _scene;
  121210. /**
  121211. * Attach the input controls to a specific dom element to get the input from.
  121212. * @param element Defines the element the controls should be listened from
  121213. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121214. */
  121215. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121216. /**
  121217. * Detach the current controls from the specified dom element.
  121218. * @param element Defines the element to stop listening the inputs from
  121219. */
  121220. detachControl(element: Nullable<HTMLElement>): void;
  121221. /**
  121222. * Gets the class name of the current intput.
  121223. * @returns the class name
  121224. */
  121225. getClassName(): string;
  121226. /** @hidden */
  121227. _onLostFocus(e: FocusEvent): void;
  121228. /**
  121229. * Get the friendly name associated with the input class.
  121230. * @returns the input friendly name
  121231. */
  121232. getSimpleName(): string;
  121233. /**
  121234. * Update the current camera state depending on the inputs that have been used this frame.
  121235. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  121236. */
  121237. checkInputs(): void;
  121238. }
  121239. }
  121240. declare module BABYLON {
  121241. /**
  121242. * Manage the mouse wheel inputs to control a follow camera.
  121243. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  121244. */
  121245. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  121246. /**
  121247. * Defines the camera the input is attached to.
  121248. */
  121249. camera: FollowCamera;
  121250. /**
  121251. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  121252. */
  121253. axisControlRadius: boolean;
  121254. /**
  121255. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  121256. */
  121257. axisControlHeight: boolean;
  121258. /**
  121259. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  121260. */
  121261. axisControlRotation: boolean;
  121262. /**
  121263. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  121264. * relation to mouseWheel events.
  121265. */
  121266. wheelPrecision: number;
  121267. /**
  121268. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  121269. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  121270. */
  121271. wheelDeltaPercentage: number;
  121272. private _wheel;
  121273. private _observer;
  121274. /**
  121275. * Attach the input controls to a specific dom element to get the input from.
  121276. * @param element Defines the element the controls should be listened from
  121277. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121278. */
  121279. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121280. /**
  121281. * Detach the current controls from the specified dom element.
  121282. * @param element Defines the element to stop listening the inputs from
  121283. */
  121284. detachControl(element: Nullable<HTMLElement>): void;
  121285. /**
  121286. * Gets the class name of the current intput.
  121287. * @returns the class name
  121288. */
  121289. getClassName(): string;
  121290. /**
  121291. * Get the friendly name associated with the input class.
  121292. * @returns the input friendly name
  121293. */
  121294. getSimpleName(): string;
  121295. }
  121296. }
  121297. declare module BABYLON {
  121298. /**
  121299. * Manage the pointers inputs to control an follow camera.
  121300. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  121301. */
  121302. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  121303. /**
  121304. * Defines the camera the input is attached to.
  121305. */
  121306. camera: FollowCamera;
  121307. /**
  121308. * Gets the class name of the current input.
  121309. * @returns the class name
  121310. */
  121311. getClassName(): string;
  121312. /**
  121313. * Defines the pointer angular sensibility along the X axis or how fast is
  121314. * the camera rotating.
  121315. * A negative number will reverse the axis direction.
  121316. */
  121317. angularSensibilityX: number;
  121318. /**
  121319. * Defines the pointer angular sensibility along the Y axis or how fast is
  121320. * the camera rotating.
  121321. * A negative number will reverse the axis direction.
  121322. */
  121323. angularSensibilityY: number;
  121324. /**
  121325. * Defines the pointer pinch precision or how fast is the camera zooming.
  121326. * A negative number will reverse the axis direction.
  121327. */
  121328. pinchPrecision: number;
  121329. /**
  121330. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  121331. * from 0.
  121332. * It defines the percentage of current camera.radius to use as delta when
  121333. * pinch zoom is used.
  121334. */
  121335. pinchDeltaPercentage: number;
  121336. /**
  121337. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  121338. */
  121339. axisXControlRadius: boolean;
  121340. /**
  121341. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  121342. */
  121343. axisXControlHeight: boolean;
  121344. /**
  121345. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  121346. */
  121347. axisXControlRotation: boolean;
  121348. /**
  121349. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  121350. */
  121351. axisYControlRadius: boolean;
  121352. /**
  121353. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  121354. */
  121355. axisYControlHeight: boolean;
  121356. /**
  121357. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  121358. */
  121359. axisYControlRotation: boolean;
  121360. /**
  121361. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  121362. */
  121363. axisPinchControlRadius: boolean;
  121364. /**
  121365. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  121366. */
  121367. axisPinchControlHeight: boolean;
  121368. /**
  121369. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  121370. */
  121371. axisPinchControlRotation: boolean;
  121372. /**
  121373. * Log error messages if basic misconfiguration has occurred.
  121374. */
  121375. warningEnable: boolean;
  121376. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  121377. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  121378. private _warningCounter;
  121379. private _warning;
  121380. }
  121381. }
  121382. declare module BABYLON {
  121383. /**
  121384. * Default Inputs manager for the FollowCamera.
  121385. * It groups all the default supported inputs for ease of use.
  121386. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  121387. */
  121388. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  121389. /**
  121390. * Instantiates a new FollowCameraInputsManager.
  121391. * @param camera Defines the camera the inputs belong to
  121392. */
  121393. constructor(camera: FollowCamera);
  121394. /**
  121395. * Add keyboard input support to the input manager.
  121396. * @returns the current input manager
  121397. */
  121398. addKeyboard(): FollowCameraInputsManager;
  121399. /**
  121400. * Add mouse wheel input support to the input manager.
  121401. * @returns the current input manager
  121402. */
  121403. addMouseWheel(): FollowCameraInputsManager;
  121404. /**
  121405. * Add pointers input support to the input manager.
  121406. * @returns the current input manager
  121407. */
  121408. addPointers(): FollowCameraInputsManager;
  121409. /**
  121410. * Add orientation input support to the input manager.
  121411. * @returns the current input manager
  121412. */
  121413. addVRDeviceOrientation(): FollowCameraInputsManager;
  121414. }
  121415. }
  121416. declare module BABYLON {
  121417. /**
  121418. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  121419. * an arc rotate version arcFollowCamera are available.
  121420. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  121421. */
  121422. export class FollowCamera extends TargetCamera {
  121423. /**
  121424. * Distance the follow camera should follow an object at
  121425. */
  121426. radius: number;
  121427. /**
  121428. * Minimum allowed distance of the camera to the axis of rotation
  121429. * (The camera can not get closer).
  121430. * This can help limiting how the Camera is able to move in the scene.
  121431. */
  121432. lowerRadiusLimit: Nullable<number>;
  121433. /**
  121434. * Maximum allowed distance of the camera to the axis of rotation
  121435. * (The camera can not get further).
  121436. * This can help limiting how the Camera is able to move in the scene.
  121437. */
  121438. upperRadiusLimit: Nullable<number>;
  121439. /**
  121440. * Define a rotation offset between the camera and the object it follows
  121441. */
  121442. rotationOffset: number;
  121443. /**
  121444. * Minimum allowed angle to camera position relative to target object.
  121445. * This can help limiting how the Camera is able to move in the scene.
  121446. */
  121447. lowerRotationOffsetLimit: Nullable<number>;
  121448. /**
  121449. * Maximum allowed angle to camera position relative to target object.
  121450. * This can help limiting how the Camera is able to move in the scene.
  121451. */
  121452. upperRotationOffsetLimit: Nullable<number>;
  121453. /**
  121454. * Define a height offset between the camera and the object it follows.
  121455. * It can help following an object from the top (like a car chaing a plane)
  121456. */
  121457. heightOffset: number;
  121458. /**
  121459. * Minimum allowed height of camera position relative to target object.
  121460. * This can help limiting how the Camera is able to move in the scene.
  121461. */
  121462. lowerHeightOffsetLimit: Nullable<number>;
  121463. /**
  121464. * Maximum allowed height of camera position relative to target object.
  121465. * This can help limiting how the Camera is able to move in the scene.
  121466. */
  121467. upperHeightOffsetLimit: Nullable<number>;
  121468. /**
  121469. * Define how fast the camera can accelerate to follow it s target.
  121470. */
  121471. cameraAcceleration: number;
  121472. /**
  121473. * Define the speed limit of the camera following an object.
  121474. */
  121475. maxCameraSpeed: number;
  121476. /**
  121477. * Define the target of the camera.
  121478. */
  121479. lockedTarget: Nullable<AbstractMesh>;
  121480. /**
  121481. * Defines the input associated with the camera.
  121482. */
  121483. inputs: FollowCameraInputsManager;
  121484. /**
  121485. * Instantiates the follow camera.
  121486. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  121487. * @param name Define the name of the camera in the scene
  121488. * @param position Define the position of the camera
  121489. * @param scene Define the scene the camera belong to
  121490. * @param lockedTarget Define the target of the camera
  121491. */
  121492. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  121493. private _follow;
  121494. /**
  121495. * Attached controls to the current camera.
  121496. * @param element Defines the element the controls should be listened from
  121497. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121498. */
  121499. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121500. /**
  121501. * Detach the current controls from the camera.
  121502. * The camera will stop reacting to inputs.
  121503. * @param element Defines the element to stop listening the inputs from
  121504. */
  121505. detachControl(element: HTMLElement): void;
  121506. /** @hidden */
  121507. _checkInputs(): void;
  121508. private _checkLimits;
  121509. /**
  121510. * Gets the camera class name.
  121511. * @returns the class name
  121512. */
  121513. getClassName(): string;
  121514. }
  121515. /**
  121516. * Arc Rotate version of the follow camera.
  121517. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  121518. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  121519. */
  121520. export class ArcFollowCamera extends TargetCamera {
  121521. /** The longitudinal angle of the camera */
  121522. alpha: number;
  121523. /** The latitudinal angle of the camera */
  121524. beta: number;
  121525. /** The radius of the camera from its target */
  121526. radius: number;
  121527. /** Define the camera target (the mesh it should follow) */
  121528. target: Nullable<AbstractMesh>;
  121529. private _cartesianCoordinates;
  121530. /**
  121531. * Instantiates a new ArcFollowCamera
  121532. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  121533. * @param name Define the name of the camera
  121534. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  121535. * @param beta Define the rotation angle of the camera around the elevation axis
  121536. * @param radius Define the radius of the camera from its target point
  121537. * @param target Define the target of the camera
  121538. * @param scene Define the scene the camera belongs to
  121539. */
  121540. constructor(name: string,
  121541. /** The longitudinal angle of the camera */
  121542. alpha: number,
  121543. /** The latitudinal angle of the camera */
  121544. beta: number,
  121545. /** The radius of the camera from its target */
  121546. radius: number,
  121547. /** Define the camera target (the mesh it should follow) */
  121548. target: Nullable<AbstractMesh>, scene: Scene);
  121549. private _follow;
  121550. /** @hidden */
  121551. _checkInputs(): void;
  121552. /**
  121553. * Returns the class name of the object.
  121554. * It is mostly used internally for serialization purposes.
  121555. */
  121556. getClassName(): string;
  121557. }
  121558. }
  121559. declare module BABYLON {
  121560. /**
  121561. * Manage the keyboard inputs to control the movement of a follow camera.
  121562. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  121563. */
  121564. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  121565. /**
  121566. * Defines the camera the input is attached to.
  121567. */
  121568. camera: FollowCamera;
  121569. /**
  121570. * Defines the list of key codes associated with the up action (increase heightOffset)
  121571. */
  121572. keysHeightOffsetIncr: number[];
  121573. /**
  121574. * Defines the list of key codes associated with the down action (decrease heightOffset)
  121575. */
  121576. keysHeightOffsetDecr: number[];
  121577. /**
  121578. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  121579. */
  121580. keysHeightOffsetModifierAlt: boolean;
  121581. /**
  121582. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  121583. */
  121584. keysHeightOffsetModifierCtrl: boolean;
  121585. /**
  121586. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  121587. */
  121588. keysHeightOffsetModifierShift: boolean;
  121589. /**
  121590. * Defines the list of key codes associated with the left action (increase rotationOffset)
  121591. */
  121592. keysRotationOffsetIncr: number[];
  121593. /**
  121594. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  121595. */
  121596. keysRotationOffsetDecr: number[];
  121597. /**
  121598. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  121599. */
  121600. keysRotationOffsetModifierAlt: boolean;
  121601. /**
  121602. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  121603. */
  121604. keysRotationOffsetModifierCtrl: boolean;
  121605. /**
  121606. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  121607. */
  121608. keysRotationOffsetModifierShift: boolean;
  121609. /**
  121610. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  121611. */
  121612. keysRadiusIncr: number[];
  121613. /**
  121614. * Defines the list of key codes associated with the zoom-out action (increase radius)
  121615. */
  121616. keysRadiusDecr: number[];
  121617. /**
  121618. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  121619. */
  121620. keysRadiusModifierAlt: boolean;
  121621. /**
  121622. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  121623. */
  121624. keysRadiusModifierCtrl: boolean;
  121625. /**
  121626. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  121627. */
  121628. keysRadiusModifierShift: boolean;
  121629. /**
  121630. * Defines the rate of change of heightOffset.
  121631. */
  121632. heightSensibility: number;
  121633. /**
  121634. * Defines the rate of change of rotationOffset.
  121635. */
  121636. rotationSensibility: number;
  121637. /**
  121638. * Defines the rate of change of radius.
  121639. */
  121640. radiusSensibility: number;
  121641. private _keys;
  121642. private _ctrlPressed;
  121643. private _altPressed;
  121644. private _shiftPressed;
  121645. private _onCanvasBlurObserver;
  121646. private _onKeyboardObserver;
  121647. private _engine;
  121648. private _scene;
  121649. /**
  121650. * Attach the input controls to a specific dom element to get the input from.
  121651. * @param element Defines the element the controls should be listened from
  121652. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121653. */
  121654. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121655. /**
  121656. * Detach the current controls from the specified dom element.
  121657. * @param element Defines the element to stop listening the inputs from
  121658. */
  121659. detachControl(element: Nullable<HTMLElement>): void;
  121660. /**
  121661. * Update the current camera state depending on the inputs that have been used this frame.
  121662. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  121663. */
  121664. checkInputs(): void;
  121665. /**
  121666. * Gets the class name of the current input.
  121667. * @returns the class name
  121668. */
  121669. getClassName(): string;
  121670. /**
  121671. * Get the friendly name associated with the input class.
  121672. * @returns the input friendly name
  121673. */
  121674. getSimpleName(): string;
  121675. /**
  121676. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  121677. * allow modification of the heightOffset value.
  121678. */
  121679. private _modifierHeightOffset;
  121680. /**
  121681. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  121682. * allow modification of the rotationOffset value.
  121683. */
  121684. private _modifierRotationOffset;
  121685. /**
  121686. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  121687. * allow modification of the radius value.
  121688. */
  121689. private _modifierRadius;
  121690. }
  121691. }
  121692. declare module BABYLON {
  121693. interface FreeCameraInputsManager {
  121694. /**
  121695. * @hidden
  121696. */
  121697. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  121698. /**
  121699. * Add orientation input support to the input manager.
  121700. * @returns the current input manager
  121701. */
  121702. addDeviceOrientation(): FreeCameraInputsManager;
  121703. }
  121704. /**
  121705. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  121706. * Screen rotation is taken into account.
  121707. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  121708. */
  121709. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  121710. private _camera;
  121711. private _screenOrientationAngle;
  121712. private _constantTranform;
  121713. private _screenQuaternion;
  121714. private _alpha;
  121715. private _beta;
  121716. private _gamma;
  121717. /**
  121718. * Can be used to detect if a device orientation sensor is available on a device
  121719. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  121720. * @returns a promise that will resolve on orientation change
  121721. */
  121722. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  121723. /**
  121724. * @hidden
  121725. */
  121726. _onDeviceOrientationChangedObservable: Observable<void>;
  121727. /**
  121728. * Instantiates a new input
  121729. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  121730. */
  121731. constructor();
  121732. /**
  121733. * Define the camera controlled by the input.
  121734. */
  121735. get camera(): FreeCamera;
  121736. set camera(camera: FreeCamera);
  121737. /**
  121738. * Attach the input controls to a specific dom element to get the input from.
  121739. * @param element Defines the element the controls should be listened from
  121740. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121741. */
  121742. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121743. private _orientationChanged;
  121744. private _deviceOrientation;
  121745. /**
  121746. * Detach the current controls from the specified dom element.
  121747. * @param element Defines the element to stop listening the inputs from
  121748. */
  121749. detachControl(element: Nullable<HTMLElement>): void;
  121750. /**
  121751. * Update the current camera state depending on the inputs that have been used this frame.
  121752. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  121753. */
  121754. checkInputs(): void;
  121755. /**
  121756. * Gets the class name of the current intput.
  121757. * @returns the class name
  121758. */
  121759. getClassName(): string;
  121760. /**
  121761. * Get the friendly name associated with the input class.
  121762. * @returns the input friendly name
  121763. */
  121764. getSimpleName(): string;
  121765. }
  121766. }
  121767. declare module BABYLON {
  121768. /**
  121769. * Manage the gamepad inputs to control a free camera.
  121770. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  121771. */
  121772. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  121773. /**
  121774. * Define the camera the input is attached to.
  121775. */
  121776. camera: FreeCamera;
  121777. /**
  121778. * Define the Gamepad controlling the input
  121779. */
  121780. gamepad: Nullable<Gamepad>;
  121781. /**
  121782. * Defines the gamepad rotation sensiblity.
  121783. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  121784. */
  121785. gamepadAngularSensibility: number;
  121786. /**
  121787. * Defines the gamepad move sensiblity.
  121788. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  121789. */
  121790. gamepadMoveSensibility: number;
  121791. private _yAxisScale;
  121792. /**
  121793. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  121794. */
  121795. get invertYAxis(): boolean;
  121796. set invertYAxis(value: boolean);
  121797. private _onGamepadConnectedObserver;
  121798. private _onGamepadDisconnectedObserver;
  121799. private _cameraTransform;
  121800. private _deltaTransform;
  121801. private _vector3;
  121802. private _vector2;
  121803. /**
  121804. * Attach the input controls to a specific dom element to get the input from.
  121805. * @param element Defines the element the controls should be listened from
  121806. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121807. */
  121808. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121809. /**
  121810. * Detach the current controls from the specified dom element.
  121811. * @param element Defines the element to stop listening the inputs from
  121812. */
  121813. detachControl(element: Nullable<HTMLElement>): void;
  121814. /**
  121815. * Update the current camera state depending on the inputs that have been used this frame.
  121816. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  121817. */
  121818. checkInputs(): void;
  121819. /**
  121820. * Gets the class name of the current intput.
  121821. * @returns the class name
  121822. */
  121823. getClassName(): string;
  121824. /**
  121825. * Get the friendly name associated with the input class.
  121826. * @returns the input friendly name
  121827. */
  121828. getSimpleName(): string;
  121829. }
  121830. }
  121831. declare module BABYLON {
  121832. /**
  121833. * Defines the potential axis of a Joystick
  121834. */
  121835. export enum JoystickAxis {
  121836. /** X axis */
  121837. X = 0,
  121838. /** Y axis */
  121839. Y = 1,
  121840. /** Z axis */
  121841. Z = 2
  121842. }
  121843. /**
  121844. * Represents the different customization options available
  121845. * for VirtualJoystick
  121846. */
  121847. interface VirtualJoystickCustomizations {
  121848. /**
  121849. * Size of the joystick's puck
  121850. */
  121851. puckSize: number;
  121852. /**
  121853. * Size of the joystick's container
  121854. */
  121855. containerSize: number;
  121856. /**
  121857. * Color of the joystick && puck
  121858. */
  121859. color: string;
  121860. /**
  121861. * Image URL for the joystick's puck
  121862. */
  121863. puckImage?: string;
  121864. /**
  121865. * Image URL for the joystick's container
  121866. */
  121867. containerImage?: string;
  121868. /**
  121869. * Defines the unmoving position of the joystick container
  121870. */
  121871. position?: {
  121872. x: number;
  121873. y: number;
  121874. };
  121875. /**
  121876. * Defines whether or not the joystick container is always visible
  121877. */
  121878. alwaysVisible: boolean;
  121879. /**
  121880. * Defines whether or not to limit the movement of the puck to the joystick's container
  121881. */
  121882. limitToContainer: boolean;
  121883. }
  121884. /**
  121885. * Class used to define virtual joystick (used in touch mode)
  121886. */
  121887. export class VirtualJoystick {
  121888. /**
  121889. * Gets or sets a boolean indicating that left and right values must be inverted
  121890. */
  121891. reverseLeftRight: boolean;
  121892. /**
  121893. * Gets or sets a boolean indicating that up and down values must be inverted
  121894. */
  121895. reverseUpDown: boolean;
  121896. /**
  121897. * Gets the offset value for the position (ie. the change of the position value)
  121898. */
  121899. deltaPosition: Vector3;
  121900. /**
  121901. * Gets a boolean indicating if the virtual joystick was pressed
  121902. */
  121903. pressed: boolean;
  121904. /**
  121905. * Canvas the virtual joystick will render onto, default z-index of this is 5
  121906. */
  121907. static Canvas: Nullable<HTMLCanvasElement>;
  121908. /**
  121909. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  121910. */
  121911. limitToContainer: boolean;
  121912. private static _globalJoystickIndex;
  121913. private static _alwaysVisibleSticks;
  121914. private static vjCanvasContext;
  121915. private static vjCanvasWidth;
  121916. private static vjCanvasHeight;
  121917. private static halfWidth;
  121918. private static _GetDefaultOptions;
  121919. private _action;
  121920. private _axisTargetedByLeftAndRight;
  121921. private _axisTargetedByUpAndDown;
  121922. private _joystickSensibility;
  121923. private _inversedSensibility;
  121924. private _joystickPointerID;
  121925. private _joystickColor;
  121926. private _joystickPointerPos;
  121927. private _joystickPreviousPointerPos;
  121928. private _joystickPointerStartPos;
  121929. private _deltaJoystickVector;
  121930. private _leftJoystick;
  121931. private _touches;
  121932. private _joystickPosition;
  121933. private _alwaysVisible;
  121934. private _puckImage;
  121935. private _containerImage;
  121936. private _joystickPuckSize;
  121937. private _joystickContainerSize;
  121938. private _clearPuckSize;
  121939. private _clearContainerSize;
  121940. private _clearPuckSizeOffset;
  121941. private _clearContainerSizeOffset;
  121942. private _onPointerDownHandlerRef;
  121943. private _onPointerMoveHandlerRef;
  121944. private _onPointerUpHandlerRef;
  121945. private _onResize;
  121946. /**
  121947. * Creates a new virtual joystick
  121948. * @param leftJoystick defines that the joystick is for left hand (false by default)
  121949. * @param customizations Defines the options we want to customize the VirtualJoystick
  121950. */
  121951. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  121952. /**
  121953. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  121954. * @param newJoystickSensibility defines the new sensibility
  121955. */
  121956. setJoystickSensibility(newJoystickSensibility: number): void;
  121957. private _onPointerDown;
  121958. private _onPointerMove;
  121959. private _onPointerUp;
  121960. /**
  121961. * Change the color of the virtual joystick
  121962. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  121963. */
  121964. setJoystickColor(newColor: string): void;
  121965. /**
  121966. * Size of the joystick's container
  121967. */
  121968. set containerSize(newSize: number);
  121969. get containerSize(): number;
  121970. /**
  121971. * Size of the joystick's puck
  121972. */
  121973. set puckSize(newSize: number);
  121974. get puckSize(): number;
  121975. /**
  121976. * Clears the set position of the joystick
  121977. */
  121978. clearPosition(): void;
  121979. /**
  121980. * Defines whether or not the joystick container is always visible
  121981. */
  121982. set alwaysVisible(value: boolean);
  121983. get alwaysVisible(): boolean;
  121984. /**
  121985. * Sets the constant position of the Joystick container
  121986. * @param x X axis coordinate
  121987. * @param y Y axis coordinate
  121988. */
  121989. setPosition(x: number, y: number): void;
  121990. /**
  121991. * Defines a callback to call when the joystick is touched
  121992. * @param action defines the callback
  121993. */
  121994. setActionOnTouch(action: () => any): void;
  121995. /**
  121996. * Defines which axis you'd like to control for left & right
  121997. * @param axis defines the axis to use
  121998. */
  121999. setAxisForLeftRight(axis: JoystickAxis): void;
  122000. /**
  122001. * Defines which axis you'd like to control for up & down
  122002. * @param axis defines the axis to use
  122003. */
  122004. setAxisForUpDown(axis: JoystickAxis): void;
  122005. /**
  122006. * Clears the canvas from the previous puck / container draw
  122007. */
  122008. private _clearPreviousDraw;
  122009. /**
  122010. * Loads `urlPath` to be used for the container's image
  122011. * @param urlPath defines the urlPath of an image to use
  122012. */
  122013. setContainerImage(urlPath: string): void;
  122014. /**
  122015. * Loads `urlPath` to be used for the puck's image
  122016. * @param urlPath defines the urlPath of an image to use
  122017. */
  122018. setPuckImage(urlPath: string): void;
  122019. /**
  122020. * Draws the Virtual Joystick's container
  122021. */
  122022. private _drawContainer;
  122023. /**
  122024. * Draws the Virtual Joystick's puck
  122025. */
  122026. private _drawPuck;
  122027. private _drawVirtualJoystick;
  122028. /**
  122029. * Release internal HTML canvas
  122030. */
  122031. releaseCanvas(): void;
  122032. }
  122033. }
  122034. declare module BABYLON {
  122035. interface FreeCameraInputsManager {
  122036. /**
  122037. * Add virtual joystick input support to the input manager.
  122038. * @returns the current input manager
  122039. */
  122040. addVirtualJoystick(): FreeCameraInputsManager;
  122041. }
  122042. /**
  122043. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  122044. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  122045. */
  122046. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  122047. /**
  122048. * Defines the camera the input is attached to.
  122049. */
  122050. camera: FreeCamera;
  122051. private _leftjoystick;
  122052. private _rightjoystick;
  122053. /**
  122054. * Gets the left stick of the virtual joystick.
  122055. * @returns The virtual Joystick
  122056. */
  122057. getLeftJoystick(): VirtualJoystick;
  122058. /**
  122059. * Gets the right stick of the virtual joystick.
  122060. * @returns The virtual Joystick
  122061. */
  122062. getRightJoystick(): VirtualJoystick;
  122063. /**
  122064. * Update the current camera state depending on the inputs that have been used this frame.
  122065. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122066. */
  122067. checkInputs(): void;
  122068. /**
  122069. * Attach the input controls to a specific dom element to get the input from.
  122070. * @param element Defines the element the controls should be listened from
  122071. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122072. */
  122073. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122074. /**
  122075. * Detach the current controls from the specified dom element.
  122076. * @param element Defines the element to stop listening the inputs from
  122077. */
  122078. detachControl(element: Nullable<HTMLElement>): void;
  122079. /**
  122080. * Gets the class name of the current intput.
  122081. * @returns the class name
  122082. */
  122083. getClassName(): string;
  122084. /**
  122085. * Get the friendly name associated with the input class.
  122086. * @returns the input friendly name
  122087. */
  122088. getSimpleName(): string;
  122089. }
  122090. }
  122091. declare module BABYLON {
  122092. /**
  122093. * This represents a FPS type of camera controlled by touch.
  122094. * This is like a universal camera minus the Gamepad controls.
  122095. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  122096. */
  122097. export class TouchCamera extends FreeCamera {
  122098. /**
  122099. * Defines the touch sensibility for rotation.
  122100. * The higher the faster.
  122101. */
  122102. get touchAngularSensibility(): number;
  122103. set touchAngularSensibility(value: number);
  122104. /**
  122105. * Defines the touch sensibility for move.
  122106. * The higher the faster.
  122107. */
  122108. get touchMoveSensibility(): number;
  122109. set touchMoveSensibility(value: number);
  122110. /**
  122111. * Instantiates a new touch camera.
  122112. * This represents a FPS type of camera controlled by touch.
  122113. * This is like a universal camera minus the Gamepad controls.
  122114. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  122115. * @param name Define the name of the camera in the scene
  122116. * @param position Define the start position of the camera in the scene
  122117. * @param scene Define the scene the camera belongs to
  122118. */
  122119. constructor(name: string, position: Vector3, scene: Scene);
  122120. /**
  122121. * Gets the current object class name.
  122122. * @return the class name
  122123. */
  122124. getClassName(): string;
  122125. /** @hidden */
  122126. _setupInputs(): void;
  122127. }
  122128. }
  122129. declare module BABYLON {
  122130. /**
  122131. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  122132. * being tilted forward or back and left or right.
  122133. */
  122134. export class DeviceOrientationCamera extends FreeCamera {
  122135. private _initialQuaternion;
  122136. private _quaternionCache;
  122137. private _tmpDragQuaternion;
  122138. private _disablePointerInputWhenUsingDeviceOrientation;
  122139. /**
  122140. * Creates a new device orientation camera
  122141. * @param name The name of the camera
  122142. * @param position The start position camera
  122143. * @param scene The scene the camera belongs to
  122144. */
  122145. constructor(name: string, position: Vector3, scene: Scene);
  122146. /**
  122147. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  122148. */
  122149. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  122150. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  122151. private _dragFactor;
  122152. /**
  122153. * Enabled turning on the y axis when the orientation sensor is active
  122154. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  122155. */
  122156. enableHorizontalDragging(dragFactor?: number): void;
  122157. /**
  122158. * Gets the current instance class name ("DeviceOrientationCamera").
  122159. * This helps avoiding instanceof at run time.
  122160. * @returns the class name
  122161. */
  122162. getClassName(): string;
  122163. /**
  122164. * @hidden
  122165. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  122166. */
  122167. _checkInputs(): void;
  122168. /**
  122169. * Reset the camera to its default orientation on the specified axis only.
  122170. * @param axis The axis to reset
  122171. */
  122172. resetToCurrentRotation(axis?: Axis): void;
  122173. }
  122174. }
  122175. declare module BABYLON {
  122176. /**
  122177. * Defines supported buttons for XBox360 compatible gamepads
  122178. */
  122179. export enum Xbox360Button {
  122180. /** A */
  122181. A = 0,
  122182. /** B */
  122183. B = 1,
  122184. /** X */
  122185. X = 2,
  122186. /** Y */
  122187. Y = 3,
  122188. /** Left button */
  122189. LB = 4,
  122190. /** Right button */
  122191. RB = 5,
  122192. /** Back */
  122193. Back = 8,
  122194. /** Start */
  122195. Start = 9,
  122196. /** Left stick */
  122197. LeftStick = 10,
  122198. /** Right stick */
  122199. RightStick = 11
  122200. }
  122201. /** Defines values for XBox360 DPad */
  122202. export enum Xbox360Dpad {
  122203. /** Up */
  122204. Up = 12,
  122205. /** Down */
  122206. Down = 13,
  122207. /** Left */
  122208. Left = 14,
  122209. /** Right */
  122210. Right = 15
  122211. }
  122212. /**
  122213. * Defines a XBox360 gamepad
  122214. */
  122215. export class Xbox360Pad extends Gamepad {
  122216. private _leftTrigger;
  122217. private _rightTrigger;
  122218. private _onlefttriggerchanged;
  122219. private _onrighttriggerchanged;
  122220. private _onbuttondown;
  122221. private _onbuttonup;
  122222. private _ondpaddown;
  122223. private _ondpadup;
  122224. /** Observable raised when a button is pressed */
  122225. onButtonDownObservable: Observable<Xbox360Button>;
  122226. /** Observable raised when a button is released */
  122227. onButtonUpObservable: Observable<Xbox360Button>;
  122228. /** Observable raised when a pad is pressed */
  122229. onPadDownObservable: Observable<Xbox360Dpad>;
  122230. /** Observable raised when a pad is released */
  122231. onPadUpObservable: Observable<Xbox360Dpad>;
  122232. private _buttonA;
  122233. private _buttonB;
  122234. private _buttonX;
  122235. private _buttonY;
  122236. private _buttonBack;
  122237. private _buttonStart;
  122238. private _buttonLB;
  122239. private _buttonRB;
  122240. private _buttonLeftStick;
  122241. private _buttonRightStick;
  122242. private _dPadUp;
  122243. private _dPadDown;
  122244. private _dPadLeft;
  122245. private _dPadRight;
  122246. private _isXboxOnePad;
  122247. /**
  122248. * Creates a new XBox360 gamepad object
  122249. * @param id defines the id of this gamepad
  122250. * @param index defines its index
  122251. * @param gamepad defines the internal HTML gamepad object
  122252. * @param xboxOne defines if it is a XBox One gamepad
  122253. */
  122254. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  122255. /**
  122256. * Defines the callback to call when left trigger is pressed
  122257. * @param callback defines the callback to use
  122258. */
  122259. onlefttriggerchanged(callback: (value: number) => void): void;
  122260. /**
  122261. * Defines the callback to call when right trigger is pressed
  122262. * @param callback defines the callback to use
  122263. */
  122264. onrighttriggerchanged(callback: (value: number) => void): void;
  122265. /**
  122266. * Gets the left trigger value
  122267. */
  122268. get leftTrigger(): number;
  122269. /**
  122270. * Sets the left trigger value
  122271. */
  122272. set leftTrigger(newValue: number);
  122273. /**
  122274. * Gets the right trigger value
  122275. */
  122276. get rightTrigger(): number;
  122277. /**
  122278. * Sets the right trigger value
  122279. */
  122280. set rightTrigger(newValue: number);
  122281. /**
  122282. * Defines the callback to call when a button is pressed
  122283. * @param callback defines the callback to use
  122284. */
  122285. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  122286. /**
  122287. * Defines the callback to call when a button is released
  122288. * @param callback defines the callback to use
  122289. */
  122290. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  122291. /**
  122292. * Defines the callback to call when a pad is pressed
  122293. * @param callback defines the callback to use
  122294. */
  122295. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  122296. /**
  122297. * Defines the callback to call when a pad is released
  122298. * @param callback defines the callback to use
  122299. */
  122300. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  122301. private _setButtonValue;
  122302. private _setDPadValue;
  122303. /**
  122304. * Gets the value of the `A` button
  122305. */
  122306. get buttonA(): number;
  122307. /**
  122308. * Sets the value of the `A` button
  122309. */
  122310. set buttonA(value: number);
  122311. /**
  122312. * Gets the value of the `B` button
  122313. */
  122314. get buttonB(): number;
  122315. /**
  122316. * Sets the value of the `B` button
  122317. */
  122318. set buttonB(value: number);
  122319. /**
  122320. * Gets the value of the `X` button
  122321. */
  122322. get buttonX(): number;
  122323. /**
  122324. * Sets the value of the `X` button
  122325. */
  122326. set buttonX(value: number);
  122327. /**
  122328. * Gets the value of the `Y` button
  122329. */
  122330. get buttonY(): number;
  122331. /**
  122332. * Sets the value of the `Y` button
  122333. */
  122334. set buttonY(value: number);
  122335. /**
  122336. * Gets the value of the `Start` button
  122337. */
  122338. get buttonStart(): number;
  122339. /**
  122340. * Sets the value of the `Start` button
  122341. */
  122342. set buttonStart(value: number);
  122343. /**
  122344. * Gets the value of the `Back` button
  122345. */
  122346. get buttonBack(): number;
  122347. /**
  122348. * Sets the value of the `Back` button
  122349. */
  122350. set buttonBack(value: number);
  122351. /**
  122352. * Gets the value of the `Left` button
  122353. */
  122354. get buttonLB(): number;
  122355. /**
  122356. * Sets the value of the `Left` button
  122357. */
  122358. set buttonLB(value: number);
  122359. /**
  122360. * Gets the value of the `Right` button
  122361. */
  122362. get buttonRB(): number;
  122363. /**
  122364. * Sets the value of the `Right` button
  122365. */
  122366. set buttonRB(value: number);
  122367. /**
  122368. * Gets the value of the Left joystick
  122369. */
  122370. get buttonLeftStick(): number;
  122371. /**
  122372. * Sets the value of the Left joystick
  122373. */
  122374. set buttonLeftStick(value: number);
  122375. /**
  122376. * Gets the value of the Right joystick
  122377. */
  122378. get buttonRightStick(): number;
  122379. /**
  122380. * Sets the value of the Right joystick
  122381. */
  122382. set buttonRightStick(value: number);
  122383. /**
  122384. * Gets the value of D-pad up
  122385. */
  122386. get dPadUp(): number;
  122387. /**
  122388. * Sets the value of D-pad up
  122389. */
  122390. set dPadUp(value: number);
  122391. /**
  122392. * Gets the value of D-pad down
  122393. */
  122394. get dPadDown(): number;
  122395. /**
  122396. * Sets the value of D-pad down
  122397. */
  122398. set dPadDown(value: number);
  122399. /**
  122400. * Gets the value of D-pad left
  122401. */
  122402. get dPadLeft(): number;
  122403. /**
  122404. * Sets the value of D-pad left
  122405. */
  122406. set dPadLeft(value: number);
  122407. /**
  122408. * Gets the value of D-pad right
  122409. */
  122410. get dPadRight(): number;
  122411. /**
  122412. * Sets the value of D-pad right
  122413. */
  122414. set dPadRight(value: number);
  122415. /**
  122416. * Force the gamepad to synchronize with device values
  122417. */
  122418. update(): void;
  122419. /**
  122420. * Disposes the gamepad
  122421. */
  122422. dispose(): void;
  122423. }
  122424. }
  122425. declare module BABYLON {
  122426. /**
  122427. * Defines supported buttons for DualShock compatible gamepads
  122428. */
  122429. export enum DualShockButton {
  122430. /** Cross */
  122431. Cross = 0,
  122432. /** Circle */
  122433. Circle = 1,
  122434. /** Square */
  122435. Square = 2,
  122436. /** Triangle */
  122437. Triangle = 3,
  122438. /** L1 */
  122439. L1 = 4,
  122440. /** R1 */
  122441. R1 = 5,
  122442. /** Share */
  122443. Share = 8,
  122444. /** Options */
  122445. Options = 9,
  122446. /** Left stick */
  122447. LeftStick = 10,
  122448. /** Right stick */
  122449. RightStick = 11
  122450. }
  122451. /** Defines values for DualShock DPad */
  122452. export enum DualShockDpad {
  122453. /** Up */
  122454. Up = 12,
  122455. /** Down */
  122456. Down = 13,
  122457. /** Left */
  122458. Left = 14,
  122459. /** Right */
  122460. Right = 15
  122461. }
  122462. /**
  122463. * Defines a DualShock gamepad
  122464. */
  122465. export class DualShockPad extends Gamepad {
  122466. private _leftTrigger;
  122467. private _rightTrigger;
  122468. private _onlefttriggerchanged;
  122469. private _onrighttriggerchanged;
  122470. private _onbuttondown;
  122471. private _onbuttonup;
  122472. private _ondpaddown;
  122473. private _ondpadup;
  122474. /** Observable raised when a button is pressed */
  122475. onButtonDownObservable: Observable<DualShockButton>;
  122476. /** Observable raised when a button is released */
  122477. onButtonUpObservable: Observable<DualShockButton>;
  122478. /** Observable raised when a pad is pressed */
  122479. onPadDownObservable: Observable<DualShockDpad>;
  122480. /** Observable raised when a pad is released */
  122481. onPadUpObservable: Observable<DualShockDpad>;
  122482. private _buttonCross;
  122483. private _buttonCircle;
  122484. private _buttonSquare;
  122485. private _buttonTriangle;
  122486. private _buttonShare;
  122487. private _buttonOptions;
  122488. private _buttonL1;
  122489. private _buttonR1;
  122490. private _buttonLeftStick;
  122491. private _buttonRightStick;
  122492. private _dPadUp;
  122493. private _dPadDown;
  122494. private _dPadLeft;
  122495. private _dPadRight;
  122496. /**
  122497. * Creates a new DualShock gamepad object
  122498. * @param id defines the id of this gamepad
  122499. * @param index defines its index
  122500. * @param gamepad defines the internal HTML gamepad object
  122501. */
  122502. constructor(id: string, index: number, gamepad: any);
  122503. /**
  122504. * Defines the callback to call when left trigger is pressed
  122505. * @param callback defines the callback to use
  122506. */
  122507. onlefttriggerchanged(callback: (value: number) => void): void;
  122508. /**
  122509. * Defines the callback to call when right trigger is pressed
  122510. * @param callback defines the callback to use
  122511. */
  122512. onrighttriggerchanged(callback: (value: number) => void): void;
  122513. /**
  122514. * Gets the left trigger value
  122515. */
  122516. get leftTrigger(): number;
  122517. /**
  122518. * Sets the left trigger value
  122519. */
  122520. set leftTrigger(newValue: number);
  122521. /**
  122522. * Gets the right trigger value
  122523. */
  122524. get rightTrigger(): number;
  122525. /**
  122526. * Sets the right trigger value
  122527. */
  122528. set rightTrigger(newValue: number);
  122529. /**
  122530. * Defines the callback to call when a button is pressed
  122531. * @param callback defines the callback to use
  122532. */
  122533. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  122534. /**
  122535. * Defines the callback to call when a button is released
  122536. * @param callback defines the callback to use
  122537. */
  122538. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  122539. /**
  122540. * Defines the callback to call when a pad is pressed
  122541. * @param callback defines the callback to use
  122542. */
  122543. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  122544. /**
  122545. * Defines the callback to call when a pad is released
  122546. * @param callback defines the callback to use
  122547. */
  122548. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  122549. private _setButtonValue;
  122550. private _setDPadValue;
  122551. /**
  122552. * Gets the value of the `Cross` button
  122553. */
  122554. get buttonCross(): number;
  122555. /**
  122556. * Sets the value of the `Cross` button
  122557. */
  122558. set buttonCross(value: number);
  122559. /**
  122560. * Gets the value of the `Circle` button
  122561. */
  122562. get buttonCircle(): number;
  122563. /**
  122564. * Sets the value of the `Circle` button
  122565. */
  122566. set buttonCircle(value: number);
  122567. /**
  122568. * Gets the value of the `Square` button
  122569. */
  122570. get buttonSquare(): number;
  122571. /**
  122572. * Sets the value of the `Square` button
  122573. */
  122574. set buttonSquare(value: number);
  122575. /**
  122576. * Gets the value of the `Triangle` button
  122577. */
  122578. get buttonTriangle(): number;
  122579. /**
  122580. * Sets the value of the `Triangle` button
  122581. */
  122582. set buttonTriangle(value: number);
  122583. /**
  122584. * Gets the value of the `Options` button
  122585. */
  122586. get buttonOptions(): number;
  122587. /**
  122588. * Sets the value of the `Options` button
  122589. */
  122590. set buttonOptions(value: number);
  122591. /**
  122592. * Gets the value of the `Share` button
  122593. */
  122594. get buttonShare(): number;
  122595. /**
  122596. * Sets the value of the `Share` button
  122597. */
  122598. set buttonShare(value: number);
  122599. /**
  122600. * Gets the value of the `L1` button
  122601. */
  122602. get buttonL1(): number;
  122603. /**
  122604. * Sets the value of the `L1` button
  122605. */
  122606. set buttonL1(value: number);
  122607. /**
  122608. * Gets the value of the `R1` button
  122609. */
  122610. get buttonR1(): number;
  122611. /**
  122612. * Sets the value of the `R1` button
  122613. */
  122614. set buttonR1(value: number);
  122615. /**
  122616. * Gets the value of the Left joystick
  122617. */
  122618. get buttonLeftStick(): number;
  122619. /**
  122620. * Sets the value of the Left joystick
  122621. */
  122622. set buttonLeftStick(value: number);
  122623. /**
  122624. * Gets the value of the Right joystick
  122625. */
  122626. get buttonRightStick(): number;
  122627. /**
  122628. * Sets the value of the Right joystick
  122629. */
  122630. set buttonRightStick(value: number);
  122631. /**
  122632. * Gets the value of D-pad up
  122633. */
  122634. get dPadUp(): number;
  122635. /**
  122636. * Sets the value of D-pad up
  122637. */
  122638. set dPadUp(value: number);
  122639. /**
  122640. * Gets the value of D-pad down
  122641. */
  122642. get dPadDown(): number;
  122643. /**
  122644. * Sets the value of D-pad down
  122645. */
  122646. set dPadDown(value: number);
  122647. /**
  122648. * Gets the value of D-pad left
  122649. */
  122650. get dPadLeft(): number;
  122651. /**
  122652. * Sets the value of D-pad left
  122653. */
  122654. set dPadLeft(value: number);
  122655. /**
  122656. * Gets the value of D-pad right
  122657. */
  122658. get dPadRight(): number;
  122659. /**
  122660. * Sets the value of D-pad right
  122661. */
  122662. set dPadRight(value: number);
  122663. /**
  122664. * Force the gamepad to synchronize with device values
  122665. */
  122666. update(): void;
  122667. /**
  122668. * Disposes the gamepad
  122669. */
  122670. dispose(): void;
  122671. }
  122672. }
  122673. declare module BABYLON {
  122674. /**
  122675. * Manager for handling gamepads
  122676. */
  122677. export class GamepadManager {
  122678. private _scene?;
  122679. private _babylonGamepads;
  122680. private _oneGamepadConnected;
  122681. /** @hidden */
  122682. _isMonitoring: boolean;
  122683. private _gamepadEventSupported;
  122684. private _gamepadSupport?;
  122685. /**
  122686. * observable to be triggered when the gamepad controller has been connected
  122687. */
  122688. onGamepadConnectedObservable: Observable<Gamepad>;
  122689. /**
  122690. * observable to be triggered when the gamepad controller has been disconnected
  122691. */
  122692. onGamepadDisconnectedObservable: Observable<Gamepad>;
  122693. private _onGamepadConnectedEvent;
  122694. private _onGamepadDisconnectedEvent;
  122695. /**
  122696. * Initializes the gamepad manager
  122697. * @param _scene BabylonJS scene
  122698. */
  122699. constructor(_scene?: Scene | undefined);
  122700. /**
  122701. * The gamepads in the game pad manager
  122702. */
  122703. get gamepads(): Gamepad[];
  122704. /**
  122705. * Get the gamepad controllers based on type
  122706. * @param type The type of gamepad controller
  122707. * @returns Nullable gamepad
  122708. */
  122709. getGamepadByType(type?: number): Nullable<Gamepad>;
  122710. /**
  122711. * Disposes the gamepad manager
  122712. */
  122713. dispose(): void;
  122714. private _addNewGamepad;
  122715. private _startMonitoringGamepads;
  122716. private _stopMonitoringGamepads;
  122717. /** @hidden */
  122718. _checkGamepadsStatus(): void;
  122719. private _updateGamepadObjects;
  122720. }
  122721. }
  122722. declare module BABYLON {
  122723. interface Scene {
  122724. /** @hidden */
  122725. _gamepadManager: Nullable<GamepadManager>;
  122726. /**
  122727. * Gets the gamepad manager associated with the scene
  122728. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  122729. */
  122730. gamepadManager: GamepadManager;
  122731. }
  122732. /**
  122733. * Interface representing a free camera inputs manager
  122734. */
  122735. interface FreeCameraInputsManager {
  122736. /**
  122737. * Adds gamepad input support to the FreeCameraInputsManager.
  122738. * @returns the FreeCameraInputsManager
  122739. */
  122740. addGamepad(): FreeCameraInputsManager;
  122741. }
  122742. /**
  122743. * Interface representing an arc rotate camera inputs manager
  122744. */
  122745. interface ArcRotateCameraInputsManager {
  122746. /**
  122747. * Adds gamepad input support to the ArcRotateCamera InputManager.
  122748. * @returns the camera inputs manager
  122749. */
  122750. addGamepad(): ArcRotateCameraInputsManager;
  122751. }
  122752. /**
  122753. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  122754. */
  122755. export class GamepadSystemSceneComponent implements ISceneComponent {
  122756. /**
  122757. * The component name helpfull to identify the component in the list of scene components.
  122758. */
  122759. readonly name: string;
  122760. /**
  122761. * The scene the component belongs to.
  122762. */
  122763. scene: Scene;
  122764. /**
  122765. * Creates a new instance of the component for the given scene
  122766. * @param scene Defines the scene to register the component in
  122767. */
  122768. constructor(scene: Scene);
  122769. /**
  122770. * Registers the component in a given scene
  122771. */
  122772. register(): void;
  122773. /**
  122774. * Rebuilds the elements related to this component in case of
  122775. * context lost for instance.
  122776. */
  122777. rebuild(): void;
  122778. /**
  122779. * Disposes the component and the associated ressources
  122780. */
  122781. dispose(): void;
  122782. private _beforeCameraUpdate;
  122783. }
  122784. }
  122785. declare module BABYLON {
  122786. /**
  122787. * 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,
  122788. * which still works and will still be found in many Playgrounds.
  122789. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  122790. */
  122791. export class UniversalCamera extends TouchCamera {
  122792. /**
  122793. * Defines the gamepad rotation sensiblity.
  122794. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  122795. */
  122796. get gamepadAngularSensibility(): number;
  122797. set gamepadAngularSensibility(value: number);
  122798. /**
  122799. * Defines the gamepad move sensiblity.
  122800. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  122801. */
  122802. get gamepadMoveSensibility(): number;
  122803. set gamepadMoveSensibility(value: number);
  122804. /**
  122805. * 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,
  122806. * which still works and will still be found in many Playgrounds.
  122807. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  122808. * @param name Define the name of the camera in the scene
  122809. * @param position Define the start position of the camera in the scene
  122810. * @param scene Define the scene the camera belongs to
  122811. */
  122812. constructor(name: string, position: Vector3, scene: Scene);
  122813. /**
  122814. * Gets the current object class name.
  122815. * @return the class name
  122816. */
  122817. getClassName(): string;
  122818. }
  122819. }
  122820. declare module BABYLON {
  122821. /**
  122822. * This represents a FPS type of camera. This is only here for back compat purpose.
  122823. * Please use the UniversalCamera instead as both are identical.
  122824. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  122825. */
  122826. export class GamepadCamera extends UniversalCamera {
  122827. /**
  122828. * Instantiates a new Gamepad Camera
  122829. * This represents a FPS type of camera. This is only here for back compat purpose.
  122830. * Please use the UniversalCamera instead as both are identical.
  122831. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  122832. * @param name Define the name of the camera in the scene
  122833. * @param position Define the start position of the camera in the scene
  122834. * @param scene Define the scene the camera belongs to
  122835. */
  122836. constructor(name: string, position: Vector3, scene: Scene);
  122837. /**
  122838. * Gets the current object class name.
  122839. * @return the class name
  122840. */
  122841. getClassName(): string;
  122842. }
  122843. }
  122844. declare module BABYLON {
  122845. /** @hidden */
  122846. export var passPixelShader: {
  122847. name: string;
  122848. shader: string;
  122849. };
  122850. }
  122851. declare module BABYLON {
  122852. /** @hidden */
  122853. export var passCubePixelShader: {
  122854. name: string;
  122855. shader: string;
  122856. };
  122857. }
  122858. declare module BABYLON {
  122859. /**
  122860. * PassPostProcess which produces an output the same as it's input
  122861. */
  122862. export class PassPostProcess extends PostProcess {
  122863. /**
  122864. * Creates the PassPostProcess
  122865. * @param name The name of the effect.
  122866. * @param options The required width/height ratio to downsize to before computing the render pass.
  122867. * @param camera The camera to apply the render pass to.
  122868. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  122869. * @param engine The engine which the post process will be applied. (default: current engine)
  122870. * @param reusable If the post process can be reused on the same frame. (default: false)
  122871. * @param textureType The type of texture to be used when performing the post processing.
  122872. * @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)
  122873. */
  122874. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  122875. }
  122876. /**
  122877. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  122878. */
  122879. export class PassCubePostProcess extends PostProcess {
  122880. private _face;
  122881. /**
  122882. * Gets or sets the cube face to display.
  122883. * * 0 is +X
  122884. * * 1 is -X
  122885. * * 2 is +Y
  122886. * * 3 is -Y
  122887. * * 4 is +Z
  122888. * * 5 is -Z
  122889. */
  122890. get face(): number;
  122891. set face(value: number);
  122892. /**
  122893. * Creates the PassCubePostProcess
  122894. * @param name The name of the effect.
  122895. * @param options The required width/height ratio to downsize to before computing the render pass.
  122896. * @param camera The camera to apply the render pass to.
  122897. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  122898. * @param engine The engine which the post process will be applied. (default: current engine)
  122899. * @param reusable If the post process can be reused on the same frame. (default: false)
  122900. * @param textureType The type of texture to be used when performing the post processing.
  122901. * @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)
  122902. */
  122903. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  122904. }
  122905. }
  122906. declare module BABYLON {
  122907. /** @hidden */
  122908. export var anaglyphPixelShader: {
  122909. name: string;
  122910. shader: string;
  122911. };
  122912. }
  122913. declare module BABYLON {
  122914. /**
  122915. * Postprocess used to generate anaglyphic rendering
  122916. */
  122917. export class AnaglyphPostProcess extends PostProcess {
  122918. private _passedProcess;
  122919. /**
  122920. * Creates a new AnaglyphPostProcess
  122921. * @param name defines postprocess name
  122922. * @param options defines creation options or target ratio scale
  122923. * @param rigCameras defines cameras using this postprocess
  122924. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  122925. * @param engine defines hosting engine
  122926. * @param reusable defines if the postprocess will be reused multiple times per frame
  122927. */
  122928. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  122929. }
  122930. }
  122931. declare module BABYLON {
  122932. /**
  122933. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  122934. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  122935. */
  122936. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  122937. /**
  122938. * Creates a new AnaglyphArcRotateCamera
  122939. * @param name defines camera name
  122940. * @param alpha defines alpha angle (in radians)
  122941. * @param beta defines beta angle (in radians)
  122942. * @param radius defines radius
  122943. * @param target defines camera target
  122944. * @param interaxialDistance defines distance between each color axis
  122945. * @param scene defines the hosting scene
  122946. */
  122947. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  122948. /**
  122949. * Gets camera class name
  122950. * @returns AnaglyphArcRotateCamera
  122951. */
  122952. getClassName(): string;
  122953. }
  122954. }
  122955. declare module BABYLON {
  122956. /**
  122957. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  122958. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  122959. */
  122960. export class AnaglyphFreeCamera extends FreeCamera {
  122961. /**
  122962. * Creates a new AnaglyphFreeCamera
  122963. * @param name defines camera name
  122964. * @param position defines initial position
  122965. * @param interaxialDistance defines distance between each color axis
  122966. * @param scene defines the hosting scene
  122967. */
  122968. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  122969. /**
  122970. * Gets camera class name
  122971. * @returns AnaglyphFreeCamera
  122972. */
  122973. getClassName(): string;
  122974. }
  122975. }
  122976. declare module BABYLON {
  122977. /**
  122978. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  122979. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  122980. */
  122981. export class AnaglyphGamepadCamera extends GamepadCamera {
  122982. /**
  122983. * Creates a new AnaglyphGamepadCamera
  122984. * @param name defines camera name
  122985. * @param position defines initial position
  122986. * @param interaxialDistance defines distance between each color axis
  122987. * @param scene defines the hosting scene
  122988. */
  122989. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  122990. /**
  122991. * Gets camera class name
  122992. * @returns AnaglyphGamepadCamera
  122993. */
  122994. getClassName(): string;
  122995. }
  122996. }
  122997. declare module BABYLON {
  122998. /**
  122999. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  123000. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  123001. */
  123002. export class AnaglyphUniversalCamera extends UniversalCamera {
  123003. /**
  123004. * Creates a new AnaglyphUniversalCamera
  123005. * @param name defines camera name
  123006. * @param position defines initial position
  123007. * @param interaxialDistance defines distance between each color axis
  123008. * @param scene defines the hosting scene
  123009. */
  123010. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  123011. /**
  123012. * Gets camera class name
  123013. * @returns AnaglyphUniversalCamera
  123014. */
  123015. getClassName(): string;
  123016. }
  123017. }
  123018. declare module BABYLON {
  123019. /**
  123020. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  123021. * @see http://doc.babylonjs.com/features/cameras
  123022. */
  123023. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  123024. /**
  123025. * Creates a new StereoscopicArcRotateCamera
  123026. * @param name defines camera name
  123027. * @param alpha defines alpha angle (in radians)
  123028. * @param beta defines beta angle (in radians)
  123029. * @param radius defines radius
  123030. * @param target defines camera target
  123031. * @param interaxialDistance defines distance between each color axis
  123032. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  123033. * @param scene defines the hosting scene
  123034. */
  123035. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  123036. /**
  123037. * Gets camera class name
  123038. * @returns StereoscopicArcRotateCamera
  123039. */
  123040. getClassName(): string;
  123041. }
  123042. }
  123043. declare module BABYLON {
  123044. /**
  123045. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  123046. * @see http://doc.babylonjs.com/features/cameras
  123047. */
  123048. export class StereoscopicFreeCamera extends FreeCamera {
  123049. /**
  123050. * Creates a new StereoscopicFreeCamera
  123051. * @param name defines camera name
  123052. * @param position defines initial position
  123053. * @param interaxialDistance defines distance between each color axis
  123054. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  123055. * @param scene defines the hosting scene
  123056. */
  123057. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  123058. /**
  123059. * Gets camera class name
  123060. * @returns StereoscopicFreeCamera
  123061. */
  123062. getClassName(): string;
  123063. }
  123064. }
  123065. declare module BABYLON {
  123066. /**
  123067. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  123068. * @see http://doc.babylonjs.com/features/cameras
  123069. */
  123070. export class StereoscopicGamepadCamera extends GamepadCamera {
  123071. /**
  123072. * Creates a new StereoscopicGamepadCamera
  123073. * @param name defines camera name
  123074. * @param position defines initial position
  123075. * @param interaxialDistance defines distance between each color axis
  123076. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  123077. * @param scene defines the hosting scene
  123078. */
  123079. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  123080. /**
  123081. * Gets camera class name
  123082. * @returns StereoscopicGamepadCamera
  123083. */
  123084. getClassName(): string;
  123085. }
  123086. }
  123087. declare module BABYLON {
  123088. /**
  123089. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  123090. * @see http://doc.babylonjs.com/features/cameras
  123091. */
  123092. export class StereoscopicUniversalCamera extends UniversalCamera {
  123093. /**
  123094. * Creates a new StereoscopicUniversalCamera
  123095. * @param name defines camera name
  123096. * @param position defines initial position
  123097. * @param interaxialDistance defines distance between each color axis
  123098. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  123099. * @param scene defines the hosting scene
  123100. */
  123101. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  123102. /**
  123103. * Gets camera class name
  123104. * @returns StereoscopicUniversalCamera
  123105. */
  123106. getClassName(): string;
  123107. }
  123108. }
  123109. declare module BABYLON {
  123110. /**
  123111. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  123112. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  123113. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  123114. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  123115. */
  123116. export class VirtualJoysticksCamera extends FreeCamera {
  123117. /**
  123118. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  123119. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  123120. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  123121. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  123122. * @param name Define the name of the camera in the scene
  123123. * @param position Define the start position of the camera in the scene
  123124. * @param scene Define the scene the camera belongs to
  123125. */
  123126. constructor(name: string, position: Vector3, scene: Scene);
  123127. /**
  123128. * Gets the current object class name.
  123129. * @return the class name
  123130. */
  123131. getClassName(): string;
  123132. }
  123133. }
  123134. declare module BABYLON {
  123135. /**
  123136. * This represents all the required metrics to create a VR camera.
  123137. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  123138. */
  123139. export class VRCameraMetrics {
  123140. /**
  123141. * Define the horizontal resolution off the screen.
  123142. */
  123143. hResolution: number;
  123144. /**
  123145. * Define the vertical resolution off the screen.
  123146. */
  123147. vResolution: number;
  123148. /**
  123149. * Define the horizontal screen size.
  123150. */
  123151. hScreenSize: number;
  123152. /**
  123153. * Define the vertical screen size.
  123154. */
  123155. vScreenSize: number;
  123156. /**
  123157. * Define the vertical screen center position.
  123158. */
  123159. vScreenCenter: number;
  123160. /**
  123161. * Define the distance of the eyes to the screen.
  123162. */
  123163. eyeToScreenDistance: number;
  123164. /**
  123165. * Define the distance between both lenses
  123166. */
  123167. lensSeparationDistance: number;
  123168. /**
  123169. * Define the distance between both viewer's eyes.
  123170. */
  123171. interpupillaryDistance: number;
  123172. /**
  123173. * Define the distortion factor of the VR postprocess.
  123174. * Please, touch with care.
  123175. */
  123176. distortionK: number[];
  123177. /**
  123178. * Define the chromatic aberration correction factors for the VR post process.
  123179. */
  123180. chromaAbCorrection: number[];
  123181. /**
  123182. * Define the scale factor of the post process.
  123183. * The smaller the better but the slower.
  123184. */
  123185. postProcessScaleFactor: number;
  123186. /**
  123187. * Define an offset for the lens center.
  123188. */
  123189. lensCenterOffset: number;
  123190. /**
  123191. * Define if the current vr camera should compensate the distortion of the lense or not.
  123192. */
  123193. compensateDistortion: boolean;
  123194. /**
  123195. * Defines if multiview should be enabled when rendering (Default: false)
  123196. */
  123197. multiviewEnabled: boolean;
  123198. /**
  123199. * Gets the rendering aspect ratio based on the provided resolutions.
  123200. */
  123201. get aspectRatio(): number;
  123202. /**
  123203. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  123204. */
  123205. get aspectRatioFov(): number;
  123206. /**
  123207. * @hidden
  123208. */
  123209. get leftHMatrix(): Matrix;
  123210. /**
  123211. * @hidden
  123212. */
  123213. get rightHMatrix(): Matrix;
  123214. /**
  123215. * @hidden
  123216. */
  123217. get leftPreViewMatrix(): Matrix;
  123218. /**
  123219. * @hidden
  123220. */
  123221. get rightPreViewMatrix(): Matrix;
  123222. /**
  123223. * Get the default VRMetrics based on the most generic setup.
  123224. * @returns the default vr metrics
  123225. */
  123226. static GetDefault(): VRCameraMetrics;
  123227. }
  123228. }
  123229. declare module BABYLON {
  123230. /** @hidden */
  123231. export var vrDistortionCorrectionPixelShader: {
  123232. name: string;
  123233. shader: string;
  123234. };
  123235. }
  123236. declare module BABYLON {
  123237. /**
  123238. * VRDistortionCorrectionPostProcess used for mobile VR
  123239. */
  123240. export class VRDistortionCorrectionPostProcess extends PostProcess {
  123241. private _isRightEye;
  123242. private _distortionFactors;
  123243. private _postProcessScaleFactor;
  123244. private _lensCenterOffset;
  123245. private _scaleIn;
  123246. private _scaleFactor;
  123247. private _lensCenter;
  123248. /**
  123249. * Initializes the VRDistortionCorrectionPostProcess
  123250. * @param name The name of the effect.
  123251. * @param camera The camera to apply the render pass to.
  123252. * @param isRightEye If this is for the right eye distortion
  123253. * @param vrMetrics All the required metrics for the VR camera
  123254. */
  123255. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  123256. }
  123257. }
  123258. declare module BABYLON {
  123259. /**
  123260. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  123261. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  123262. */
  123263. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  123264. /**
  123265. * Creates a new VRDeviceOrientationArcRotateCamera
  123266. * @param name defines camera name
  123267. * @param alpha defines the camera rotation along the logitudinal axis
  123268. * @param beta defines the camera rotation along the latitudinal axis
  123269. * @param radius defines the camera distance from its target
  123270. * @param target defines the camera target
  123271. * @param scene defines the scene the camera belongs to
  123272. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  123273. * @param vrCameraMetrics defines the vr metrics associated to the camera
  123274. */
  123275. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  123276. /**
  123277. * Gets camera class name
  123278. * @returns VRDeviceOrientationArcRotateCamera
  123279. */
  123280. getClassName(): string;
  123281. }
  123282. }
  123283. declare module BABYLON {
  123284. /**
  123285. * Camera used to simulate VR rendering (based on FreeCamera)
  123286. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  123287. */
  123288. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  123289. /**
  123290. * Creates a new VRDeviceOrientationFreeCamera
  123291. * @param name defines camera name
  123292. * @param position defines the start position of the camera
  123293. * @param scene defines the scene the camera belongs to
  123294. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  123295. * @param vrCameraMetrics defines the vr metrics associated to the camera
  123296. */
  123297. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  123298. /**
  123299. * Gets camera class name
  123300. * @returns VRDeviceOrientationFreeCamera
  123301. */
  123302. getClassName(): string;
  123303. }
  123304. }
  123305. declare module BABYLON {
  123306. /**
  123307. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  123308. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  123309. */
  123310. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  123311. /**
  123312. * Creates a new VRDeviceOrientationGamepadCamera
  123313. * @param name defines camera name
  123314. * @param position defines the start position of the camera
  123315. * @param scene defines the scene the camera belongs to
  123316. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  123317. * @param vrCameraMetrics defines the vr metrics associated to the camera
  123318. */
  123319. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  123320. /**
  123321. * Gets camera class name
  123322. * @returns VRDeviceOrientationGamepadCamera
  123323. */
  123324. getClassName(): string;
  123325. }
  123326. }
  123327. declare module BABYLON {
  123328. /**
  123329. * A class extending Texture allowing drawing on a texture
  123330. * @see http://doc.babylonjs.com/how_to/dynamictexture
  123331. */
  123332. export class DynamicTexture extends Texture {
  123333. private _generateMipMaps;
  123334. private _canvas;
  123335. private _context;
  123336. /**
  123337. * Creates a DynamicTexture
  123338. * @param name defines the name of the texture
  123339. * @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
  123340. * @param scene defines the scene where you want the texture
  123341. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  123342. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  123343. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  123344. */
  123345. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  123346. /**
  123347. * Get the current class name of the texture useful for serialization or dynamic coding.
  123348. * @returns "DynamicTexture"
  123349. */
  123350. getClassName(): string;
  123351. /**
  123352. * Gets the current state of canRescale
  123353. */
  123354. get canRescale(): boolean;
  123355. private _recreate;
  123356. /**
  123357. * Scales the texture
  123358. * @param ratio the scale factor to apply to both width and height
  123359. */
  123360. scale(ratio: number): void;
  123361. /**
  123362. * Resizes the texture
  123363. * @param width the new width
  123364. * @param height the new height
  123365. */
  123366. scaleTo(width: number, height: number): void;
  123367. /**
  123368. * Gets the context of the canvas used by the texture
  123369. * @returns the canvas context of the dynamic texture
  123370. */
  123371. getContext(): CanvasRenderingContext2D;
  123372. /**
  123373. * Clears the texture
  123374. */
  123375. clear(): void;
  123376. /**
  123377. * Updates the texture
  123378. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  123379. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  123380. */
  123381. update(invertY?: boolean, premulAlpha?: boolean): void;
  123382. /**
  123383. * Draws text onto the texture
  123384. * @param text defines the text to be drawn
  123385. * @param x defines the placement of the text from the left
  123386. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  123387. * @param font defines the font to be used with font-style, font-size, font-name
  123388. * @param color defines the color used for the text
  123389. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  123390. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  123391. * @param update defines whether texture is immediately update (default is true)
  123392. */
  123393. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  123394. /**
  123395. * Clones the texture
  123396. * @returns the clone of the texture.
  123397. */
  123398. clone(): DynamicTexture;
  123399. /**
  123400. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  123401. * @returns a serialized dynamic texture object
  123402. */
  123403. serialize(): any;
  123404. private _IsCanvasElement;
  123405. /** @hidden */
  123406. _rebuild(): void;
  123407. }
  123408. }
  123409. declare module BABYLON {
  123410. /** @hidden */
  123411. export var imageProcessingPixelShader: {
  123412. name: string;
  123413. shader: string;
  123414. };
  123415. }
  123416. declare module BABYLON {
  123417. /**
  123418. * ImageProcessingPostProcess
  123419. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  123420. */
  123421. export class ImageProcessingPostProcess extends PostProcess {
  123422. /**
  123423. * Default configuration related to image processing available in the PBR Material.
  123424. */
  123425. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  123426. /**
  123427. * Gets the image processing configuration used either in this material.
  123428. */
  123429. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  123430. /**
  123431. * Sets the Default image processing configuration used either in the this material.
  123432. *
  123433. * If sets to null, the scene one is in use.
  123434. */
  123435. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  123436. /**
  123437. * Keep track of the image processing observer to allow dispose and replace.
  123438. */
  123439. private _imageProcessingObserver;
  123440. /**
  123441. * Attaches a new image processing configuration to the PBR Material.
  123442. * @param configuration
  123443. */
  123444. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  123445. /**
  123446. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  123447. */
  123448. get colorCurves(): Nullable<ColorCurves>;
  123449. /**
  123450. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  123451. */
  123452. set colorCurves(value: Nullable<ColorCurves>);
  123453. /**
  123454. * Gets wether the color curves effect is enabled.
  123455. */
  123456. get colorCurvesEnabled(): boolean;
  123457. /**
  123458. * Sets wether the color curves effect is enabled.
  123459. */
  123460. set colorCurvesEnabled(value: boolean);
  123461. /**
  123462. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  123463. */
  123464. get colorGradingTexture(): Nullable<BaseTexture>;
  123465. /**
  123466. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  123467. */
  123468. set colorGradingTexture(value: Nullable<BaseTexture>);
  123469. /**
  123470. * Gets wether the color grading effect is enabled.
  123471. */
  123472. get colorGradingEnabled(): boolean;
  123473. /**
  123474. * Gets wether the color grading effect is enabled.
  123475. */
  123476. set colorGradingEnabled(value: boolean);
  123477. /**
  123478. * Gets exposure used in the effect.
  123479. */
  123480. get exposure(): number;
  123481. /**
  123482. * Sets exposure used in the effect.
  123483. */
  123484. set exposure(value: number);
  123485. /**
  123486. * Gets wether tonemapping is enabled or not.
  123487. */
  123488. get toneMappingEnabled(): boolean;
  123489. /**
  123490. * Sets wether tonemapping is enabled or not
  123491. */
  123492. set toneMappingEnabled(value: boolean);
  123493. /**
  123494. * Gets the type of tone mapping effect.
  123495. */
  123496. get toneMappingType(): number;
  123497. /**
  123498. * Sets the type of tone mapping effect.
  123499. */
  123500. set toneMappingType(value: number);
  123501. /**
  123502. * Gets contrast used in the effect.
  123503. */
  123504. get contrast(): number;
  123505. /**
  123506. * Sets contrast used in the effect.
  123507. */
  123508. set contrast(value: number);
  123509. /**
  123510. * Gets Vignette stretch size.
  123511. */
  123512. get vignetteStretch(): number;
  123513. /**
  123514. * Sets Vignette stretch size.
  123515. */
  123516. set vignetteStretch(value: number);
  123517. /**
  123518. * Gets Vignette centre X Offset.
  123519. */
  123520. get vignetteCentreX(): number;
  123521. /**
  123522. * Sets Vignette centre X Offset.
  123523. */
  123524. set vignetteCentreX(value: number);
  123525. /**
  123526. * Gets Vignette centre Y Offset.
  123527. */
  123528. get vignetteCentreY(): number;
  123529. /**
  123530. * Sets Vignette centre Y Offset.
  123531. */
  123532. set vignetteCentreY(value: number);
  123533. /**
  123534. * Gets Vignette weight or intensity of the vignette effect.
  123535. */
  123536. get vignetteWeight(): number;
  123537. /**
  123538. * Sets Vignette weight or intensity of the vignette effect.
  123539. */
  123540. set vignetteWeight(value: number);
  123541. /**
  123542. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  123543. * if vignetteEnabled is set to true.
  123544. */
  123545. get vignetteColor(): Color4;
  123546. /**
  123547. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  123548. * if vignetteEnabled is set to true.
  123549. */
  123550. set vignetteColor(value: Color4);
  123551. /**
  123552. * Gets Camera field of view used by the Vignette effect.
  123553. */
  123554. get vignetteCameraFov(): number;
  123555. /**
  123556. * Sets Camera field of view used by the Vignette effect.
  123557. */
  123558. set vignetteCameraFov(value: number);
  123559. /**
  123560. * Gets the vignette blend mode allowing different kind of effect.
  123561. */
  123562. get vignetteBlendMode(): number;
  123563. /**
  123564. * Sets the vignette blend mode allowing different kind of effect.
  123565. */
  123566. set vignetteBlendMode(value: number);
  123567. /**
  123568. * Gets wether the vignette effect is enabled.
  123569. */
  123570. get vignetteEnabled(): boolean;
  123571. /**
  123572. * Sets wether the vignette effect is enabled.
  123573. */
  123574. set vignetteEnabled(value: boolean);
  123575. private _fromLinearSpace;
  123576. /**
  123577. * Gets wether the input of the processing is in Gamma or Linear Space.
  123578. */
  123579. get fromLinearSpace(): boolean;
  123580. /**
  123581. * Sets wether the input of the processing is in Gamma or Linear Space.
  123582. */
  123583. set fromLinearSpace(value: boolean);
  123584. /**
  123585. * Defines cache preventing GC.
  123586. */
  123587. private _defines;
  123588. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  123589. /**
  123590. * "ImageProcessingPostProcess"
  123591. * @returns "ImageProcessingPostProcess"
  123592. */
  123593. getClassName(): string;
  123594. protected _updateParameters(): void;
  123595. dispose(camera?: Camera): void;
  123596. }
  123597. }
  123598. declare module BABYLON {
  123599. /**
  123600. * Class containing static functions to help procedurally build meshes
  123601. */
  123602. export class GroundBuilder {
  123603. /**
  123604. * Creates a ground mesh
  123605. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  123606. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  123607. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123608. * @param name defines the name of the mesh
  123609. * @param options defines the options used to create the mesh
  123610. * @param scene defines the hosting scene
  123611. * @returns the ground mesh
  123612. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  123613. */
  123614. static CreateGround(name: string, options: {
  123615. width?: number;
  123616. height?: number;
  123617. subdivisions?: number;
  123618. subdivisionsX?: number;
  123619. subdivisionsY?: number;
  123620. updatable?: boolean;
  123621. }, scene: any): Mesh;
  123622. /**
  123623. * Creates a tiled ground mesh
  123624. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  123625. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  123626. * * 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
  123627. * * 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
  123628. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  123629. * @param name defines the name of the mesh
  123630. * @param options defines the options used to create the mesh
  123631. * @param scene defines the hosting scene
  123632. * @returns the tiled ground mesh
  123633. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  123634. */
  123635. static CreateTiledGround(name: string, options: {
  123636. xmin: number;
  123637. zmin: number;
  123638. xmax: number;
  123639. zmax: number;
  123640. subdivisions?: {
  123641. w: number;
  123642. h: number;
  123643. };
  123644. precision?: {
  123645. w: number;
  123646. h: number;
  123647. };
  123648. updatable?: boolean;
  123649. }, scene?: Nullable<Scene>): Mesh;
  123650. /**
  123651. * Creates a ground mesh from a height map
  123652. * * The parameter `url` sets the URL of the height map image resource.
  123653. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  123654. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  123655. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  123656. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  123657. * * 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.
  123658. * * 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).
  123659. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  123660. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  123661. * @param name defines the name of the mesh
  123662. * @param url defines the url to the height map
  123663. * @param options defines the options used to create the mesh
  123664. * @param scene defines the hosting scene
  123665. * @returns the ground mesh
  123666. * @see https://doc.babylonjs.com/babylon101/height_map
  123667. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  123668. */
  123669. static CreateGroundFromHeightMap(name: string, url: string, options: {
  123670. width?: number;
  123671. height?: number;
  123672. subdivisions?: number;
  123673. minHeight?: number;
  123674. maxHeight?: number;
  123675. colorFilter?: Color3;
  123676. alphaFilter?: number;
  123677. updatable?: boolean;
  123678. onReady?: (mesh: GroundMesh) => void;
  123679. }, scene?: Nullable<Scene>): GroundMesh;
  123680. }
  123681. }
  123682. declare module BABYLON {
  123683. /**
  123684. * Class containing static functions to help procedurally build meshes
  123685. */
  123686. export class TorusBuilder {
  123687. /**
  123688. * Creates a torus mesh
  123689. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  123690. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  123691. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  123692. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123693. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  123694. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  123695. * @param name defines the name of the mesh
  123696. * @param options defines the options used to create the mesh
  123697. * @param scene defines the hosting scene
  123698. * @returns the torus mesh
  123699. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  123700. */
  123701. static CreateTorus(name: string, options: {
  123702. diameter?: number;
  123703. thickness?: number;
  123704. tessellation?: number;
  123705. updatable?: boolean;
  123706. sideOrientation?: number;
  123707. frontUVs?: Vector4;
  123708. backUVs?: Vector4;
  123709. }, scene: any): Mesh;
  123710. }
  123711. }
  123712. declare module BABYLON {
  123713. /**
  123714. * Class containing static functions to help procedurally build meshes
  123715. */
  123716. export class CylinderBuilder {
  123717. /**
  123718. * Creates a cylinder or a cone mesh
  123719. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  123720. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  123721. * * 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.
  123722. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  123723. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  123724. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  123725. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  123726. * * 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).
  123727. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  123728. * * 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).
  123729. * * 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
  123730. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  123731. * * 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
  123732. * * 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.
  123733. * * If `enclose` is false, a ring surface is one element.
  123734. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  123735. * * 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
  123736. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123737. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  123738. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  123739. * @param name defines the name of the mesh
  123740. * @param options defines the options used to create the mesh
  123741. * @param scene defines the hosting scene
  123742. * @returns the cylinder mesh
  123743. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  123744. */
  123745. static CreateCylinder(name: string, options: {
  123746. height?: number;
  123747. diameterTop?: number;
  123748. diameterBottom?: number;
  123749. diameter?: number;
  123750. tessellation?: number;
  123751. subdivisions?: number;
  123752. arc?: number;
  123753. faceColors?: Color4[];
  123754. faceUV?: Vector4[];
  123755. updatable?: boolean;
  123756. hasRings?: boolean;
  123757. enclose?: boolean;
  123758. cap?: number;
  123759. sideOrientation?: number;
  123760. frontUVs?: Vector4;
  123761. backUVs?: Vector4;
  123762. }, scene: any): Mesh;
  123763. }
  123764. }
  123765. declare module BABYLON {
  123766. /**
  123767. * States of the webXR experience
  123768. */
  123769. export enum WebXRState {
  123770. /**
  123771. * Transitioning to being in XR mode
  123772. */
  123773. ENTERING_XR = 0,
  123774. /**
  123775. * Transitioning to non XR mode
  123776. */
  123777. EXITING_XR = 1,
  123778. /**
  123779. * In XR mode and presenting
  123780. */
  123781. IN_XR = 2,
  123782. /**
  123783. * Not entered XR mode
  123784. */
  123785. NOT_IN_XR = 3
  123786. }
  123787. /**
  123788. * Abstraction of the XR render target
  123789. */
  123790. export interface WebXRRenderTarget extends IDisposable {
  123791. /**
  123792. * xrpresent context of the canvas which can be used to display/mirror xr content
  123793. */
  123794. canvasContext: WebGLRenderingContext;
  123795. /**
  123796. * xr layer for the canvas
  123797. */
  123798. xrLayer: Nullable<XRWebGLLayer>;
  123799. /**
  123800. * Initializes the xr layer for the session
  123801. * @param xrSession xr session
  123802. * @returns a promise that will resolve once the XR Layer has been created
  123803. */
  123804. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  123805. }
  123806. }
  123807. declare module BABYLON {
  123808. /**
  123809. * COnfiguration object for WebXR output canvas
  123810. */
  123811. export class WebXRManagedOutputCanvasOptions {
  123812. /**
  123813. * An optional canvas in case you wish to create it yourself and provide it here.
  123814. * If not provided, a new canvas will be created
  123815. */
  123816. canvasElement?: HTMLCanvasElement;
  123817. /**
  123818. * Options for this XR Layer output
  123819. */
  123820. canvasOptions?: XRWebGLLayerOptions;
  123821. /**
  123822. * CSS styling for a newly created canvas (if not provided)
  123823. */
  123824. newCanvasCssStyle?: string;
  123825. /**
  123826. * Get the default values of the configuration object
  123827. * @returns default values of this configuration object
  123828. */
  123829. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  123830. }
  123831. /**
  123832. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  123833. */
  123834. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  123835. private _options;
  123836. private _canvas;
  123837. private _engine;
  123838. /**
  123839. * Rendering context of the canvas which can be used to display/mirror xr content
  123840. */
  123841. canvasContext: WebGLRenderingContext;
  123842. /**
  123843. * xr layer for the canvas
  123844. */
  123845. xrLayer: Nullable<XRWebGLLayer>;
  123846. /**
  123847. * Initializes the canvas to be added/removed upon entering/exiting xr
  123848. * @param _xrSessionManager The XR Session manager
  123849. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  123850. */
  123851. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  123852. /**
  123853. * Disposes of the object
  123854. */
  123855. dispose(): void;
  123856. /**
  123857. * Initializes the xr layer for the session
  123858. * @param xrSession xr session
  123859. * @returns a promise that will resolve once the XR Layer has been created
  123860. */
  123861. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  123862. private _addCanvas;
  123863. private _removeCanvas;
  123864. private _setManagedOutputCanvas;
  123865. }
  123866. }
  123867. declare module BABYLON {
  123868. /**
  123869. * Manages an XRSession to work with Babylon's engine
  123870. * @see https://doc.babylonjs.com/how_to/webxr
  123871. */
  123872. export class WebXRSessionManager implements IDisposable {
  123873. /** The scene which the session should be created for */
  123874. scene: Scene;
  123875. private _referenceSpace;
  123876. private _rttProvider;
  123877. private _sessionEnded;
  123878. private _xrNavigator;
  123879. private baseLayer;
  123880. /**
  123881. * The base reference space from which the session started. good if you want to reset your
  123882. * reference space
  123883. */
  123884. baseReferenceSpace: XRReferenceSpace;
  123885. /**
  123886. * Current XR frame
  123887. */
  123888. currentFrame: Nullable<XRFrame>;
  123889. /** WebXR timestamp updated every frame */
  123890. currentTimestamp: number;
  123891. /**
  123892. * Used just in case of a failure to initialize an immersive session.
  123893. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  123894. */
  123895. defaultHeightCompensation: number;
  123896. /**
  123897. * Fires every time a new xrFrame arrives which can be used to update the camera
  123898. */
  123899. onXRFrameObservable: Observable<XRFrame>;
  123900. /**
  123901. * Fires when the reference space changed
  123902. */
  123903. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  123904. /**
  123905. * Fires when the xr session is ended either by the device or manually done
  123906. */
  123907. onXRSessionEnded: Observable<any>;
  123908. /**
  123909. * Fires when the xr session is ended either by the device or manually done
  123910. */
  123911. onXRSessionInit: Observable<XRSession>;
  123912. /**
  123913. * Underlying xr session
  123914. */
  123915. session: XRSession;
  123916. /**
  123917. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  123918. * or get the offset the player is currently at.
  123919. */
  123920. viewerReferenceSpace: XRReferenceSpace;
  123921. /**
  123922. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  123923. * @param scene The scene which the session should be created for
  123924. */
  123925. constructor(
  123926. /** The scene which the session should be created for */
  123927. scene: Scene);
  123928. /**
  123929. * The current reference space used in this session. This reference space can constantly change!
  123930. * It is mainly used to offset the camera's position.
  123931. */
  123932. get referenceSpace(): XRReferenceSpace;
  123933. /**
  123934. * Set a new reference space and triggers the observable
  123935. */
  123936. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  123937. /**
  123938. * Disposes of the session manager
  123939. */
  123940. dispose(): void;
  123941. /**
  123942. * Stops the xrSession and restores the render loop
  123943. * @returns Promise which resolves after it exits XR
  123944. */
  123945. exitXRAsync(): Promise<void>;
  123946. /**
  123947. * Gets the correct render target texture to be rendered this frame for this eye
  123948. * @param eye the eye for which to get the render target
  123949. * @returns the render target for the specified eye
  123950. */
  123951. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  123952. /**
  123953. * Creates a WebXRRenderTarget object for the XR session
  123954. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  123955. * @param options optional options to provide when creating a new render target
  123956. * @returns a WebXR render target to which the session can render
  123957. */
  123958. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  123959. /**
  123960. * Initializes the manager
  123961. * After initialization enterXR can be called to start an XR session
  123962. * @returns Promise which resolves after it is initialized
  123963. */
  123964. initializeAsync(): Promise<void>;
  123965. /**
  123966. * Initializes an xr session
  123967. * @param xrSessionMode mode to initialize
  123968. * @param xrSessionInit defines optional and required values to pass to the session builder
  123969. * @returns a promise which will resolve once the session has been initialized
  123970. */
  123971. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  123972. /**
  123973. * Checks if a session would be supported for the creation options specified
  123974. * @param sessionMode session mode to check if supported eg. immersive-vr
  123975. * @returns A Promise that resolves to true if supported and false if not
  123976. */
  123977. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  123978. /**
  123979. * Resets the reference space to the one started the session
  123980. */
  123981. resetReferenceSpace(): void;
  123982. /**
  123983. * Starts rendering to the xr layer
  123984. */
  123985. runXRRenderLoop(): void;
  123986. /**
  123987. * Sets the reference space on the xr session
  123988. * @param referenceSpaceType space to set
  123989. * @returns a promise that will resolve once the reference space has been set
  123990. */
  123991. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  123992. /**
  123993. * Updates the render state of the session
  123994. * @param state state to set
  123995. * @returns a promise that resolves once the render state has been updated
  123996. */
  123997. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  123998. /**
  123999. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  124000. * @param sessionMode defines the session to test
  124001. * @returns a promise with boolean as final value
  124002. */
  124003. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  124004. private _createRenderTargetTexture;
  124005. }
  124006. }
  124007. declare module BABYLON {
  124008. /**
  124009. * WebXR Camera which holds the views for the xrSession
  124010. * @see https://doc.babylonjs.com/how_to/webxr_camera
  124011. */
  124012. export class WebXRCamera extends FreeCamera {
  124013. private _xrSessionManager;
  124014. private _firstFrame;
  124015. private _referenceQuaternion;
  124016. private _referencedPosition;
  124017. private _xrInvPositionCache;
  124018. private _xrInvQuaternionCache;
  124019. /**
  124020. * Should position compensation execute on first frame.
  124021. * This is used when copying the position from a native (non XR) camera
  124022. */
  124023. compensateOnFirstFrame: boolean;
  124024. /**
  124025. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  124026. * @param name the name of the camera
  124027. * @param scene the scene to add the camera to
  124028. * @param _xrSessionManager a constructed xr session manager
  124029. */
  124030. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  124031. /**
  124032. * Return the user's height, unrelated to the current ground.
  124033. * This will be the y position of this camera, when ground level is 0.
  124034. */
  124035. get realWorldHeight(): number;
  124036. /** @hidden */
  124037. _updateForDualEyeDebugging(): void;
  124038. /**
  124039. * Sets this camera's transformation based on a non-vr camera
  124040. * @param otherCamera the non-vr camera to copy the transformation from
  124041. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  124042. */
  124043. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  124044. /**
  124045. * Gets the current instance class name ("WebXRCamera").
  124046. * @returns the class name
  124047. */
  124048. getClassName(): string;
  124049. /**
  124050. * Overriding the _getViewMatrix function, as it is computed by WebXR
  124051. */
  124052. _getViewMatrix(): Matrix;
  124053. private _updateFromXRSession;
  124054. private _updateNumberOfRigCameras;
  124055. private _updateReferenceSpace;
  124056. private _updateReferenceSpaceOffset;
  124057. }
  124058. }
  124059. declare module BABYLON {
  124060. /**
  124061. * Defining the interface required for a (webxr) feature
  124062. */
  124063. export interface IWebXRFeature extends IDisposable {
  124064. /**
  124065. * Is this feature attached
  124066. */
  124067. attached: boolean;
  124068. /**
  124069. * Should auto-attach be disabled?
  124070. */
  124071. disableAutoAttach: boolean;
  124072. /**
  124073. * Attach the feature to the session
  124074. * Will usually be called by the features manager
  124075. *
  124076. * @param force should attachment be forced (even when already attached)
  124077. * @returns true if successful.
  124078. */
  124079. attach(force?: boolean): boolean;
  124080. /**
  124081. * Detach the feature from the session
  124082. * Will usually be called by the features manager
  124083. *
  124084. * @returns true if successful.
  124085. */
  124086. detach(): boolean;
  124087. }
  124088. /**
  124089. * A list of the currently available features without referencing them
  124090. */
  124091. export class WebXRFeatureName {
  124092. /**
  124093. * The name of the anchor system feature
  124094. */
  124095. static ANCHOR_SYSTEM: string;
  124096. /**
  124097. * The name of the background remover feature
  124098. */
  124099. static BACKGROUND_REMOVER: string;
  124100. /**
  124101. * The name of the hit test feature
  124102. */
  124103. static HIT_TEST: string;
  124104. /**
  124105. * physics impostors for xr controllers feature
  124106. */
  124107. static PHYSICS_CONTROLLERS: string;
  124108. /**
  124109. * The name of the plane detection feature
  124110. */
  124111. static PLANE_DETECTION: string;
  124112. /**
  124113. * The name of the pointer selection feature
  124114. */
  124115. static POINTER_SELECTION: string;
  124116. /**
  124117. * The name of the teleportation feature
  124118. */
  124119. static TELEPORTATION: string;
  124120. }
  124121. /**
  124122. * Defining the constructor of a feature. Used to register the modules.
  124123. */
  124124. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => (() => IWebXRFeature);
  124125. /**
  124126. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  124127. * It is mainly used in AR sessions.
  124128. *
  124129. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  124130. */
  124131. export class WebXRFeaturesManager implements IDisposable {
  124132. private _xrSessionManager;
  124133. private static readonly _AvailableFeatures;
  124134. private _features;
  124135. /**
  124136. * constructs a new features manages.
  124137. *
  124138. * @param _xrSessionManager an instance of WebXRSessionManager
  124139. */
  124140. constructor(_xrSessionManager: WebXRSessionManager);
  124141. /**
  124142. * Used to register a module. After calling this function a developer can use this feature in the scene.
  124143. * Mainly used internally.
  124144. *
  124145. * @param featureName the name of the feature to register
  124146. * @param constructorFunction the function used to construct the module
  124147. * @param version the (babylon) version of the module
  124148. * @param stable is that a stable version of this module
  124149. */
  124150. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  124151. /**
  124152. * Returns a constructor of a specific feature.
  124153. *
  124154. * @param featureName the name of the feature to construct
  124155. * @param version the version of the feature to load
  124156. * @param xrSessionManager the xrSessionManager. Used to construct the module
  124157. * @param options optional options provided to the module.
  124158. * @returns a function that, when called, will return a new instance of this feature
  124159. */
  124160. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): (() => IWebXRFeature);
  124161. /**
  124162. * Can be used to return the list of features currently registered
  124163. *
  124164. * @returns an Array of available features
  124165. */
  124166. static GetAvailableFeatures(): string[];
  124167. /**
  124168. * Gets the versions available for a specific feature
  124169. * @param featureName the name of the feature
  124170. * @returns an array with the available versions
  124171. */
  124172. static GetAvailableVersions(featureName: string): string[];
  124173. /**
  124174. * Return the latest unstable version of this feature
  124175. * @param featureName the name of the feature to search
  124176. * @returns the version number. if not found will return -1
  124177. */
  124178. static GetLatestVersionOfFeature(featureName: string): number;
  124179. /**
  124180. * Return the latest stable version of this feature
  124181. * @param featureName the name of the feature to search
  124182. * @returns the version number. if not found will return -1
  124183. */
  124184. static GetStableVersionOfFeature(featureName: string): number;
  124185. /**
  124186. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  124187. * Can be used during a session to start a feature
  124188. * @param featureName the name of feature to attach
  124189. */
  124190. attachFeature(featureName: string): void;
  124191. /**
  124192. * Can be used inside a session or when the session ends to detach a specific feature
  124193. * @param featureName the name of the feature to detach
  124194. */
  124195. detachFeature(featureName: string): void;
  124196. /**
  124197. * Used to disable an already-enabled feature
  124198. * The feature will be disposed and will be recreated once enabled.
  124199. * @param featureName the feature to disable
  124200. * @returns true if disable was successful
  124201. */
  124202. disableFeature(featureName: string | {
  124203. Name: string;
  124204. }): boolean;
  124205. /**
  124206. * dispose this features manager
  124207. */
  124208. dispose(): void;
  124209. /**
  124210. * Enable a feature using its name and a version. This will enable it in the scene, and will be responsible to attach it when the session starts.
  124211. * If used twice, the old version will be disposed and a new one will be constructed. This way you can re-enable with different configuration.
  124212. *
  124213. * @param featureName the name of the feature to load or the class of the feature
  124214. * @param version optional version to load. if not provided the latest version will be enabled
  124215. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  124216. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  124217. * @returns a new constructed feature or throws an error if feature not found.
  124218. */
  124219. enableFeature(featureName: string | {
  124220. Name: string;
  124221. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean): IWebXRFeature;
  124222. /**
  124223. * get the implementation of an enabled feature.
  124224. * @param featureName the name of the feature to load
  124225. * @returns the feature class, if found
  124226. */
  124227. getEnabledFeature(featureName: string): IWebXRFeature;
  124228. /**
  124229. * Get the list of enabled features
  124230. * @returns an array of enabled features
  124231. */
  124232. getEnabledFeatures(): string[];
  124233. }
  124234. }
  124235. declare module BABYLON {
  124236. /**
  124237. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  124238. * @see https://doc.babylonjs.com/how_to/webxr
  124239. */
  124240. export class WebXRExperienceHelper implements IDisposable {
  124241. private scene;
  124242. private _nonVRCamera;
  124243. private _originalSceneAutoClear;
  124244. private _supported;
  124245. /**
  124246. * Camera used to render xr content
  124247. */
  124248. camera: WebXRCamera;
  124249. /** A features manager for this xr session */
  124250. featuresManager: WebXRFeaturesManager;
  124251. /**
  124252. * Observers registered here will be triggered after the camera's initial transformation is set
  124253. * This can be used to set a different ground level or an extra rotation.
  124254. *
  124255. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  124256. * to the position set after this observable is done executing.
  124257. */
  124258. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  124259. /**
  124260. * Fires when the state of the experience helper has changed
  124261. */
  124262. onStateChangedObservable: Observable<WebXRState>;
  124263. /** Session manager used to keep track of xr session */
  124264. sessionManager: WebXRSessionManager;
  124265. /**
  124266. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  124267. */
  124268. state: WebXRState;
  124269. /**
  124270. * Creates a WebXRExperienceHelper
  124271. * @param scene The scene the helper should be created in
  124272. */
  124273. private constructor();
  124274. /**
  124275. * Creates the experience helper
  124276. * @param scene the scene to attach the experience helper to
  124277. * @returns a promise for the experience helper
  124278. */
  124279. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  124280. /**
  124281. * Disposes of the experience helper
  124282. */
  124283. dispose(): void;
  124284. /**
  124285. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  124286. * @param sessionMode options for the XR session
  124287. * @param referenceSpaceType frame of reference of the XR session
  124288. * @param renderTarget the output canvas that will be used to enter XR mode
  124289. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  124290. * @returns promise that resolves after xr mode has entered
  124291. */
  124292. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  124293. /**
  124294. * Exits XR mode and returns the scene to its original state
  124295. * @returns promise that resolves after xr mode has exited
  124296. */
  124297. exitXRAsync(): Promise<void>;
  124298. private _nonXRToXRCamera;
  124299. private _setState;
  124300. }
  124301. }
  124302. declare module BABYLON {
  124303. /**
  124304. * X-Y values for axes in WebXR
  124305. */
  124306. export interface IWebXRMotionControllerAxesValue {
  124307. /**
  124308. * The value of the x axis
  124309. */
  124310. x: number;
  124311. /**
  124312. * The value of the y-axis
  124313. */
  124314. y: number;
  124315. }
  124316. /**
  124317. * changed / previous values for the values of this component
  124318. */
  124319. export interface IWebXRMotionControllerComponentChangesValues<T> {
  124320. /**
  124321. * current (this frame) value
  124322. */
  124323. current: T;
  124324. /**
  124325. * previous (last change) value
  124326. */
  124327. previous: T;
  124328. }
  124329. /**
  124330. * Represents changes in the component between current frame and last values recorded
  124331. */
  124332. export interface IWebXRMotionControllerComponentChanges {
  124333. /**
  124334. * will be populated with previous and current values if axes changed
  124335. */
  124336. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  124337. /**
  124338. * will be populated with previous and current values if pressed changed
  124339. */
  124340. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  124341. /**
  124342. * will be populated with previous and current values if touched changed
  124343. */
  124344. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  124345. /**
  124346. * will be populated with previous and current values if value changed
  124347. */
  124348. value?: IWebXRMotionControllerComponentChangesValues<number>;
  124349. }
  124350. /**
  124351. * This class represents a single component (for example button or thumbstick) of a motion controller
  124352. */
  124353. export class WebXRControllerComponent implements IDisposable {
  124354. /**
  124355. * the id of this component
  124356. */
  124357. id: string;
  124358. /**
  124359. * the type of the component
  124360. */
  124361. type: MotionControllerComponentType;
  124362. private _buttonIndex;
  124363. private _axesIndices;
  124364. private _axes;
  124365. private _changes;
  124366. private _currentValue;
  124367. private _hasChanges;
  124368. private _pressed;
  124369. private _touched;
  124370. /**
  124371. * button component type
  124372. */
  124373. static BUTTON_TYPE: MotionControllerComponentType;
  124374. /**
  124375. * squeeze component type
  124376. */
  124377. static SQUEEZE_TYPE: MotionControllerComponentType;
  124378. /**
  124379. * Thumbstick component type
  124380. */
  124381. static THUMBSTICK_TYPE: MotionControllerComponentType;
  124382. /**
  124383. * Touchpad component type
  124384. */
  124385. static TOUCHPAD_TYPE: MotionControllerComponentType;
  124386. /**
  124387. * trigger component type
  124388. */
  124389. static TRIGGER_TYPE: MotionControllerComponentType;
  124390. /**
  124391. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  124392. * the axes data changes
  124393. */
  124394. onAxisValueChangedObservable: Observable<{
  124395. x: number;
  124396. y: number;
  124397. }>;
  124398. /**
  124399. * Observers registered here will be triggered when the state of a button changes
  124400. * State change is either pressed / touched / value
  124401. */
  124402. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  124403. /**
  124404. * Creates a new component for a motion controller.
  124405. * It is created by the motion controller itself
  124406. *
  124407. * @param id the id of this component
  124408. * @param type the type of the component
  124409. * @param _buttonIndex index in the buttons array of the gamepad
  124410. * @param _axesIndices indices of the values in the axes array of the gamepad
  124411. */
  124412. constructor(
  124413. /**
  124414. * the id of this component
  124415. */
  124416. id: string,
  124417. /**
  124418. * the type of the component
  124419. */
  124420. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  124421. /**
  124422. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  124423. */
  124424. get axes(): IWebXRMotionControllerAxesValue;
  124425. /**
  124426. * Get the changes. Elements will be populated only if they changed with their previous and current value
  124427. */
  124428. get changes(): IWebXRMotionControllerComponentChanges;
  124429. /**
  124430. * Return whether or not the component changed the last frame
  124431. */
  124432. get hasChanges(): boolean;
  124433. /**
  124434. * is the button currently pressed
  124435. */
  124436. get pressed(): boolean;
  124437. /**
  124438. * is the button currently touched
  124439. */
  124440. get touched(): boolean;
  124441. /**
  124442. * Get the current value of this component
  124443. */
  124444. get value(): number;
  124445. /**
  124446. * Dispose this component
  124447. */
  124448. dispose(): void;
  124449. /**
  124450. * Are there axes correlating to this component
  124451. * @return true is axes data is available
  124452. */
  124453. isAxes(): boolean;
  124454. /**
  124455. * Is this component a button (hence - pressable)
  124456. * @returns true if can be pressed
  124457. */
  124458. isButton(): boolean;
  124459. /**
  124460. * update this component using the gamepad object it is in. Called on every frame
  124461. * @param nativeController the native gamepad controller object
  124462. */
  124463. update(nativeController: IMinimalMotionControllerObject): void;
  124464. }
  124465. }
  124466. declare module BABYLON {
  124467. /**
  124468. * Interface used to represent data loading progression
  124469. */
  124470. export interface ISceneLoaderProgressEvent {
  124471. /**
  124472. * Defines if data length to load can be evaluated
  124473. */
  124474. readonly lengthComputable: boolean;
  124475. /**
  124476. * Defines the loaded data length
  124477. */
  124478. readonly loaded: number;
  124479. /**
  124480. * Defines the data length to load
  124481. */
  124482. readonly total: number;
  124483. }
  124484. /**
  124485. * Interface used by SceneLoader plugins to define supported file extensions
  124486. */
  124487. export interface ISceneLoaderPluginExtensions {
  124488. /**
  124489. * Defines the list of supported extensions
  124490. */
  124491. [extension: string]: {
  124492. isBinary: boolean;
  124493. };
  124494. }
  124495. /**
  124496. * Interface used by SceneLoader plugin factory
  124497. */
  124498. export interface ISceneLoaderPluginFactory {
  124499. /**
  124500. * Defines the name of the factory
  124501. */
  124502. name: string;
  124503. /**
  124504. * Function called to create a new plugin
  124505. * @return the new plugin
  124506. */
  124507. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  124508. /**
  124509. * The callback that returns true if the data can be directly loaded.
  124510. * @param data string containing the file data
  124511. * @returns if the data can be loaded directly
  124512. */
  124513. canDirectLoad?(data: string): boolean;
  124514. }
  124515. /**
  124516. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  124517. */
  124518. export interface ISceneLoaderPluginBase {
  124519. /**
  124520. * The friendly name of this plugin.
  124521. */
  124522. name: string;
  124523. /**
  124524. * The file extensions supported by this plugin.
  124525. */
  124526. extensions: string | ISceneLoaderPluginExtensions;
  124527. /**
  124528. * The callback called when loading from a url.
  124529. * @param scene scene loading this url
  124530. * @param url url to load
  124531. * @param onSuccess callback called when the file successfully loads
  124532. * @param onProgress callback called while file is loading (if the server supports this mode)
  124533. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  124534. * @param onError callback called when the file fails to load
  124535. * @returns a file request object
  124536. */
  124537. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  124538. /**
  124539. * The callback called when loading from a file object.
  124540. * @param scene scene loading this file
  124541. * @param file defines the file to load
  124542. * @param onSuccess defines the callback to call when data is loaded
  124543. * @param onProgress defines the callback to call during loading process
  124544. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  124545. * @param onError defines the callback to call when an error occurs
  124546. * @returns a file request object
  124547. */
  124548. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  124549. /**
  124550. * The callback that returns true if the data can be directly loaded.
  124551. * @param data string containing the file data
  124552. * @returns if the data can be loaded directly
  124553. */
  124554. canDirectLoad?(data: string): boolean;
  124555. /**
  124556. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  124557. * @param scene scene loading this data
  124558. * @param data string containing the data
  124559. * @returns data to pass to the plugin
  124560. */
  124561. directLoad?(scene: Scene, data: string): any;
  124562. /**
  124563. * The callback that allows custom handling of the root url based on the response url.
  124564. * @param rootUrl the original root url
  124565. * @param responseURL the response url if available
  124566. * @returns the new root url
  124567. */
  124568. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  124569. }
  124570. /**
  124571. * Interface used to define a SceneLoader plugin
  124572. */
  124573. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  124574. /**
  124575. * Import meshes into a scene.
  124576. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  124577. * @param scene The scene to import into
  124578. * @param data The data to import
  124579. * @param rootUrl The root url for scene and resources
  124580. * @param meshes The meshes array to import into
  124581. * @param particleSystems The particle systems array to import into
  124582. * @param skeletons The skeletons array to import into
  124583. * @param onError The callback when import fails
  124584. * @returns True if successful or false otherwise
  124585. */
  124586. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  124587. /**
  124588. * Load into a scene.
  124589. * @param scene The scene to load into
  124590. * @param data The data to import
  124591. * @param rootUrl The root url for scene and resources
  124592. * @param onError The callback when import fails
  124593. * @returns True if successful or false otherwise
  124594. */
  124595. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  124596. /**
  124597. * Load into an asset container.
  124598. * @param scene The scene to load into
  124599. * @param data The data to import
  124600. * @param rootUrl The root url for scene and resources
  124601. * @param onError The callback when import fails
  124602. * @returns The loaded asset container
  124603. */
  124604. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  124605. }
  124606. /**
  124607. * Interface used to define an async SceneLoader plugin
  124608. */
  124609. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  124610. /**
  124611. * Import meshes into a scene.
  124612. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  124613. * @param scene The scene to import into
  124614. * @param data The data to import
  124615. * @param rootUrl The root url for scene and resources
  124616. * @param onProgress The callback when the load progresses
  124617. * @param fileName Defines the name of the file to load
  124618. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  124619. */
  124620. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  124621. meshes: AbstractMesh[];
  124622. particleSystems: IParticleSystem[];
  124623. skeletons: Skeleton[];
  124624. animationGroups: AnimationGroup[];
  124625. }>;
  124626. /**
  124627. * Load into a scene.
  124628. * @param scene The scene to load into
  124629. * @param data The data to import
  124630. * @param rootUrl The root url for scene and resources
  124631. * @param onProgress The callback when the load progresses
  124632. * @param fileName Defines the name of the file to load
  124633. * @returns Nothing
  124634. */
  124635. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  124636. /**
  124637. * Load into an asset container.
  124638. * @param scene The scene to load into
  124639. * @param data The data to import
  124640. * @param rootUrl The root url for scene and resources
  124641. * @param onProgress The callback when the load progresses
  124642. * @param fileName Defines the name of the file to load
  124643. * @returns The loaded asset container
  124644. */
  124645. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  124646. }
  124647. /**
  124648. * Mode that determines how to handle old animation groups before loading new ones.
  124649. */
  124650. export enum SceneLoaderAnimationGroupLoadingMode {
  124651. /**
  124652. * Reset all old animations to initial state then dispose them.
  124653. */
  124654. Clean = 0,
  124655. /**
  124656. * Stop all old animations.
  124657. */
  124658. Stop = 1,
  124659. /**
  124660. * Restart old animations from first frame.
  124661. */
  124662. Sync = 2,
  124663. /**
  124664. * Old animations remains untouched.
  124665. */
  124666. NoSync = 3
  124667. }
  124668. /**
  124669. * Class used to load scene from various file formats using registered plugins
  124670. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  124671. */
  124672. export class SceneLoader {
  124673. /**
  124674. * No logging while loading
  124675. */
  124676. static readonly NO_LOGGING: number;
  124677. /**
  124678. * Minimal logging while loading
  124679. */
  124680. static readonly MINIMAL_LOGGING: number;
  124681. /**
  124682. * Summary logging while loading
  124683. */
  124684. static readonly SUMMARY_LOGGING: number;
  124685. /**
  124686. * Detailled logging while loading
  124687. */
  124688. static readonly DETAILED_LOGGING: number;
  124689. /**
  124690. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  124691. */
  124692. static get ForceFullSceneLoadingForIncremental(): boolean;
  124693. static set ForceFullSceneLoadingForIncremental(value: boolean);
  124694. /**
  124695. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  124696. */
  124697. static get ShowLoadingScreen(): boolean;
  124698. static set ShowLoadingScreen(value: boolean);
  124699. /**
  124700. * Defines the current logging level (while loading the scene)
  124701. * @ignorenaming
  124702. */
  124703. static get loggingLevel(): number;
  124704. static set loggingLevel(value: number);
  124705. /**
  124706. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  124707. */
  124708. static get CleanBoneMatrixWeights(): boolean;
  124709. static set CleanBoneMatrixWeights(value: boolean);
  124710. /**
  124711. * Event raised when a plugin is used to load a scene
  124712. */
  124713. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  124714. private static _registeredPlugins;
  124715. private static _getDefaultPlugin;
  124716. private static _getPluginForExtension;
  124717. private static _getPluginForDirectLoad;
  124718. private static _getPluginForFilename;
  124719. private static _getDirectLoad;
  124720. private static _loadData;
  124721. private static _getFileInfo;
  124722. /**
  124723. * Gets a plugin that can load the given extension
  124724. * @param extension defines the extension to load
  124725. * @returns a plugin or null if none works
  124726. */
  124727. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  124728. /**
  124729. * Gets a boolean indicating that the given extension can be loaded
  124730. * @param extension defines the extension to load
  124731. * @returns true if the extension is supported
  124732. */
  124733. static IsPluginForExtensionAvailable(extension: string): boolean;
  124734. /**
  124735. * Adds a new plugin to the list of registered plugins
  124736. * @param plugin defines the plugin to add
  124737. */
  124738. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  124739. /**
  124740. * Import meshes into a scene
  124741. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  124742. * @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)
  124743. * @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)
  124744. * @param scene the instance of BABYLON.Scene to append to
  124745. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  124746. * @param onProgress a callback with a progress event for each file being loaded
  124747. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  124748. * @param pluginExtension the extension used to determine the plugin
  124749. * @returns The loaded plugin
  124750. */
  124751. static ImportMesh(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], animationGroups: AnimationGroup[]) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  124752. /**
  124753. * Import meshes into a scene
  124754. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  124755. * @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)
  124756. * @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)
  124757. * @param scene the instance of BABYLON.Scene to append to
  124758. * @param onProgress a callback with a progress event for each file being loaded
  124759. * @param pluginExtension the extension used to determine the plugin
  124760. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  124761. */
  124762. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  124763. meshes: AbstractMesh[];
  124764. particleSystems: IParticleSystem[];
  124765. skeletons: Skeleton[];
  124766. animationGroups: AnimationGroup[];
  124767. }>;
  124768. /**
  124769. * Load a scene
  124770. * @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)
  124771. * @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)
  124772. * @param engine is the instance of BABYLON.Engine to use to create the scene
  124773. * @param onSuccess a callback with the scene when import succeeds
  124774. * @param onProgress a callback with a progress event for each file being loaded
  124775. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  124776. * @param pluginExtension the extension used to determine the plugin
  124777. * @returns The loaded plugin
  124778. */
  124779. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  124780. /**
  124781. * Load a scene
  124782. * @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)
  124783. * @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)
  124784. * @param engine is the instance of BABYLON.Engine to use to create the scene
  124785. * @param onProgress a callback with a progress event for each file being loaded
  124786. * @param pluginExtension the extension used to determine the plugin
  124787. * @returns The loaded scene
  124788. */
  124789. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  124790. /**
  124791. * Append a scene
  124792. * @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)
  124793. * @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)
  124794. * @param scene is the instance of BABYLON.Scene to append to
  124795. * @param onSuccess a callback with the scene when import succeeds
  124796. * @param onProgress a callback with a progress event for each file being loaded
  124797. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  124798. * @param pluginExtension the extension used to determine the plugin
  124799. * @returns The loaded plugin
  124800. */
  124801. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  124802. /**
  124803. * Append a scene
  124804. * @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)
  124805. * @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)
  124806. * @param scene is the instance of BABYLON.Scene to append to
  124807. * @param onProgress a callback with a progress event for each file being loaded
  124808. * @param pluginExtension the extension used to determine the plugin
  124809. * @returns The given scene
  124810. */
  124811. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  124812. /**
  124813. * Load a scene into an asset container
  124814. * @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)
  124815. * @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)
  124816. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  124817. * @param onSuccess a callback with the scene when import succeeds
  124818. * @param onProgress a callback with a progress event for each file being loaded
  124819. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  124820. * @param pluginExtension the extension used to determine the plugin
  124821. * @returns The loaded plugin
  124822. */
  124823. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  124824. /**
  124825. * Load a scene into an asset container
  124826. * @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)
  124827. * @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)
  124828. * @param scene is the instance of Scene to append to
  124829. * @param onProgress a callback with a progress event for each file being loaded
  124830. * @param pluginExtension the extension used to determine the plugin
  124831. * @returns The loaded asset container
  124832. */
  124833. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  124834. /**
  124835. * Import animations from a file into a scene
  124836. * @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)
  124837. * @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)
  124838. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  124839. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  124840. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  124841. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  124842. * @param onSuccess a callback with the scene when import succeeds
  124843. * @param onProgress a callback with a progress event for each file being loaded
  124844. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  124845. */
  124846. static ImportAnimations(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>): void;
  124847. /**
  124848. * Import animations from a file into a scene
  124849. * @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)
  124850. * @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)
  124851. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  124852. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  124853. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  124854. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  124855. * @param onSuccess a callback with the scene when import succeeds
  124856. * @param onProgress a callback with a progress event for each file being loaded
  124857. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  124858. * @returns the updated scene with imported animations
  124859. */
  124860. static ImportAnimationsAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>): Promise<Scene>;
  124861. }
  124862. }
  124863. declare module BABYLON {
  124864. /**
  124865. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  124866. */
  124867. export type MotionControllerHandedness = "none" | "left" | "right";
  124868. /**
  124869. * The type of components available in motion controllers.
  124870. * This is not the name of the component.
  124871. */
  124872. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  124873. /**
  124874. * The state of a controller component
  124875. */
  124876. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  124877. /**
  124878. * The schema of motion controller layout.
  124879. * No object will be initialized using this interface
  124880. * This is used just to define the profile.
  124881. */
  124882. export interface IMotionControllerLayout {
  124883. /**
  124884. * Path to load the assets. Usually relative to the base path
  124885. */
  124886. assetPath: string;
  124887. /**
  124888. * Available components (unsorted)
  124889. */
  124890. components: {
  124891. /**
  124892. * A map of component Ids
  124893. */
  124894. [componentId: string]: {
  124895. /**
  124896. * The type of input the component outputs
  124897. */
  124898. type: MotionControllerComponentType;
  124899. /**
  124900. * The indices of this component in the gamepad object
  124901. */
  124902. gamepadIndices: {
  124903. /**
  124904. * Index of button
  124905. */
  124906. button?: number;
  124907. /**
  124908. * If available, index of x-axis
  124909. */
  124910. xAxis?: number;
  124911. /**
  124912. * If available, index of y-axis
  124913. */
  124914. yAxis?: number;
  124915. };
  124916. /**
  124917. * The mesh's root node name
  124918. */
  124919. rootNodeName: string;
  124920. /**
  124921. * Animation definitions for this model
  124922. */
  124923. visualResponses: {
  124924. [stateKey: string]: {
  124925. /**
  124926. * What property will be animated
  124927. */
  124928. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  124929. /**
  124930. * What states influence this visual response
  124931. */
  124932. states: MotionControllerComponentStateType[];
  124933. /**
  124934. * Type of animation - movement or visibility
  124935. */
  124936. valueNodeProperty: "transform" | "visibility";
  124937. /**
  124938. * Base node name to move. Its position will be calculated according to the min and max nodes
  124939. */
  124940. valueNodeName?: string;
  124941. /**
  124942. * Minimum movement node
  124943. */
  124944. minNodeName?: string;
  124945. /**
  124946. * Max movement node
  124947. */
  124948. maxNodeName?: string;
  124949. };
  124950. };
  124951. /**
  124952. * If touch enabled, what is the name of node to display user feedback
  124953. */
  124954. touchPointNodeName?: string;
  124955. };
  124956. };
  124957. /**
  124958. * Is it xr standard mapping or not
  124959. */
  124960. gamepadMapping: "" | "xr-standard";
  124961. /**
  124962. * Base root node of this entire model
  124963. */
  124964. rootNodeName: string;
  124965. /**
  124966. * Defines the main button component id
  124967. */
  124968. selectComponentId: string;
  124969. }
  124970. /**
  124971. * A definition for the layout map in the input profile
  124972. */
  124973. export interface IMotionControllerLayoutMap {
  124974. /**
  124975. * Layouts with handedness type as a key
  124976. */
  124977. [handedness: string]: IMotionControllerLayout;
  124978. }
  124979. /**
  124980. * The XR Input profile schema
  124981. * Profiles can be found here:
  124982. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  124983. */
  124984. export interface IMotionControllerProfile {
  124985. /**
  124986. * fallback profiles for this profileId
  124987. */
  124988. fallbackProfileIds: string[];
  124989. /**
  124990. * The layout map, with handedness as key
  124991. */
  124992. layouts: IMotionControllerLayoutMap;
  124993. /**
  124994. * The id of this profile
  124995. * correlates to the profile(s) in the xrInput.profiles array
  124996. */
  124997. profileId: string;
  124998. }
  124999. /**
  125000. * A helper-interface for the 3 meshes needed for controller button animation
  125001. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  125002. */
  125003. export interface IMotionControllerButtonMeshMap {
  125004. /**
  125005. * the mesh that defines the pressed value mesh position.
  125006. * This is used to find the max-position of this button
  125007. */
  125008. pressedMesh: AbstractMesh;
  125009. /**
  125010. * the mesh that defines the unpressed value mesh position.
  125011. * This is used to find the min (or initial) position of this button
  125012. */
  125013. unpressedMesh: AbstractMesh;
  125014. /**
  125015. * The mesh that will be changed when value changes
  125016. */
  125017. valueMesh: AbstractMesh;
  125018. }
  125019. /**
  125020. * A helper-interface for the 3 meshes needed for controller axis animation.
  125021. * This will be expanded when touchpad animations are fully supported
  125022. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  125023. */
  125024. export interface IMotionControllerMeshMap {
  125025. /**
  125026. * the mesh that defines the maximum value mesh position.
  125027. */
  125028. maxMesh?: AbstractMesh;
  125029. /**
  125030. * the mesh that defines the minimum value mesh position.
  125031. */
  125032. minMesh?: AbstractMesh;
  125033. /**
  125034. * The mesh that will be changed when axis value changes
  125035. */
  125036. valueMesh: AbstractMesh;
  125037. }
  125038. /**
  125039. * The elements needed for change-detection of the gamepad objects in motion controllers
  125040. */
  125041. export interface IMinimalMotionControllerObject {
  125042. /**
  125043. * Available axes of this controller
  125044. */
  125045. axes: number[];
  125046. /**
  125047. * An array of available buttons
  125048. */
  125049. buttons: Array<{
  125050. /**
  125051. * Value of the button/trigger
  125052. */
  125053. value: number;
  125054. /**
  125055. * If the button/trigger is currently touched
  125056. */
  125057. touched: boolean;
  125058. /**
  125059. * If the button/trigger is currently pressed
  125060. */
  125061. pressed: boolean;
  125062. }>;
  125063. /**
  125064. * EXPERIMENTAL haptic support.
  125065. */
  125066. hapticActuators?: Array<{
  125067. pulse: (value: number, duration: number) => Promise<boolean>;
  125068. }>;
  125069. }
  125070. /**
  125071. * An Abstract Motion controller
  125072. * This class receives an xrInput and a profile layout and uses those to initialize the components
  125073. * Each component has an observable to check for changes in value and state
  125074. */
  125075. export abstract class WebXRAbstractMotionController implements IDisposable {
  125076. protected scene: Scene;
  125077. protected layout: IMotionControllerLayout;
  125078. /**
  125079. * The gamepad object correlating to this controller
  125080. */
  125081. gamepadObject: IMinimalMotionControllerObject;
  125082. /**
  125083. * handedness (left/right/none) of this controller
  125084. */
  125085. handedness: MotionControllerHandedness;
  125086. private _initComponent;
  125087. private _modelReady;
  125088. /**
  125089. * A map of components (WebXRControllerComponent) in this motion controller
  125090. * Components have a ComponentType and can also have both button and axis definitions
  125091. */
  125092. readonly components: {
  125093. [id: string]: WebXRControllerComponent;
  125094. };
  125095. /**
  125096. * Disable the model's animation. Can be set at any time.
  125097. */
  125098. disableAnimation: boolean;
  125099. /**
  125100. * Observers registered here will be triggered when the model of this controller is done loading
  125101. */
  125102. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  125103. /**
  125104. * The profile id of this motion controller
  125105. */
  125106. abstract profileId: string;
  125107. /**
  125108. * The root mesh of the model. It is null if the model was not yet initialized
  125109. */
  125110. rootMesh: Nullable<AbstractMesh>;
  125111. /**
  125112. * constructs a new abstract motion controller
  125113. * @param scene the scene to which the model of the controller will be added
  125114. * @param layout The profile layout to load
  125115. * @param gamepadObject The gamepad object correlating to this controller
  125116. * @param handedness handedness (left/right/none) of this controller
  125117. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  125118. */
  125119. constructor(scene: Scene, layout: IMotionControllerLayout,
  125120. /**
  125121. * The gamepad object correlating to this controller
  125122. */
  125123. gamepadObject: IMinimalMotionControllerObject,
  125124. /**
  125125. * handedness (left/right/none) of this controller
  125126. */
  125127. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  125128. /**
  125129. * Dispose this controller, the model mesh and all its components
  125130. */
  125131. dispose(): void;
  125132. /**
  125133. * Returns all components of specific type
  125134. * @param type the type to search for
  125135. * @return an array of components with this type
  125136. */
  125137. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  125138. /**
  125139. * get a component based an its component id as defined in layout.components
  125140. * @param id the id of the component
  125141. * @returns the component correlates to the id or undefined if not found
  125142. */
  125143. getComponent(id: string): WebXRControllerComponent;
  125144. /**
  125145. * Get the list of components available in this motion controller
  125146. * @returns an array of strings correlating to available components
  125147. */
  125148. getComponentIds(): string[];
  125149. /**
  125150. * Get the first component of specific type
  125151. * @param type type of component to find
  125152. * @return a controller component or null if not found
  125153. */
  125154. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  125155. /**
  125156. * Get the main (Select) component of this controller as defined in the layout
  125157. * @returns the main component of this controller
  125158. */
  125159. getMainComponent(): WebXRControllerComponent;
  125160. /**
  125161. * Loads the model correlating to this controller
  125162. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  125163. * @returns A promise fulfilled with the result of the model loading
  125164. */
  125165. loadModel(): Promise<boolean>;
  125166. /**
  125167. * Update this model using the current XRFrame
  125168. * @param xrFrame the current xr frame to use and update the model
  125169. */
  125170. updateFromXRFrame(xrFrame: XRFrame): void;
  125171. /**
  125172. * Backwards compatibility due to a deeply-integrated typo
  125173. */
  125174. get handness(): XREye;
  125175. /**
  125176. * Pulse (vibrate) this controller
  125177. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  125178. * Consecutive calls to this function will cancel the last pulse call
  125179. *
  125180. * @param value the strength of the pulse in 0.0...1.0 range
  125181. * @param duration Duration of the pulse in milliseconds
  125182. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  125183. * @returns a promise that will send true when the pulse has ended and false if the device doesn't support pulse or an error accrued
  125184. */
  125185. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  125186. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh;
  125187. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh;
  125188. /**
  125189. * Moves the axis on the controller mesh based on its current state
  125190. * @param axis the index of the axis
  125191. * @param axisValue the value of the axis which determines the meshes new position
  125192. * @hidden
  125193. */
  125194. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  125195. /**
  125196. * Update the model itself with the current frame data
  125197. * @param xrFrame the frame to use for updating the model mesh
  125198. */
  125199. protected updateModel(xrFrame: XRFrame): void;
  125200. /**
  125201. * Get the filename and path for this controller's model
  125202. * @returns a map of filename and path
  125203. */
  125204. protected abstract _getFilenameAndPath(): {
  125205. filename: string;
  125206. path: string;
  125207. };
  125208. /**
  125209. * This function is called before the mesh is loaded. It checks for loading constraints.
  125210. * For example, this function can check if the GLB loader is available
  125211. * If this function returns false, the generic controller will be loaded instead
  125212. * @returns Is the client ready to load the mesh
  125213. */
  125214. protected abstract _getModelLoadingConstraints(): boolean;
  125215. /**
  125216. * This function will be called after the model was successfully loaded and can be used
  125217. * for mesh transformations before it is available for the user
  125218. * @param meshes the loaded meshes
  125219. */
  125220. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  125221. /**
  125222. * Set the root mesh for this controller. Important for the WebXR controller class
  125223. * @param meshes the loaded meshes
  125224. */
  125225. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  125226. /**
  125227. * A function executed each frame that updates the mesh (if needed)
  125228. * @param xrFrame the current xrFrame
  125229. */
  125230. protected abstract _updateModel(xrFrame: XRFrame): void;
  125231. private _getGenericFilenameAndPath;
  125232. private _getGenericParentMesh;
  125233. }
  125234. }
  125235. declare module BABYLON {
  125236. /**
  125237. * A generic trigger-only motion controller for WebXR
  125238. */
  125239. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  125240. /**
  125241. * Static version of the profile id of this controller
  125242. */
  125243. static ProfileId: string;
  125244. profileId: string;
  125245. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  125246. protected _getFilenameAndPath(): {
  125247. filename: string;
  125248. path: string;
  125249. };
  125250. protected _getModelLoadingConstraints(): boolean;
  125251. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  125252. protected _setRootMesh(meshes: AbstractMesh[]): void;
  125253. protected _updateModel(): void;
  125254. }
  125255. }
  125256. declare module BABYLON {
  125257. /**
  125258. * Class containing static functions to help procedurally build meshes
  125259. */
  125260. export class SphereBuilder {
  125261. /**
  125262. * Creates a sphere mesh
  125263. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  125264. * * 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`)
  125265. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  125266. * * 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
  125267. * * 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)
  125268. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125269. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125270. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125271. * @param name defines the name of the mesh
  125272. * @param options defines the options used to create the mesh
  125273. * @param scene defines the hosting scene
  125274. * @returns the sphere mesh
  125275. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  125276. */
  125277. static CreateSphere(name: string, options: {
  125278. segments?: number;
  125279. diameter?: number;
  125280. diameterX?: number;
  125281. diameterY?: number;
  125282. diameterZ?: number;
  125283. arc?: number;
  125284. slice?: number;
  125285. sideOrientation?: number;
  125286. frontUVs?: Vector4;
  125287. backUVs?: Vector4;
  125288. updatable?: boolean;
  125289. }, scene?: Nullable<Scene>): Mesh;
  125290. }
  125291. }
  125292. declare module BABYLON {
  125293. /**
  125294. * A profiled motion controller has its profile loaded from an online repository.
  125295. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  125296. */
  125297. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  125298. private _repositoryUrl;
  125299. private _buttonMeshMapping;
  125300. private _touchDots;
  125301. /**
  125302. * The profile ID of this controller. Will be populated when the controller initializes.
  125303. */
  125304. profileId: string;
  125305. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  125306. dispose(): void;
  125307. protected _getFilenameAndPath(): {
  125308. filename: string;
  125309. path: string;
  125310. };
  125311. protected _getModelLoadingConstraints(): boolean;
  125312. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  125313. protected _setRootMesh(meshes: AbstractMesh[]): void;
  125314. protected _updateModel(_xrFrame: XRFrame): void;
  125315. }
  125316. }
  125317. declare module BABYLON {
  125318. /**
  125319. * A construction function type to create a new controller based on an xrInput object
  125320. */
  125321. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  125322. /**
  125323. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  125324. *
  125325. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  125326. * it should be replaced with auto-loaded controllers.
  125327. *
  125328. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  125329. */
  125330. export class WebXRMotionControllerManager {
  125331. private static _AvailableControllers;
  125332. private static _Fallbacks;
  125333. private static _ProfileLoadingPromises;
  125334. private static _ProfilesList;
  125335. /**
  125336. * The base URL of the online controller repository. Can be changed at any time.
  125337. */
  125338. static BaseRepositoryUrl: string;
  125339. /**
  125340. * Which repository gets priority - local or online
  125341. */
  125342. static PrioritizeOnlineRepository: boolean;
  125343. /**
  125344. * Use the online repository, or use only locally-defined controllers
  125345. */
  125346. static UseOnlineRepository: boolean;
  125347. /**
  125348. * Clear the cache used for profile loading and reload when requested again
  125349. */
  125350. static ClearProfilesCache(): void;
  125351. /**
  125352. * Register the default fallbacks.
  125353. * This function is called automatically when this file is imported.
  125354. */
  125355. static DefaultFallbacks(): void;
  125356. /**
  125357. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  125358. * @param profileId the profile to which a fallback needs to be found
  125359. * @return an array with corresponding fallback profiles
  125360. */
  125361. static FindFallbackWithProfileId(profileId: string): string[];
  125362. /**
  125363. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  125364. * The order of search:
  125365. *
  125366. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  125367. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  125368. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  125369. * 4) return the generic trigger controller if none were found
  125370. *
  125371. * @param xrInput the xrInput to which a new controller is initialized
  125372. * @param scene the scene to which the model will be added
  125373. * @param forceProfile force a certain profile for this controller
  125374. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  125375. */
  125376. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  125377. /**
  125378. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  125379. *
  125380. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  125381. *
  125382. * @param type the profile type to register
  125383. * @param constructFunction the function to be called when loading this profile
  125384. */
  125385. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  125386. /**
  125387. * Register a fallback to a specific profile.
  125388. * @param profileId the profileId that will receive the fallbacks
  125389. * @param fallbacks A list of fallback profiles
  125390. */
  125391. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  125392. /**
  125393. * Will update the list of profiles available in the repository
  125394. * @return a promise that resolves to a map of profiles available online
  125395. */
  125396. static UpdateProfilesList(): Promise<{
  125397. [profile: string]: string;
  125398. }>;
  125399. private static _LoadProfileFromRepository;
  125400. private static _LoadProfilesFromAvailableControllers;
  125401. }
  125402. }
  125403. declare module BABYLON {
  125404. /**
  125405. * Configuration options for the WebXR controller creation
  125406. */
  125407. export interface IWebXRControllerOptions {
  125408. /**
  125409. * Should the controller mesh be animated when a user interacts with it
  125410. * The pressed buttons / thumbstick and touchpad animations will be disabled
  125411. */
  125412. disableMotionControllerAnimation?: boolean;
  125413. /**
  125414. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  125415. */
  125416. doNotLoadControllerMesh?: boolean;
  125417. /**
  125418. * Force a specific controller type for this controller.
  125419. * This can be used when creating your own profile or when testing different controllers
  125420. */
  125421. forceControllerProfile?: string;
  125422. /**
  125423. * Defines a rendering group ID for meshes that will be loaded.
  125424. * This is for the default controllers only.
  125425. */
  125426. renderingGroupId?: number;
  125427. }
  125428. /**
  125429. * Represents an XR controller
  125430. */
  125431. export class WebXRInputSource {
  125432. private _scene;
  125433. /** The underlying input source for the controller */
  125434. inputSource: XRInputSource;
  125435. private _options;
  125436. private _tmpVector;
  125437. private _uniqueId;
  125438. /**
  125439. * 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
  125440. */
  125441. grip?: AbstractMesh;
  125442. /**
  125443. * If available, this is the gamepad object related to this controller.
  125444. * Using this object it is possible to get click events and trackpad changes of the
  125445. * webxr controller that is currently being used.
  125446. */
  125447. motionController?: WebXRAbstractMotionController;
  125448. /**
  125449. * Event that fires when the controller is removed/disposed.
  125450. * The object provided as event data is this controller, after associated assets were disposed.
  125451. * uniqueId is still available.
  125452. */
  125453. onDisposeObservable: Observable<WebXRInputSource>;
  125454. /**
  125455. * Will be triggered when the mesh associated with the motion controller is done loading.
  125456. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  125457. * A shortened version of controller -> motion controller -> on mesh loaded.
  125458. */
  125459. onMeshLoadedObservable: Observable<AbstractMesh>;
  125460. /**
  125461. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  125462. */
  125463. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  125464. /**
  125465. * Pointer which can be used to select objects or attach a visible laser to
  125466. */
  125467. pointer: AbstractMesh;
  125468. /**
  125469. * Creates the controller
  125470. * @see https://doc.babylonjs.com/how_to/webxr
  125471. * @param _scene the scene which the controller should be associated to
  125472. * @param inputSource the underlying input source for the controller
  125473. * @param _options options for this controller creation
  125474. */
  125475. constructor(_scene: Scene,
  125476. /** The underlying input source for the controller */
  125477. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  125478. /**
  125479. * Get this controllers unique id
  125480. */
  125481. get uniqueId(): string;
  125482. /**
  125483. * Disposes of the object
  125484. */
  125485. dispose(): void;
  125486. /**
  125487. * Gets a world space ray coming from the pointer or grip
  125488. * @param result the resulting ray
  125489. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  125490. */
  125491. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  125492. /**
  125493. * Updates the controller pose based on the given XRFrame
  125494. * @param xrFrame xr frame to update the pose with
  125495. * @param referenceSpace reference space to use
  125496. */
  125497. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  125498. }
  125499. }
  125500. declare module BABYLON {
  125501. /**
  125502. * The schema for initialization options of the XR Input class
  125503. */
  125504. export interface IWebXRInputOptions {
  125505. /**
  125506. * If set to true no model will be automatically loaded
  125507. */
  125508. doNotLoadControllerMeshes?: boolean;
  125509. /**
  125510. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  125511. * If not found, the xr input profile data will be used.
  125512. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  125513. */
  125514. forceInputProfile?: string;
  125515. /**
  125516. * Do not send a request to the controller repository to load the profile.
  125517. *
  125518. * Instead, use the controllers available in babylon itself.
  125519. */
  125520. disableOnlineControllerRepository?: boolean;
  125521. /**
  125522. * A custom URL for the controllers repository
  125523. */
  125524. customControllersRepositoryURL?: string;
  125525. /**
  125526. * Should the controller model's components not move according to the user input
  125527. */
  125528. disableControllerAnimation?: boolean;
  125529. /**
  125530. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  125531. */
  125532. controllerOptions?: IWebXRControllerOptions;
  125533. }
  125534. /**
  125535. * XR input used to track XR inputs such as controllers/rays
  125536. */
  125537. export class WebXRInput implements IDisposable {
  125538. /**
  125539. * the xr session manager for this session
  125540. */
  125541. xrSessionManager: WebXRSessionManager;
  125542. /**
  125543. * the WebXR camera for this session. Mainly used for teleportation
  125544. */
  125545. xrCamera: WebXRCamera;
  125546. private readonly options;
  125547. /**
  125548. * XR controllers being tracked
  125549. */
  125550. controllers: Array<WebXRInputSource>;
  125551. private _frameObserver;
  125552. private _sessionEndedObserver;
  125553. private _sessionInitObserver;
  125554. /**
  125555. * Event when a controller has been connected/added
  125556. */
  125557. onControllerAddedObservable: Observable<WebXRInputSource>;
  125558. /**
  125559. * Event when a controller has been removed/disconnected
  125560. */
  125561. onControllerRemovedObservable: Observable<WebXRInputSource>;
  125562. /**
  125563. * Initializes the WebXRInput
  125564. * @param xrSessionManager the xr session manager for this session
  125565. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  125566. * @param options = initialization options for this xr input
  125567. */
  125568. constructor(
  125569. /**
  125570. * the xr session manager for this session
  125571. */
  125572. xrSessionManager: WebXRSessionManager,
  125573. /**
  125574. * the WebXR camera for this session. Mainly used for teleportation
  125575. */
  125576. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  125577. private _onInputSourcesChange;
  125578. private _addAndRemoveControllers;
  125579. /**
  125580. * Disposes of the object
  125581. */
  125582. dispose(): void;
  125583. }
  125584. }
  125585. declare module BABYLON {
  125586. /**
  125587. * This is the base class for all WebXR features.
  125588. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  125589. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  125590. */
  125591. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  125592. protected _xrSessionManager: WebXRSessionManager;
  125593. private _attached;
  125594. private _removeOnDetach;
  125595. /**
  125596. * Should auto-attach be disabled?
  125597. */
  125598. disableAutoAttach: boolean;
  125599. /**
  125600. * Construct a new (abstract) WebXR feature
  125601. * @param _xrSessionManager the xr session manager for this feature
  125602. */
  125603. constructor(_xrSessionManager: WebXRSessionManager);
  125604. /**
  125605. * Is this feature attached
  125606. */
  125607. get attached(): boolean;
  125608. /**
  125609. * attach this feature
  125610. *
  125611. * @param force should attachment be forced (even when already attached)
  125612. * @returns true if successful, false is failed or already attached
  125613. */
  125614. attach(force?: boolean): boolean;
  125615. /**
  125616. * detach this feature.
  125617. *
  125618. * @returns true if successful, false if failed or already detached
  125619. */
  125620. detach(): boolean;
  125621. /**
  125622. * Dispose this feature and all of the resources attached
  125623. */
  125624. dispose(): void;
  125625. /**
  125626. * This is used to register callbacks that will automatically be removed when detach is called.
  125627. * @param observable the observable to which the observer will be attached
  125628. * @param callback the callback to register
  125629. */
  125630. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  125631. /**
  125632. * Code in this function will be executed on each xrFrame received from the browser.
  125633. * This function will not execute after the feature is detached.
  125634. * @param _xrFrame the current frame
  125635. */
  125636. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  125637. }
  125638. }
  125639. declare module BABYLON {
  125640. /**
  125641. * Renders a layer on top of an existing scene
  125642. */
  125643. export class UtilityLayerRenderer implements IDisposable {
  125644. /** the original scene that will be rendered on top of */
  125645. originalScene: Scene;
  125646. private _pointerCaptures;
  125647. private _lastPointerEvents;
  125648. private static _DefaultUtilityLayer;
  125649. private static _DefaultKeepDepthUtilityLayer;
  125650. private _sharedGizmoLight;
  125651. private _renderCamera;
  125652. /**
  125653. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  125654. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  125655. * @returns the camera that is used when rendering the utility layer
  125656. */
  125657. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  125658. /**
  125659. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  125660. * @param cam the camera that should be used when rendering the utility layer
  125661. */
  125662. setRenderCamera(cam: Nullable<Camera>): void;
  125663. /**
  125664. * @hidden
  125665. * Light which used by gizmos to get light shading
  125666. */
  125667. _getSharedGizmoLight(): HemisphericLight;
  125668. /**
  125669. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  125670. */
  125671. pickUtilitySceneFirst: boolean;
  125672. /**
  125673. * 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)
  125674. */
  125675. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  125676. /**
  125677. * 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)
  125678. */
  125679. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  125680. /**
  125681. * The scene that is rendered on top of the original scene
  125682. */
  125683. utilityLayerScene: Scene;
  125684. /**
  125685. * If the utility layer should automatically be rendered on top of existing scene
  125686. */
  125687. shouldRender: boolean;
  125688. /**
  125689. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  125690. */
  125691. onlyCheckPointerDownEvents: boolean;
  125692. /**
  125693. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  125694. */
  125695. processAllEvents: boolean;
  125696. /**
  125697. * Observable raised when the pointer move from the utility layer scene to the main scene
  125698. */
  125699. onPointerOutObservable: Observable<number>;
  125700. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  125701. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  125702. private _afterRenderObserver;
  125703. private _sceneDisposeObserver;
  125704. private _originalPointerObserver;
  125705. /**
  125706. * Instantiates a UtilityLayerRenderer
  125707. * @param originalScene the original scene that will be rendered on top of
  125708. * @param handleEvents boolean indicating if the utility layer should handle events
  125709. */
  125710. constructor(
  125711. /** the original scene that will be rendered on top of */
  125712. originalScene: Scene, handleEvents?: boolean);
  125713. private _notifyObservers;
  125714. /**
  125715. * Renders the utility layers scene on top of the original scene
  125716. */
  125717. render(): void;
  125718. /**
  125719. * Disposes of the renderer
  125720. */
  125721. dispose(): void;
  125722. private _updateCamera;
  125723. }
  125724. }
  125725. declare module BABYLON {
  125726. /**
  125727. * Options interface for the pointer selection module
  125728. */
  125729. export interface IWebXRControllerPointerSelectionOptions {
  125730. /**
  125731. * if provided, this scene will be used to render meshes.
  125732. */
  125733. customUtilityLayerScene?: Scene;
  125734. /**
  125735. * Disable the pointer up event when the xr controller in screen and gaze mode is disposed (meaning - when the user removed the finger from the screen)
  125736. * If not disabled, the last picked point will be used to execute a pointer up event
  125737. * If disabled, pointer up event will be triggered right after the pointer down event.
  125738. * Used in screen and gaze target ray mode only
  125739. */
  125740. disablePointerUpOnTouchOut: boolean;
  125741. /**
  125742. * For gaze mode (time to select instead of press)
  125743. */
  125744. forceGazeMode: boolean;
  125745. /**
  125746. * Factor to be applied to the pointer-moved function in the gaze mode. How sensitive should the gaze mode be when checking if the pointer moved
  125747. * to start a new countdown to the pointer down event.
  125748. * Defaults to 1.
  125749. */
  125750. gazeModePointerMovedFactor?: number;
  125751. /**
  125752. * Different button type to use instead of the main component
  125753. */
  125754. overrideButtonId?: string;
  125755. /**
  125756. * use this rendering group id for the meshes (optional)
  125757. */
  125758. renderingGroupId?: number;
  125759. /**
  125760. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  125761. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  125762. * 3000 means 3 seconds between pointing at something and selecting it
  125763. */
  125764. timeToSelect?: number;
  125765. /**
  125766. * Should meshes created here be added to a utility layer or the main scene
  125767. */
  125768. useUtilityLayer?: boolean;
  125769. /**
  125770. * the xr input to use with this pointer selection
  125771. */
  125772. xrInput: WebXRInput;
  125773. }
  125774. /**
  125775. * A module that will enable pointer selection for motion controllers of XR Input Sources
  125776. */
  125777. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  125778. private readonly _options;
  125779. private static _idCounter;
  125780. private _attachController;
  125781. private _controllers;
  125782. private _scene;
  125783. private _tmpVectorForPickCompare;
  125784. /**
  125785. * The module's name
  125786. */
  125787. static readonly Name: string;
  125788. /**
  125789. * The (Babylon) version of this module.
  125790. * This is an integer representing the implementation version.
  125791. * This number does not correspond to the WebXR specs version
  125792. */
  125793. static readonly Version: number;
  125794. /**
  125795. * Disable lighting on the laser pointer (so it will always be visible)
  125796. */
  125797. disablePointerLighting: boolean;
  125798. /**
  125799. * Disable lighting on the selection mesh (so it will always be visible)
  125800. */
  125801. disableSelectionMeshLighting: boolean;
  125802. /**
  125803. * Should the laser pointer be displayed
  125804. */
  125805. displayLaserPointer: boolean;
  125806. /**
  125807. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  125808. */
  125809. displaySelectionMesh: boolean;
  125810. /**
  125811. * This color will be set to the laser pointer when selection is triggered
  125812. */
  125813. laserPointerPickedColor: Color3;
  125814. /**
  125815. * Default color of the laser pointer
  125816. */
  125817. laserPointerDefaultColor: Color3;
  125818. /**
  125819. * default color of the selection ring
  125820. */
  125821. selectionMeshDefaultColor: Color3;
  125822. /**
  125823. * This color will be applied to the selection ring when selection is triggered
  125824. */
  125825. selectionMeshPickedColor: Color3;
  125826. /**
  125827. * Optional filter to be used for ray selection. This predicate shares behavior with
  125828. * scene.pointerMovePredicate which takes priority if it is also assigned.
  125829. */
  125830. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  125831. /**
  125832. * constructs a new background remover module
  125833. * @param _xrSessionManager the session manager for this module
  125834. * @param _options read-only options to be used in this module
  125835. */
  125836. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  125837. /**
  125838. * attach this feature
  125839. * Will usually be called by the features manager
  125840. *
  125841. * @returns true if successful.
  125842. */
  125843. attach(): boolean;
  125844. /**
  125845. * detach this feature.
  125846. * Will usually be called by the features manager
  125847. *
  125848. * @returns true if successful.
  125849. */
  125850. detach(): boolean;
  125851. /**
  125852. * Will get the mesh under a specific pointer.
  125853. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  125854. * @param controllerId the controllerId to check
  125855. * @returns The mesh under pointer or null if no mesh is under the pointer
  125856. */
  125857. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  125858. /**
  125859. * Get the xr controller that correlates to the pointer id in the pointer event
  125860. *
  125861. * @param id the pointer id to search for
  125862. * @returns the controller that correlates to this id or null if not found
  125863. */
  125864. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  125865. protected _onXRFrame(_xrFrame: XRFrame): void;
  125866. private _attachGazeMode;
  125867. private _attachScreenRayMode;
  125868. private _attachTrackedPointerRayMode;
  125869. private _convertNormalToDirectionOfRay;
  125870. private _detachController;
  125871. private _generateNewMeshPair;
  125872. private _pickingMoved;
  125873. private _updatePointerDistance;
  125874. /** @hidden */
  125875. get lasterPointerDefaultColor(): Color3;
  125876. }
  125877. }
  125878. declare module BABYLON {
  125879. /**
  125880. * Button which can be used to enter a different mode of XR
  125881. */
  125882. export class WebXREnterExitUIButton {
  125883. /** button element */
  125884. element: HTMLElement;
  125885. /** XR initialization options for the button */
  125886. sessionMode: XRSessionMode;
  125887. /** Reference space type */
  125888. referenceSpaceType: XRReferenceSpaceType;
  125889. /**
  125890. * Creates a WebXREnterExitUIButton
  125891. * @param element button element
  125892. * @param sessionMode XR initialization session mode
  125893. * @param referenceSpaceType the type of reference space to be used
  125894. */
  125895. constructor(
  125896. /** button element */
  125897. element: HTMLElement,
  125898. /** XR initialization options for the button */
  125899. sessionMode: XRSessionMode,
  125900. /** Reference space type */
  125901. referenceSpaceType: XRReferenceSpaceType);
  125902. /**
  125903. * Extendable function which can be used to update the button's visuals when the state changes
  125904. * @param activeButton the current active button in the UI
  125905. */
  125906. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  125907. }
  125908. /**
  125909. * Options to create the webXR UI
  125910. */
  125911. export class WebXREnterExitUIOptions {
  125912. /**
  125913. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  125914. */
  125915. customButtons?: Array<WebXREnterExitUIButton>;
  125916. /**
  125917. * A reference space type to use when creating the default button.
  125918. * Default is local-floor
  125919. */
  125920. referenceSpaceType?: XRReferenceSpaceType;
  125921. /**
  125922. * Context to enter xr with
  125923. */
  125924. renderTarget?: Nullable<WebXRRenderTarget>;
  125925. /**
  125926. * A session mode to use when creating the default button.
  125927. * Default is immersive-vr
  125928. */
  125929. sessionMode?: XRSessionMode;
  125930. /**
  125931. * A list of optional features to init the session with
  125932. */
  125933. optionalFeatures?: string[];
  125934. }
  125935. /**
  125936. * UI to allow the user to enter/exit XR mode
  125937. */
  125938. export class WebXREnterExitUI implements IDisposable {
  125939. private scene;
  125940. /** version of the options passed to this UI */
  125941. options: WebXREnterExitUIOptions;
  125942. private _activeButton;
  125943. private _buttons;
  125944. private _overlay;
  125945. /**
  125946. * Fired every time the active button is changed.
  125947. *
  125948. * When xr is entered via a button that launches xr that button will be the callback parameter
  125949. *
  125950. * When exiting xr the callback parameter will be null)
  125951. */
  125952. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  125953. /**
  125954. *
  125955. * @param scene babylon scene object to use
  125956. * @param options (read-only) version of the options passed to this UI
  125957. */
  125958. private constructor();
  125959. /**
  125960. * Creates UI to allow the user to enter/exit XR mode
  125961. * @param scene the scene to add the ui to
  125962. * @param helper the xr experience helper to enter/exit xr with
  125963. * @param options options to configure the UI
  125964. * @returns the created ui
  125965. */
  125966. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  125967. /**
  125968. * Disposes of the XR UI component
  125969. */
  125970. dispose(): void;
  125971. private _updateButtons;
  125972. }
  125973. }
  125974. declare module BABYLON {
  125975. /**
  125976. * Class containing static functions to help procedurally build meshes
  125977. */
  125978. export class LinesBuilder {
  125979. /**
  125980. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  125981. * * 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
  125982. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  125983. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  125984. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  125985. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  125986. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  125987. * * 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
  125988. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  125989. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125990. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  125991. * @param name defines the name of the new line system
  125992. * @param options defines the options used to create the line system
  125993. * @param scene defines the hosting scene
  125994. * @returns a new line system mesh
  125995. */
  125996. static CreateLineSystem(name: string, options: {
  125997. lines: Vector3[][];
  125998. updatable?: boolean;
  125999. instance?: Nullable<LinesMesh>;
  126000. colors?: Nullable<Color4[][]>;
  126001. useVertexAlpha?: boolean;
  126002. }, scene: Nullable<Scene>): LinesMesh;
  126003. /**
  126004. * Creates a line mesh
  126005. * 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
  126006. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  126007. * * The parameter `points` is an array successive Vector3
  126008. * * 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
  126009. * * The optional parameter `colors` is an array of successive Color4, one per line point
  126010. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  126011. * * When updating an instance, remember that only point positions can change, not the number of points
  126012. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126013. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  126014. * @param name defines the name of the new line system
  126015. * @param options defines the options used to create the line system
  126016. * @param scene defines the hosting scene
  126017. * @returns a new line mesh
  126018. */
  126019. static CreateLines(name: string, options: {
  126020. points: Vector3[];
  126021. updatable?: boolean;
  126022. instance?: Nullable<LinesMesh>;
  126023. colors?: Color4[];
  126024. useVertexAlpha?: boolean;
  126025. }, scene?: Nullable<Scene>): LinesMesh;
  126026. /**
  126027. * Creates a dashed line mesh
  126028. * * 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
  126029. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  126030. * * The parameter `points` is an array successive Vector3
  126031. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  126032. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  126033. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  126034. * * 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
  126035. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  126036. * * When updating an instance, remember that only point positions can change, not the number of points
  126037. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126038. * @param name defines the name of the mesh
  126039. * @param options defines the options used to create the mesh
  126040. * @param scene defines the hosting scene
  126041. * @returns the dashed line mesh
  126042. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  126043. */
  126044. static CreateDashedLines(name: string, options: {
  126045. points: Vector3[];
  126046. dashSize?: number;
  126047. gapSize?: number;
  126048. dashNb?: number;
  126049. updatable?: boolean;
  126050. instance?: LinesMesh;
  126051. useVertexAlpha?: boolean;
  126052. }, scene?: Nullable<Scene>): LinesMesh;
  126053. }
  126054. }
  126055. declare module BABYLON {
  126056. /**
  126057. * Construction options for a timer
  126058. */
  126059. export interface ITimerOptions<T> {
  126060. /**
  126061. * Time-to-end
  126062. */
  126063. timeout: number;
  126064. /**
  126065. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  126066. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  126067. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  126068. */
  126069. contextObservable: Observable<T>;
  126070. /**
  126071. * Optional parameters when adding an observer to the observable
  126072. */
  126073. observableParameters?: {
  126074. mask?: number;
  126075. insertFirst?: boolean;
  126076. scope?: any;
  126077. };
  126078. /**
  126079. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  126080. */
  126081. breakCondition?: (data?: ITimerData<T>) => boolean;
  126082. /**
  126083. * Will be triggered when the time condition has met
  126084. */
  126085. onEnded?: (data: ITimerData<any>) => void;
  126086. /**
  126087. * Will be triggered when the break condition has met (prematurely ended)
  126088. */
  126089. onAborted?: (data: ITimerData<any>) => void;
  126090. /**
  126091. * Optional function to execute on each tick (or count)
  126092. */
  126093. onTick?: (data: ITimerData<any>) => void;
  126094. }
  126095. /**
  126096. * An interface defining the data sent by the timer
  126097. */
  126098. export interface ITimerData<T> {
  126099. /**
  126100. * When did it start
  126101. */
  126102. startTime: number;
  126103. /**
  126104. * Time now
  126105. */
  126106. currentTime: number;
  126107. /**
  126108. * Time passed since started
  126109. */
  126110. deltaTime: number;
  126111. /**
  126112. * How much is completed, in [0.0...1.0].
  126113. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  126114. */
  126115. completeRate: number;
  126116. /**
  126117. * What the registered observable sent in the last count
  126118. */
  126119. payload: T;
  126120. }
  126121. /**
  126122. * The current state of the timer
  126123. */
  126124. export enum TimerState {
  126125. /**
  126126. * Timer initialized, not yet started
  126127. */
  126128. INIT = 0,
  126129. /**
  126130. * Timer started and counting
  126131. */
  126132. STARTED = 1,
  126133. /**
  126134. * Timer ended (whether aborted or time reached)
  126135. */
  126136. ENDED = 2
  126137. }
  126138. /**
  126139. * A simple version of the timer. Will take options and start the timer immediately after calling it
  126140. *
  126141. * @param options options with which to initialize this timer
  126142. */
  126143. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  126144. /**
  126145. * An advanced implementation of a timer class
  126146. */
  126147. export class AdvancedTimer<T = any> implements IDisposable {
  126148. /**
  126149. * Will notify each time the timer calculates the remaining time
  126150. */
  126151. onEachCountObservable: Observable<ITimerData<T>>;
  126152. /**
  126153. * Will trigger when the timer was aborted due to the break condition
  126154. */
  126155. onTimerAbortedObservable: Observable<ITimerData<T>>;
  126156. /**
  126157. * Will trigger when the timer ended successfully
  126158. */
  126159. onTimerEndedObservable: Observable<ITimerData<T>>;
  126160. /**
  126161. * Will trigger when the timer state has changed
  126162. */
  126163. onStateChangedObservable: Observable<TimerState>;
  126164. private _observer;
  126165. private _contextObservable;
  126166. private _observableParameters;
  126167. private _startTime;
  126168. private _timer;
  126169. private _state;
  126170. private _breakCondition;
  126171. private _timeToEnd;
  126172. private _breakOnNextTick;
  126173. /**
  126174. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  126175. * @param options construction options for this advanced timer
  126176. */
  126177. constructor(options: ITimerOptions<T>);
  126178. /**
  126179. * set a breaking condition for this timer. Default is to never break during count
  126180. * @param predicate the new break condition. Returns true to break, false otherwise
  126181. */
  126182. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  126183. /**
  126184. * Reset ALL associated observables in this advanced timer
  126185. */
  126186. clearObservables(): void;
  126187. /**
  126188. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  126189. *
  126190. * @param timeToEnd how much time to measure until timer ended
  126191. */
  126192. start(timeToEnd?: number): void;
  126193. /**
  126194. * Will force a stop on the next tick.
  126195. */
  126196. stop(): void;
  126197. /**
  126198. * Dispose this timer, clearing all resources
  126199. */
  126200. dispose(): void;
  126201. private _setState;
  126202. private _tick;
  126203. private _stop;
  126204. }
  126205. }
  126206. declare module BABYLON {
  126207. /**
  126208. * The options container for the teleportation module
  126209. */
  126210. export interface IWebXRTeleportationOptions {
  126211. /**
  126212. * if provided, this scene will be used to render meshes.
  126213. */
  126214. customUtilityLayerScene?: Scene;
  126215. /**
  126216. * Values to configure the default target mesh
  126217. */
  126218. defaultTargetMeshOptions?: {
  126219. /**
  126220. * Fill color of the teleportation area
  126221. */
  126222. teleportationFillColor?: string;
  126223. /**
  126224. * Border color for the teleportation area
  126225. */
  126226. teleportationBorderColor?: string;
  126227. /**
  126228. * Disable the mesh's animation sequence
  126229. */
  126230. disableAnimation?: boolean;
  126231. /**
  126232. * Disable lighting on the material or the ring and arrow
  126233. */
  126234. disableLighting?: boolean;
  126235. /**
  126236. * Override the default material of the torus and arrow
  126237. */
  126238. torusArrowMaterial?: Material;
  126239. };
  126240. /**
  126241. * A list of meshes to use as floor meshes.
  126242. * Meshes can be added and removed after initializing the feature using the
  126243. * addFloorMesh and removeFloorMesh functions
  126244. * If empty, rotation will still work
  126245. */
  126246. floorMeshes?: AbstractMesh[];
  126247. /**
  126248. * use this rendering group id for the meshes (optional)
  126249. */
  126250. renderingGroupId?: number;
  126251. /**
  126252. * Should teleportation move only to snap points
  126253. */
  126254. snapPointsOnly?: boolean;
  126255. /**
  126256. * An array of points to which the teleportation will snap to.
  126257. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  126258. */
  126259. snapPositions?: Vector3[];
  126260. /**
  126261. * How close should the teleportation ray be in order to snap to position.
  126262. * Default to 0.8 units (meters)
  126263. */
  126264. snapToPositionRadius?: number;
  126265. /**
  126266. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  126267. * If you want to support rotation, make sure your mesh has a direction indicator.
  126268. *
  126269. * When left untouched, the default mesh will be initialized.
  126270. */
  126271. teleportationTargetMesh?: AbstractMesh;
  126272. /**
  126273. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  126274. */
  126275. timeToTeleport?: number;
  126276. /**
  126277. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  126278. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  126279. */
  126280. useMainComponentOnly?: boolean;
  126281. /**
  126282. * Should meshes created here be added to a utility layer or the main scene
  126283. */
  126284. useUtilityLayer?: boolean;
  126285. /**
  126286. * Babylon XR Input class for controller
  126287. */
  126288. xrInput: WebXRInput;
  126289. }
  126290. /**
  126291. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  126292. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  126293. * the input of the attached controllers.
  126294. */
  126295. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  126296. private _options;
  126297. private _controllers;
  126298. private _currentTeleportationControllerId;
  126299. private _floorMeshes;
  126300. private _quadraticBezierCurve;
  126301. private _selectionFeature;
  126302. private _snapToPositions;
  126303. private _snappedToPoint;
  126304. private _teleportationRingMaterial?;
  126305. private _tmpRay;
  126306. private _tmpVector;
  126307. /**
  126308. * The module's name
  126309. */
  126310. static readonly Name: string;
  126311. /**
  126312. * The (Babylon) version of this module.
  126313. * This is an integer representing the implementation version.
  126314. * This number does not correspond to the webxr specs version
  126315. */
  126316. static readonly Version: number;
  126317. /**
  126318. * Is movement backwards enabled
  126319. */
  126320. backwardsMovementEnabled: boolean;
  126321. /**
  126322. * Distance to travel when moving backwards
  126323. */
  126324. backwardsTeleportationDistance: number;
  126325. /**
  126326. * The distance from the user to the inspection point in the direction of the controller
  126327. * A higher number will allow the user to move further
  126328. * defaults to 5 (meters, in xr units)
  126329. */
  126330. parabolicCheckRadius: number;
  126331. /**
  126332. * Should the module support parabolic ray on top of direct ray
  126333. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  126334. * Very helpful when moving between floors / different heights
  126335. */
  126336. parabolicRayEnabled: boolean;
  126337. /**
  126338. * How much rotation should be applied when rotating right and left
  126339. */
  126340. rotationAngle: number;
  126341. /**
  126342. * Is rotation enabled when moving forward?
  126343. * Disabling this feature will prevent the user from deciding the direction when teleporting
  126344. */
  126345. rotationEnabled: boolean;
  126346. /**
  126347. * constructs a new anchor system
  126348. * @param _xrSessionManager an instance of WebXRSessionManager
  126349. * @param _options configuration object for this feature
  126350. */
  126351. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  126352. /**
  126353. * Get the snapPointsOnly flag
  126354. */
  126355. get snapPointsOnly(): boolean;
  126356. /**
  126357. * Sets the snapPointsOnly flag
  126358. * @param snapToPoints should teleportation be exclusively to snap points
  126359. */
  126360. set snapPointsOnly(snapToPoints: boolean);
  126361. /**
  126362. * Add a new mesh to the floor meshes array
  126363. * @param mesh the mesh to use as floor mesh
  126364. */
  126365. addFloorMesh(mesh: AbstractMesh): void;
  126366. /**
  126367. * Add a new snap-to point to fix teleportation to this position
  126368. * @param newSnapPoint The new Snap-To point
  126369. */
  126370. addSnapPoint(newSnapPoint: Vector3): void;
  126371. attach(): boolean;
  126372. detach(): boolean;
  126373. dispose(): void;
  126374. /**
  126375. * Remove a mesh from the floor meshes array
  126376. * @param mesh the mesh to remove
  126377. */
  126378. removeFloorMesh(mesh: AbstractMesh): void;
  126379. /**
  126380. * Remove a mesh from the floor meshes array using its name
  126381. * @param name the mesh name to remove
  126382. */
  126383. removeFloorMeshByName(name: string): void;
  126384. /**
  126385. * This function will iterate through the array, searching for this point or equal to it. It will then remove it from the snap-to array
  126386. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  126387. * @returns was the point found and removed or not
  126388. */
  126389. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  126390. /**
  126391. * This function sets a selection feature that will be disabled when
  126392. * the forward ray is shown and will be reattached when hidden.
  126393. * This is used to remove the selection rays when moving.
  126394. * @param selectionFeature the feature to disable when forward movement is enabled
  126395. */
  126396. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  126397. protected _onXRFrame(_xrFrame: XRFrame): void;
  126398. private _attachController;
  126399. private _createDefaultTargetMesh;
  126400. private _detachController;
  126401. private _findClosestSnapPointWithRadius;
  126402. private _setTargetMeshPosition;
  126403. private _setTargetMeshVisibility;
  126404. private _showParabolicPath;
  126405. private _teleportForward;
  126406. }
  126407. }
  126408. declare module BABYLON {
  126409. /**
  126410. * Options for the default xr helper
  126411. */
  126412. export class WebXRDefaultExperienceOptions {
  126413. /**
  126414. * Enable or disable default UI to enter XR
  126415. */
  126416. disableDefaultUI?: boolean;
  126417. /**
  126418. * Should teleportation not initialize. defaults to false.
  126419. */
  126420. disableTeleportation?: boolean;
  126421. /**
  126422. * Floor meshes that will be used for teleport
  126423. */
  126424. floorMeshes?: Array<AbstractMesh>;
  126425. /**
  126426. * If set to true, the first frame will not be used to reset position
  126427. * The first frame is mainly used when copying transformation from the old camera
  126428. * Mainly used in AR
  126429. */
  126430. ignoreNativeCameraTransformation?: boolean;
  126431. /**
  126432. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  126433. */
  126434. inputOptions?: IWebXRInputOptions;
  126435. /**
  126436. * optional configuration for the output canvas
  126437. */
  126438. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  126439. /**
  126440. * optional UI options. This can be used among other to change session mode and reference space type
  126441. */
  126442. uiOptions?: WebXREnterExitUIOptions;
  126443. /**
  126444. * When loading teleportation and pointer select, use stable versions instead of latest.
  126445. */
  126446. useStablePlugins?: boolean;
  126447. /**
  126448. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  126449. */
  126450. renderingGroupId?: number;
  126451. /**
  126452. * A list of optional features to init the session with
  126453. * If set to true, all features we support will be added
  126454. */
  126455. optionalFeatures?: boolean | string[];
  126456. }
  126457. /**
  126458. * Default experience which provides a similar setup to the previous webVRExperience
  126459. */
  126460. export class WebXRDefaultExperience {
  126461. /**
  126462. * Base experience
  126463. */
  126464. baseExperience: WebXRExperienceHelper;
  126465. /**
  126466. * Enables ui for entering/exiting xr
  126467. */
  126468. enterExitUI: WebXREnterExitUI;
  126469. /**
  126470. * Input experience extension
  126471. */
  126472. input: WebXRInput;
  126473. /**
  126474. * Enables laser pointer and selection
  126475. */
  126476. pointerSelection: WebXRControllerPointerSelection;
  126477. /**
  126478. * Default target xr should render to
  126479. */
  126480. renderTarget: WebXRRenderTarget;
  126481. /**
  126482. * Enables teleportation
  126483. */
  126484. teleportation: WebXRMotionControllerTeleportation;
  126485. private constructor();
  126486. /**
  126487. * Creates the default xr experience
  126488. * @param scene scene
  126489. * @param options options for basic configuration
  126490. * @returns resulting WebXRDefaultExperience
  126491. */
  126492. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  126493. /**
  126494. * DIsposes of the experience helper
  126495. */
  126496. dispose(): void;
  126497. }
  126498. }
  126499. declare module BABYLON {
  126500. /**
  126501. * Options to modify the vr teleportation behavior.
  126502. */
  126503. export interface VRTeleportationOptions {
  126504. /**
  126505. * The name of the mesh which should be used as the teleportation floor. (default: null)
  126506. */
  126507. floorMeshName?: string;
  126508. /**
  126509. * A list of meshes to be used as the teleportation floor. (default: empty)
  126510. */
  126511. floorMeshes?: Mesh[];
  126512. /**
  126513. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  126514. */
  126515. teleportationMode?: number;
  126516. /**
  126517. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  126518. */
  126519. teleportationTime?: number;
  126520. /**
  126521. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  126522. */
  126523. teleportationSpeed?: number;
  126524. /**
  126525. * The easing function used in the animation or null for Linear. (default CircleEase)
  126526. */
  126527. easingFunction?: EasingFunction;
  126528. }
  126529. /**
  126530. * Options to modify the vr experience helper's behavior.
  126531. */
  126532. export interface VRExperienceHelperOptions extends WebVROptions {
  126533. /**
  126534. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  126535. */
  126536. createDeviceOrientationCamera?: boolean;
  126537. /**
  126538. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  126539. */
  126540. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  126541. /**
  126542. * Uses the main button on the controller to toggle the laser casted. (default: true)
  126543. */
  126544. laserToggle?: boolean;
  126545. /**
  126546. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  126547. */
  126548. floorMeshes?: Mesh[];
  126549. /**
  126550. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  126551. */
  126552. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  126553. /**
  126554. * Defines if WebXR should be used instead of WebVR (if available)
  126555. */
  126556. useXR?: boolean;
  126557. }
  126558. /**
  126559. * Event containing information after VR has been entered
  126560. */
  126561. export class OnAfterEnteringVRObservableEvent {
  126562. /**
  126563. * If entering vr was successful
  126564. */
  126565. success: boolean;
  126566. }
  126567. /**
  126568. * Helps to quickly add VR support to an existing scene.
  126569. * See http://doc.babylonjs.com/how_to/webvr_helper
  126570. */
  126571. export class VRExperienceHelper {
  126572. /** Options to modify the vr experience helper's behavior. */
  126573. webVROptions: VRExperienceHelperOptions;
  126574. private _scene;
  126575. private _position;
  126576. private _btnVR;
  126577. private _btnVRDisplayed;
  126578. private _webVRsupported;
  126579. private _webVRready;
  126580. private _webVRrequesting;
  126581. private _webVRpresenting;
  126582. private _hasEnteredVR;
  126583. private _fullscreenVRpresenting;
  126584. private _inputElement;
  126585. private _webVRCamera;
  126586. private _vrDeviceOrientationCamera;
  126587. private _deviceOrientationCamera;
  126588. private _existingCamera;
  126589. private _onKeyDown;
  126590. private _onVrDisplayPresentChange;
  126591. private _onVRDisplayChanged;
  126592. private _onVRRequestPresentStart;
  126593. private _onVRRequestPresentComplete;
  126594. /**
  126595. * 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)
  126596. */
  126597. enableGazeEvenWhenNoPointerLock: boolean;
  126598. /**
  126599. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  126600. */
  126601. exitVROnDoubleTap: boolean;
  126602. /**
  126603. * Observable raised right before entering VR.
  126604. */
  126605. onEnteringVRObservable: Observable<VRExperienceHelper>;
  126606. /**
  126607. * Observable raised when entering VR has completed.
  126608. */
  126609. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  126610. /**
  126611. * Observable raised when exiting VR.
  126612. */
  126613. onExitingVRObservable: Observable<VRExperienceHelper>;
  126614. /**
  126615. * Observable raised when controller mesh is loaded.
  126616. */
  126617. onControllerMeshLoadedObservable: Observable<WebVRController>;
  126618. /** Return this.onEnteringVRObservable
  126619. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  126620. */
  126621. get onEnteringVR(): Observable<VRExperienceHelper>;
  126622. /** Return this.onExitingVRObservable
  126623. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  126624. */
  126625. get onExitingVR(): Observable<VRExperienceHelper>;
  126626. /** Return this.onControllerMeshLoadedObservable
  126627. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  126628. */
  126629. get onControllerMeshLoaded(): Observable<WebVRController>;
  126630. private _rayLength;
  126631. private _useCustomVRButton;
  126632. private _teleportationRequested;
  126633. private _teleportActive;
  126634. private _floorMeshName;
  126635. private _floorMeshesCollection;
  126636. private _teleportationMode;
  126637. private _teleportationTime;
  126638. private _teleportationSpeed;
  126639. private _teleportationEasing;
  126640. private _rotationAllowed;
  126641. private _teleportBackwardsVector;
  126642. private _teleportationTarget;
  126643. private _isDefaultTeleportationTarget;
  126644. private _postProcessMove;
  126645. private _teleportationFillColor;
  126646. private _teleportationBorderColor;
  126647. private _rotationAngle;
  126648. private _haloCenter;
  126649. private _cameraGazer;
  126650. private _padSensibilityUp;
  126651. private _padSensibilityDown;
  126652. private _leftController;
  126653. private _rightController;
  126654. private _gazeColor;
  126655. private _laserColor;
  126656. private _pickedLaserColor;
  126657. private _pickedGazeColor;
  126658. /**
  126659. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  126660. */
  126661. onNewMeshSelected: Observable<AbstractMesh>;
  126662. /**
  126663. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  126664. * This observable will provide the mesh and the controller used to select the mesh
  126665. */
  126666. onMeshSelectedWithController: Observable<{
  126667. mesh: AbstractMesh;
  126668. controller: WebVRController;
  126669. }>;
  126670. /**
  126671. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  126672. */
  126673. onNewMeshPicked: Observable<PickingInfo>;
  126674. private _circleEase;
  126675. /**
  126676. * Observable raised before camera teleportation
  126677. */
  126678. onBeforeCameraTeleport: Observable<Vector3>;
  126679. /**
  126680. * Observable raised after camera teleportation
  126681. */
  126682. onAfterCameraTeleport: Observable<Vector3>;
  126683. /**
  126684. * Observable raised when current selected mesh gets unselected
  126685. */
  126686. onSelectedMeshUnselected: Observable<AbstractMesh>;
  126687. private _raySelectionPredicate;
  126688. /**
  126689. * To be optionaly changed by user to define custom ray selection
  126690. */
  126691. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  126692. /**
  126693. * To be optionaly changed by user to define custom selection logic (after ray selection)
  126694. */
  126695. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  126696. /**
  126697. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  126698. */
  126699. teleportationEnabled: boolean;
  126700. private _defaultHeight;
  126701. private _teleportationInitialized;
  126702. private _interactionsEnabled;
  126703. private _interactionsRequested;
  126704. private _displayGaze;
  126705. private _displayLaserPointer;
  126706. /**
  126707. * The mesh used to display where the user is going to teleport.
  126708. */
  126709. get teleportationTarget(): Mesh;
  126710. /**
  126711. * Sets the mesh to be used to display where the user is going to teleport.
  126712. */
  126713. set teleportationTarget(value: Mesh);
  126714. /**
  126715. * 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
  126716. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  126717. * See http://doc.babylonjs.com/resources/baking_transformations
  126718. */
  126719. get gazeTrackerMesh(): Mesh;
  126720. set gazeTrackerMesh(value: Mesh);
  126721. /**
  126722. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  126723. */
  126724. updateGazeTrackerScale: boolean;
  126725. /**
  126726. * If the gaze trackers color should be updated when selecting meshes
  126727. */
  126728. updateGazeTrackerColor: boolean;
  126729. /**
  126730. * If the controller laser color should be updated when selecting meshes
  126731. */
  126732. updateControllerLaserColor: boolean;
  126733. /**
  126734. * The gaze tracking mesh corresponding to the left controller
  126735. */
  126736. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  126737. /**
  126738. * The gaze tracking mesh corresponding to the right controller
  126739. */
  126740. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  126741. /**
  126742. * If the ray of the gaze should be displayed.
  126743. */
  126744. get displayGaze(): boolean;
  126745. /**
  126746. * Sets if the ray of the gaze should be displayed.
  126747. */
  126748. set displayGaze(value: boolean);
  126749. /**
  126750. * If the ray of the LaserPointer should be displayed.
  126751. */
  126752. get displayLaserPointer(): boolean;
  126753. /**
  126754. * Sets if the ray of the LaserPointer should be displayed.
  126755. */
  126756. set displayLaserPointer(value: boolean);
  126757. /**
  126758. * The deviceOrientationCamera used as the camera when not in VR.
  126759. */
  126760. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  126761. /**
  126762. * Based on the current WebVR support, returns the current VR camera used.
  126763. */
  126764. get currentVRCamera(): Nullable<Camera>;
  126765. /**
  126766. * The webVRCamera which is used when in VR.
  126767. */
  126768. get webVRCamera(): WebVRFreeCamera;
  126769. /**
  126770. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  126771. */
  126772. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  126773. /**
  126774. * The html button that is used to trigger entering into VR.
  126775. */
  126776. get vrButton(): Nullable<HTMLButtonElement>;
  126777. private get _teleportationRequestInitiated();
  126778. /**
  126779. * Defines whether or not Pointer lock should be requested when switching to
  126780. * full screen.
  126781. */
  126782. requestPointerLockOnFullScreen: boolean;
  126783. /**
  126784. * If asking to force XR, this will be populated with the default xr experience
  126785. */
  126786. xr: WebXRDefaultExperience;
  126787. /**
  126788. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  126789. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  126790. */
  126791. xrTestDone: boolean;
  126792. /**
  126793. * Instantiates a VRExperienceHelper.
  126794. * Helps to quickly add VR support to an existing scene.
  126795. * @param scene The scene the VRExperienceHelper belongs to.
  126796. * @param webVROptions Options to modify the vr experience helper's behavior.
  126797. */
  126798. constructor(scene: Scene,
  126799. /** Options to modify the vr experience helper's behavior. */
  126800. webVROptions?: VRExperienceHelperOptions);
  126801. private completeVRInit;
  126802. private _onDefaultMeshLoaded;
  126803. private _onResize;
  126804. private _onFullscreenChange;
  126805. /**
  126806. * Gets a value indicating if we are currently in VR mode.
  126807. */
  126808. get isInVRMode(): boolean;
  126809. private onVrDisplayPresentChange;
  126810. private onVRDisplayChanged;
  126811. private moveButtonToBottomRight;
  126812. private displayVRButton;
  126813. private updateButtonVisibility;
  126814. private _cachedAngularSensibility;
  126815. /**
  126816. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  126817. * Otherwise, will use the fullscreen API.
  126818. */
  126819. enterVR(): void;
  126820. /**
  126821. * Attempt to exit VR, or fullscreen.
  126822. */
  126823. exitVR(): void;
  126824. /**
  126825. * The position of the vr experience helper.
  126826. */
  126827. get position(): Vector3;
  126828. /**
  126829. * Sets the position of the vr experience helper.
  126830. */
  126831. set position(value: Vector3);
  126832. /**
  126833. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  126834. */
  126835. enableInteractions(): void;
  126836. private get _noControllerIsActive();
  126837. private beforeRender;
  126838. private _isTeleportationFloor;
  126839. /**
  126840. * Adds a floor mesh to be used for teleportation.
  126841. * @param floorMesh the mesh to be used for teleportation.
  126842. */
  126843. addFloorMesh(floorMesh: Mesh): void;
  126844. /**
  126845. * Removes a floor mesh from being used for teleportation.
  126846. * @param floorMesh the mesh to be removed.
  126847. */
  126848. removeFloorMesh(floorMesh: Mesh): void;
  126849. /**
  126850. * Enables interactions and teleportation using the VR controllers and gaze.
  126851. * @param vrTeleportationOptions options to modify teleportation behavior.
  126852. */
  126853. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  126854. private _onNewGamepadConnected;
  126855. private _tryEnableInteractionOnController;
  126856. private _onNewGamepadDisconnected;
  126857. private _enableInteractionOnController;
  126858. private _checkTeleportWithRay;
  126859. private _checkRotate;
  126860. private _checkTeleportBackwards;
  126861. private _enableTeleportationOnController;
  126862. private _createTeleportationCircles;
  126863. private _displayTeleportationTarget;
  126864. private _hideTeleportationTarget;
  126865. private _rotateCamera;
  126866. private _moveTeleportationSelectorTo;
  126867. private _workingVector;
  126868. private _workingQuaternion;
  126869. private _workingMatrix;
  126870. /**
  126871. * Time Constant Teleportation Mode
  126872. */
  126873. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  126874. /**
  126875. * Speed Constant Teleportation Mode
  126876. */
  126877. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  126878. /**
  126879. * Teleports the users feet to the desired location
  126880. * @param location The location where the user's feet should be placed
  126881. */
  126882. teleportCamera(location: Vector3): void;
  126883. private _convertNormalToDirectionOfRay;
  126884. private _castRayAndSelectObject;
  126885. private _notifySelectedMeshUnselected;
  126886. /**
  126887. * Permanently set new colors for the laser pointer
  126888. * @param color the new laser color
  126889. * @param pickedColor the new laser color when picked mesh detected
  126890. */
  126891. setLaserColor(color: Color3, pickedColor?: Color3): void;
  126892. /**
  126893. * Set lighting enabled / disabled on the laser pointer of both controllers
  126894. * @param enabled should the lighting be enabled on the laser pointer
  126895. */
  126896. setLaserLightingState(enabled?: boolean): void;
  126897. /**
  126898. * Permanently set new colors for the gaze pointer
  126899. * @param color the new gaze color
  126900. * @param pickedColor the new gaze color when picked mesh detected
  126901. */
  126902. setGazeColor(color: Color3, pickedColor?: Color3): void;
  126903. /**
  126904. * Sets the color of the laser ray from the vr controllers.
  126905. * @param color new color for the ray.
  126906. */
  126907. changeLaserColor(color: Color3): void;
  126908. /**
  126909. * Sets the color of the ray from the vr headsets gaze.
  126910. * @param color new color for the ray.
  126911. */
  126912. changeGazeColor(color: Color3): void;
  126913. /**
  126914. * Exits VR and disposes of the vr experience helper
  126915. */
  126916. dispose(): void;
  126917. /**
  126918. * Gets the name of the VRExperienceHelper class
  126919. * @returns "VRExperienceHelper"
  126920. */
  126921. getClassName(): string;
  126922. }
  126923. }
  126924. declare module BABYLON {
  126925. /**
  126926. * Contains an array of blocks representing the octree
  126927. */
  126928. export interface IOctreeContainer<T> {
  126929. /**
  126930. * Blocks within the octree
  126931. */
  126932. blocks: Array<OctreeBlock<T>>;
  126933. }
  126934. /**
  126935. * Class used to store a cell in an octree
  126936. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  126937. */
  126938. export class OctreeBlock<T> {
  126939. /**
  126940. * Gets the content of the current block
  126941. */
  126942. entries: T[];
  126943. /**
  126944. * Gets the list of block children
  126945. */
  126946. blocks: Array<OctreeBlock<T>>;
  126947. private _depth;
  126948. private _maxDepth;
  126949. private _capacity;
  126950. private _minPoint;
  126951. private _maxPoint;
  126952. private _boundingVectors;
  126953. private _creationFunc;
  126954. /**
  126955. * Creates a new block
  126956. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  126957. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  126958. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  126959. * @param depth defines the current depth of this block in the octree
  126960. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  126961. * @param creationFunc defines a callback to call when an element is added to the block
  126962. */
  126963. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  126964. /**
  126965. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  126966. */
  126967. get capacity(): number;
  126968. /**
  126969. * Gets the minimum vector (in world space) of the block's bounding box
  126970. */
  126971. get minPoint(): Vector3;
  126972. /**
  126973. * Gets the maximum vector (in world space) of the block's bounding box
  126974. */
  126975. get maxPoint(): Vector3;
  126976. /**
  126977. * Add a new element to this block
  126978. * @param entry defines the element to add
  126979. */
  126980. addEntry(entry: T): void;
  126981. /**
  126982. * Remove an element from this block
  126983. * @param entry defines the element to remove
  126984. */
  126985. removeEntry(entry: T): void;
  126986. /**
  126987. * Add an array of elements to this block
  126988. * @param entries defines the array of elements to add
  126989. */
  126990. addEntries(entries: T[]): void;
  126991. /**
  126992. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  126993. * @param frustumPlanes defines the frustum planes to test
  126994. * @param selection defines the array to store current content if selection is positive
  126995. * @param allowDuplicate defines if the selection array can contains duplicated entries
  126996. */
  126997. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  126998. /**
  126999. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  127000. * @param sphereCenter defines the bounding sphere center
  127001. * @param sphereRadius defines the bounding sphere radius
  127002. * @param selection defines the array to store current content if selection is positive
  127003. * @param allowDuplicate defines if the selection array can contains duplicated entries
  127004. */
  127005. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  127006. /**
  127007. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  127008. * @param ray defines the ray to test with
  127009. * @param selection defines the array to store current content if selection is positive
  127010. */
  127011. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  127012. /**
  127013. * Subdivide the content into child blocks (this block will then be empty)
  127014. */
  127015. createInnerBlocks(): void;
  127016. /**
  127017. * @hidden
  127018. */
  127019. 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;
  127020. }
  127021. }
  127022. declare module BABYLON {
  127023. /**
  127024. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  127025. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  127026. */
  127027. export class Octree<T> {
  127028. /** 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.) */
  127029. maxDepth: number;
  127030. /**
  127031. * Blocks within the octree containing objects
  127032. */
  127033. blocks: Array<OctreeBlock<T>>;
  127034. /**
  127035. * Content stored in the octree
  127036. */
  127037. dynamicContent: T[];
  127038. private _maxBlockCapacity;
  127039. private _selectionContent;
  127040. private _creationFunc;
  127041. /**
  127042. * Creates a octree
  127043. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  127044. * @param creationFunc function to be used to instatiate the octree
  127045. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  127046. * @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.)
  127047. */
  127048. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  127049. /** 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.) */
  127050. maxDepth?: number);
  127051. /**
  127052. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  127053. * @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);
  127054. * @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);
  127055. * @param entries meshes to be added to the octree blocks
  127056. */
  127057. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  127058. /**
  127059. * Adds a mesh to the octree
  127060. * @param entry Mesh to add to the octree
  127061. */
  127062. addMesh(entry: T): void;
  127063. /**
  127064. * Remove an element from the octree
  127065. * @param entry defines the element to remove
  127066. */
  127067. removeMesh(entry: T): void;
  127068. /**
  127069. * Selects an array of meshes within the frustum
  127070. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  127071. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  127072. * @returns array of meshes within the frustum
  127073. */
  127074. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  127075. /**
  127076. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  127077. * @param sphereCenter defines the bounding sphere center
  127078. * @param sphereRadius defines the bounding sphere radius
  127079. * @param allowDuplicate defines if the selection array can contains duplicated entries
  127080. * @returns an array of objects that intersect the sphere
  127081. */
  127082. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  127083. /**
  127084. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  127085. * @param ray defines the ray to test with
  127086. * @returns array of intersected objects
  127087. */
  127088. intersectsRay(ray: Ray): SmartArray<T>;
  127089. /**
  127090. * Adds a mesh into the octree block if it intersects the block
  127091. */
  127092. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  127093. /**
  127094. * Adds a submesh into the octree block if it intersects the block
  127095. */
  127096. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  127097. }
  127098. }
  127099. declare module BABYLON {
  127100. interface Scene {
  127101. /**
  127102. * @hidden
  127103. * Backing Filed
  127104. */
  127105. _selectionOctree: Octree<AbstractMesh>;
  127106. /**
  127107. * Gets the octree used to boost mesh selection (picking)
  127108. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  127109. */
  127110. selectionOctree: Octree<AbstractMesh>;
  127111. /**
  127112. * Creates or updates the octree used to boost selection (picking)
  127113. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  127114. * @param maxCapacity defines the maximum capacity per leaf
  127115. * @param maxDepth defines the maximum depth of the octree
  127116. * @returns an octree of AbstractMesh
  127117. */
  127118. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  127119. }
  127120. interface AbstractMesh {
  127121. /**
  127122. * @hidden
  127123. * Backing Field
  127124. */
  127125. _submeshesOctree: Octree<SubMesh>;
  127126. /**
  127127. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  127128. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  127129. * @param maxCapacity defines the maximum size of each block (64 by default)
  127130. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  127131. * @returns the new octree
  127132. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  127133. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  127134. */
  127135. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  127136. }
  127137. /**
  127138. * Defines the octree scene component responsible to manage any octrees
  127139. * in a given scene.
  127140. */
  127141. export class OctreeSceneComponent {
  127142. /**
  127143. * The component name help to identify the component in the list of scene components.
  127144. */
  127145. readonly name: string;
  127146. /**
  127147. * The scene the component belongs to.
  127148. */
  127149. scene: Scene;
  127150. /**
  127151. * Indicates if the meshes have been checked to make sure they are isEnabled()
  127152. */
  127153. readonly checksIsEnabled: boolean;
  127154. /**
  127155. * Creates a new instance of the component for the given scene
  127156. * @param scene Defines the scene to register the component in
  127157. */
  127158. constructor(scene: Scene);
  127159. /**
  127160. * Registers the component in a given scene
  127161. */
  127162. register(): void;
  127163. /**
  127164. * Return the list of active meshes
  127165. * @returns the list of active meshes
  127166. */
  127167. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  127168. /**
  127169. * Return the list of active sub meshes
  127170. * @param mesh The mesh to get the candidates sub meshes from
  127171. * @returns the list of active sub meshes
  127172. */
  127173. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  127174. private _tempRay;
  127175. /**
  127176. * Return the list of sub meshes intersecting with a given local ray
  127177. * @param mesh defines the mesh to find the submesh for
  127178. * @param localRay defines the ray in local space
  127179. * @returns the list of intersecting sub meshes
  127180. */
  127181. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  127182. /**
  127183. * Return the list of sub meshes colliding with a collider
  127184. * @param mesh defines the mesh to find the submesh for
  127185. * @param collider defines the collider to evaluate the collision against
  127186. * @returns the list of colliding sub meshes
  127187. */
  127188. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  127189. /**
  127190. * Rebuilds the elements related to this component in case of
  127191. * context lost for instance.
  127192. */
  127193. rebuild(): void;
  127194. /**
  127195. * Disposes the component and the associated ressources.
  127196. */
  127197. dispose(): void;
  127198. }
  127199. }
  127200. declare module BABYLON {
  127201. /**
  127202. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  127203. */
  127204. export class Gizmo implements IDisposable {
  127205. /** The utility layer the gizmo will be added to */
  127206. gizmoLayer: UtilityLayerRenderer;
  127207. /**
  127208. * The root mesh of the gizmo
  127209. */
  127210. _rootMesh: Mesh;
  127211. private _attachedMesh;
  127212. /**
  127213. * Ratio for the scale of the gizmo (Default: 1)
  127214. */
  127215. scaleRatio: number;
  127216. /**
  127217. * If a custom mesh has been set (Default: false)
  127218. */
  127219. protected _customMeshSet: boolean;
  127220. /**
  127221. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  127222. * * When set, interactions will be enabled
  127223. */
  127224. get attachedMesh(): Nullable<AbstractMesh>;
  127225. set attachedMesh(value: Nullable<AbstractMesh>);
  127226. /**
  127227. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  127228. * @param mesh The mesh to replace the default mesh of the gizmo
  127229. */
  127230. setCustomMesh(mesh: Mesh): void;
  127231. /**
  127232. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  127233. */
  127234. updateGizmoRotationToMatchAttachedMesh: boolean;
  127235. /**
  127236. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  127237. */
  127238. updateGizmoPositionToMatchAttachedMesh: boolean;
  127239. /**
  127240. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  127241. */
  127242. updateScale: boolean;
  127243. protected _interactionsEnabled: boolean;
  127244. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  127245. private _beforeRenderObserver;
  127246. private _tempVector;
  127247. /**
  127248. * Creates a gizmo
  127249. * @param gizmoLayer The utility layer the gizmo will be added to
  127250. */
  127251. constructor(
  127252. /** The utility layer the gizmo will be added to */
  127253. gizmoLayer?: UtilityLayerRenderer);
  127254. /**
  127255. * Updates the gizmo to match the attached mesh's position/rotation
  127256. */
  127257. protected _update(): void;
  127258. /**
  127259. * Disposes of the gizmo
  127260. */
  127261. dispose(): void;
  127262. }
  127263. }
  127264. declare module BABYLON {
  127265. /**
  127266. * Single plane drag gizmo
  127267. */
  127268. export class PlaneDragGizmo extends Gizmo {
  127269. /**
  127270. * Drag behavior responsible for the gizmos dragging interactions
  127271. */
  127272. dragBehavior: PointerDragBehavior;
  127273. private _pointerObserver;
  127274. /**
  127275. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  127276. */
  127277. snapDistance: number;
  127278. /**
  127279. * Event that fires each time the gizmo snaps to a new location.
  127280. * * snapDistance is the the change in distance
  127281. */
  127282. onSnapObservable: Observable<{
  127283. snapDistance: number;
  127284. }>;
  127285. private _plane;
  127286. private _coloredMaterial;
  127287. private _hoverMaterial;
  127288. private _isEnabled;
  127289. private _parent;
  127290. /** @hidden */
  127291. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  127292. /** @hidden */
  127293. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  127294. /**
  127295. * Creates a PlaneDragGizmo
  127296. * @param gizmoLayer The utility layer the gizmo will be added to
  127297. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  127298. * @param color The color of the gizmo
  127299. */
  127300. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  127301. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  127302. /**
  127303. * If the gizmo is enabled
  127304. */
  127305. set isEnabled(value: boolean);
  127306. get isEnabled(): boolean;
  127307. /**
  127308. * Disposes of the gizmo
  127309. */
  127310. dispose(): void;
  127311. }
  127312. }
  127313. declare module BABYLON {
  127314. /**
  127315. * Gizmo that enables dragging a mesh along 3 axis
  127316. */
  127317. export class PositionGizmo extends Gizmo {
  127318. /**
  127319. * Internal gizmo used for interactions on the x axis
  127320. */
  127321. xGizmo: AxisDragGizmo;
  127322. /**
  127323. * Internal gizmo used for interactions on the y axis
  127324. */
  127325. yGizmo: AxisDragGizmo;
  127326. /**
  127327. * Internal gizmo used for interactions on the z axis
  127328. */
  127329. zGizmo: AxisDragGizmo;
  127330. /**
  127331. * Internal gizmo used for interactions on the yz plane
  127332. */
  127333. xPlaneGizmo: PlaneDragGizmo;
  127334. /**
  127335. * Internal gizmo used for interactions on the xz plane
  127336. */
  127337. yPlaneGizmo: PlaneDragGizmo;
  127338. /**
  127339. * Internal gizmo used for interactions on the xy plane
  127340. */
  127341. zPlaneGizmo: PlaneDragGizmo;
  127342. /**
  127343. * private variables
  127344. */
  127345. private _meshAttached;
  127346. private _updateGizmoRotationToMatchAttachedMesh;
  127347. private _snapDistance;
  127348. private _scaleRatio;
  127349. /** Fires an event when any of it's sub gizmos are dragged */
  127350. onDragStartObservable: Observable<unknown>;
  127351. /** Fires an event when any of it's sub gizmos are released from dragging */
  127352. onDragEndObservable: Observable<unknown>;
  127353. /**
  127354. * If set to true, planar drag is enabled
  127355. */
  127356. private _planarGizmoEnabled;
  127357. get attachedMesh(): Nullable<AbstractMesh>;
  127358. set attachedMesh(mesh: Nullable<AbstractMesh>);
  127359. /**
  127360. * Creates a PositionGizmo
  127361. * @param gizmoLayer The utility layer the gizmo will be added to
  127362. */
  127363. constructor(gizmoLayer?: UtilityLayerRenderer);
  127364. /**
  127365. * If the planar drag gizmo is enabled
  127366. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  127367. */
  127368. set planarGizmoEnabled(value: boolean);
  127369. get planarGizmoEnabled(): boolean;
  127370. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  127371. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  127372. /**
  127373. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  127374. */
  127375. set snapDistance(value: number);
  127376. get snapDistance(): number;
  127377. /**
  127378. * Ratio for the scale of the gizmo (Default: 1)
  127379. */
  127380. set scaleRatio(value: number);
  127381. get scaleRatio(): number;
  127382. /**
  127383. * Disposes of the gizmo
  127384. */
  127385. dispose(): void;
  127386. /**
  127387. * CustomMeshes are not supported by this gizmo
  127388. * @param mesh The mesh to replace the default mesh of the gizmo
  127389. */
  127390. setCustomMesh(mesh: Mesh): void;
  127391. }
  127392. }
  127393. declare module BABYLON {
  127394. /**
  127395. * Single axis drag gizmo
  127396. */
  127397. export class AxisDragGizmo extends Gizmo {
  127398. /**
  127399. * Drag behavior responsible for the gizmos dragging interactions
  127400. */
  127401. dragBehavior: PointerDragBehavior;
  127402. private _pointerObserver;
  127403. /**
  127404. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  127405. */
  127406. snapDistance: number;
  127407. /**
  127408. * Event that fires each time the gizmo snaps to a new location.
  127409. * * snapDistance is the the change in distance
  127410. */
  127411. onSnapObservable: Observable<{
  127412. snapDistance: number;
  127413. }>;
  127414. private _isEnabled;
  127415. private _parent;
  127416. private _arrow;
  127417. private _coloredMaterial;
  127418. private _hoverMaterial;
  127419. /** @hidden */
  127420. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  127421. /** @hidden */
  127422. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  127423. /**
  127424. * Creates an AxisDragGizmo
  127425. * @param gizmoLayer The utility layer the gizmo will be added to
  127426. * @param dragAxis The axis which the gizmo will be able to drag on
  127427. * @param color The color of the gizmo
  127428. */
  127429. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  127430. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  127431. /**
  127432. * If the gizmo is enabled
  127433. */
  127434. set isEnabled(value: boolean);
  127435. get isEnabled(): boolean;
  127436. /**
  127437. * Disposes of the gizmo
  127438. */
  127439. dispose(): void;
  127440. }
  127441. }
  127442. declare module BABYLON.Debug {
  127443. /**
  127444. * The Axes viewer will show 3 axes in a specific point in space
  127445. */
  127446. export class AxesViewer {
  127447. private _xAxis;
  127448. private _yAxis;
  127449. private _zAxis;
  127450. private _scaleLinesFactor;
  127451. private _instanced;
  127452. /**
  127453. * Gets the hosting scene
  127454. */
  127455. scene: Scene;
  127456. /**
  127457. * Gets or sets a number used to scale line length
  127458. */
  127459. scaleLines: number;
  127460. /** Gets the node hierarchy used to render x-axis */
  127461. get xAxis(): TransformNode;
  127462. /** Gets the node hierarchy used to render y-axis */
  127463. get yAxis(): TransformNode;
  127464. /** Gets the node hierarchy used to render z-axis */
  127465. get zAxis(): TransformNode;
  127466. /**
  127467. * Creates a new AxesViewer
  127468. * @param scene defines the hosting scene
  127469. * @param scaleLines defines a number used to scale line length (1 by default)
  127470. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  127471. * @param xAxis defines the node hierarchy used to render the x-axis
  127472. * @param yAxis defines the node hierarchy used to render the y-axis
  127473. * @param zAxis defines the node hierarchy used to render the z-axis
  127474. */
  127475. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  127476. /**
  127477. * Force the viewer to update
  127478. * @param position defines the position of the viewer
  127479. * @param xaxis defines the x axis of the viewer
  127480. * @param yaxis defines the y axis of the viewer
  127481. * @param zaxis defines the z axis of the viewer
  127482. */
  127483. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  127484. /**
  127485. * Creates an instance of this axes viewer.
  127486. * @returns a new axes viewer with instanced meshes
  127487. */
  127488. createInstance(): AxesViewer;
  127489. /** Releases resources */
  127490. dispose(): void;
  127491. private static _SetRenderingGroupId;
  127492. }
  127493. }
  127494. declare module BABYLON.Debug {
  127495. /**
  127496. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  127497. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  127498. */
  127499. export class BoneAxesViewer extends AxesViewer {
  127500. /**
  127501. * Gets or sets the target mesh where to display the axes viewer
  127502. */
  127503. mesh: Nullable<Mesh>;
  127504. /**
  127505. * Gets or sets the target bone where to display the axes viewer
  127506. */
  127507. bone: Nullable<Bone>;
  127508. /** Gets current position */
  127509. pos: Vector3;
  127510. /** Gets direction of X axis */
  127511. xaxis: Vector3;
  127512. /** Gets direction of Y axis */
  127513. yaxis: Vector3;
  127514. /** Gets direction of Z axis */
  127515. zaxis: Vector3;
  127516. /**
  127517. * Creates a new BoneAxesViewer
  127518. * @param scene defines the hosting scene
  127519. * @param bone defines the target bone
  127520. * @param mesh defines the target mesh
  127521. * @param scaleLines defines a scaling factor for line length (1 by default)
  127522. */
  127523. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  127524. /**
  127525. * Force the viewer to update
  127526. */
  127527. update(): void;
  127528. /** Releases resources */
  127529. dispose(): void;
  127530. }
  127531. }
  127532. declare module BABYLON {
  127533. /**
  127534. * Interface used to define scene explorer extensibility option
  127535. */
  127536. export interface IExplorerExtensibilityOption {
  127537. /**
  127538. * Define the option label
  127539. */
  127540. label: string;
  127541. /**
  127542. * Defines the action to execute on click
  127543. */
  127544. action: (entity: any) => void;
  127545. }
  127546. /**
  127547. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  127548. */
  127549. export interface IExplorerExtensibilityGroup {
  127550. /**
  127551. * Defines a predicate to test if a given type mut be extended
  127552. */
  127553. predicate: (entity: any) => boolean;
  127554. /**
  127555. * Gets the list of options added to a type
  127556. */
  127557. entries: IExplorerExtensibilityOption[];
  127558. }
  127559. /**
  127560. * Interface used to define the options to use to create the Inspector
  127561. */
  127562. export interface IInspectorOptions {
  127563. /**
  127564. * Display in overlay mode (default: false)
  127565. */
  127566. overlay?: boolean;
  127567. /**
  127568. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  127569. */
  127570. globalRoot?: HTMLElement;
  127571. /**
  127572. * Display the Scene explorer
  127573. */
  127574. showExplorer?: boolean;
  127575. /**
  127576. * Display the property inspector
  127577. */
  127578. showInspector?: boolean;
  127579. /**
  127580. * Display in embed mode (both panes on the right)
  127581. */
  127582. embedMode?: boolean;
  127583. /**
  127584. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  127585. */
  127586. handleResize?: boolean;
  127587. /**
  127588. * Allow the panes to popup (default: true)
  127589. */
  127590. enablePopup?: boolean;
  127591. /**
  127592. * Allow the panes to be closed by users (default: true)
  127593. */
  127594. enableClose?: boolean;
  127595. /**
  127596. * Optional list of extensibility entries
  127597. */
  127598. explorerExtensibility?: IExplorerExtensibilityGroup[];
  127599. /**
  127600. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  127601. */
  127602. inspectorURL?: string;
  127603. /**
  127604. * Optional initial tab (default to DebugLayerTab.Properties)
  127605. */
  127606. initialTab?: DebugLayerTab;
  127607. }
  127608. interface Scene {
  127609. /**
  127610. * @hidden
  127611. * Backing field
  127612. */
  127613. _debugLayer: DebugLayer;
  127614. /**
  127615. * Gets the debug layer (aka Inspector) associated with the scene
  127616. * @see http://doc.babylonjs.com/features/playground_debuglayer
  127617. */
  127618. debugLayer: DebugLayer;
  127619. }
  127620. /**
  127621. * Enum of inspector action tab
  127622. */
  127623. export enum DebugLayerTab {
  127624. /**
  127625. * Properties tag (default)
  127626. */
  127627. Properties = 0,
  127628. /**
  127629. * Debug tab
  127630. */
  127631. Debug = 1,
  127632. /**
  127633. * Statistics tab
  127634. */
  127635. Statistics = 2,
  127636. /**
  127637. * Tools tab
  127638. */
  127639. Tools = 3,
  127640. /**
  127641. * Settings tab
  127642. */
  127643. Settings = 4
  127644. }
  127645. /**
  127646. * The debug layer (aka Inspector) is the go to tool in order to better understand
  127647. * what is happening in your scene
  127648. * @see http://doc.babylonjs.com/features/playground_debuglayer
  127649. */
  127650. export class DebugLayer {
  127651. /**
  127652. * Define the url to get the inspector script from.
  127653. * By default it uses the babylonjs CDN.
  127654. * @ignoreNaming
  127655. */
  127656. static InspectorURL: string;
  127657. private _scene;
  127658. private BJSINSPECTOR;
  127659. private _onPropertyChangedObservable?;
  127660. /**
  127661. * Observable triggered when a property is changed through the inspector.
  127662. */
  127663. get onPropertyChangedObservable(): any;
  127664. /**
  127665. * Instantiates a new debug layer.
  127666. * The debug layer (aka Inspector) is the go to tool in order to better understand
  127667. * what is happening in your scene
  127668. * @see http://doc.babylonjs.com/features/playground_debuglayer
  127669. * @param scene Defines the scene to inspect
  127670. */
  127671. constructor(scene: Scene);
  127672. /** Creates the inspector window. */
  127673. private _createInspector;
  127674. /**
  127675. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  127676. * @param entity defines the entity to select
  127677. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  127678. */
  127679. select(entity: any, lineContainerTitles?: string | string[]): void;
  127680. /** Get the inspector from bundle or global */
  127681. private _getGlobalInspector;
  127682. /**
  127683. * Get if the inspector is visible or not.
  127684. * @returns true if visible otherwise, false
  127685. */
  127686. isVisible(): boolean;
  127687. /**
  127688. * Hide the inspector and close its window.
  127689. */
  127690. hide(): void;
  127691. /**
  127692. * Update the scene in the inspector
  127693. */
  127694. setAsActiveScene(): void;
  127695. /**
  127696. * Launch the debugLayer.
  127697. * @param config Define the configuration of the inspector
  127698. * @return a promise fulfilled when the debug layer is visible
  127699. */
  127700. show(config?: IInspectorOptions): Promise<DebugLayer>;
  127701. }
  127702. }
  127703. declare module BABYLON {
  127704. /**
  127705. * Class containing static functions to help procedurally build meshes
  127706. */
  127707. export class BoxBuilder {
  127708. /**
  127709. * Creates a box mesh
  127710. * * The parameter `size` sets the size (float) of each box side (default 1)
  127711. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  127712. * * 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)
  127713. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  127714. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127715. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127716. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127717. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  127718. * @param name defines the name of the mesh
  127719. * @param options defines the options used to create the mesh
  127720. * @param scene defines the hosting scene
  127721. * @returns the box mesh
  127722. */
  127723. static CreateBox(name: string, options: {
  127724. size?: number;
  127725. width?: number;
  127726. height?: number;
  127727. depth?: number;
  127728. faceUV?: Vector4[];
  127729. faceColors?: Color4[];
  127730. sideOrientation?: number;
  127731. frontUVs?: Vector4;
  127732. backUVs?: Vector4;
  127733. wrap?: boolean;
  127734. topBaseAt?: number;
  127735. bottomBaseAt?: number;
  127736. updatable?: boolean;
  127737. }, scene?: Nullable<Scene>): Mesh;
  127738. }
  127739. }
  127740. declare module BABYLON.Debug {
  127741. /**
  127742. * Used to show the physics impostor around the specific mesh
  127743. */
  127744. export class PhysicsViewer {
  127745. /** @hidden */
  127746. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  127747. /** @hidden */
  127748. protected _meshes: Array<Nullable<AbstractMesh>>;
  127749. /** @hidden */
  127750. protected _scene: Nullable<Scene>;
  127751. /** @hidden */
  127752. protected _numMeshes: number;
  127753. /** @hidden */
  127754. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  127755. private _renderFunction;
  127756. private _utilityLayer;
  127757. private _debugBoxMesh;
  127758. private _debugSphereMesh;
  127759. private _debugCylinderMesh;
  127760. private _debugMaterial;
  127761. private _debugMeshMeshes;
  127762. /**
  127763. * Creates a new PhysicsViewer
  127764. * @param scene defines the hosting scene
  127765. */
  127766. constructor(scene: Scene);
  127767. /** @hidden */
  127768. protected _updateDebugMeshes(): void;
  127769. /**
  127770. * Renders a specified physic impostor
  127771. * @param impostor defines the impostor to render
  127772. * @param targetMesh defines the mesh represented by the impostor
  127773. * @returns the new debug mesh used to render the impostor
  127774. */
  127775. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  127776. /**
  127777. * Hides a specified physic impostor
  127778. * @param impostor defines the impostor to hide
  127779. */
  127780. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  127781. private _getDebugMaterial;
  127782. private _getDebugBoxMesh;
  127783. private _getDebugSphereMesh;
  127784. private _getDebugCylinderMesh;
  127785. private _getDebugMeshMesh;
  127786. private _getDebugMesh;
  127787. /** Releases all resources */
  127788. dispose(): void;
  127789. }
  127790. }
  127791. declare module BABYLON {
  127792. /**
  127793. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  127794. * in order to better appreciate the issue one might have.
  127795. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  127796. */
  127797. export class RayHelper {
  127798. /**
  127799. * Defines the ray we are currently tryin to visualize.
  127800. */
  127801. ray: Nullable<Ray>;
  127802. private _renderPoints;
  127803. private _renderLine;
  127804. private _renderFunction;
  127805. private _scene;
  127806. private _updateToMeshFunction;
  127807. private _attachedToMesh;
  127808. private _meshSpaceDirection;
  127809. private _meshSpaceOrigin;
  127810. /**
  127811. * Helper function to create a colored helper in a scene in one line.
  127812. * @param ray Defines the ray we are currently tryin to visualize
  127813. * @param scene Defines the scene the ray is used in
  127814. * @param color Defines the color we want to see the ray in
  127815. * @returns The newly created ray helper.
  127816. */
  127817. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  127818. /**
  127819. * Instantiate a new ray helper.
  127820. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  127821. * in order to better appreciate the issue one might have.
  127822. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  127823. * @param ray Defines the ray we are currently tryin to visualize
  127824. */
  127825. constructor(ray: Ray);
  127826. /**
  127827. * Shows the ray we are willing to debug.
  127828. * @param scene Defines the scene the ray needs to be rendered in
  127829. * @param color Defines the color the ray needs to be rendered in
  127830. */
  127831. show(scene: Scene, color?: Color3): void;
  127832. /**
  127833. * Hides the ray we are debugging.
  127834. */
  127835. hide(): void;
  127836. private _render;
  127837. /**
  127838. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  127839. * @param mesh Defines the mesh we want the helper attached to
  127840. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  127841. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  127842. * @param length Defines the length of the ray
  127843. */
  127844. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  127845. /**
  127846. * Detach the ray helper from the mesh it has previously been attached to.
  127847. */
  127848. detachFromMesh(): void;
  127849. private _updateToMesh;
  127850. /**
  127851. * Dispose the helper and release its associated resources.
  127852. */
  127853. dispose(): void;
  127854. }
  127855. }
  127856. declare module BABYLON.Debug {
  127857. /**
  127858. * Class used to render a debug view of a given skeleton
  127859. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  127860. */
  127861. export class SkeletonViewer {
  127862. /** defines the skeleton to render */
  127863. skeleton: Skeleton;
  127864. /** defines the mesh attached to the skeleton */
  127865. mesh: AbstractMesh;
  127866. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  127867. autoUpdateBonesMatrices: boolean;
  127868. /** defines the rendering group id to use with the viewer */
  127869. renderingGroupId: number;
  127870. /** Gets or sets the color used to render the skeleton */
  127871. color: Color3;
  127872. private _scene;
  127873. private _debugLines;
  127874. private _debugMesh;
  127875. private _isEnabled;
  127876. private _renderFunction;
  127877. private _utilityLayer;
  127878. /**
  127879. * Returns the mesh used to render the bones
  127880. */
  127881. get debugMesh(): Nullable<LinesMesh>;
  127882. /**
  127883. * Creates a new SkeletonViewer
  127884. * @param skeleton defines the skeleton to render
  127885. * @param mesh defines the mesh attached to the skeleton
  127886. * @param scene defines the hosting scene
  127887. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  127888. * @param renderingGroupId defines the rendering group id to use with the viewer
  127889. */
  127890. constructor(
  127891. /** defines the skeleton to render */
  127892. skeleton: Skeleton,
  127893. /** defines the mesh attached to the skeleton */
  127894. mesh: AbstractMesh, scene: Scene,
  127895. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  127896. autoUpdateBonesMatrices?: boolean,
  127897. /** defines the rendering group id to use with the viewer */
  127898. renderingGroupId?: number);
  127899. /** Gets or sets a boolean indicating if the viewer is enabled */
  127900. set isEnabled(value: boolean);
  127901. get isEnabled(): boolean;
  127902. private _getBonePosition;
  127903. private _getLinesForBonesWithLength;
  127904. private _getLinesForBonesNoLength;
  127905. /** Update the viewer to sync with current skeleton state */
  127906. update(): void;
  127907. /** Release associated resources */
  127908. dispose(): void;
  127909. }
  127910. }
  127911. declare module BABYLON {
  127912. /**
  127913. * Enum for Device Types
  127914. */
  127915. export enum DeviceType {
  127916. /** Generic */
  127917. Generic = 0,
  127918. /** Keyboard */
  127919. Keyboard = 1,
  127920. /** Mouse */
  127921. Mouse = 2,
  127922. /** Touch Pointers */
  127923. Touch = 3,
  127924. /** PS4 Dual Shock */
  127925. DualShock = 4,
  127926. /** Xbox */
  127927. Xbox = 5,
  127928. /** Switch Controller */
  127929. Switch = 6
  127930. }
  127931. /**
  127932. * Enum for All Pointers (Touch/Mouse)
  127933. */
  127934. export enum PointerInput {
  127935. /** Horizontal Axis */
  127936. Horizontal = 0,
  127937. /** Vertical Axis */
  127938. Vertical = 1,
  127939. /** Left Click or Touch */
  127940. LeftClick = 2,
  127941. /** Middle Click */
  127942. MiddleClick = 3,
  127943. /** Right Click */
  127944. RightClick = 4,
  127945. /** Browser Back */
  127946. BrowserBack = 5,
  127947. /** Browser Forward */
  127948. BrowserForward = 6
  127949. }
  127950. /**
  127951. * Enum for Dual Shock Gamepad
  127952. */
  127953. export enum DualShockInput {
  127954. /** Cross */
  127955. Cross = 0,
  127956. /** Circle */
  127957. Circle = 1,
  127958. /** Square */
  127959. Square = 2,
  127960. /** Triangle */
  127961. Triangle = 3,
  127962. /** L1 */
  127963. L1 = 4,
  127964. /** R1 */
  127965. R1 = 5,
  127966. /** L2 */
  127967. L2 = 6,
  127968. /** R2 */
  127969. R2 = 7,
  127970. /** Share */
  127971. Share = 8,
  127972. /** Options */
  127973. Options = 9,
  127974. /** L3 */
  127975. L3 = 10,
  127976. /** R3 */
  127977. R3 = 11,
  127978. /** DPadUp */
  127979. DPadUp = 12,
  127980. /** DPadDown */
  127981. DPadDown = 13,
  127982. /** DPadLeft */
  127983. DPadLeft = 14,
  127984. /** DRight */
  127985. DPadRight = 15,
  127986. /** Home */
  127987. Home = 16,
  127988. /** TouchPad */
  127989. TouchPad = 17,
  127990. /** LStickXAxis */
  127991. LStickXAxis = 18,
  127992. /** LStickYAxis */
  127993. LStickYAxis = 19,
  127994. /** RStickXAxis */
  127995. RStickXAxis = 20,
  127996. /** RStickYAxis */
  127997. RStickYAxis = 21
  127998. }
  127999. /**
  128000. * Enum for Xbox Gamepad
  128001. */
  128002. export enum XboxInput {
  128003. /** A */
  128004. A = 0,
  128005. /** B */
  128006. B = 1,
  128007. /** X */
  128008. X = 2,
  128009. /** Y */
  128010. Y = 3,
  128011. /** LB */
  128012. LB = 4,
  128013. /** RB */
  128014. RB = 5,
  128015. /** LT */
  128016. LT = 6,
  128017. /** RT */
  128018. RT = 7,
  128019. /** Back */
  128020. Back = 8,
  128021. /** Start */
  128022. Start = 9,
  128023. /** LS */
  128024. LS = 10,
  128025. /** RS */
  128026. RS = 11,
  128027. /** DPadUp */
  128028. DPadUp = 12,
  128029. /** DPadDown */
  128030. DPadDown = 13,
  128031. /** DPadLeft */
  128032. DPadLeft = 14,
  128033. /** DRight */
  128034. DPadRight = 15,
  128035. /** Home */
  128036. Home = 16,
  128037. /** LStickXAxis */
  128038. LStickXAxis = 17,
  128039. /** LStickYAxis */
  128040. LStickYAxis = 18,
  128041. /** RStickXAxis */
  128042. RStickXAxis = 19,
  128043. /** RStickYAxis */
  128044. RStickYAxis = 20
  128045. }
  128046. /**
  128047. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  128048. */
  128049. export enum SwitchInput {
  128050. /** B */
  128051. B = 0,
  128052. /** A */
  128053. A = 1,
  128054. /** Y */
  128055. Y = 2,
  128056. /** X */
  128057. X = 3,
  128058. /** L */
  128059. L = 4,
  128060. /** R */
  128061. R = 5,
  128062. /** ZL */
  128063. ZL = 6,
  128064. /** ZR */
  128065. ZR = 7,
  128066. /** Minus */
  128067. Minus = 8,
  128068. /** Plus */
  128069. Plus = 9,
  128070. /** LS */
  128071. LS = 10,
  128072. /** RS */
  128073. RS = 11,
  128074. /** DPadUp */
  128075. DPadUp = 12,
  128076. /** DPadDown */
  128077. DPadDown = 13,
  128078. /** DPadLeft */
  128079. DPadLeft = 14,
  128080. /** DRight */
  128081. DPadRight = 15,
  128082. /** Home */
  128083. Home = 16,
  128084. /** Capture */
  128085. Capture = 17,
  128086. /** LStickXAxis */
  128087. LStickXAxis = 18,
  128088. /** LStickYAxis */
  128089. LStickYAxis = 19,
  128090. /** RStickXAxis */
  128091. RStickXAxis = 20,
  128092. /** RStickYAxis */
  128093. RStickYAxis = 21
  128094. }
  128095. }
  128096. declare module BABYLON {
  128097. /**
  128098. * This class will take all inputs from Keyboard, Pointer, and
  128099. * any Gamepads and provide a polling system that all devices
  128100. * will use. This class assumes that there will only be one
  128101. * pointer device and one keyboard.
  128102. */
  128103. export class DeviceInputSystem implements IDisposable {
  128104. /**
  128105. * Callback to be triggered when a device is connected
  128106. */
  128107. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  128108. /**
  128109. * Callback to be triggered when a device is disconnected
  128110. */
  128111. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  128112. /**
  128113. * Callback to be triggered when event driven input is updated
  128114. */
  128115. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  128116. private _inputs;
  128117. private _gamepads;
  128118. private _keyboardActive;
  128119. private _pointerActive;
  128120. private _elementToAttachTo;
  128121. private _keyboardDownEvent;
  128122. private _keyboardUpEvent;
  128123. private _pointerMoveEvent;
  128124. private _pointerDownEvent;
  128125. private _pointerUpEvent;
  128126. private _gamepadConnectedEvent;
  128127. private _gamepadDisconnectedEvent;
  128128. private static _MAX_KEYCODES;
  128129. private static _MAX_POINTER_INPUTS;
  128130. private constructor();
  128131. /**
  128132. * Creates a new DeviceInputSystem instance
  128133. * @param engine Engine to pull input element from
  128134. * @returns The new instance
  128135. */
  128136. static Create(engine: Engine): DeviceInputSystem;
  128137. /**
  128138. * Checks for current device input value, given an id and input index
  128139. * @param deviceName Id of connected device
  128140. * @param inputIndex Index of device input
  128141. * @returns Current value of input
  128142. */
  128143. /**
  128144. * Checks for current device input value, given an id and input index
  128145. * @param deviceType Enum specifiying device type
  128146. * @param deviceSlot "Slot" or index that device is referenced in
  128147. * @param inputIndex Id of input to be checked
  128148. * @returns Current value of input
  128149. */
  128150. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): Nullable<number>;
  128151. /**
  128152. * Dispose of all the eventlisteners
  128153. */
  128154. dispose(): void;
  128155. /**
  128156. * Add device and inputs to device array
  128157. * @param deviceType Enum specifiying device type
  128158. * @param deviceSlot "Slot" or index that device is referenced in
  128159. * @param numberOfInputs Number of input entries to create for given device
  128160. */
  128161. private _registerDevice;
  128162. /**
  128163. * Given a specific device name, remove that device from the device map
  128164. * @param deviceType Enum specifiying device type
  128165. * @param deviceSlot "Slot" or index that device is referenced in
  128166. */
  128167. private _unregisterDevice;
  128168. /**
  128169. * Handle all actions that come from keyboard interaction
  128170. */
  128171. private _handleKeyActions;
  128172. /**
  128173. * Handle all actions that come from pointer interaction
  128174. */
  128175. private _handlePointerActions;
  128176. /**
  128177. * Handle all actions that come from gamepad interaction
  128178. */
  128179. private _handleGamepadActions;
  128180. /**
  128181. * Update all non-event based devices with each frame
  128182. * @param deviceType Enum specifiying device type
  128183. * @param deviceSlot "Slot" or index that device is referenced in
  128184. * @param inputIndex Id of input to be checked
  128185. */
  128186. private _updateDevice;
  128187. /**
  128188. * Gets DeviceType from the device name
  128189. * @param deviceName Name of Device from DeviceInputSystem
  128190. * @returns DeviceType enum value
  128191. */
  128192. private _getGamepadDeviceType;
  128193. }
  128194. }
  128195. declare module BABYLON {
  128196. /**
  128197. * Type to handle enforcement of inputs
  128198. */
  128199. export type DeviceInput<T extends DeviceType> = T extends DeviceType.Keyboard | DeviceType.Generic ? number : T extends DeviceType.Mouse | DeviceType.Touch ? PointerInput : T extends DeviceType.DualShock ? DualShockInput : T extends DeviceType.Xbox ? XboxInput : T extends DeviceType.Switch ? SwitchInput : never;
  128200. }
  128201. declare module BABYLON {
  128202. /**
  128203. * Class that handles all input for a specific device
  128204. */
  128205. export class DeviceSource<T extends DeviceType> {
  128206. /** Type of device */
  128207. readonly deviceType: DeviceType;
  128208. /** "Slot" or index that device is referenced in */
  128209. readonly deviceSlot: number;
  128210. /**
  128211. * Observable to handle device input changes per device
  128212. */
  128213. readonly onInputChangedObservable: Observable<{
  128214. inputIndex: DeviceInput<T>;
  128215. previousState: Nullable<number>;
  128216. currentState: Nullable<number>;
  128217. }>;
  128218. private readonly _deviceInputSystem;
  128219. /**
  128220. * Default Constructor
  128221. * @param deviceInputSystem Reference to DeviceInputSystem
  128222. * @param deviceType Type of device
  128223. * @param deviceSlot "Slot" or index that device is referenced in
  128224. */
  128225. constructor(deviceInputSystem: DeviceInputSystem,
  128226. /** Type of device */
  128227. deviceType: DeviceType,
  128228. /** "Slot" or index that device is referenced in */
  128229. deviceSlot?: number);
  128230. /**
  128231. * Get input for specific input
  128232. * @param inputIndex index of specific input on device
  128233. * @returns Input value from DeviceInputSystem
  128234. */
  128235. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  128236. }
  128237. /**
  128238. * Class to keep track of devices
  128239. */
  128240. export class DeviceSourceManager implements IDisposable {
  128241. /**
  128242. * Observable to be triggered when before a device is connected
  128243. */
  128244. readonly onBeforeDeviceConnectedObservable: Observable<{
  128245. deviceType: DeviceType;
  128246. deviceSlot: number;
  128247. }>;
  128248. /**
  128249. * Observable to be triggered when before a device is disconnected
  128250. */
  128251. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  128252. deviceType: DeviceType;
  128253. deviceSlot: number;
  128254. }>;
  128255. /**
  128256. * Observable to be triggered when after a device is connected
  128257. */
  128258. readonly onAfterDeviceConnectedObservable: Observable<{
  128259. deviceType: DeviceType;
  128260. deviceSlot: number;
  128261. }>;
  128262. /**
  128263. * Observable to be triggered when after a device is disconnected
  128264. */
  128265. readonly onAfterDeviceDisconnectedObservable: Observable<{
  128266. deviceType: DeviceType;
  128267. deviceSlot: number;
  128268. }>;
  128269. private readonly _devices;
  128270. private readonly _firstDevice;
  128271. private readonly _deviceInputSystem;
  128272. /**
  128273. * Default Constructor
  128274. * @param engine engine to pull input element from
  128275. */
  128276. constructor(engine: Engine);
  128277. /**
  128278. * Gets a DeviceSource, given a type and slot
  128279. * @param deviceType Enum specifying device type
  128280. * @param deviceSlot "Slot" or index that device is referenced in
  128281. * @returns DeviceSource object
  128282. */
  128283. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  128284. /**
  128285. * Gets an array of DeviceSource objects for a given device type
  128286. * @param deviceType Enum specifying device type
  128287. * @returns Array of DeviceSource objects
  128288. */
  128289. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  128290. /**
  128291. * Dispose of DeviceInputSystem and other parts
  128292. */
  128293. dispose(): void;
  128294. /**
  128295. * Function to add device name to device list
  128296. * @param deviceType Enum specifying device type
  128297. * @param deviceSlot "Slot" or index that device is referenced in
  128298. */
  128299. private _addDevice;
  128300. /**
  128301. * Function to remove device name to device list
  128302. * @param deviceType Enum specifying device type
  128303. * @param deviceSlot "Slot" or index that device is referenced in
  128304. */
  128305. private _removeDevice;
  128306. /**
  128307. * Updates array storing first connected device of each type
  128308. * @param type Type of Device
  128309. */
  128310. private _updateFirstDevices;
  128311. }
  128312. }
  128313. declare module BABYLON {
  128314. /**
  128315. * Options to create the null engine
  128316. */
  128317. export class NullEngineOptions {
  128318. /**
  128319. * Render width (Default: 512)
  128320. */
  128321. renderWidth: number;
  128322. /**
  128323. * Render height (Default: 256)
  128324. */
  128325. renderHeight: number;
  128326. /**
  128327. * Texture size (Default: 512)
  128328. */
  128329. textureSize: number;
  128330. /**
  128331. * If delta time between frames should be constant
  128332. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  128333. */
  128334. deterministicLockstep: boolean;
  128335. /**
  128336. * Maximum about of steps between frames (Default: 4)
  128337. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  128338. */
  128339. lockstepMaxSteps: number;
  128340. }
  128341. /**
  128342. * The null engine class provides support for headless version of babylon.js.
  128343. * This can be used in server side scenario or for testing purposes
  128344. */
  128345. export class NullEngine extends Engine {
  128346. private _options;
  128347. /**
  128348. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  128349. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  128350. * @returns true if engine is in deterministic lock step mode
  128351. */
  128352. isDeterministicLockStep(): boolean;
  128353. /**
  128354. * Gets the max steps when engine is running in deterministic lock step
  128355. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  128356. * @returns the max steps
  128357. */
  128358. getLockstepMaxSteps(): number;
  128359. /**
  128360. * Gets the current hardware scaling level.
  128361. * By default the hardware scaling level is computed from the window device ratio.
  128362. * 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.
  128363. * @returns a number indicating the current hardware scaling level
  128364. */
  128365. getHardwareScalingLevel(): number;
  128366. constructor(options?: NullEngineOptions);
  128367. /**
  128368. * Creates a vertex buffer
  128369. * @param vertices the data for the vertex buffer
  128370. * @returns the new WebGL static buffer
  128371. */
  128372. createVertexBuffer(vertices: FloatArray): DataBuffer;
  128373. /**
  128374. * Creates a new index buffer
  128375. * @param indices defines the content of the index buffer
  128376. * @param updatable defines if the index buffer must be updatable
  128377. * @returns a new webGL buffer
  128378. */
  128379. createIndexBuffer(indices: IndicesArray): DataBuffer;
  128380. /**
  128381. * Clear the current render buffer or the current render target (if any is set up)
  128382. * @param color defines the color to use
  128383. * @param backBuffer defines if the back buffer must be cleared
  128384. * @param depth defines if the depth buffer must be cleared
  128385. * @param stencil defines if the stencil buffer must be cleared
  128386. */
  128387. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  128388. /**
  128389. * Gets the current render width
  128390. * @param useScreen defines if screen size must be used (or the current render target if any)
  128391. * @returns a number defining the current render width
  128392. */
  128393. getRenderWidth(useScreen?: boolean): number;
  128394. /**
  128395. * Gets the current render height
  128396. * @param useScreen defines if screen size must be used (or the current render target if any)
  128397. * @returns a number defining the current render height
  128398. */
  128399. getRenderHeight(useScreen?: boolean): number;
  128400. /**
  128401. * Set the WebGL's viewport
  128402. * @param viewport defines the viewport element to be used
  128403. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  128404. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  128405. */
  128406. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  128407. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  128408. /**
  128409. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  128410. * @param pipelineContext defines the pipeline context to use
  128411. * @param uniformsNames defines the list of uniform names
  128412. * @returns an array of webGL uniform locations
  128413. */
  128414. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  128415. /**
  128416. * Gets the lsit of active attributes for a given webGL program
  128417. * @param pipelineContext defines the pipeline context to use
  128418. * @param attributesNames defines the list of attribute names to get
  128419. * @returns an array of indices indicating the offset of each attribute
  128420. */
  128421. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  128422. /**
  128423. * Binds an effect to the webGL context
  128424. * @param effect defines the effect to bind
  128425. */
  128426. bindSamplers(effect: Effect): void;
  128427. /**
  128428. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  128429. * @param effect defines the effect to activate
  128430. */
  128431. enableEffect(effect: Effect): void;
  128432. /**
  128433. * Set various states to the webGL context
  128434. * @param culling defines backface culling state
  128435. * @param zOffset defines the value to apply to zOffset (0 by default)
  128436. * @param force defines if states must be applied even if cache is up to date
  128437. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  128438. */
  128439. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  128440. /**
  128441. * Set the value of an uniform to an array of int32
  128442. * @param uniform defines the webGL uniform location where to store the value
  128443. * @param array defines the array of int32 to store
  128444. */
  128445. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  128446. /**
  128447. * Set the value of an uniform to an array of int32 (stored as vec2)
  128448. * @param uniform defines the webGL uniform location where to store the value
  128449. * @param array defines the array of int32 to store
  128450. */
  128451. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  128452. /**
  128453. * Set the value of an uniform to an array of int32 (stored as vec3)
  128454. * @param uniform defines the webGL uniform location where to store the value
  128455. * @param array defines the array of int32 to store
  128456. */
  128457. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  128458. /**
  128459. * Set the value of an uniform to an array of int32 (stored as vec4)
  128460. * @param uniform defines the webGL uniform location where to store the value
  128461. * @param array defines the array of int32 to store
  128462. */
  128463. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  128464. /**
  128465. * Set the value of an uniform to an array of float32
  128466. * @param uniform defines the webGL uniform location where to store the value
  128467. * @param array defines the array of float32 to store
  128468. */
  128469. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  128470. /**
  128471. * Set the value of an uniform to an array of float32 (stored as vec2)
  128472. * @param uniform defines the webGL uniform location where to store the value
  128473. * @param array defines the array of float32 to store
  128474. */
  128475. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  128476. /**
  128477. * Set the value of an uniform to an array of float32 (stored as vec3)
  128478. * @param uniform defines the webGL uniform location where to store the value
  128479. * @param array defines the array of float32 to store
  128480. */
  128481. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  128482. /**
  128483. * Set the value of an uniform to an array of float32 (stored as vec4)
  128484. * @param uniform defines the webGL uniform location where to store the value
  128485. * @param array defines the array of float32 to store
  128486. */
  128487. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  128488. /**
  128489. * Set the value of an uniform to an array of number
  128490. * @param uniform defines the webGL uniform location where to store the value
  128491. * @param array defines the array of number to store
  128492. */
  128493. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  128494. /**
  128495. * Set the value of an uniform to an array of number (stored as vec2)
  128496. * @param uniform defines the webGL uniform location where to store the value
  128497. * @param array defines the array of number to store
  128498. */
  128499. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  128500. /**
  128501. * Set the value of an uniform to an array of number (stored as vec3)
  128502. * @param uniform defines the webGL uniform location where to store the value
  128503. * @param array defines the array of number to store
  128504. */
  128505. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  128506. /**
  128507. * Set the value of an uniform to an array of number (stored as vec4)
  128508. * @param uniform defines the webGL uniform location where to store the value
  128509. * @param array defines the array of number to store
  128510. */
  128511. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  128512. /**
  128513. * Set the value of an uniform to an array of float32 (stored as matrices)
  128514. * @param uniform defines the webGL uniform location where to store the value
  128515. * @param matrices defines the array of float32 to store
  128516. */
  128517. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  128518. /**
  128519. * Set the value of an uniform to a matrix (3x3)
  128520. * @param uniform defines the webGL uniform location where to store the value
  128521. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  128522. */
  128523. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  128524. /**
  128525. * Set the value of an uniform to a matrix (2x2)
  128526. * @param uniform defines the webGL uniform location where to store the value
  128527. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  128528. */
  128529. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  128530. /**
  128531. * Set the value of an uniform to a number (float)
  128532. * @param uniform defines the webGL uniform location where to store the value
  128533. * @param value defines the float number to store
  128534. */
  128535. setFloat(uniform: WebGLUniformLocation, value: number): void;
  128536. /**
  128537. * Set the value of an uniform to a vec2
  128538. * @param uniform defines the webGL uniform location where to store the value
  128539. * @param x defines the 1st component of the value
  128540. * @param y defines the 2nd component of the value
  128541. */
  128542. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  128543. /**
  128544. * Set the value of an uniform to a vec3
  128545. * @param uniform defines the webGL uniform location where to store the value
  128546. * @param x defines the 1st component of the value
  128547. * @param y defines the 2nd component of the value
  128548. * @param z defines the 3rd component of the value
  128549. */
  128550. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  128551. /**
  128552. * Set the value of an uniform to a boolean
  128553. * @param uniform defines the webGL uniform location where to store the value
  128554. * @param bool defines the boolean to store
  128555. */
  128556. setBool(uniform: WebGLUniformLocation, bool: number): void;
  128557. /**
  128558. * Set the value of an uniform to a vec4
  128559. * @param uniform defines the webGL uniform location where to store the value
  128560. * @param x defines the 1st component of the value
  128561. * @param y defines the 2nd component of the value
  128562. * @param z defines the 3rd component of the value
  128563. * @param w defines the 4th component of the value
  128564. */
  128565. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  128566. /**
  128567. * Sets the current alpha mode
  128568. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  128569. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  128570. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  128571. */
  128572. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  128573. /**
  128574. * Bind webGl buffers directly to the webGL context
  128575. * @param vertexBuffers defines the vertex buffer to bind
  128576. * @param indexBuffer defines the index buffer to bind
  128577. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  128578. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  128579. * @param effect defines the effect associated with the vertex buffer
  128580. */
  128581. bindBuffers(vertexBuffers: {
  128582. [key: string]: VertexBuffer;
  128583. }, indexBuffer: DataBuffer, effect: Effect): void;
  128584. /**
  128585. * Force the entire cache to be cleared
  128586. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  128587. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  128588. */
  128589. wipeCaches(bruteForce?: boolean): void;
  128590. /**
  128591. * Send a draw order
  128592. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  128593. * @param indexStart defines the starting index
  128594. * @param indexCount defines the number of index to draw
  128595. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  128596. */
  128597. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  128598. /**
  128599. * Draw a list of indexed primitives
  128600. * @param fillMode defines the primitive to use
  128601. * @param indexStart defines the starting index
  128602. * @param indexCount defines the number of index to draw
  128603. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  128604. */
  128605. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  128606. /**
  128607. * Draw a list of unindexed primitives
  128608. * @param fillMode defines the primitive to use
  128609. * @param verticesStart defines the index of first vertex to draw
  128610. * @param verticesCount defines the count of vertices to draw
  128611. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  128612. */
  128613. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  128614. /** @hidden */
  128615. _createTexture(): WebGLTexture;
  128616. /** @hidden */
  128617. _releaseTexture(texture: InternalTexture): void;
  128618. /**
  128619. * Usually called from Texture.ts.
  128620. * Passed information to create a WebGLTexture
  128621. * @param urlArg defines a value which contains one of the following:
  128622. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  128623. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  128624. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  128625. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  128626. * @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)
  128627. * @param scene needed for loading to the correct scene
  128628. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  128629. * @param onLoad optional callback to be called upon successful completion
  128630. * @param onError optional callback to be called upon failure
  128631. * @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
  128632. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  128633. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  128634. * @param forcedExtension defines the extension to use to pick the right loader
  128635. * @param mimeType defines an optional mime type
  128636. * @returns a InternalTexture for assignment back into BABYLON.Texture
  128637. */
  128638. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string): InternalTexture;
  128639. /**
  128640. * Creates a new render target texture
  128641. * @param size defines the size of the texture
  128642. * @param options defines the options used to create the texture
  128643. * @returns a new render target texture stored in an InternalTexture
  128644. */
  128645. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  128646. /**
  128647. * Update the sampling mode of a given texture
  128648. * @param samplingMode defines the required sampling mode
  128649. * @param texture defines the texture to update
  128650. */
  128651. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  128652. /**
  128653. * Binds the frame buffer to the specified texture.
  128654. * @param texture The texture to render to or null for the default canvas
  128655. * @param faceIndex The face of the texture to render to in case of cube texture
  128656. * @param requiredWidth The width of the target to render to
  128657. * @param requiredHeight The height of the target to render to
  128658. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  128659. * @param lodLevel defines le lod level to bind to the frame buffer
  128660. */
  128661. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  128662. /**
  128663. * Unbind the current render target texture from the webGL context
  128664. * @param texture defines the render target texture to unbind
  128665. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  128666. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  128667. */
  128668. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  128669. /**
  128670. * Creates a dynamic vertex buffer
  128671. * @param vertices the data for the dynamic vertex buffer
  128672. * @returns the new WebGL dynamic buffer
  128673. */
  128674. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  128675. /**
  128676. * Update the content of a dynamic texture
  128677. * @param texture defines the texture to update
  128678. * @param canvas defines the canvas containing the source
  128679. * @param invertY defines if data must be stored with Y axis inverted
  128680. * @param premulAlpha defines if alpha is stored as premultiplied
  128681. * @param format defines the format of the data
  128682. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  128683. */
  128684. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  128685. /**
  128686. * Gets a boolean indicating if all created effects are ready
  128687. * @returns true if all effects are ready
  128688. */
  128689. areAllEffectsReady(): boolean;
  128690. /**
  128691. * @hidden
  128692. * Get the current error code of the webGL context
  128693. * @returns the error code
  128694. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  128695. */
  128696. getError(): number;
  128697. /** @hidden */
  128698. _getUnpackAlignement(): number;
  128699. /** @hidden */
  128700. _unpackFlipY(value: boolean): void;
  128701. /**
  128702. * Update a dynamic index buffer
  128703. * @param indexBuffer defines the target index buffer
  128704. * @param indices defines the data to update
  128705. * @param offset defines the offset in the target index buffer where update should start
  128706. */
  128707. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  128708. /**
  128709. * Updates a dynamic vertex buffer.
  128710. * @param vertexBuffer the vertex buffer to update
  128711. * @param vertices the data used to update the vertex buffer
  128712. * @param byteOffset the byte offset of the data (optional)
  128713. * @param byteLength the byte length of the data (optional)
  128714. */
  128715. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  128716. /** @hidden */
  128717. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  128718. /** @hidden */
  128719. _bindTexture(channel: number, texture: InternalTexture): void;
  128720. protected _deleteBuffer(buffer: WebGLBuffer): void;
  128721. /**
  128722. * 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
  128723. */
  128724. releaseEffects(): void;
  128725. displayLoadingUI(): void;
  128726. hideLoadingUI(): void;
  128727. /** @hidden */
  128728. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  128729. /** @hidden */
  128730. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  128731. /** @hidden */
  128732. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  128733. /** @hidden */
  128734. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  128735. }
  128736. }
  128737. declare module BABYLON {
  128738. /**
  128739. * @hidden
  128740. **/
  128741. export class _TimeToken {
  128742. _startTimeQuery: Nullable<WebGLQuery>;
  128743. _endTimeQuery: Nullable<WebGLQuery>;
  128744. _timeElapsedQuery: Nullable<WebGLQuery>;
  128745. _timeElapsedQueryEnded: boolean;
  128746. }
  128747. }
  128748. declare module BABYLON {
  128749. /** @hidden */
  128750. export class _OcclusionDataStorage {
  128751. /** @hidden */
  128752. occlusionInternalRetryCounter: number;
  128753. /** @hidden */
  128754. isOcclusionQueryInProgress: boolean;
  128755. /** @hidden */
  128756. isOccluded: boolean;
  128757. /** @hidden */
  128758. occlusionRetryCount: number;
  128759. /** @hidden */
  128760. occlusionType: number;
  128761. /** @hidden */
  128762. occlusionQueryAlgorithmType: number;
  128763. }
  128764. interface Engine {
  128765. /**
  128766. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  128767. * @return the new query
  128768. */
  128769. createQuery(): WebGLQuery;
  128770. /**
  128771. * Delete and release a webGL query
  128772. * @param query defines the query to delete
  128773. * @return the current engine
  128774. */
  128775. deleteQuery(query: WebGLQuery): Engine;
  128776. /**
  128777. * Check if a given query has resolved and got its value
  128778. * @param query defines the query to check
  128779. * @returns true if the query got its value
  128780. */
  128781. isQueryResultAvailable(query: WebGLQuery): boolean;
  128782. /**
  128783. * Gets the value of a given query
  128784. * @param query defines the query to check
  128785. * @returns the value of the query
  128786. */
  128787. getQueryResult(query: WebGLQuery): number;
  128788. /**
  128789. * Initiates an occlusion query
  128790. * @param algorithmType defines the algorithm to use
  128791. * @param query defines the query to use
  128792. * @returns the current engine
  128793. * @see http://doc.babylonjs.com/features/occlusionquery
  128794. */
  128795. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  128796. /**
  128797. * Ends an occlusion query
  128798. * @see http://doc.babylonjs.com/features/occlusionquery
  128799. * @param algorithmType defines the algorithm to use
  128800. * @returns the current engine
  128801. */
  128802. endOcclusionQuery(algorithmType: number): Engine;
  128803. /**
  128804. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  128805. * Please note that only one query can be issued at a time
  128806. * @returns a time token used to track the time span
  128807. */
  128808. startTimeQuery(): Nullable<_TimeToken>;
  128809. /**
  128810. * Ends a time query
  128811. * @param token defines the token used to measure the time span
  128812. * @returns the time spent (in ns)
  128813. */
  128814. endTimeQuery(token: _TimeToken): int;
  128815. /** @hidden */
  128816. _currentNonTimestampToken: Nullable<_TimeToken>;
  128817. /** @hidden */
  128818. _createTimeQuery(): WebGLQuery;
  128819. /** @hidden */
  128820. _deleteTimeQuery(query: WebGLQuery): void;
  128821. /** @hidden */
  128822. _getGlAlgorithmType(algorithmType: number): number;
  128823. /** @hidden */
  128824. _getTimeQueryResult(query: WebGLQuery): any;
  128825. /** @hidden */
  128826. _getTimeQueryAvailability(query: WebGLQuery): any;
  128827. }
  128828. interface AbstractMesh {
  128829. /**
  128830. * Backing filed
  128831. * @hidden
  128832. */
  128833. __occlusionDataStorage: _OcclusionDataStorage;
  128834. /**
  128835. * Access property
  128836. * @hidden
  128837. */
  128838. _occlusionDataStorage: _OcclusionDataStorage;
  128839. /**
  128840. * 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.
  128841. * The default value is -1 which means don't break the query and wait till the result
  128842. * @see http://doc.babylonjs.com/features/occlusionquery
  128843. */
  128844. occlusionRetryCount: number;
  128845. /**
  128846. * 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:
  128847. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  128848. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  128849. * * 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.
  128850. * @see http://doc.babylonjs.com/features/occlusionquery
  128851. */
  128852. occlusionType: number;
  128853. /**
  128854. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  128855. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  128856. * * 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.
  128857. * @see http://doc.babylonjs.com/features/occlusionquery
  128858. */
  128859. occlusionQueryAlgorithmType: number;
  128860. /**
  128861. * 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
  128862. * @see http://doc.babylonjs.com/features/occlusionquery
  128863. */
  128864. isOccluded: boolean;
  128865. /**
  128866. * Flag to check the progress status of the query
  128867. * @see http://doc.babylonjs.com/features/occlusionquery
  128868. */
  128869. isOcclusionQueryInProgress: boolean;
  128870. }
  128871. }
  128872. declare module BABYLON {
  128873. /** @hidden */
  128874. export var _forceTransformFeedbackToBundle: boolean;
  128875. interface Engine {
  128876. /**
  128877. * Creates a webGL transform feedback object
  128878. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  128879. * @returns the webGL transform feedback object
  128880. */
  128881. createTransformFeedback(): WebGLTransformFeedback;
  128882. /**
  128883. * Delete a webGL transform feedback object
  128884. * @param value defines the webGL transform feedback object to delete
  128885. */
  128886. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  128887. /**
  128888. * Bind a webGL transform feedback object to the webgl context
  128889. * @param value defines the webGL transform feedback object to bind
  128890. */
  128891. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  128892. /**
  128893. * Begins a transform feedback operation
  128894. * @param usePoints defines if points or triangles must be used
  128895. */
  128896. beginTransformFeedback(usePoints: boolean): void;
  128897. /**
  128898. * Ends a transform feedback operation
  128899. */
  128900. endTransformFeedback(): void;
  128901. /**
  128902. * Specify the varyings to use with transform feedback
  128903. * @param program defines the associated webGL program
  128904. * @param value defines the list of strings representing the varying names
  128905. */
  128906. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  128907. /**
  128908. * Bind a webGL buffer for a transform feedback operation
  128909. * @param value defines the webGL buffer to bind
  128910. */
  128911. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  128912. }
  128913. }
  128914. declare module BABYLON {
  128915. /**
  128916. * Creation options of the multi render target texture.
  128917. */
  128918. export interface IMultiRenderTargetOptions {
  128919. /**
  128920. * Define if the texture needs to create mip maps after render.
  128921. */
  128922. generateMipMaps?: boolean;
  128923. /**
  128924. * Define the types of all the draw buffers we want to create
  128925. */
  128926. types?: number[];
  128927. /**
  128928. * Define the sampling modes of all the draw buffers we want to create
  128929. */
  128930. samplingModes?: number[];
  128931. /**
  128932. * Define if a depth buffer is required
  128933. */
  128934. generateDepthBuffer?: boolean;
  128935. /**
  128936. * Define if a stencil buffer is required
  128937. */
  128938. generateStencilBuffer?: boolean;
  128939. /**
  128940. * Define if a depth texture is required instead of a depth buffer
  128941. */
  128942. generateDepthTexture?: boolean;
  128943. /**
  128944. * Define the number of desired draw buffers
  128945. */
  128946. textureCount?: number;
  128947. /**
  128948. * Define if aspect ratio should be adapted to the texture or stay the scene one
  128949. */
  128950. doNotChangeAspectRatio?: boolean;
  128951. /**
  128952. * Define the default type of the buffers we are creating
  128953. */
  128954. defaultType?: number;
  128955. }
  128956. /**
  128957. * A multi render target, like a render target provides the ability to render to a texture.
  128958. * Unlike the render target, it can render to several draw buffers in one draw.
  128959. * This is specially interesting in deferred rendering or for any effects requiring more than
  128960. * just one color from a single pass.
  128961. */
  128962. export class MultiRenderTarget extends RenderTargetTexture {
  128963. private _internalTextures;
  128964. private _textures;
  128965. private _multiRenderTargetOptions;
  128966. /**
  128967. * Get if draw buffers are currently supported by the used hardware and browser.
  128968. */
  128969. get isSupported(): boolean;
  128970. /**
  128971. * Get the list of textures generated by the multi render target.
  128972. */
  128973. get textures(): Texture[];
  128974. /**
  128975. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  128976. */
  128977. get depthTexture(): Texture;
  128978. /**
  128979. * Set the wrapping mode on U of all the textures we are rendering to.
  128980. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  128981. */
  128982. set wrapU(wrap: number);
  128983. /**
  128984. * Set the wrapping mode on V of all the textures we are rendering to.
  128985. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  128986. */
  128987. set wrapV(wrap: number);
  128988. /**
  128989. * Instantiate a new multi render target texture.
  128990. * A multi render target, like a render target provides the ability to render to a texture.
  128991. * Unlike the render target, it can render to several draw buffers in one draw.
  128992. * This is specially interesting in deferred rendering or for any effects requiring more than
  128993. * just one color from a single pass.
  128994. * @param name Define the name of the texture
  128995. * @param size Define the size of the buffers to render to
  128996. * @param count Define the number of target we are rendering into
  128997. * @param scene Define the scene the texture belongs to
  128998. * @param options Define the options used to create the multi render target
  128999. */
  129000. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  129001. /** @hidden */
  129002. _rebuild(): void;
  129003. private _createInternalTextures;
  129004. private _createTextures;
  129005. /**
  129006. * Define the number of samples used if MSAA is enabled.
  129007. */
  129008. get samples(): number;
  129009. set samples(value: number);
  129010. /**
  129011. * Resize all the textures in the multi render target.
  129012. * Be carrefull as it will recreate all the data in the new texture.
  129013. * @param size Define the new size
  129014. */
  129015. resize(size: any): void;
  129016. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  129017. /**
  129018. * Dispose the render targets and their associated resources
  129019. */
  129020. dispose(): void;
  129021. /**
  129022. * Release all the underlying texture used as draw buffers.
  129023. */
  129024. releaseInternalTextures(): void;
  129025. }
  129026. }
  129027. declare module BABYLON {
  129028. interface ThinEngine {
  129029. /**
  129030. * Unbind a list of render target textures from the webGL context
  129031. * This is used only when drawBuffer extension or webGL2 are active
  129032. * @param textures defines the render target textures to unbind
  129033. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  129034. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  129035. */
  129036. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  129037. /**
  129038. * Create a multi render target texture
  129039. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  129040. * @param size defines the size of the texture
  129041. * @param options defines the creation options
  129042. * @returns the cube texture as an InternalTexture
  129043. */
  129044. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  129045. /**
  129046. * Update the sample count for a given multiple render target texture
  129047. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  129048. * @param textures defines the textures to update
  129049. * @param samples defines the sample count to set
  129050. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  129051. */
  129052. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  129053. }
  129054. }
  129055. declare module BABYLON {
  129056. /**
  129057. * Class used to define an additional view for the engine
  129058. * @see https://doc.babylonjs.com/how_to/multi_canvases
  129059. */
  129060. export class EngineView {
  129061. /** Defines the canvas where to render the view */
  129062. target: HTMLCanvasElement;
  129063. /** Defines an optional camera used to render the view (will use active camera else) */
  129064. camera?: Camera;
  129065. }
  129066. interface Engine {
  129067. /**
  129068. * Gets or sets the HTML element to use for attaching events
  129069. */
  129070. inputElement: Nullable<HTMLElement>;
  129071. /**
  129072. * Gets the current engine view
  129073. * @see https://doc.babylonjs.com/how_to/multi_canvases
  129074. */
  129075. activeView: Nullable<EngineView>;
  129076. /** Gets or sets the list of views */
  129077. views: EngineView[];
  129078. /**
  129079. * Register a new child canvas
  129080. * @param canvas defines the canvas to register
  129081. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  129082. * @returns the associated view
  129083. */
  129084. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  129085. /**
  129086. * Remove a registered child canvas
  129087. * @param canvas defines the canvas to remove
  129088. * @returns the current engine
  129089. */
  129090. unRegisterView(canvas: HTMLCanvasElement): Engine;
  129091. }
  129092. }
  129093. declare module BABYLON {
  129094. interface Engine {
  129095. /** @hidden */
  129096. _excludedCompressedTextures: string[];
  129097. /** @hidden */
  129098. _textureFormatInUse: string;
  129099. /**
  129100. * Gets the list of texture formats supported
  129101. */
  129102. readonly texturesSupported: Array<string>;
  129103. /**
  129104. * Gets the texture format in use
  129105. */
  129106. readonly textureFormatInUse: Nullable<string>;
  129107. /**
  129108. * Set the compressed texture extensions or file names to skip.
  129109. *
  129110. * @param skippedFiles defines the list of those texture files you want to skip
  129111. * Example: [".dds", ".env", "myfile.png"]
  129112. */
  129113. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  129114. /**
  129115. * Set the compressed texture format to use, based on the formats you have, and the formats
  129116. * supported by the hardware / browser.
  129117. *
  129118. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  129119. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  129120. * to API arguments needed to compressed textures. This puts the burden on the container
  129121. * generator to house the arcane code for determining these for current & future formats.
  129122. *
  129123. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  129124. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  129125. *
  129126. * Note: The result of this call is not taken into account when a texture is base64.
  129127. *
  129128. * @param formatsAvailable defines the list of those format families you have created
  129129. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  129130. *
  129131. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  129132. * @returns The extension selected.
  129133. */
  129134. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  129135. }
  129136. }
  129137. declare module BABYLON {
  129138. /**
  129139. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  129140. */
  129141. export interface CubeMapInfo {
  129142. /**
  129143. * The pixel array for the front face.
  129144. * This is stored in format, left to right, up to down format.
  129145. */
  129146. front: Nullable<ArrayBufferView>;
  129147. /**
  129148. * The pixel array for the back face.
  129149. * This is stored in format, left to right, up to down format.
  129150. */
  129151. back: Nullable<ArrayBufferView>;
  129152. /**
  129153. * The pixel array for the left face.
  129154. * This is stored in format, left to right, up to down format.
  129155. */
  129156. left: Nullable<ArrayBufferView>;
  129157. /**
  129158. * The pixel array for the right face.
  129159. * This is stored in format, left to right, up to down format.
  129160. */
  129161. right: Nullable<ArrayBufferView>;
  129162. /**
  129163. * The pixel array for the up face.
  129164. * This is stored in format, left to right, up to down format.
  129165. */
  129166. up: Nullable<ArrayBufferView>;
  129167. /**
  129168. * The pixel array for the down face.
  129169. * This is stored in format, left to right, up to down format.
  129170. */
  129171. down: Nullable<ArrayBufferView>;
  129172. /**
  129173. * The size of the cubemap stored.
  129174. *
  129175. * Each faces will be size * size pixels.
  129176. */
  129177. size: number;
  129178. /**
  129179. * The format of the texture.
  129180. *
  129181. * RGBA, RGB.
  129182. */
  129183. format: number;
  129184. /**
  129185. * The type of the texture data.
  129186. *
  129187. * UNSIGNED_INT, FLOAT.
  129188. */
  129189. type: number;
  129190. /**
  129191. * Specifies whether the texture is in gamma space.
  129192. */
  129193. gammaSpace: boolean;
  129194. }
  129195. /**
  129196. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  129197. */
  129198. export class PanoramaToCubeMapTools {
  129199. private static FACE_LEFT;
  129200. private static FACE_RIGHT;
  129201. private static FACE_FRONT;
  129202. private static FACE_BACK;
  129203. private static FACE_DOWN;
  129204. private static FACE_UP;
  129205. /**
  129206. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  129207. *
  129208. * @param float32Array The source data.
  129209. * @param inputWidth The width of the input panorama.
  129210. * @param inputHeight The height of the input panorama.
  129211. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  129212. * @return The cubemap data
  129213. */
  129214. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  129215. private static CreateCubemapTexture;
  129216. private static CalcProjectionSpherical;
  129217. }
  129218. }
  129219. declare module BABYLON {
  129220. /**
  129221. * Helper class dealing with the extraction of spherical polynomial dataArray
  129222. * from a cube map.
  129223. */
  129224. export class CubeMapToSphericalPolynomialTools {
  129225. private static FileFaces;
  129226. /**
  129227. * Converts a texture to the according Spherical Polynomial data.
  129228. * This extracts the first 3 orders only as they are the only one used in the lighting.
  129229. *
  129230. * @param texture The texture to extract the information from.
  129231. * @return The Spherical Polynomial data.
  129232. */
  129233. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  129234. /**
  129235. * Converts a cubemap to the according Spherical Polynomial data.
  129236. * This extracts the first 3 orders only as they are the only one used in the lighting.
  129237. *
  129238. * @param cubeInfo The Cube map to extract the information from.
  129239. * @return The Spherical Polynomial data.
  129240. */
  129241. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  129242. }
  129243. }
  129244. declare module BABYLON {
  129245. interface BaseTexture {
  129246. /**
  129247. * Get the polynomial representation of the texture data.
  129248. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  129249. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  129250. */
  129251. sphericalPolynomial: Nullable<SphericalPolynomial>;
  129252. }
  129253. }
  129254. declare module BABYLON {
  129255. /** @hidden */
  129256. export var rgbdEncodePixelShader: {
  129257. name: string;
  129258. shader: string;
  129259. };
  129260. }
  129261. declare module BABYLON {
  129262. /** @hidden */
  129263. export var rgbdDecodePixelShader: {
  129264. name: string;
  129265. shader: string;
  129266. };
  129267. }
  129268. declare module BABYLON {
  129269. /**
  129270. * Raw texture data and descriptor sufficient for WebGL texture upload
  129271. */
  129272. export interface EnvironmentTextureInfo {
  129273. /**
  129274. * Version of the environment map
  129275. */
  129276. version: number;
  129277. /**
  129278. * Width of image
  129279. */
  129280. width: number;
  129281. /**
  129282. * Irradiance information stored in the file.
  129283. */
  129284. irradiance: any;
  129285. /**
  129286. * Specular information stored in the file.
  129287. */
  129288. specular: any;
  129289. }
  129290. /**
  129291. * Defines One Image in the file. It requires only the position in the file
  129292. * as well as the length.
  129293. */
  129294. interface BufferImageData {
  129295. /**
  129296. * Length of the image data.
  129297. */
  129298. length: number;
  129299. /**
  129300. * Position of the data from the null terminator delimiting the end of the JSON.
  129301. */
  129302. position: number;
  129303. }
  129304. /**
  129305. * Defines the specular data enclosed in the file.
  129306. * This corresponds to the version 1 of the data.
  129307. */
  129308. export interface EnvironmentTextureSpecularInfoV1 {
  129309. /**
  129310. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  129311. */
  129312. specularDataPosition?: number;
  129313. /**
  129314. * This contains all the images data needed to reconstruct the cubemap.
  129315. */
  129316. mipmaps: Array<BufferImageData>;
  129317. /**
  129318. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  129319. */
  129320. lodGenerationScale: number;
  129321. }
  129322. /**
  129323. * Sets of helpers addressing the serialization and deserialization of environment texture
  129324. * stored in a BabylonJS env file.
  129325. * Those files are usually stored as .env files.
  129326. */
  129327. export class EnvironmentTextureTools {
  129328. /**
  129329. * Magic number identifying the env file.
  129330. */
  129331. private static _MagicBytes;
  129332. /**
  129333. * Gets the environment info from an env file.
  129334. * @param data The array buffer containing the .env bytes.
  129335. * @returns the environment file info (the json header) if successfully parsed.
  129336. */
  129337. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  129338. /**
  129339. * Creates an environment texture from a loaded cube texture.
  129340. * @param texture defines the cube texture to convert in env file
  129341. * @return a promise containing the environment data if succesfull.
  129342. */
  129343. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  129344. /**
  129345. * Creates a JSON representation of the spherical data.
  129346. * @param texture defines the texture containing the polynomials
  129347. * @return the JSON representation of the spherical info
  129348. */
  129349. private static _CreateEnvTextureIrradiance;
  129350. /**
  129351. * Creates the ArrayBufferViews used for initializing environment texture image data.
  129352. * @param data the image data
  129353. * @param info parameters that determine what views will be created for accessing the underlying buffer
  129354. * @return the views described by info providing access to the underlying buffer
  129355. */
  129356. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  129357. /**
  129358. * Uploads the texture info contained in the env file to the GPU.
  129359. * @param texture defines the internal texture to upload to
  129360. * @param data defines the data to load
  129361. * @param info defines the texture info retrieved through the GetEnvInfo method
  129362. * @returns a promise
  129363. */
  129364. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  129365. private static _OnImageReadyAsync;
  129366. /**
  129367. * Uploads the levels of image data to the GPU.
  129368. * @param texture defines the internal texture to upload to
  129369. * @param imageData defines the array buffer views of image data [mipmap][face]
  129370. * @returns a promise
  129371. */
  129372. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  129373. /**
  129374. * Uploads spherical polynomials information to the texture.
  129375. * @param texture defines the texture we are trying to upload the information to
  129376. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  129377. */
  129378. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  129379. /** @hidden */
  129380. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  129381. }
  129382. }
  129383. declare module BABYLON {
  129384. /** @hidden */
  129385. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  129386. private _genericAttributeLocation;
  129387. private _varyingLocationCount;
  129388. private _varyingLocationMap;
  129389. private _replacements;
  129390. private _textureCount;
  129391. private _uniforms;
  129392. lineProcessor(line: string): string;
  129393. attributeProcessor(attribute: string): string;
  129394. varyingProcessor(varying: string, isFragment: boolean): string;
  129395. uniformProcessor(uniform: string): string;
  129396. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  129397. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  129398. }
  129399. }
  129400. declare module BABYLON {
  129401. /**
  129402. * Class used to inline functions in shader code
  129403. */
  129404. export class ShaderCodeInliner {
  129405. private static readonly _RegexpFindFunctionNameAndType;
  129406. private _sourceCode;
  129407. private _functionDescr;
  129408. private _numMaxIterations;
  129409. /** Gets or sets the token used to mark the functions to inline */
  129410. inlineToken: string;
  129411. /** Gets or sets the debug mode */
  129412. debug: boolean;
  129413. /** Gets the code after the inlining process */
  129414. get code(): string;
  129415. /**
  129416. * Initializes the inliner
  129417. * @param sourceCode shader code source to inline
  129418. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  129419. */
  129420. constructor(sourceCode: string, numMaxIterations?: number);
  129421. /**
  129422. * Start the processing of the shader code
  129423. */
  129424. processCode(): void;
  129425. private _collectFunctions;
  129426. private _processInlining;
  129427. private _extractBetweenMarkers;
  129428. private _skipWhitespaces;
  129429. private _removeComments;
  129430. private _replaceFunctionCallsByCode;
  129431. private _findBackward;
  129432. private _escapeRegExp;
  129433. private _replaceNames;
  129434. }
  129435. }
  129436. declare module BABYLON {
  129437. /**
  129438. * Container for accessors for natively-stored mesh data buffers.
  129439. */
  129440. class NativeDataBuffer extends DataBuffer {
  129441. /**
  129442. * Accessor value used to identify/retrieve a natively-stored index buffer.
  129443. */
  129444. nativeIndexBuffer?: any;
  129445. /**
  129446. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  129447. */
  129448. nativeVertexBuffer?: any;
  129449. }
  129450. /** @hidden */
  129451. class NativeTexture extends InternalTexture {
  129452. getInternalTexture(): InternalTexture;
  129453. getViewCount(): number;
  129454. }
  129455. /** @hidden */
  129456. export class NativeEngine extends Engine {
  129457. private readonly _native;
  129458. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  129459. private readonly INVALID_HANDLE;
  129460. getHardwareScalingLevel(): number;
  129461. constructor();
  129462. dispose(): void;
  129463. /**
  129464. * Can be used to override the current requestAnimationFrame requester.
  129465. * @hidden
  129466. */
  129467. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  129468. /**
  129469. * Override default engine behavior.
  129470. * @param color
  129471. * @param backBuffer
  129472. * @param depth
  129473. * @param stencil
  129474. */
  129475. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  129476. /**
  129477. * Gets host document
  129478. * @returns the host document object
  129479. */
  129480. getHostDocument(): Nullable<Document>;
  129481. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  129482. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  129483. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  129484. recordVertexArrayObject(vertexBuffers: {
  129485. [key: string]: VertexBuffer;
  129486. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  129487. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  129488. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  129489. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  129490. /**
  129491. * Draw a list of indexed primitives
  129492. * @param fillMode defines the primitive to use
  129493. * @param indexStart defines the starting index
  129494. * @param indexCount defines the number of index to draw
  129495. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  129496. */
  129497. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  129498. /**
  129499. * Draw a list of unindexed primitives
  129500. * @param fillMode defines the primitive to use
  129501. * @param verticesStart defines the index of first vertex to draw
  129502. * @param verticesCount defines the count of vertices to draw
  129503. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  129504. */
  129505. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  129506. createPipelineContext(): IPipelineContext;
  129507. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  129508. /** @hidden */
  129509. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  129510. /** @hidden */
  129511. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  129512. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  129513. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  129514. protected _setProgram(program: WebGLProgram): void;
  129515. _releaseEffect(effect: Effect): void;
  129516. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  129517. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  129518. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  129519. bindSamplers(effect: Effect): void;
  129520. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  129521. getRenderWidth(useScreen?: boolean): number;
  129522. getRenderHeight(useScreen?: boolean): number;
  129523. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  129524. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  129525. /**
  129526. * Set the z offset to apply to current rendering
  129527. * @param value defines the offset to apply
  129528. */
  129529. setZOffset(value: number): void;
  129530. /**
  129531. * Gets the current value of the zOffset
  129532. * @returns the current zOffset state
  129533. */
  129534. getZOffset(): number;
  129535. /**
  129536. * Enable or disable depth buffering
  129537. * @param enable defines the state to set
  129538. */
  129539. setDepthBuffer(enable: boolean): void;
  129540. /**
  129541. * Gets a boolean indicating if depth writing is enabled
  129542. * @returns the current depth writing state
  129543. */
  129544. getDepthWrite(): boolean;
  129545. /**
  129546. * Enable or disable depth writing
  129547. * @param enable defines the state to set
  129548. */
  129549. setDepthWrite(enable: boolean): void;
  129550. /**
  129551. * Enable or disable color writing
  129552. * @param enable defines the state to set
  129553. */
  129554. setColorWrite(enable: boolean): void;
  129555. /**
  129556. * Gets a boolean indicating if color writing is enabled
  129557. * @returns the current color writing state
  129558. */
  129559. getColorWrite(): boolean;
  129560. /**
  129561. * Sets alpha constants used by some alpha blending modes
  129562. * @param r defines the red component
  129563. * @param g defines the green component
  129564. * @param b defines the blue component
  129565. * @param a defines the alpha component
  129566. */
  129567. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  129568. /**
  129569. * Sets the current alpha mode
  129570. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  129571. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  129572. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  129573. */
  129574. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  129575. /**
  129576. * Gets the current alpha mode
  129577. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  129578. * @returns the current alpha mode
  129579. */
  129580. getAlphaMode(): number;
  129581. setInt(uniform: WebGLUniformLocation, int: number): void;
  129582. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  129583. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  129584. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  129585. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  129586. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  129587. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  129588. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  129589. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  129590. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  129591. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  129592. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  129593. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  129594. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  129595. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  129596. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  129597. setFloat(uniform: WebGLUniformLocation, value: number): void;
  129598. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  129599. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  129600. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  129601. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  129602. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  129603. wipeCaches(bruteForce?: boolean): void;
  129604. _createTexture(): WebGLTexture;
  129605. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  129606. /**
  129607. * Usually called from Texture.ts.
  129608. * Passed information to create a WebGLTexture
  129609. * @param url defines a value which contains one of the following:
  129610. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  129611. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  129612. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  129613. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  129614. * @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)
  129615. * @param scene needed for loading to the correct scene
  129616. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  129617. * @param onLoad optional callback to be called upon successful completion
  129618. * @param onError optional callback to be called upon failure
  129619. * @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
  129620. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  129621. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  129622. * @param forcedExtension defines the extension to use to pick the right loader
  129623. * @param mimeType defines an optional mime type
  129624. * @returns a InternalTexture for assignment back into BABYLON.Texture
  129625. */
  129626. createTexture(url: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string): InternalTexture;
  129627. /**
  129628. * Creates a cube texture
  129629. * @param rootUrl defines the url where the files to load is located
  129630. * @param scene defines the current scene
  129631. * @param files defines the list of files to load (1 per face)
  129632. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  129633. * @param onLoad defines an optional callback raised when the texture is loaded
  129634. * @param onError defines an optional callback raised if there is an issue to load the texture
  129635. * @param format defines the format of the data
  129636. * @param forcedExtension defines the extension to use to pick the right loader
  129637. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  129638. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  129639. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  129640. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  129641. * @returns the cube texture as an InternalTexture
  129642. */
  129643. 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;
  129644. private _getSamplingFilter;
  129645. private static _GetNativeTextureFormat;
  129646. createRenderTargetTexture(size: number | {
  129647. width: number;
  129648. height: number;
  129649. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  129650. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  129651. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  129652. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  129653. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  129654. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  129655. /**
  129656. * Updates a dynamic vertex buffer.
  129657. * @param vertexBuffer the vertex buffer to update
  129658. * @param data the data used to update the vertex buffer
  129659. * @param byteOffset the byte offset of the data (optional)
  129660. * @param byteLength the byte length of the data (optional)
  129661. */
  129662. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  129663. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  129664. private _updateAnisotropicLevel;
  129665. private _getAddressMode;
  129666. /** @hidden */
  129667. _bindTexture(channel: number, texture: InternalTexture): void;
  129668. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  129669. releaseEffects(): void;
  129670. /** @hidden */
  129671. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  129672. /** @hidden */
  129673. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  129674. /** @hidden */
  129675. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  129676. /** @hidden */
  129677. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  129678. }
  129679. }
  129680. declare module BABYLON {
  129681. /**
  129682. * Gather the list of clipboard event types as constants.
  129683. */
  129684. export class ClipboardEventTypes {
  129685. /**
  129686. * The clipboard event is fired when a copy command is active (pressed).
  129687. */
  129688. static readonly COPY: number;
  129689. /**
  129690. * The clipboard event is fired when a cut command is active (pressed).
  129691. */
  129692. static readonly CUT: number;
  129693. /**
  129694. * The clipboard event is fired when a paste command is active (pressed).
  129695. */
  129696. static readonly PASTE: number;
  129697. }
  129698. /**
  129699. * This class is used to store clipboard related info for the onClipboardObservable event.
  129700. */
  129701. export class ClipboardInfo {
  129702. /**
  129703. * Defines the type of event (BABYLON.ClipboardEventTypes)
  129704. */
  129705. type: number;
  129706. /**
  129707. * Defines the related dom event
  129708. */
  129709. event: ClipboardEvent;
  129710. /**
  129711. *Creates an instance of ClipboardInfo.
  129712. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  129713. * @param event Defines the related dom event
  129714. */
  129715. constructor(
  129716. /**
  129717. * Defines the type of event (BABYLON.ClipboardEventTypes)
  129718. */
  129719. type: number,
  129720. /**
  129721. * Defines the related dom event
  129722. */
  129723. event: ClipboardEvent);
  129724. /**
  129725. * Get the clipboard event's type from the keycode.
  129726. * @param keyCode Defines the keyCode for the current keyboard event.
  129727. * @return {number}
  129728. */
  129729. static GetTypeFromCharacter(keyCode: number): number;
  129730. }
  129731. }
  129732. declare module BABYLON {
  129733. /**
  129734. * Google Daydream controller
  129735. */
  129736. export class DaydreamController extends WebVRController {
  129737. /**
  129738. * Base Url for the controller model.
  129739. */
  129740. static MODEL_BASE_URL: string;
  129741. /**
  129742. * File name for the controller model.
  129743. */
  129744. static MODEL_FILENAME: string;
  129745. /**
  129746. * Gamepad Id prefix used to identify Daydream Controller.
  129747. */
  129748. static readonly GAMEPAD_ID_PREFIX: string;
  129749. /**
  129750. * Creates a new DaydreamController from a gamepad
  129751. * @param vrGamepad the gamepad that the controller should be created from
  129752. */
  129753. constructor(vrGamepad: any);
  129754. /**
  129755. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  129756. * @param scene scene in which to add meshes
  129757. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  129758. */
  129759. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  129760. /**
  129761. * Called once for each button that changed state since the last frame
  129762. * @param buttonIdx Which button index changed
  129763. * @param state New state of the button
  129764. * @param changes Which properties on the state changed since last frame
  129765. */
  129766. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  129767. }
  129768. }
  129769. declare module BABYLON {
  129770. /**
  129771. * Gear VR Controller
  129772. */
  129773. export class GearVRController extends WebVRController {
  129774. /**
  129775. * Base Url for the controller model.
  129776. */
  129777. static MODEL_BASE_URL: string;
  129778. /**
  129779. * File name for the controller model.
  129780. */
  129781. static MODEL_FILENAME: string;
  129782. /**
  129783. * Gamepad Id prefix used to identify this controller.
  129784. */
  129785. static readonly GAMEPAD_ID_PREFIX: string;
  129786. private readonly _buttonIndexToObservableNameMap;
  129787. /**
  129788. * Creates a new GearVRController from a gamepad
  129789. * @param vrGamepad the gamepad that the controller should be created from
  129790. */
  129791. constructor(vrGamepad: any);
  129792. /**
  129793. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  129794. * @param scene scene in which to add meshes
  129795. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  129796. */
  129797. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  129798. /**
  129799. * Called once for each button that changed state since the last frame
  129800. * @param buttonIdx Which button index changed
  129801. * @param state New state of the button
  129802. * @param changes Which properties on the state changed since last frame
  129803. */
  129804. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  129805. }
  129806. }
  129807. declare module BABYLON {
  129808. /**
  129809. * Generic Controller
  129810. */
  129811. export class GenericController extends WebVRController {
  129812. /**
  129813. * Base Url for the controller model.
  129814. */
  129815. static readonly MODEL_BASE_URL: string;
  129816. /**
  129817. * File name for the controller model.
  129818. */
  129819. static readonly MODEL_FILENAME: string;
  129820. /**
  129821. * Creates a new GenericController from a gamepad
  129822. * @param vrGamepad the gamepad that the controller should be created from
  129823. */
  129824. constructor(vrGamepad: any);
  129825. /**
  129826. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  129827. * @param scene scene in which to add meshes
  129828. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  129829. */
  129830. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  129831. /**
  129832. * Called once for each button that changed state since the last frame
  129833. * @param buttonIdx Which button index changed
  129834. * @param state New state of the button
  129835. * @param changes Which properties on the state changed since last frame
  129836. */
  129837. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  129838. }
  129839. }
  129840. declare module BABYLON {
  129841. /**
  129842. * Oculus Touch Controller
  129843. */
  129844. export class OculusTouchController extends WebVRController {
  129845. /**
  129846. * Base Url for the controller model.
  129847. */
  129848. static MODEL_BASE_URL: string;
  129849. /**
  129850. * File name for the left controller model.
  129851. */
  129852. static MODEL_LEFT_FILENAME: string;
  129853. /**
  129854. * File name for the right controller model.
  129855. */
  129856. static MODEL_RIGHT_FILENAME: string;
  129857. /**
  129858. * Base Url for the Quest controller model.
  129859. */
  129860. static QUEST_MODEL_BASE_URL: string;
  129861. /**
  129862. * @hidden
  129863. * If the controllers are running on a device that needs the updated Quest controller models
  129864. */
  129865. static _IsQuest: boolean;
  129866. /**
  129867. * Fired when the secondary trigger on this controller is modified
  129868. */
  129869. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  129870. /**
  129871. * Fired when the thumb rest on this controller is modified
  129872. */
  129873. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  129874. /**
  129875. * Creates a new OculusTouchController from a gamepad
  129876. * @param vrGamepad the gamepad that the controller should be created from
  129877. */
  129878. constructor(vrGamepad: any);
  129879. /**
  129880. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  129881. * @param scene scene in which to add meshes
  129882. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  129883. */
  129884. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  129885. /**
  129886. * Fired when the A button on this controller is modified
  129887. */
  129888. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  129889. /**
  129890. * Fired when the B button on this controller is modified
  129891. */
  129892. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  129893. /**
  129894. * Fired when the X button on this controller is modified
  129895. */
  129896. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  129897. /**
  129898. * Fired when the Y button on this controller is modified
  129899. */
  129900. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  129901. /**
  129902. * Called once for each button that changed state since the last frame
  129903. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  129904. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  129905. * 2) secondary trigger (same)
  129906. * 3) A (right) X (left), touch, pressed = value
  129907. * 4) B / Y
  129908. * 5) thumb rest
  129909. * @param buttonIdx Which button index changed
  129910. * @param state New state of the button
  129911. * @param changes Which properties on the state changed since last frame
  129912. */
  129913. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  129914. }
  129915. }
  129916. declare module BABYLON {
  129917. /**
  129918. * Vive Controller
  129919. */
  129920. export class ViveController extends WebVRController {
  129921. /**
  129922. * Base Url for the controller model.
  129923. */
  129924. static MODEL_BASE_URL: string;
  129925. /**
  129926. * File name for the controller model.
  129927. */
  129928. static MODEL_FILENAME: string;
  129929. /**
  129930. * Creates a new ViveController from a gamepad
  129931. * @param vrGamepad the gamepad that the controller should be created from
  129932. */
  129933. constructor(vrGamepad: any);
  129934. /**
  129935. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  129936. * @param scene scene in which to add meshes
  129937. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  129938. */
  129939. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  129940. /**
  129941. * Fired when the left button on this controller is modified
  129942. */
  129943. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  129944. /**
  129945. * Fired when the right button on this controller is modified
  129946. */
  129947. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  129948. /**
  129949. * Fired when the menu button on this controller is modified
  129950. */
  129951. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  129952. /**
  129953. * Called once for each button that changed state since the last frame
  129954. * Vive mapping:
  129955. * 0: touchpad
  129956. * 1: trigger
  129957. * 2: left AND right buttons
  129958. * 3: menu button
  129959. * @param buttonIdx Which button index changed
  129960. * @param state New state of the button
  129961. * @param changes Which properties on the state changed since last frame
  129962. */
  129963. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  129964. }
  129965. }
  129966. declare module BABYLON {
  129967. /**
  129968. * Defines the WindowsMotionController object that the state of the windows motion controller
  129969. */
  129970. export class WindowsMotionController extends WebVRController {
  129971. /**
  129972. * The base url used to load the left and right controller models
  129973. */
  129974. static MODEL_BASE_URL: string;
  129975. /**
  129976. * The name of the left controller model file
  129977. */
  129978. static MODEL_LEFT_FILENAME: string;
  129979. /**
  129980. * The name of the right controller model file
  129981. */
  129982. static MODEL_RIGHT_FILENAME: string;
  129983. /**
  129984. * The controller name prefix for this controller type
  129985. */
  129986. static readonly GAMEPAD_ID_PREFIX: string;
  129987. /**
  129988. * The controller id pattern for this controller type
  129989. */
  129990. private static readonly GAMEPAD_ID_PATTERN;
  129991. private _loadedMeshInfo;
  129992. protected readonly _mapping: {
  129993. buttons: string[];
  129994. buttonMeshNames: {
  129995. trigger: string;
  129996. menu: string;
  129997. grip: string;
  129998. thumbstick: string;
  129999. trackpad: string;
  130000. };
  130001. buttonObservableNames: {
  130002. trigger: string;
  130003. menu: string;
  130004. grip: string;
  130005. thumbstick: string;
  130006. trackpad: string;
  130007. };
  130008. axisMeshNames: string[];
  130009. pointingPoseMeshName: string;
  130010. };
  130011. /**
  130012. * Fired when the trackpad on this controller is clicked
  130013. */
  130014. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  130015. /**
  130016. * Fired when the trackpad on this controller is modified
  130017. */
  130018. onTrackpadValuesChangedObservable: Observable<StickValues>;
  130019. /**
  130020. * The current x and y values of this controller's trackpad
  130021. */
  130022. trackpad: StickValues;
  130023. /**
  130024. * Creates a new WindowsMotionController from a gamepad
  130025. * @param vrGamepad the gamepad that the controller should be created from
  130026. */
  130027. constructor(vrGamepad: any);
  130028. /**
  130029. * Fired when the trigger on this controller is modified
  130030. */
  130031. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  130032. /**
  130033. * Fired when the menu button on this controller is modified
  130034. */
  130035. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  130036. /**
  130037. * Fired when the grip button on this controller is modified
  130038. */
  130039. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  130040. /**
  130041. * Fired when the thumbstick button on this controller is modified
  130042. */
  130043. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  130044. /**
  130045. * Fired when the touchpad button on this controller is modified
  130046. */
  130047. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  130048. /**
  130049. * Fired when the touchpad values on this controller are modified
  130050. */
  130051. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  130052. protected _updateTrackpad(): void;
  130053. /**
  130054. * Called once per frame by the engine.
  130055. */
  130056. update(): void;
  130057. /**
  130058. * Called once for each button that changed state since the last frame
  130059. * @param buttonIdx Which button index changed
  130060. * @param state New state of the button
  130061. * @param changes Which properties on the state changed since last frame
  130062. */
  130063. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  130064. /**
  130065. * Moves the buttons on the controller mesh based on their current state
  130066. * @param buttonName the name of the button to move
  130067. * @param buttonValue the value of the button which determines the buttons new position
  130068. */
  130069. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  130070. /**
  130071. * Moves the axis on the controller mesh based on its current state
  130072. * @param axis the index of the axis
  130073. * @param axisValue the value of the axis which determines the meshes new position
  130074. * @hidden
  130075. */
  130076. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  130077. /**
  130078. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  130079. * @param scene scene in which to add meshes
  130080. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  130081. */
  130082. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  130083. /**
  130084. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  130085. * can be transformed by button presses and axes values, based on this._mapping.
  130086. *
  130087. * @param scene scene in which the meshes exist
  130088. * @param meshes list of meshes that make up the controller model to process
  130089. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  130090. */
  130091. private processModel;
  130092. private createMeshInfo;
  130093. /**
  130094. * Gets the ray of the controller in the direction the controller is pointing
  130095. * @param length the length the resulting ray should be
  130096. * @returns a ray in the direction the controller is pointing
  130097. */
  130098. getForwardRay(length?: number): Ray;
  130099. /**
  130100. * Disposes of the controller
  130101. */
  130102. dispose(): void;
  130103. }
  130104. /**
  130105. * This class represents a new windows motion controller in XR.
  130106. */
  130107. export class XRWindowsMotionController extends WindowsMotionController {
  130108. /**
  130109. * Changing the original WIndowsMotionController mapping to fir the new mapping
  130110. */
  130111. protected readonly _mapping: {
  130112. buttons: string[];
  130113. buttonMeshNames: {
  130114. trigger: string;
  130115. menu: string;
  130116. grip: string;
  130117. thumbstick: string;
  130118. trackpad: string;
  130119. };
  130120. buttonObservableNames: {
  130121. trigger: string;
  130122. menu: string;
  130123. grip: string;
  130124. thumbstick: string;
  130125. trackpad: string;
  130126. };
  130127. axisMeshNames: string[];
  130128. pointingPoseMeshName: string;
  130129. };
  130130. /**
  130131. * Construct a new XR-Based windows motion controller
  130132. *
  130133. * @param gamepadInfo the gamepad object from the browser
  130134. */
  130135. constructor(gamepadInfo: any);
  130136. /**
  130137. * holds the thumbstick values (X,Y)
  130138. */
  130139. thumbstickValues: StickValues;
  130140. /**
  130141. * Fired when the thumbstick on this controller is clicked
  130142. */
  130143. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  130144. /**
  130145. * Fired when the thumbstick on this controller is modified
  130146. */
  130147. onThumbstickValuesChangedObservable: Observable<StickValues>;
  130148. /**
  130149. * Fired when the touchpad button on this controller is modified
  130150. */
  130151. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  130152. /**
  130153. * Fired when the touchpad values on this controller are modified
  130154. */
  130155. onTrackpadValuesChangedObservable: Observable<StickValues>;
  130156. /**
  130157. * Fired when the thumbstick button on this controller is modified
  130158. * here to prevent breaking changes
  130159. */
  130160. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  130161. /**
  130162. * updating the thumbstick(!) and not the trackpad.
  130163. * This is named this way due to the difference between WebVR and XR and to avoid
  130164. * changing the parent class.
  130165. */
  130166. protected _updateTrackpad(): void;
  130167. /**
  130168. * Disposes the class with joy
  130169. */
  130170. dispose(): void;
  130171. }
  130172. }
  130173. declare module BABYLON {
  130174. /**
  130175. * Class containing static functions to help procedurally build meshes
  130176. */
  130177. export class PolyhedronBuilder {
  130178. /**
  130179. * Creates a polyhedron mesh
  130180. * * 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
  130181. * * The parameter `size` (positive float, default 1) sets the polygon size
  130182. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  130183. * * 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`
  130184. * * 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
  130185. * * 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)`)
  130186. * * 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
  130187. * * 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
  130188. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130189. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130190. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130191. * @param name defines the name of the mesh
  130192. * @param options defines the options used to create the mesh
  130193. * @param scene defines the hosting scene
  130194. * @returns the polyhedron mesh
  130195. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  130196. */
  130197. static CreatePolyhedron(name: string, options: {
  130198. type?: number;
  130199. size?: number;
  130200. sizeX?: number;
  130201. sizeY?: number;
  130202. sizeZ?: number;
  130203. custom?: any;
  130204. faceUV?: Vector4[];
  130205. faceColors?: Color4[];
  130206. flat?: boolean;
  130207. updatable?: boolean;
  130208. sideOrientation?: number;
  130209. frontUVs?: Vector4;
  130210. backUVs?: Vector4;
  130211. }, scene?: Nullable<Scene>): Mesh;
  130212. }
  130213. }
  130214. declare module BABYLON {
  130215. /**
  130216. * Gizmo that enables scaling a mesh along 3 axis
  130217. */
  130218. export class ScaleGizmo extends Gizmo {
  130219. /**
  130220. * Internal gizmo used for interactions on the x axis
  130221. */
  130222. xGizmo: AxisScaleGizmo;
  130223. /**
  130224. * Internal gizmo used for interactions on the y axis
  130225. */
  130226. yGizmo: AxisScaleGizmo;
  130227. /**
  130228. * Internal gizmo used for interactions on the z axis
  130229. */
  130230. zGizmo: AxisScaleGizmo;
  130231. /**
  130232. * Internal gizmo used to scale all axis equally
  130233. */
  130234. uniformScaleGizmo: AxisScaleGizmo;
  130235. private _meshAttached;
  130236. private _updateGizmoRotationToMatchAttachedMesh;
  130237. private _snapDistance;
  130238. private _scaleRatio;
  130239. private _uniformScalingMesh;
  130240. private _octahedron;
  130241. private _sensitivity;
  130242. /** Fires an event when any of it's sub gizmos are dragged */
  130243. onDragStartObservable: Observable<unknown>;
  130244. /** Fires an event when any of it's sub gizmos are released from dragging */
  130245. onDragEndObservable: Observable<unknown>;
  130246. get attachedMesh(): Nullable<AbstractMesh>;
  130247. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130248. /**
  130249. * Creates a ScaleGizmo
  130250. * @param gizmoLayer The utility layer the gizmo will be added to
  130251. */
  130252. constructor(gizmoLayer?: UtilityLayerRenderer);
  130253. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130254. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130255. /**
  130256. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130257. */
  130258. set snapDistance(value: number);
  130259. get snapDistance(): number;
  130260. /**
  130261. * Ratio for the scale of the gizmo (Default: 1)
  130262. */
  130263. set scaleRatio(value: number);
  130264. get scaleRatio(): number;
  130265. /**
  130266. * Sensitivity factor for dragging (Default: 1)
  130267. */
  130268. set sensitivity(value: number);
  130269. get sensitivity(): number;
  130270. /**
  130271. * Disposes of the gizmo
  130272. */
  130273. dispose(): void;
  130274. }
  130275. }
  130276. declare module BABYLON {
  130277. /**
  130278. * Single axis scale gizmo
  130279. */
  130280. export class AxisScaleGizmo extends Gizmo {
  130281. /**
  130282. * Drag behavior responsible for the gizmos dragging interactions
  130283. */
  130284. dragBehavior: PointerDragBehavior;
  130285. private _pointerObserver;
  130286. /**
  130287. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130288. */
  130289. snapDistance: number;
  130290. /**
  130291. * Event that fires each time the gizmo snaps to a new location.
  130292. * * snapDistance is the the change in distance
  130293. */
  130294. onSnapObservable: Observable<{
  130295. snapDistance: number;
  130296. }>;
  130297. /**
  130298. * If the scaling operation should be done on all axis (default: false)
  130299. */
  130300. uniformScaling: boolean;
  130301. /**
  130302. * Custom sensitivity value for the drag strength
  130303. */
  130304. sensitivity: number;
  130305. private _isEnabled;
  130306. private _parent;
  130307. private _arrow;
  130308. private _coloredMaterial;
  130309. private _hoverMaterial;
  130310. /**
  130311. * Creates an AxisScaleGizmo
  130312. * @param gizmoLayer The utility layer the gizmo will be added to
  130313. * @param dragAxis The axis which the gizmo will be able to scale on
  130314. * @param color The color of the gizmo
  130315. */
  130316. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  130317. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  130318. /**
  130319. * If the gizmo is enabled
  130320. */
  130321. set isEnabled(value: boolean);
  130322. get isEnabled(): boolean;
  130323. /**
  130324. * Disposes of the gizmo
  130325. */
  130326. dispose(): void;
  130327. /**
  130328. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  130329. * @param mesh The mesh to replace the default mesh of the gizmo
  130330. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  130331. */
  130332. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  130333. }
  130334. }
  130335. declare module BABYLON {
  130336. /**
  130337. * Bounding box gizmo
  130338. */
  130339. export class BoundingBoxGizmo extends Gizmo {
  130340. private _lineBoundingBox;
  130341. private _rotateSpheresParent;
  130342. private _scaleBoxesParent;
  130343. private _boundingDimensions;
  130344. private _renderObserver;
  130345. private _pointerObserver;
  130346. private _scaleDragSpeed;
  130347. private _tmpQuaternion;
  130348. private _tmpVector;
  130349. private _tmpRotationMatrix;
  130350. /**
  130351. * 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)
  130352. */
  130353. ignoreChildren: boolean;
  130354. /**
  130355. * 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)
  130356. */
  130357. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  130358. /**
  130359. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  130360. */
  130361. rotationSphereSize: number;
  130362. /**
  130363. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  130364. */
  130365. scaleBoxSize: number;
  130366. /**
  130367. * 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)
  130368. */
  130369. fixedDragMeshScreenSize: boolean;
  130370. /**
  130371. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  130372. */
  130373. fixedDragMeshScreenSizeDistanceFactor: number;
  130374. /**
  130375. * Fired when a rotation sphere or scale box is dragged
  130376. */
  130377. onDragStartObservable: Observable<{}>;
  130378. /**
  130379. * Fired when a scale box is dragged
  130380. */
  130381. onScaleBoxDragObservable: Observable<{}>;
  130382. /**
  130383. * Fired when a scale box drag is ended
  130384. */
  130385. onScaleBoxDragEndObservable: Observable<{}>;
  130386. /**
  130387. * Fired when a rotation sphere is dragged
  130388. */
  130389. onRotationSphereDragObservable: Observable<{}>;
  130390. /**
  130391. * Fired when a rotation sphere drag is ended
  130392. */
  130393. onRotationSphereDragEndObservable: Observable<{}>;
  130394. /**
  130395. * 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)
  130396. */
  130397. scalePivot: Nullable<Vector3>;
  130398. /**
  130399. * Mesh used as a pivot to rotate the attached mesh
  130400. */
  130401. private _anchorMesh;
  130402. private _existingMeshScale;
  130403. private _dragMesh;
  130404. private pointerDragBehavior;
  130405. private coloredMaterial;
  130406. private hoverColoredMaterial;
  130407. /**
  130408. * Sets the color of the bounding box gizmo
  130409. * @param color the color to set
  130410. */
  130411. setColor(color: Color3): void;
  130412. /**
  130413. * Creates an BoundingBoxGizmo
  130414. * @param gizmoLayer The utility layer the gizmo will be added to
  130415. * @param color The color of the gizmo
  130416. */
  130417. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  130418. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  130419. private _selectNode;
  130420. /**
  130421. * Updates the bounding box information for the Gizmo
  130422. */
  130423. updateBoundingBox(): void;
  130424. private _updateRotationSpheres;
  130425. private _updateScaleBoxes;
  130426. /**
  130427. * Enables rotation on the specified axis and disables rotation on the others
  130428. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  130429. */
  130430. setEnabledRotationAxis(axis: string): void;
  130431. /**
  130432. * Enables/disables scaling
  130433. * @param enable if scaling should be enabled
  130434. * @param homogeneousScaling defines if scaling should only be homogeneous
  130435. */
  130436. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  130437. private _updateDummy;
  130438. /**
  130439. * Enables a pointer drag behavior on the bounding box of the gizmo
  130440. */
  130441. enableDragBehavior(): void;
  130442. /**
  130443. * Disposes of the gizmo
  130444. */
  130445. dispose(): void;
  130446. /**
  130447. * 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)
  130448. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  130449. * @returns the bounding box mesh with the passed in mesh as a child
  130450. */
  130451. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  130452. /**
  130453. * CustomMeshes are not supported by this gizmo
  130454. * @param mesh The mesh to replace the default mesh of the gizmo
  130455. */
  130456. setCustomMesh(mesh: Mesh): void;
  130457. }
  130458. }
  130459. declare module BABYLON {
  130460. /**
  130461. * Single plane rotation gizmo
  130462. */
  130463. export class PlaneRotationGizmo extends Gizmo {
  130464. /**
  130465. * Drag behavior responsible for the gizmos dragging interactions
  130466. */
  130467. dragBehavior: PointerDragBehavior;
  130468. private _pointerObserver;
  130469. /**
  130470. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  130471. */
  130472. snapDistance: number;
  130473. /**
  130474. * Event that fires each time the gizmo snaps to a new location.
  130475. * * snapDistance is the the change in distance
  130476. */
  130477. onSnapObservable: Observable<{
  130478. snapDistance: number;
  130479. }>;
  130480. private _isEnabled;
  130481. private _parent;
  130482. /**
  130483. * Creates a PlaneRotationGizmo
  130484. * @param gizmoLayer The utility layer the gizmo will be added to
  130485. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  130486. * @param color The color of the gizmo
  130487. * @param tessellation Amount of tessellation to be used when creating rotation circles
  130488. * @param useEulerRotation Use and update Euler angle instead of quaternion
  130489. */
  130490. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  130491. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  130492. /**
  130493. * If the gizmo is enabled
  130494. */
  130495. set isEnabled(value: boolean);
  130496. get isEnabled(): boolean;
  130497. /**
  130498. * Disposes of the gizmo
  130499. */
  130500. dispose(): void;
  130501. }
  130502. }
  130503. declare module BABYLON {
  130504. /**
  130505. * Gizmo that enables rotating a mesh along 3 axis
  130506. */
  130507. export class RotationGizmo extends Gizmo {
  130508. /**
  130509. * Internal gizmo used for interactions on the x axis
  130510. */
  130511. xGizmo: PlaneRotationGizmo;
  130512. /**
  130513. * Internal gizmo used for interactions on the y axis
  130514. */
  130515. yGizmo: PlaneRotationGizmo;
  130516. /**
  130517. * Internal gizmo used for interactions on the z axis
  130518. */
  130519. zGizmo: PlaneRotationGizmo;
  130520. /** Fires an event when any of it's sub gizmos are dragged */
  130521. onDragStartObservable: Observable<unknown>;
  130522. /** Fires an event when any of it's sub gizmos are released from dragging */
  130523. onDragEndObservable: Observable<unknown>;
  130524. private _meshAttached;
  130525. get attachedMesh(): Nullable<AbstractMesh>;
  130526. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130527. /**
  130528. * Creates a RotationGizmo
  130529. * @param gizmoLayer The utility layer the gizmo will be added to
  130530. * @param tessellation Amount of tessellation to be used when creating rotation circles
  130531. * @param useEulerRotation Use and update Euler angle instead of quaternion
  130532. */
  130533. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  130534. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130535. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130536. /**
  130537. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130538. */
  130539. set snapDistance(value: number);
  130540. get snapDistance(): number;
  130541. /**
  130542. * Ratio for the scale of the gizmo (Default: 1)
  130543. */
  130544. set scaleRatio(value: number);
  130545. get scaleRatio(): number;
  130546. /**
  130547. * Disposes of the gizmo
  130548. */
  130549. dispose(): void;
  130550. /**
  130551. * CustomMeshes are not supported by this gizmo
  130552. * @param mesh The mesh to replace the default mesh of the gizmo
  130553. */
  130554. setCustomMesh(mesh: Mesh): void;
  130555. }
  130556. }
  130557. declare module BABYLON {
  130558. /**
  130559. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  130560. */
  130561. export class GizmoManager implements IDisposable {
  130562. private scene;
  130563. /**
  130564. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  130565. */
  130566. gizmos: {
  130567. positionGizmo: Nullable<PositionGizmo>;
  130568. rotationGizmo: Nullable<RotationGizmo>;
  130569. scaleGizmo: Nullable<ScaleGizmo>;
  130570. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  130571. };
  130572. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  130573. clearGizmoOnEmptyPointerEvent: boolean;
  130574. /** Fires an event when the manager is attached to a mesh */
  130575. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  130576. private _gizmosEnabled;
  130577. private _pointerObserver;
  130578. private _attachedMesh;
  130579. private _boundingBoxColor;
  130580. private _defaultUtilityLayer;
  130581. private _defaultKeepDepthUtilityLayer;
  130582. /**
  130583. * When bounding box gizmo is enabled, this can be used to track drag/end events
  130584. */
  130585. boundingBoxDragBehavior: SixDofDragBehavior;
  130586. /**
  130587. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  130588. */
  130589. attachableMeshes: Nullable<Array<AbstractMesh>>;
  130590. /**
  130591. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  130592. */
  130593. usePointerToAttachGizmos: boolean;
  130594. /**
  130595. * Utility layer that the bounding box gizmo belongs to
  130596. */
  130597. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  130598. /**
  130599. * Utility layer that all gizmos besides bounding box belong to
  130600. */
  130601. get utilityLayer(): UtilityLayerRenderer;
  130602. /**
  130603. * Instatiates a gizmo manager
  130604. * @param scene the scene to overlay the gizmos on top of
  130605. */
  130606. constructor(scene: Scene);
  130607. /**
  130608. * Attaches a set of gizmos to the specified mesh
  130609. * @param mesh The mesh the gizmo's should be attached to
  130610. */
  130611. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  130612. /**
  130613. * If the position gizmo is enabled
  130614. */
  130615. set positionGizmoEnabled(value: boolean);
  130616. get positionGizmoEnabled(): boolean;
  130617. /**
  130618. * If the rotation gizmo is enabled
  130619. */
  130620. set rotationGizmoEnabled(value: boolean);
  130621. get rotationGizmoEnabled(): boolean;
  130622. /**
  130623. * If the scale gizmo is enabled
  130624. */
  130625. set scaleGizmoEnabled(value: boolean);
  130626. get scaleGizmoEnabled(): boolean;
  130627. /**
  130628. * If the boundingBox gizmo is enabled
  130629. */
  130630. set boundingBoxGizmoEnabled(value: boolean);
  130631. get boundingBoxGizmoEnabled(): boolean;
  130632. /**
  130633. * Disposes of the gizmo manager
  130634. */
  130635. dispose(): void;
  130636. }
  130637. }
  130638. declare module BABYLON {
  130639. /**
  130640. * A directional light is defined by a direction (what a surprise!).
  130641. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  130642. * 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.
  130643. * Documentation: https://doc.babylonjs.com/babylon101/lights
  130644. */
  130645. export class DirectionalLight extends ShadowLight {
  130646. private _shadowFrustumSize;
  130647. /**
  130648. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  130649. */
  130650. get shadowFrustumSize(): number;
  130651. /**
  130652. * Specifies a fix frustum size for the shadow generation.
  130653. */
  130654. set shadowFrustumSize(value: number);
  130655. private _shadowOrthoScale;
  130656. /**
  130657. * Gets the shadow projection scale against the optimal computed one.
  130658. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  130659. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  130660. */
  130661. get shadowOrthoScale(): number;
  130662. /**
  130663. * Sets the shadow projection scale against the optimal computed one.
  130664. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  130665. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  130666. */
  130667. set shadowOrthoScale(value: number);
  130668. /**
  130669. * Automatically compute the projection matrix to best fit (including all the casters)
  130670. * on each frame.
  130671. */
  130672. autoUpdateExtends: boolean;
  130673. /**
  130674. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  130675. * on each frame. autoUpdateExtends must be set to true for this to work
  130676. */
  130677. autoCalcShadowZBounds: boolean;
  130678. private _orthoLeft;
  130679. private _orthoRight;
  130680. private _orthoTop;
  130681. private _orthoBottom;
  130682. /**
  130683. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  130684. * The directional light is emitted from everywhere in the given direction.
  130685. * It can cast shadows.
  130686. * Documentation : https://doc.babylonjs.com/babylon101/lights
  130687. * @param name The friendly name of the light
  130688. * @param direction The direction of the light
  130689. * @param scene The scene the light belongs to
  130690. */
  130691. constructor(name: string, direction: Vector3, scene: Scene);
  130692. /**
  130693. * Returns the string "DirectionalLight".
  130694. * @return The class name
  130695. */
  130696. getClassName(): string;
  130697. /**
  130698. * Returns the integer 1.
  130699. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  130700. */
  130701. getTypeID(): number;
  130702. /**
  130703. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  130704. * Returns the DirectionalLight Shadow projection matrix.
  130705. */
  130706. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  130707. /**
  130708. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  130709. * Returns the DirectionalLight Shadow projection matrix.
  130710. */
  130711. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  130712. /**
  130713. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  130714. * Returns the DirectionalLight Shadow projection matrix.
  130715. */
  130716. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  130717. protected _buildUniformLayout(): void;
  130718. /**
  130719. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  130720. * @param effect The effect to update
  130721. * @param lightIndex The index of the light in the effect to update
  130722. * @returns The directional light
  130723. */
  130724. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  130725. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  130726. /**
  130727. * Gets the minZ used for shadow according to both the scene and the light.
  130728. *
  130729. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  130730. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  130731. * @param activeCamera The camera we are returning the min for
  130732. * @returns the depth min z
  130733. */
  130734. getDepthMinZ(activeCamera: Camera): number;
  130735. /**
  130736. * Gets the maxZ used for shadow according to both the scene and the light.
  130737. *
  130738. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  130739. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  130740. * @param activeCamera The camera we are returning the max for
  130741. * @returns the depth max z
  130742. */
  130743. getDepthMaxZ(activeCamera: Camera): number;
  130744. /**
  130745. * Prepares the list of defines specific to the light type.
  130746. * @param defines the list of defines
  130747. * @param lightIndex defines the index of the light for the effect
  130748. */
  130749. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  130750. }
  130751. }
  130752. declare module BABYLON {
  130753. /**
  130754. * Class containing static functions to help procedurally build meshes
  130755. */
  130756. export class HemisphereBuilder {
  130757. /**
  130758. * Creates a hemisphere mesh
  130759. * @param name defines the name of the mesh
  130760. * @param options defines the options used to create the mesh
  130761. * @param scene defines the hosting scene
  130762. * @returns the hemisphere mesh
  130763. */
  130764. static CreateHemisphere(name: string, options: {
  130765. segments?: number;
  130766. diameter?: number;
  130767. sideOrientation?: number;
  130768. }, scene: any): Mesh;
  130769. }
  130770. }
  130771. declare module BABYLON {
  130772. /**
  130773. * A spot light is defined by a position, a direction, an angle, and an exponent.
  130774. * These values define a cone of light starting from the position, emitting toward the direction.
  130775. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  130776. * and the exponent defines the speed of the decay of the light with distance (reach).
  130777. * Documentation: https://doc.babylonjs.com/babylon101/lights
  130778. */
  130779. export class SpotLight extends ShadowLight {
  130780. private _angle;
  130781. private _innerAngle;
  130782. private _cosHalfAngle;
  130783. private _lightAngleScale;
  130784. private _lightAngleOffset;
  130785. /**
  130786. * Gets the cone angle of the spot light in Radians.
  130787. */
  130788. get angle(): number;
  130789. /**
  130790. * Sets the cone angle of the spot light in Radians.
  130791. */
  130792. set angle(value: number);
  130793. /**
  130794. * Only used in gltf falloff mode, this defines the angle where
  130795. * the directional falloff will start before cutting at angle which could be seen
  130796. * as outer angle.
  130797. */
  130798. get innerAngle(): number;
  130799. /**
  130800. * Only used in gltf falloff mode, this defines the angle where
  130801. * the directional falloff will start before cutting at angle which could be seen
  130802. * as outer angle.
  130803. */
  130804. set innerAngle(value: number);
  130805. private _shadowAngleScale;
  130806. /**
  130807. * Allows scaling the angle of the light for shadow generation only.
  130808. */
  130809. get shadowAngleScale(): number;
  130810. /**
  130811. * Allows scaling the angle of the light for shadow generation only.
  130812. */
  130813. set shadowAngleScale(value: number);
  130814. /**
  130815. * The light decay speed with the distance from the emission spot.
  130816. */
  130817. exponent: number;
  130818. private _projectionTextureMatrix;
  130819. /**
  130820. * Allows reading the projecton texture
  130821. */
  130822. get projectionTextureMatrix(): Matrix;
  130823. protected _projectionTextureLightNear: number;
  130824. /**
  130825. * Gets the near clip of the Spotlight for texture projection.
  130826. */
  130827. get projectionTextureLightNear(): number;
  130828. /**
  130829. * Sets the near clip of the Spotlight for texture projection.
  130830. */
  130831. set projectionTextureLightNear(value: number);
  130832. protected _projectionTextureLightFar: number;
  130833. /**
  130834. * Gets the far clip of the Spotlight for texture projection.
  130835. */
  130836. get projectionTextureLightFar(): number;
  130837. /**
  130838. * Sets the far clip of the Spotlight for texture projection.
  130839. */
  130840. set projectionTextureLightFar(value: number);
  130841. protected _projectionTextureUpDirection: Vector3;
  130842. /**
  130843. * Gets the Up vector of the Spotlight for texture projection.
  130844. */
  130845. get projectionTextureUpDirection(): Vector3;
  130846. /**
  130847. * Sets the Up vector of the Spotlight for texture projection.
  130848. */
  130849. set projectionTextureUpDirection(value: Vector3);
  130850. private _projectionTexture;
  130851. /**
  130852. * Gets the projection texture of the light.
  130853. */
  130854. get projectionTexture(): Nullable<BaseTexture>;
  130855. /**
  130856. * Sets the projection texture of the light.
  130857. */
  130858. set projectionTexture(value: Nullable<BaseTexture>);
  130859. private _projectionTextureViewLightDirty;
  130860. private _projectionTextureProjectionLightDirty;
  130861. private _projectionTextureDirty;
  130862. private _projectionTextureViewTargetVector;
  130863. private _projectionTextureViewLightMatrix;
  130864. private _projectionTextureProjectionLightMatrix;
  130865. private _projectionTextureScalingMatrix;
  130866. /**
  130867. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  130868. * It can cast shadows.
  130869. * Documentation : https://doc.babylonjs.com/babylon101/lights
  130870. * @param name The light friendly name
  130871. * @param position The position of the spot light in the scene
  130872. * @param direction The direction of the light in the scene
  130873. * @param angle The cone angle of the light in Radians
  130874. * @param exponent The light decay speed with the distance from the emission spot
  130875. * @param scene The scene the lights belongs to
  130876. */
  130877. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  130878. /**
  130879. * Returns the string "SpotLight".
  130880. * @returns the class name
  130881. */
  130882. getClassName(): string;
  130883. /**
  130884. * Returns the integer 2.
  130885. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  130886. */
  130887. getTypeID(): number;
  130888. /**
  130889. * Overrides the direction setter to recompute the projection texture view light Matrix.
  130890. */
  130891. protected _setDirection(value: Vector3): void;
  130892. /**
  130893. * Overrides the position setter to recompute the projection texture view light Matrix.
  130894. */
  130895. protected _setPosition(value: Vector3): void;
  130896. /**
  130897. * 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.
  130898. * Returns the SpotLight.
  130899. */
  130900. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  130901. protected _computeProjectionTextureViewLightMatrix(): void;
  130902. protected _computeProjectionTextureProjectionLightMatrix(): void;
  130903. /**
  130904. * Main function for light texture projection matrix computing.
  130905. */
  130906. protected _computeProjectionTextureMatrix(): void;
  130907. protected _buildUniformLayout(): void;
  130908. private _computeAngleValues;
  130909. /**
  130910. * Sets the passed Effect "effect" with the Light textures.
  130911. * @param effect The effect to update
  130912. * @param lightIndex The index of the light in the effect to update
  130913. * @returns The light
  130914. */
  130915. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  130916. /**
  130917. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  130918. * @param effect The effect to update
  130919. * @param lightIndex The index of the light in the effect to update
  130920. * @returns The spot light
  130921. */
  130922. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  130923. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  130924. /**
  130925. * Disposes the light and the associated resources.
  130926. */
  130927. dispose(): void;
  130928. /**
  130929. * Prepares the list of defines specific to the light type.
  130930. * @param defines the list of defines
  130931. * @param lightIndex defines the index of the light for the effect
  130932. */
  130933. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  130934. }
  130935. }
  130936. declare module BABYLON {
  130937. /**
  130938. * Gizmo that enables viewing a light
  130939. */
  130940. export class LightGizmo extends Gizmo {
  130941. private _lightMesh;
  130942. private _material;
  130943. private _cachedPosition;
  130944. private _cachedForward;
  130945. private _attachedMeshParent;
  130946. /**
  130947. * Creates a LightGizmo
  130948. * @param gizmoLayer The utility layer the gizmo will be added to
  130949. */
  130950. constructor(gizmoLayer?: UtilityLayerRenderer);
  130951. private _light;
  130952. /**
  130953. * The light that the gizmo is attached to
  130954. */
  130955. set light(light: Nullable<Light>);
  130956. get light(): Nullable<Light>;
  130957. /**
  130958. * Gets the material used to render the light gizmo
  130959. */
  130960. get material(): StandardMaterial;
  130961. /**
  130962. * @hidden
  130963. * Updates the gizmo to match the attached mesh's position/rotation
  130964. */
  130965. protected _update(): void;
  130966. private static _Scale;
  130967. /**
  130968. * Creates the lines for a light mesh
  130969. */
  130970. private static _CreateLightLines;
  130971. /**
  130972. * Disposes of the light gizmo
  130973. */
  130974. dispose(): void;
  130975. private static _CreateHemisphericLightMesh;
  130976. private static _CreatePointLightMesh;
  130977. private static _CreateSpotLightMesh;
  130978. private static _CreateDirectionalLightMesh;
  130979. }
  130980. }
  130981. declare module BABYLON {
  130982. /** @hidden */
  130983. export var backgroundFragmentDeclaration: {
  130984. name: string;
  130985. shader: string;
  130986. };
  130987. }
  130988. declare module BABYLON {
  130989. /** @hidden */
  130990. export var backgroundUboDeclaration: {
  130991. name: string;
  130992. shader: string;
  130993. };
  130994. }
  130995. declare module BABYLON {
  130996. /** @hidden */
  130997. export var backgroundPixelShader: {
  130998. name: string;
  130999. shader: string;
  131000. };
  131001. }
  131002. declare module BABYLON {
  131003. /** @hidden */
  131004. export var backgroundVertexDeclaration: {
  131005. name: string;
  131006. shader: string;
  131007. };
  131008. }
  131009. declare module BABYLON {
  131010. /** @hidden */
  131011. export var backgroundVertexShader: {
  131012. name: string;
  131013. shader: string;
  131014. };
  131015. }
  131016. declare module BABYLON {
  131017. /**
  131018. * Background material used to create an efficient environement around your scene.
  131019. */
  131020. export class BackgroundMaterial extends PushMaterial {
  131021. /**
  131022. * Standard reflectance value at parallel view angle.
  131023. */
  131024. static StandardReflectance0: number;
  131025. /**
  131026. * Standard reflectance value at grazing angle.
  131027. */
  131028. static StandardReflectance90: number;
  131029. protected _primaryColor: Color3;
  131030. /**
  131031. * Key light Color (multiply against the environement texture)
  131032. */
  131033. primaryColor: Color3;
  131034. protected __perceptualColor: Nullable<Color3>;
  131035. /**
  131036. * Experimental Internal Use Only.
  131037. *
  131038. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  131039. * This acts as a helper to set the primary color to a more "human friendly" value.
  131040. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  131041. * output color as close as possible from the chosen value.
  131042. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  131043. * part of lighting setup.)
  131044. */
  131045. get _perceptualColor(): Nullable<Color3>;
  131046. set _perceptualColor(value: Nullable<Color3>);
  131047. protected _primaryColorShadowLevel: float;
  131048. /**
  131049. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  131050. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  131051. */
  131052. get primaryColorShadowLevel(): float;
  131053. set primaryColorShadowLevel(value: float);
  131054. protected _primaryColorHighlightLevel: float;
  131055. /**
  131056. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  131057. * The primary color is used at the level chosen to define what the white area would look.
  131058. */
  131059. get primaryColorHighlightLevel(): float;
  131060. set primaryColorHighlightLevel(value: float);
  131061. protected _reflectionTexture: Nullable<BaseTexture>;
  131062. /**
  131063. * Reflection Texture used in the material.
  131064. * Should be author in a specific way for the best result (refer to the documentation).
  131065. */
  131066. reflectionTexture: Nullable<BaseTexture>;
  131067. protected _reflectionBlur: float;
  131068. /**
  131069. * Reflection Texture level of blur.
  131070. *
  131071. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  131072. * texture twice.
  131073. */
  131074. reflectionBlur: float;
  131075. protected _diffuseTexture: Nullable<BaseTexture>;
  131076. /**
  131077. * Diffuse Texture used in the material.
  131078. * Should be author in a specific way for the best result (refer to the documentation).
  131079. */
  131080. diffuseTexture: Nullable<BaseTexture>;
  131081. protected _shadowLights: Nullable<IShadowLight[]>;
  131082. /**
  131083. * Specify the list of lights casting shadow on the material.
  131084. * All scene shadow lights will be included if null.
  131085. */
  131086. shadowLights: Nullable<IShadowLight[]>;
  131087. protected _shadowLevel: float;
  131088. /**
  131089. * Helps adjusting the shadow to a softer level if required.
  131090. * 0 means black shadows and 1 means no shadows.
  131091. */
  131092. shadowLevel: float;
  131093. protected _sceneCenter: Vector3;
  131094. /**
  131095. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  131096. * It is usually zero but might be interesting to modify according to your setup.
  131097. */
  131098. sceneCenter: Vector3;
  131099. protected _opacityFresnel: boolean;
  131100. /**
  131101. * This helps specifying that the material is falling off to the sky box at grazing angle.
  131102. * This helps ensuring a nice transition when the camera goes under the ground.
  131103. */
  131104. opacityFresnel: boolean;
  131105. protected _reflectionFresnel: boolean;
  131106. /**
  131107. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  131108. * This helps adding a mirror texture on the ground.
  131109. */
  131110. reflectionFresnel: boolean;
  131111. protected _reflectionFalloffDistance: number;
  131112. /**
  131113. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  131114. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  131115. */
  131116. reflectionFalloffDistance: number;
  131117. protected _reflectionAmount: number;
  131118. /**
  131119. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  131120. */
  131121. reflectionAmount: number;
  131122. protected _reflectionReflectance0: number;
  131123. /**
  131124. * This specifies the weight of the reflection at grazing angle.
  131125. */
  131126. reflectionReflectance0: number;
  131127. protected _reflectionReflectance90: number;
  131128. /**
  131129. * This specifies the weight of the reflection at a perpendicular point of view.
  131130. */
  131131. reflectionReflectance90: number;
  131132. /**
  131133. * Sets the reflection reflectance fresnel values according to the default standard
  131134. * empirically know to work well :-)
  131135. */
  131136. set reflectionStandardFresnelWeight(value: number);
  131137. protected _useRGBColor: boolean;
  131138. /**
  131139. * Helps to directly use the maps channels instead of their level.
  131140. */
  131141. useRGBColor: boolean;
  131142. protected _enableNoise: boolean;
  131143. /**
  131144. * This helps reducing the banding effect that could occur on the background.
  131145. */
  131146. enableNoise: boolean;
  131147. /**
  131148. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  131149. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  131150. * Recommended to be keep at 1.0 except for special cases.
  131151. */
  131152. get fovMultiplier(): number;
  131153. set fovMultiplier(value: number);
  131154. private _fovMultiplier;
  131155. /**
  131156. * Enable the FOV adjustment feature controlled by fovMultiplier.
  131157. */
  131158. useEquirectangularFOV: boolean;
  131159. private _maxSimultaneousLights;
  131160. /**
  131161. * Number of Simultaneous lights allowed on the material.
  131162. */
  131163. maxSimultaneousLights: int;
  131164. /**
  131165. * Default configuration related to image processing available in the Background Material.
  131166. */
  131167. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  131168. /**
  131169. * Keep track of the image processing observer to allow dispose and replace.
  131170. */
  131171. private _imageProcessingObserver;
  131172. /**
  131173. * Attaches a new image processing configuration to the PBR Material.
  131174. * @param configuration (if null the scene configuration will be use)
  131175. */
  131176. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  131177. /**
  131178. * Gets the image processing configuration used either in this material.
  131179. */
  131180. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  131181. /**
  131182. * Sets the Default image processing configuration used either in the this material.
  131183. *
  131184. * If sets to null, the scene one is in use.
  131185. */
  131186. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  131187. /**
  131188. * Gets wether the color curves effect is enabled.
  131189. */
  131190. get cameraColorCurvesEnabled(): boolean;
  131191. /**
  131192. * Sets wether the color curves effect is enabled.
  131193. */
  131194. set cameraColorCurvesEnabled(value: boolean);
  131195. /**
  131196. * Gets wether the color grading effect is enabled.
  131197. */
  131198. get cameraColorGradingEnabled(): boolean;
  131199. /**
  131200. * Gets wether the color grading effect is enabled.
  131201. */
  131202. set cameraColorGradingEnabled(value: boolean);
  131203. /**
  131204. * Gets wether tonemapping is enabled or not.
  131205. */
  131206. get cameraToneMappingEnabled(): boolean;
  131207. /**
  131208. * Sets wether tonemapping is enabled or not
  131209. */
  131210. set cameraToneMappingEnabled(value: boolean);
  131211. /**
  131212. * The camera exposure used on this material.
  131213. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  131214. * This corresponds to a photographic exposure.
  131215. */
  131216. get cameraExposure(): float;
  131217. /**
  131218. * The camera exposure used on this material.
  131219. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  131220. * This corresponds to a photographic exposure.
  131221. */
  131222. set cameraExposure(value: float);
  131223. /**
  131224. * Gets The camera contrast used on this material.
  131225. */
  131226. get cameraContrast(): float;
  131227. /**
  131228. * Sets The camera contrast used on this material.
  131229. */
  131230. set cameraContrast(value: float);
  131231. /**
  131232. * Gets the Color Grading 2D Lookup Texture.
  131233. */
  131234. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  131235. /**
  131236. * Sets the Color Grading 2D Lookup Texture.
  131237. */
  131238. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  131239. /**
  131240. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  131241. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  131242. * 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;
  131243. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  131244. */
  131245. get cameraColorCurves(): Nullable<ColorCurves>;
  131246. /**
  131247. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  131248. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  131249. * 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;
  131250. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  131251. */
  131252. set cameraColorCurves(value: Nullable<ColorCurves>);
  131253. /**
  131254. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  131255. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  131256. */
  131257. switchToBGR: boolean;
  131258. private _renderTargets;
  131259. private _reflectionControls;
  131260. private _white;
  131261. private _primaryShadowColor;
  131262. private _primaryHighlightColor;
  131263. /**
  131264. * Instantiates a Background Material in the given scene
  131265. * @param name The friendly name of the material
  131266. * @param scene The scene to add the material to
  131267. */
  131268. constructor(name: string, scene: Scene);
  131269. /**
  131270. * Gets a boolean indicating that current material needs to register RTT
  131271. */
  131272. get hasRenderTargetTextures(): boolean;
  131273. /**
  131274. * The entire material has been created in order to prevent overdraw.
  131275. * @returns false
  131276. */
  131277. needAlphaTesting(): boolean;
  131278. /**
  131279. * The entire material has been created in order to prevent overdraw.
  131280. * @returns true if blending is enable
  131281. */
  131282. needAlphaBlending(): boolean;
  131283. /**
  131284. * Checks wether the material is ready to be rendered for a given mesh.
  131285. * @param mesh The mesh to render
  131286. * @param subMesh The submesh to check against
  131287. * @param useInstances Specify wether or not the material is used with instances
  131288. * @returns true if all the dependencies are ready (Textures, Effects...)
  131289. */
  131290. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  131291. /**
  131292. * Compute the primary color according to the chosen perceptual color.
  131293. */
  131294. private _computePrimaryColorFromPerceptualColor;
  131295. /**
  131296. * Compute the highlights and shadow colors according to their chosen levels.
  131297. */
  131298. private _computePrimaryColors;
  131299. /**
  131300. * Build the uniform buffer used in the material.
  131301. */
  131302. buildUniformLayout(): void;
  131303. /**
  131304. * Unbind the material.
  131305. */
  131306. unbind(): void;
  131307. /**
  131308. * Bind only the world matrix to the material.
  131309. * @param world The world matrix to bind.
  131310. */
  131311. bindOnlyWorldMatrix(world: Matrix): void;
  131312. /**
  131313. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  131314. * @param world The world matrix to bind.
  131315. * @param subMesh The submesh to bind for.
  131316. */
  131317. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  131318. /**
  131319. * Checks to see if a texture is used in the material.
  131320. * @param texture - Base texture to use.
  131321. * @returns - Boolean specifying if a texture is used in the material.
  131322. */
  131323. hasTexture(texture: BaseTexture): boolean;
  131324. /**
  131325. * Dispose the material.
  131326. * @param forceDisposeEffect Force disposal of the associated effect.
  131327. * @param forceDisposeTextures Force disposal of the associated textures.
  131328. */
  131329. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  131330. /**
  131331. * Clones the material.
  131332. * @param name The cloned name.
  131333. * @returns The cloned material.
  131334. */
  131335. clone(name: string): BackgroundMaterial;
  131336. /**
  131337. * Serializes the current material to its JSON representation.
  131338. * @returns The JSON representation.
  131339. */
  131340. serialize(): any;
  131341. /**
  131342. * Gets the class name of the material
  131343. * @returns "BackgroundMaterial"
  131344. */
  131345. getClassName(): string;
  131346. /**
  131347. * Parse a JSON input to create back a background material.
  131348. * @param source The JSON data to parse
  131349. * @param scene The scene to create the parsed material in
  131350. * @param rootUrl The root url of the assets the material depends upon
  131351. * @returns the instantiated BackgroundMaterial.
  131352. */
  131353. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  131354. }
  131355. }
  131356. declare module BABYLON {
  131357. /**
  131358. * Represents the different options available during the creation of
  131359. * a Environment helper.
  131360. *
  131361. * This can control the default ground, skybox and image processing setup of your scene.
  131362. */
  131363. export interface IEnvironmentHelperOptions {
  131364. /**
  131365. * Specifies whether or not to create a ground.
  131366. * True by default.
  131367. */
  131368. createGround: boolean;
  131369. /**
  131370. * Specifies the ground size.
  131371. * 15 by default.
  131372. */
  131373. groundSize: number;
  131374. /**
  131375. * The texture used on the ground for the main color.
  131376. * Comes from the BabylonJS CDN by default.
  131377. *
  131378. * Remarks: Can be either a texture or a url.
  131379. */
  131380. groundTexture: string | BaseTexture;
  131381. /**
  131382. * The color mixed in the ground texture by default.
  131383. * BabylonJS clearColor by default.
  131384. */
  131385. groundColor: Color3;
  131386. /**
  131387. * Specifies the ground opacity.
  131388. * 1 by default.
  131389. */
  131390. groundOpacity: number;
  131391. /**
  131392. * Enables the ground to receive shadows.
  131393. * True by default.
  131394. */
  131395. enableGroundShadow: boolean;
  131396. /**
  131397. * Helps preventing the shadow to be fully black on the ground.
  131398. * 0.5 by default.
  131399. */
  131400. groundShadowLevel: number;
  131401. /**
  131402. * Creates a mirror texture attach to the ground.
  131403. * false by default.
  131404. */
  131405. enableGroundMirror: boolean;
  131406. /**
  131407. * Specifies the ground mirror size ratio.
  131408. * 0.3 by default as the default kernel is 64.
  131409. */
  131410. groundMirrorSizeRatio: number;
  131411. /**
  131412. * Specifies the ground mirror blur kernel size.
  131413. * 64 by default.
  131414. */
  131415. groundMirrorBlurKernel: number;
  131416. /**
  131417. * Specifies the ground mirror visibility amount.
  131418. * 1 by default
  131419. */
  131420. groundMirrorAmount: number;
  131421. /**
  131422. * Specifies the ground mirror reflectance weight.
  131423. * This uses the standard weight of the background material to setup the fresnel effect
  131424. * of the mirror.
  131425. * 1 by default.
  131426. */
  131427. groundMirrorFresnelWeight: number;
  131428. /**
  131429. * Specifies the ground mirror Falloff distance.
  131430. * This can helps reducing the size of the reflection.
  131431. * 0 by Default.
  131432. */
  131433. groundMirrorFallOffDistance: number;
  131434. /**
  131435. * Specifies the ground mirror texture type.
  131436. * Unsigned Int by Default.
  131437. */
  131438. groundMirrorTextureType: number;
  131439. /**
  131440. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  131441. * the shown objects.
  131442. */
  131443. groundYBias: number;
  131444. /**
  131445. * Specifies whether or not to create a skybox.
  131446. * True by default.
  131447. */
  131448. createSkybox: boolean;
  131449. /**
  131450. * Specifies the skybox size.
  131451. * 20 by default.
  131452. */
  131453. skyboxSize: number;
  131454. /**
  131455. * The texture used on the skybox for the main color.
  131456. * Comes from the BabylonJS CDN by default.
  131457. *
  131458. * Remarks: Can be either a texture or a url.
  131459. */
  131460. skyboxTexture: string | BaseTexture;
  131461. /**
  131462. * The color mixed in the skybox texture by default.
  131463. * BabylonJS clearColor by default.
  131464. */
  131465. skyboxColor: Color3;
  131466. /**
  131467. * The background rotation around the Y axis of the scene.
  131468. * This helps aligning the key lights of your scene with the background.
  131469. * 0 by default.
  131470. */
  131471. backgroundYRotation: number;
  131472. /**
  131473. * Compute automatically the size of the elements to best fit with the scene.
  131474. */
  131475. sizeAuto: boolean;
  131476. /**
  131477. * Default position of the rootMesh if autoSize is not true.
  131478. */
  131479. rootPosition: Vector3;
  131480. /**
  131481. * Sets up the image processing in the scene.
  131482. * true by default.
  131483. */
  131484. setupImageProcessing: boolean;
  131485. /**
  131486. * The texture used as your environment texture in the scene.
  131487. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  131488. *
  131489. * Remarks: Can be either a texture or a url.
  131490. */
  131491. environmentTexture: string | BaseTexture;
  131492. /**
  131493. * The value of the exposure to apply to the scene.
  131494. * 0.6 by default if setupImageProcessing is true.
  131495. */
  131496. cameraExposure: number;
  131497. /**
  131498. * The value of the contrast to apply to the scene.
  131499. * 1.6 by default if setupImageProcessing is true.
  131500. */
  131501. cameraContrast: number;
  131502. /**
  131503. * Specifies whether or not tonemapping should be enabled in the scene.
  131504. * true by default if setupImageProcessing is true.
  131505. */
  131506. toneMappingEnabled: boolean;
  131507. }
  131508. /**
  131509. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  131510. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  131511. * It also helps with the default setup of your imageProcessing configuration.
  131512. */
  131513. export class EnvironmentHelper {
  131514. /**
  131515. * Default ground texture URL.
  131516. */
  131517. private static _groundTextureCDNUrl;
  131518. /**
  131519. * Default skybox texture URL.
  131520. */
  131521. private static _skyboxTextureCDNUrl;
  131522. /**
  131523. * Default environment texture URL.
  131524. */
  131525. private static _environmentTextureCDNUrl;
  131526. /**
  131527. * Creates the default options for the helper.
  131528. */
  131529. private static _getDefaultOptions;
  131530. private _rootMesh;
  131531. /**
  131532. * Gets the root mesh created by the helper.
  131533. */
  131534. get rootMesh(): Mesh;
  131535. private _skybox;
  131536. /**
  131537. * Gets the skybox created by the helper.
  131538. */
  131539. get skybox(): Nullable<Mesh>;
  131540. private _skyboxTexture;
  131541. /**
  131542. * Gets the skybox texture created by the helper.
  131543. */
  131544. get skyboxTexture(): Nullable<BaseTexture>;
  131545. private _skyboxMaterial;
  131546. /**
  131547. * Gets the skybox material created by the helper.
  131548. */
  131549. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  131550. private _ground;
  131551. /**
  131552. * Gets the ground mesh created by the helper.
  131553. */
  131554. get ground(): Nullable<Mesh>;
  131555. private _groundTexture;
  131556. /**
  131557. * Gets the ground texture created by the helper.
  131558. */
  131559. get groundTexture(): Nullable<BaseTexture>;
  131560. private _groundMirror;
  131561. /**
  131562. * Gets the ground mirror created by the helper.
  131563. */
  131564. get groundMirror(): Nullable<MirrorTexture>;
  131565. /**
  131566. * Gets the ground mirror render list to helps pushing the meshes
  131567. * you wish in the ground reflection.
  131568. */
  131569. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  131570. private _groundMaterial;
  131571. /**
  131572. * Gets the ground material created by the helper.
  131573. */
  131574. get groundMaterial(): Nullable<BackgroundMaterial>;
  131575. /**
  131576. * Stores the creation options.
  131577. */
  131578. private readonly _scene;
  131579. private _options;
  131580. /**
  131581. * This observable will be notified with any error during the creation of the environment,
  131582. * mainly texture creation errors.
  131583. */
  131584. onErrorObservable: Observable<{
  131585. message?: string;
  131586. exception?: any;
  131587. }>;
  131588. /**
  131589. * constructor
  131590. * @param options Defines the options we want to customize the helper
  131591. * @param scene The scene to add the material to
  131592. */
  131593. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  131594. /**
  131595. * Updates the background according to the new options
  131596. * @param options
  131597. */
  131598. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  131599. /**
  131600. * Sets the primary color of all the available elements.
  131601. * @param color the main color to affect to the ground and the background
  131602. */
  131603. setMainColor(color: Color3): void;
  131604. /**
  131605. * Setup the image processing according to the specified options.
  131606. */
  131607. private _setupImageProcessing;
  131608. /**
  131609. * Setup the environment texture according to the specified options.
  131610. */
  131611. private _setupEnvironmentTexture;
  131612. /**
  131613. * Setup the background according to the specified options.
  131614. */
  131615. private _setupBackground;
  131616. /**
  131617. * Get the scene sizes according to the setup.
  131618. */
  131619. private _getSceneSize;
  131620. /**
  131621. * Setup the ground according to the specified options.
  131622. */
  131623. private _setupGround;
  131624. /**
  131625. * Setup the ground material according to the specified options.
  131626. */
  131627. private _setupGroundMaterial;
  131628. /**
  131629. * Setup the ground diffuse texture according to the specified options.
  131630. */
  131631. private _setupGroundDiffuseTexture;
  131632. /**
  131633. * Setup the ground mirror texture according to the specified options.
  131634. */
  131635. private _setupGroundMirrorTexture;
  131636. /**
  131637. * Setup the ground to receive the mirror texture.
  131638. */
  131639. private _setupMirrorInGroundMaterial;
  131640. /**
  131641. * Setup the skybox according to the specified options.
  131642. */
  131643. private _setupSkybox;
  131644. /**
  131645. * Setup the skybox material according to the specified options.
  131646. */
  131647. private _setupSkyboxMaterial;
  131648. /**
  131649. * Setup the skybox reflection texture according to the specified options.
  131650. */
  131651. private _setupSkyboxReflectionTexture;
  131652. private _errorHandler;
  131653. /**
  131654. * Dispose all the elements created by the Helper.
  131655. */
  131656. dispose(): void;
  131657. }
  131658. }
  131659. declare module BABYLON {
  131660. /**
  131661. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  131662. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  131663. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  131664. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  131665. */
  131666. export class PhotoDome extends TransformNode {
  131667. /**
  131668. * Define the image as a Monoscopic panoramic 360 image.
  131669. */
  131670. static readonly MODE_MONOSCOPIC: number;
  131671. /**
  131672. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  131673. */
  131674. static readonly MODE_TOPBOTTOM: number;
  131675. /**
  131676. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  131677. */
  131678. static readonly MODE_SIDEBYSIDE: number;
  131679. private _useDirectMapping;
  131680. /**
  131681. * The texture being displayed on the sphere
  131682. */
  131683. protected _photoTexture: Texture;
  131684. /**
  131685. * Gets or sets the texture being displayed on the sphere
  131686. */
  131687. get photoTexture(): Texture;
  131688. set photoTexture(value: Texture);
  131689. /**
  131690. * Observable raised when an error occured while loading the 360 image
  131691. */
  131692. onLoadErrorObservable: Observable<string>;
  131693. /**
  131694. * The skybox material
  131695. */
  131696. protected _material: BackgroundMaterial;
  131697. /**
  131698. * The surface used for the skybox
  131699. */
  131700. protected _mesh: Mesh;
  131701. /**
  131702. * Gets the mesh used for the skybox.
  131703. */
  131704. get mesh(): Mesh;
  131705. /**
  131706. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  131707. * Also see the options.resolution property.
  131708. */
  131709. get fovMultiplier(): number;
  131710. set fovMultiplier(value: number);
  131711. private _imageMode;
  131712. /**
  131713. * Gets or set the current video mode for the video. It can be:
  131714. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  131715. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  131716. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  131717. */
  131718. get imageMode(): number;
  131719. set imageMode(value: number);
  131720. /**
  131721. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  131722. * @param name Element's name, child elements will append suffixes for their own names.
  131723. * @param urlsOfPhoto defines the url of the photo to display
  131724. * @param options defines an object containing optional or exposed sub element properties
  131725. * @param onError defines a callback called when an error occured while loading the texture
  131726. */
  131727. constructor(name: string, urlOfPhoto: string, options: {
  131728. resolution?: number;
  131729. size?: number;
  131730. useDirectMapping?: boolean;
  131731. faceForward?: boolean;
  131732. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  131733. private _onBeforeCameraRenderObserver;
  131734. private _changeImageMode;
  131735. /**
  131736. * Releases resources associated with this node.
  131737. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  131738. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  131739. */
  131740. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  131741. }
  131742. }
  131743. declare module BABYLON {
  131744. /**
  131745. * Class used to host RGBD texture specific utilities
  131746. */
  131747. export class RGBDTextureTools {
  131748. /**
  131749. * Expand the RGBD Texture from RGBD to Half Float if possible.
  131750. * @param texture the texture to expand.
  131751. */
  131752. static ExpandRGBDTexture(texture: Texture): void;
  131753. }
  131754. }
  131755. declare module BABYLON {
  131756. /**
  131757. * Class used to host texture specific utilities
  131758. */
  131759. export class BRDFTextureTools {
  131760. /**
  131761. * Prevents texture cache collision
  131762. */
  131763. private static _instanceNumber;
  131764. /**
  131765. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  131766. * @param scene defines the hosting scene
  131767. * @returns the environment BRDF texture
  131768. */
  131769. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  131770. private static _environmentBRDFBase64Texture;
  131771. }
  131772. }
  131773. declare module BABYLON {
  131774. /**
  131775. * @hidden
  131776. */
  131777. export interface IMaterialClearCoatDefines {
  131778. CLEARCOAT: boolean;
  131779. CLEARCOAT_DEFAULTIOR: boolean;
  131780. CLEARCOAT_TEXTURE: boolean;
  131781. CLEARCOAT_TEXTUREDIRECTUV: number;
  131782. CLEARCOAT_BUMP: boolean;
  131783. CLEARCOAT_BUMPDIRECTUV: number;
  131784. CLEARCOAT_TINT: boolean;
  131785. CLEARCOAT_TINT_TEXTURE: boolean;
  131786. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  131787. /** @hidden */
  131788. _areTexturesDirty: boolean;
  131789. }
  131790. /**
  131791. * Define the code related to the clear coat parameters of the pbr material.
  131792. */
  131793. export class PBRClearCoatConfiguration {
  131794. /**
  131795. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  131796. * The default fits with a polyurethane material.
  131797. */
  131798. private static readonly _DefaultIndexOfRefraction;
  131799. private _isEnabled;
  131800. /**
  131801. * Defines if the clear coat is enabled in the material.
  131802. */
  131803. isEnabled: boolean;
  131804. /**
  131805. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  131806. */
  131807. intensity: number;
  131808. /**
  131809. * Defines the clear coat layer roughness.
  131810. */
  131811. roughness: number;
  131812. private _indexOfRefraction;
  131813. /**
  131814. * Defines the index of refraction of the clear coat.
  131815. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  131816. * The default fits with a polyurethane material.
  131817. * Changing the default value is more performance intensive.
  131818. */
  131819. indexOfRefraction: number;
  131820. private _texture;
  131821. /**
  131822. * Stores the clear coat values in a texture.
  131823. */
  131824. texture: Nullable<BaseTexture>;
  131825. private _bumpTexture;
  131826. /**
  131827. * Define the clear coat specific bump texture.
  131828. */
  131829. bumpTexture: Nullable<BaseTexture>;
  131830. private _isTintEnabled;
  131831. /**
  131832. * Defines if the clear coat tint is enabled in the material.
  131833. */
  131834. isTintEnabled: boolean;
  131835. /**
  131836. * Defines the clear coat tint of the material.
  131837. * This is only use if tint is enabled
  131838. */
  131839. tintColor: Color3;
  131840. /**
  131841. * Defines the distance at which the tint color should be found in the
  131842. * clear coat media.
  131843. * This is only use if tint is enabled
  131844. */
  131845. tintColorAtDistance: number;
  131846. /**
  131847. * Defines the clear coat layer thickness.
  131848. * This is only use if tint is enabled
  131849. */
  131850. tintThickness: number;
  131851. private _tintTexture;
  131852. /**
  131853. * Stores the clear tint values in a texture.
  131854. * rgb is tint
  131855. * a is a thickness factor
  131856. */
  131857. tintTexture: Nullable<BaseTexture>;
  131858. /** @hidden */
  131859. private _internalMarkAllSubMeshesAsTexturesDirty;
  131860. /** @hidden */
  131861. _markAllSubMeshesAsTexturesDirty(): void;
  131862. /**
  131863. * Instantiate a new istance of clear coat configuration.
  131864. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  131865. */
  131866. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  131867. /**
  131868. * Gets wehter the submesh is ready to be used or not.
  131869. * @param defines the list of "defines" to update.
  131870. * @param scene defines the scene the material belongs to.
  131871. * @param engine defines the engine the material belongs to.
  131872. * @param disableBumpMap defines wether the material disables bump or not.
  131873. * @returns - boolean indicating that the submesh is ready or not.
  131874. */
  131875. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  131876. /**
  131877. * Checks to see if a texture is used in the material.
  131878. * @param defines the list of "defines" to update.
  131879. * @param scene defines the scene to the material belongs to.
  131880. */
  131881. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  131882. /**
  131883. * Binds the material data.
  131884. * @param uniformBuffer defines the Uniform buffer to fill in.
  131885. * @param scene defines the scene the material belongs to.
  131886. * @param engine defines the engine the material belongs to.
  131887. * @param disableBumpMap defines wether the material disables bump or not.
  131888. * @param isFrozen defines wether the material is frozen or not.
  131889. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  131890. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  131891. */
  131892. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  131893. /**
  131894. * Checks to see if a texture is used in the material.
  131895. * @param texture - Base texture to use.
  131896. * @returns - Boolean specifying if a texture is used in the material.
  131897. */
  131898. hasTexture(texture: BaseTexture): boolean;
  131899. /**
  131900. * Returns an array of the actively used textures.
  131901. * @param activeTextures Array of BaseTextures
  131902. */
  131903. getActiveTextures(activeTextures: BaseTexture[]): void;
  131904. /**
  131905. * Returns the animatable textures.
  131906. * @param animatables Array of animatable textures.
  131907. */
  131908. getAnimatables(animatables: IAnimatable[]): void;
  131909. /**
  131910. * Disposes the resources of the material.
  131911. * @param forceDisposeTextures - Forces the disposal of all textures.
  131912. */
  131913. dispose(forceDisposeTextures?: boolean): void;
  131914. /**
  131915. * Get the current class name of the texture useful for serialization or dynamic coding.
  131916. * @returns "PBRClearCoatConfiguration"
  131917. */
  131918. getClassName(): string;
  131919. /**
  131920. * Add fallbacks to the effect fallbacks list.
  131921. * @param defines defines the Base texture to use.
  131922. * @param fallbacks defines the current fallback list.
  131923. * @param currentRank defines the current fallback rank.
  131924. * @returns the new fallback rank.
  131925. */
  131926. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  131927. /**
  131928. * Add the required uniforms to the current list.
  131929. * @param uniforms defines the current uniform list.
  131930. */
  131931. static AddUniforms(uniforms: string[]): void;
  131932. /**
  131933. * Add the required samplers to the current list.
  131934. * @param samplers defines the current sampler list.
  131935. */
  131936. static AddSamplers(samplers: string[]): void;
  131937. /**
  131938. * Add the required uniforms to the current buffer.
  131939. * @param uniformBuffer defines the current uniform buffer.
  131940. */
  131941. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  131942. /**
  131943. * Makes a duplicate of the current configuration into another one.
  131944. * @param clearCoatConfiguration define the config where to copy the info
  131945. */
  131946. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  131947. /**
  131948. * Serializes this clear coat configuration.
  131949. * @returns - An object with the serialized config.
  131950. */
  131951. serialize(): any;
  131952. /**
  131953. * Parses a anisotropy Configuration from a serialized object.
  131954. * @param source - Serialized object.
  131955. * @param scene Defines the scene we are parsing for
  131956. * @param rootUrl Defines the rootUrl to load from
  131957. */
  131958. parse(source: any, scene: Scene, rootUrl: string): void;
  131959. }
  131960. }
  131961. declare module BABYLON {
  131962. /**
  131963. * @hidden
  131964. */
  131965. export interface IMaterialAnisotropicDefines {
  131966. ANISOTROPIC: boolean;
  131967. ANISOTROPIC_TEXTURE: boolean;
  131968. ANISOTROPIC_TEXTUREDIRECTUV: number;
  131969. MAINUV1: boolean;
  131970. _areTexturesDirty: boolean;
  131971. _needUVs: boolean;
  131972. }
  131973. /**
  131974. * Define the code related to the anisotropic parameters of the pbr material.
  131975. */
  131976. export class PBRAnisotropicConfiguration {
  131977. private _isEnabled;
  131978. /**
  131979. * Defines if the anisotropy is enabled in the material.
  131980. */
  131981. isEnabled: boolean;
  131982. /**
  131983. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  131984. */
  131985. intensity: number;
  131986. /**
  131987. * Defines if the effect is along the tangents, bitangents or in between.
  131988. * By default, the effect is "strectching" the highlights along the tangents.
  131989. */
  131990. direction: Vector2;
  131991. private _texture;
  131992. /**
  131993. * Stores the anisotropy values in a texture.
  131994. * rg is direction (like normal from -1 to 1)
  131995. * b is a intensity
  131996. */
  131997. texture: Nullable<BaseTexture>;
  131998. /** @hidden */
  131999. private _internalMarkAllSubMeshesAsTexturesDirty;
  132000. /** @hidden */
  132001. _markAllSubMeshesAsTexturesDirty(): void;
  132002. /**
  132003. * Instantiate a new istance of anisotropy configuration.
  132004. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  132005. */
  132006. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  132007. /**
  132008. * Specifies that the submesh is ready to be used.
  132009. * @param defines the list of "defines" to update.
  132010. * @param scene defines the scene the material belongs to.
  132011. * @returns - boolean indicating that the submesh is ready or not.
  132012. */
  132013. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  132014. /**
  132015. * Checks to see if a texture is used in the material.
  132016. * @param defines the list of "defines" to update.
  132017. * @param mesh the mesh we are preparing the defines for.
  132018. * @param scene defines the scene the material belongs to.
  132019. */
  132020. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  132021. /**
  132022. * Binds the material data.
  132023. * @param uniformBuffer defines the Uniform buffer to fill in.
  132024. * @param scene defines the scene the material belongs to.
  132025. * @param isFrozen defines wether the material is frozen or not.
  132026. */
  132027. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  132028. /**
  132029. * Checks to see if a texture is used in the material.
  132030. * @param texture - Base texture to use.
  132031. * @returns - Boolean specifying if a texture is used in the material.
  132032. */
  132033. hasTexture(texture: BaseTexture): boolean;
  132034. /**
  132035. * Returns an array of the actively used textures.
  132036. * @param activeTextures Array of BaseTextures
  132037. */
  132038. getActiveTextures(activeTextures: BaseTexture[]): void;
  132039. /**
  132040. * Returns the animatable textures.
  132041. * @param animatables Array of animatable textures.
  132042. */
  132043. getAnimatables(animatables: IAnimatable[]): void;
  132044. /**
  132045. * Disposes the resources of the material.
  132046. * @param forceDisposeTextures - Forces the disposal of all textures.
  132047. */
  132048. dispose(forceDisposeTextures?: boolean): void;
  132049. /**
  132050. * Get the current class name of the texture useful for serialization or dynamic coding.
  132051. * @returns "PBRAnisotropicConfiguration"
  132052. */
  132053. getClassName(): string;
  132054. /**
  132055. * Add fallbacks to the effect fallbacks list.
  132056. * @param defines defines the Base texture to use.
  132057. * @param fallbacks defines the current fallback list.
  132058. * @param currentRank defines the current fallback rank.
  132059. * @returns the new fallback rank.
  132060. */
  132061. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  132062. /**
  132063. * Add the required uniforms to the current list.
  132064. * @param uniforms defines the current uniform list.
  132065. */
  132066. static AddUniforms(uniforms: string[]): void;
  132067. /**
  132068. * Add the required uniforms to the current buffer.
  132069. * @param uniformBuffer defines the current uniform buffer.
  132070. */
  132071. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  132072. /**
  132073. * Add the required samplers to the current list.
  132074. * @param samplers defines the current sampler list.
  132075. */
  132076. static AddSamplers(samplers: string[]): void;
  132077. /**
  132078. * Makes a duplicate of the current configuration into another one.
  132079. * @param anisotropicConfiguration define the config where to copy the info
  132080. */
  132081. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  132082. /**
  132083. * Serializes this anisotropy configuration.
  132084. * @returns - An object with the serialized config.
  132085. */
  132086. serialize(): any;
  132087. /**
  132088. * Parses a anisotropy Configuration from a serialized object.
  132089. * @param source - Serialized object.
  132090. * @param scene Defines the scene we are parsing for
  132091. * @param rootUrl Defines the rootUrl to load from
  132092. */
  132093. parse(source: any, scene: Scene, rootUrl: string): void;
  132094. }
  132095. }
  132096. declare module BABYLON {
  132097. /**
  132098. * @hidden
  132099. */
  132100. export interface IMaterialBRDFDefines {
  132101. BRDF_V_HEIGHT_CORRELATED: boolean;
  132102. MS_BRDF_ENERGY_CONSERVATION: boolean;
  132103. SPHERICAL_HARMONICS: boolean;
  132104. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  132105. /** @hidden */
  132106. _areMiscDirty: boolean;
  132107. }
  132108. /**
  132109. * Define the code related to the BRDF parameters of the pbr material.
  132110. */
  132111. export class PBRBRDFConfiguration {
  132112. /**
  132113. * Default value used for the energy conservation.
  132114. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  132115. */
  132116. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  132117. /**
  132118. * Default value used for the Smith Visibility Height Correlated mode.
  132119. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  132120. */
  132121. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  132122. /**
  132123. * Default value used for the IBL diffuse part.
  132124. * This can help switching back to the polynomials mode globally which is a tiny bit
  132125. * less GPU intensive at the drawback of a lower quality.
  132126. */
  132127. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  132128. /**
  132129. * Default value used for activating energy conservation for the specular workflow.
  132130. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  132131. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  132132. */
  132133. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  132134. private _useEnergyConservation;
  132135. /**
  132136. * Defines if the material uses energy conservation.
  132137. */
  132138. useEnergyConservation: boolean;
  132139. private _useSmithVisibilityHeightCorrelated;
  132140. /**
  132141. * LEGACY Mode set to false
  132142. * Defines if the material uses height smith correlated visibility term.
  132143. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  132144. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  132145. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  132146. * Not relying on height correlated will also disable energy conservation.
  132147. */
  132148. useSmithVisibilityHeightCorrelated: boolean;
  132149. private _useSphericalHarmonics;
  132150. /**
  132151. * LEGACY Mode set to false
  132152. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  132153. * diffuse part of the IBL.
  132154. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  132155. * to the ground truth.
  132156. */
  132157. useSphericalHarmonics: boolean;
  132158. private _useSpecularGlossinessInputEnergyConservation;
  132159. /**
  132160. * Defines if the material uses energy conservation, when the specular workflow is active.
  132161. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  132162. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  132163. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  132164. */
  132165. useSpecularGlossinessInputEnergyConservation: boolean;
  132166. /** @hidden */
  132167. private _internalMarkAllSubMeshesAsMiscDirty;
  132168. /** @hidden */
  132169. _markAllSubMeshesAsMiscDirty(): void;
  132170. /**
  132171. * Instantiate a new istance of clear coat configuration.
  132172. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  132173. */
  132174. constructor(markAllSubMeshesAsMiscDirty: () => void);
  132175. /**
  132176. * Checks to see if a texture is used in the material.
  132177. * @param defines the list of "defines" to update.
  132178. */
  132179. prepareDefines(defines: IMaterialBRDFDefines): void;
  132180. /**
  132181. * Get the current class name of the texture useful for serialization or dynamic coding.
  132182. * @returns "PBRClearCoatConfiguration"
  132183. */
  132184. getClassName(): string;
  132185. /**
  132186. * Makes a duplicate of the current configuration into another one.
  132187. * @param brdfConfiguration define the config where to copy the info
  132188. */
  132189. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  132190. /**
  132191. * Serializes this BRDF configuration.
  132192. * @returns - An object with the serialized config.
  132193. */
  132194. serialize(): any;
  132195. /**
  132196. * Parses a anisotropy Configuration from a serialized object.
  132197. * @param source - Serialized object.
  132198. * @param scene Defines the scene we are parsing for
  132199. * @param rootUrl Defines the rootUrl to load from
  132200. */
  132201. parse(source: any, scene: Scene, rootUrl: string): void;
  132202. }
  132203. }
  132204. declare module BABYLON {
  132205. /**
  132206. * @hidden
  132207. */
  132208. export interface IMaterialSheenDefines {
  132209. SHEEN: boolean;
  132210. SHEEN_TEXTURE: boolean;
  132211. SHEEN_TEXTUREDIRECTUV: number;
  132212. SHEEN_LINKWITHALBEDO: boolean;
  132213. SHEEN_ROUGHNESS: boolean;
  132214. SHEEN_ALBEDOSCALING: boolean;
  132215. /** @hidden */
  132216. _areTexturesDirty: boolean;
  132217. }
  132218. /**
  132219. * Define the code related to the Sheen parameters of the pbr material.
  132220. */
  132221. export class PBRSheenConfiguration {
  132222. private _isEnabled;
  132223. /**
  132224. * Defines if the material uses sheen.
  132225. */
  132226. isEnabled: boolean;
  132227. private _linkSheenWithAlbedo;
  132228. /**
  132229. * Defines if the sheen is linked to the sheen color.
  132230. */
  132231. linkSheenWithAlbedo: boolean;
  132232. /**
  132233. * Defines the sheen intensity.
  132234. */
  132235. intensity: number;
  132236. /**
  132237. * Defines the sheen color.
  132238. */
  132239. color: Color3;
  132240. private _texture;
  132241. /**
  132242. * Stores the sheen tint values in a texture.
  132243. * rgb is tint
  132244. * a is a intensity
  132245. */
  132246. texture: Nullable<BaseTexture>;
  132247. private _roughness;
  132248. /**
  132249. * Defines the sheen roughness.
  132250. * It is not taken into account if linkSheenWithAlbedo is true.
  132251. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  132252. */
  132253. roughness: Nullable<number>;
  132254. private _albedoScaling;
  132255. /**
  132256. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  132257. * It allows the strength of the sheen effect to not depend on the base color of the material,
  132258. * making it easier to setup and tweak the effect
  132259. */
  132260. albedoScaling: boolean;
  132261. /** @hidden */
  132262. private _internalMarkAllSubMeshesAsTexturesDirty;
  132263. /** @hidden */
  132264. _markAllSubMeshesAsTexturesDirty(): void;
  132265. /**
  132266. * Instantiate a new istance of clear coat configuration.
  132267. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  132268. */
  132269. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  132270. /**
  132271. * Specifies that the submesh is ready to be used.
  132272. * @param defines the list of "defines" to update.
  132273. * @param scene defines the scene the material belongs to.
  132274. * @returns - boolean indicating that the submesh is ready or not.
  132275. */
  132276. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  132277. /**
  132278. * Checks to see if a texture is used in the material.
  132279. * @param defines the list of "defines" to update.
  132280. * @param scene defines the scene the material belongs to.
  132281. */
  132282. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  132283. /**
  132284. * Binds the material data.
  132285. * @param uniformBuffer defines the Uniform buffer to fill in.
  132286. * @param scene defines the scene the material belongs to.
  132287. * @param isFrozen defines wether the material is frozen or not.
  132288. */
  132289. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  132290. /**
  132291. * Checks to see if a texture is used in the material.
  132292. * @param texture - Base texture to use.
  132293. * @returns - Boolean specifying if a texture is used in the material.
  132294. */
  132295. hasTexture(texture: BaseTexture): boolean;
  132296. /**
  132297. * Returns an array of the actively used textures.
  132298. * @param activeTextures Array of BaseTextures
  132299. */
  132300. getActiveTextures(activeTextures: BaseTexture[]): void;
  132301. /**
  132302. * Returns the animatable textures.
  132303. * @param animatables Array of animatable textures.
  132304. */
  132305. getAnimatables(animatables: IAnimatable[]): void;
  132306. /**
  132307. * Disposes the resources of the material.
  132308. * @param forceDisposeTextures - Forces the disposal of all textures.
  132309. */
  132310. dispose(forceDisposeTextures?: boolean): void;
  132311. /**
  132312. * Get the current class name of the texture useful for serialization or dynamic coding.
  132313. * @returns "PBRSheenConfiguration"
  132314. */
  132315. getClassName(): string;
  132316. /**
  132317. * Add fallbacks to the effect fallbacks list.
  132318. * @param defines defines the Base texture to use.
  132319. * @param fallbacks defines the current fallback list.
  132320. * @param currentRank defines the current fallback rank.
  132321. * @returns the new fallback rank.
  132322. */
  132323. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  132324. /**
  132325. * Add the required uniforms to the current list.
  132326. * @param uniforms defines the current uniform list.
  132327. */
  132328. static AddUniforms(uniforms: string[]): void;
  132329. /**
  132330. * Add the required uniforms to the current buffer.
  132331. * @param uniformBuffer defines the current uniform buffer.
  132332. */
  132333. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  132334. /**
  132335. * Add the required samplers to the current list.
  132336. * @param samplers defines the current sampler list.
  132337. */
  132338. static AddSamplers(samplers: string[]): void;
  132339. /**
  132340. * Makes a duplicate of the current configuration into another one.
  132341. * @param sheenConfiguration define the config where to copy the info
  132342. */
  132343. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  132344. /**
  132345. * Serializes this BRDF configuration.
  132346. * @returns - An object with the serialized config.
  132347. */
  132348. serialize(): any;
  132349. /**
  132350. * Parses a anisotropy Configuration from a serialized object.
  132351. * @param source - Serialized object.
  132352. * @param scene Defines the scene we are parsing for
  132353. * @param rootUrl Defines the rootUrl to load from
  132354. */
  132355. parse(source: any, scene: Scene, rootUrl: string): void;
  132356. }
  132357. }
  132358. declare module BABYLON {
  132359. /**
  132360. * @hidden
  132361. */
  132362. export interface IMaterialSubSurfaceDefines {
  132363. SUBSURFACE: boolean;
  132364. SS_REFRACTION: boolean;
  132365. SS_TRANSLUCENCY: boolean;
  132366. SS_SCATTERING: boolean;
  132367. SS_THICKNESSANDMASK_TEXTURE: boolean;
  132368. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  132369. SS_REFRACTIONMAP_3D: boolean;
  132370. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  132371. SS_LODINREFRACTIONALPHA: boolean;
  132372. SS_GAMMAREFRACTION: boolean;
  132373. SS_RGBDREFRACTION: boolean;
  132374. SS_LINEARSPECULARREFRACTION: boolean;
  132375. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  132376. SS_ALBEDOFORREFRACTIONTINT: boolean;
  132377. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  132378. /** @hidden */
  132379. _areTexturesDirty: boolean;
  132380. }
  132381. /**
  132382. * Define the code related to the sub surface parameters of the pbr material.
  132383. */
  132384. export class PBRSubSurfaceConfiguration {
  132385. private _isRefractionEnabled;
  132386. /**
  132387. * Defines if the refraction is enabled in the material.
  132388. */
  132389. isRefractionEnabled: boolean;
  132390. private _isTranslucencyEnabled;
  132391. /**
  132392. * Defines if the translucency is enabled in the material.
  132393. */
  132394. isTranslucencyEnabled: boolean;
  132395. private _isScatteringEnabled;
  132396. /**
  132397. * Defines the refraction intensity of the material.
  132398. * The refraction when enabled replaces the Diffuse part of the material.
  132399. * The intensity helps transitionning between diffuse and refraction.
  132400. */
  132401. refractionIntensity: number;
  132402. /**
  132403. * Defines the translucency intensity of the material.
  132404. * When translucency has been enabled, this defines how much of the "translucency"
  132405. * is addded to the diffuse part of the material.
  132406. */
  132407. translucencyIntensity: number;
  132408. /**
  132409. * Defines the scattering intensity of the material.
  132410. * When scattering has been enabled, this defines how much of the "scattered light"
  132411. * is addded to the diffuse part of the material.
  132412. */
  132413. scatteringIntensity: number;
  132414. /**
  132415. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  132416. */
  132417. useAlbedoToTintRefraction: boolean;
  132418. private _thicknessTexture;
  132419. /**
  132420. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  132421. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  132422. * 0 would mean minimumThickness
  132423. * 1 would mean maximumThickness
  132424. * The other channels might be use as a mask to vary the different effects intensity.
  132425. */
  132426. thicknessTexture: Nullable<BaseTexture>;
  132427. private _refractionTexture;
  132428. /**
  132429. * Defines the texture to use for refraction.
  132430. */
  132431. refractionTexture: Nullable<BaseTexture>;
  132432. private _indexOfRefraction;
  132433. /**
  132434. * Index of refraction of the material base layer.
  132435. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  132436. *
  132437. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  132438. *
  132439. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  132440. */
  132441. indexOfRefraction: number;
  132442. private _volumeIndexOfRefraction;
  132443. /**
  132444. * Index of refraction of the material's volume.
  132445. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  132446. *
  132447. * This ONLY impacts refraction. If not provided or given a non-valid value,
  132448. * the volume will use the same IOR as the surface.
  132449. */
  132450. get volumeIndexOfRefraction(): number;
  132451. set volumeIndexOfRefraction(value: number);
  132452. private _invertRefractionY;
  132453. /**
  132454. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  132455. */
  132456. invertRefractionY: boolean;
  132457. private _linkRefractionWithTransparency;
  132458. /**
  132459. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  132460. * Materials half opaque for instance using refraction could benefit from this control.
  132461. */
  132462. linkRefractionWithTransparency: boolean;
  132463. /**
  132464. * Defines the minimum thickness stored in the thickness map.
  132465. * If no thickness map is defined, this value will be used to simulate thickness.
  132466. */
  132467. minimumThickness: number;
  132468. /**
  132469. * Defines the maximum thickness stored in the thickness map.
  132470. */
  132471. maximumThickness: number;
  132472. /**
  132473. * Defines the volume tint of the material.
  132474. * This is used for both translucency and scattering.
  132475. */
  132476. tintColor: Color3;
  132477. /**
  132478. * Defines the distance at which the tint color should be found in the media.
  132479. * This is used for refraction only.
  132480. */
  132481. tintColorAtDistance: number;
  132482. /**
  132483. * Defines how far each channel transmit through the media.
  132484. * It is defined as a color to simplify it selection.
  132485. */
  132486. diffusionDistance: Color3;
  132487. private _useMaskFromThicknessTexture;
  132488. /**
  132489. * Stores the intensity of the different subsurface effects in the thickness texture.
  132490. * * the green channel is the translucency intensity.
  132491. * * the blue channel is the scattering intensity.
  132492. * * the alpha channel is the refraction intensity.
  132493. */
  132494. useMaskFromThicknessTexture: boolean;
  132495. /** @hidden */
  132496. private _internalMarkAllSubMeshesAsTexturesDirty;
  132497. /** @hidden */
  132498. _markAllSubMeshesAsTexturesDirty(): void;
  132499. /**
  132500. * Instantiate a new istance of sub surface configuration.
  132501. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  132502. */
  132503. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  132504. /**
  132505. * Gets wehter the submesh is ready to be used or not.
  132506. * @param defines the list of "defines" to update.
  132507. * @param scene defines the scene the material belongs to.
  132508. * @returns - boolean indicating that the submesh is ready or not.
  132509. */
  132510. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  132511. /**
  132512. * Checks to see if a texture is used in the material.
  132513. * @param defines the list of "defines" to update.
  132514. * @param scene defines the scene to the material belongs to.
  132515. */
  132516. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  132517. /**
  132518. * Binds the material data.
  132519. * @param uniformBuffer defines the Uniform buffer to fill in.
  132520. * @param scene defines the scene the material belongs to.
  132521. * @param engine defines the engine the material belongs to.
  132522. * @param isFrozen defines whether the material is frozen or not.
  132523. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  132524. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  132525. */
  132526. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  132527. /**
  132528. * Unbinds the material from the mesh.
  132529. * @param activeEffect defines the effect that should be unbound from.
  132530. * @returns true if unbound, otherwise false
  132531. */
  132532. unbind(activeEffect: Effect): boolean;
  132533. /**
  132534. * Returns the texture used for refraction or null if none is used.
  132535. * @param scene defines the scene the material belongs to.
  132536. * @returns - Refraction texture if present. If no refraction texture and refraction
  132537. * is linked with transparency, returns environment texture. Otherwise, returns null.
  132538. */
  132539. private _getRefractionTexture;
  132540. /**
  132541. * Returns true if alpha blending should be disabled.
  132542. */
  132543. get disableAlphaBlending(): boolean;
  132544. /**
  132545. * Fills the list of render target textures.
  132546. * @param renderTargets the list of render targets to update
  132547. */
  132548. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  132549. /**
  132550. * Checks to see if a texture is used in the material.
  132551. * @param texture - Base texture to use.
  132552. * @returns - Boolean specifying if a texture is used in the material.
  132553. */
  132554. hasTexture(texture: BaseTexture): boolean;
  132555. /**
  132556. * Gets a boolean indicating that current material needs to register RTT
  132557. * @returns true if this uses a render target otherwise false.
  132558. */
  132559. hasRenderTargetTextures(): boolean;
  132560. /**
  132561. * Returns an array of the actively used textures.
  132562. * @param activeTextures Array of BaseTextures
  132563. */
  132564. getActiveTextures(activeTextures: BaseTexture[]): void;
  132565. /**
  132566. * Returns the animatable textures.
  132567. * @param animatables Array of animatable textures.
  132568. */
  132569. getAnimatables(animatables: IAnimatable[]): void;
  132570. /**
  132571. * Disposes the resources of the material.
  132572. * @param forceDisposeTextures - Forces the disposal of all textures.
  132573. */
  132574. dispose(forceDisposeTextures?: boolean): void;
  132575. /**
  132576. * Get the current class name of the texture useful for serialization or dynamic coding.
  132577. * @returns "PBRSubSurfaceConfiguration"
  132578. */
  132579. getClassName(): string;
  132580. /**
  132581. * Add fallbacks to the effect fallbacks list.
  132582. * @param defines defines the Base texture to use.
  132583. * @param fallbacks defines the current fallback list.
  132584. * @param currentRank defines the current fallback rank.
  132585. * @returns the new fallback rank.
  132586. */
  132587. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  132588. /**
  132589. * Add the required uniforms to the current list.
  132590. * @param uniforms defines the current uniform list.
  132591. */
  132592. static AddUniforms(uniforms: string[]): void;
  132593. /**
  132594. * Add the required samplers to the current list.
  132595. * @param samplers defines the current sampler list.
  132596. */
  132597. static AddSamplers(samplers: string[]): void;
  132598. /**
  132599. * Add the required uniforms to the current buffer.
  132600. * @param uniformBuffer defines the current uniform buffer.
  132601. */
  132602. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  132603. /**
  132604. * Makes a duplicate of the current configuration into another one.
  132605. * @param configuration define the config where to copy the info
  132606. */
  132607. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  132608. /**
  132609. * Serializes this Sub Surface configuration.
  132610. * @returns - An object with the serialized config.
  132611. */
  132612. serialize(): any;
  132613. /**
  132614. * Parses a anisotropy Configuration from a serialized object.
  132615. * @param source - Serialized object.
  132616. * @param scene Defines the scene we are parsing for
  132617. * @param rootUrl Defines the rootUrl to load from
  132618. */
  132619. parse(source: any, scene: Scene, rootUrl: string): void;
  132620. }
  132621. }
  132622. declare module BABYLON {
  132623. /** @hidden */
  132624. export var pbrFragmentDeclaration: {
  132625. name: string;
  132626. shader: string;
  132627. };
  132628. }
  132629. declare module BABYLON {
  132630. /** @hidden */
  132631. export var pbrUboDeclaration: {
  132632. name: string;
  132633. shader: string;
  132634. };
  132635. }
  132636. declare module BABYLON {
  132637. /** @hidden */
  132638. export var pbrFragmentExtraDeclaration: {
  132639. name: string;
  132640. shader: string;
  132641. };
  132642. }
  132643. declare module BABYLON {
  132644. /** @hidden */
  132645. export var pbrFragmentSamplersDeclaration: {
  132646. name: string;
  132647. shader: string;
  132648. };
  132649. }
  132650. declare module BABYLON {
  132651. /** @hidden */
  132652. export var importanceSampling: {
  132653. name: string;
  132654. shader: string;
  132655. };
  132656. }
  132657. declare module BABYLON {
  132658. /** @hidden */
  132659. export var pbrHelperFunctions: {
  132660. name: string;
  132661. shader: string;
  132662. };
  132663. }
  132664. declare module BABYLON {
  132665. /** @hidden */
  132666. export var harmonicsFunctions: {
  132667. name: string;
  132668. shader: string;
  132669. };
  132670. }
  132671. declare module BABYLON {
  132672. /** @hidden */
  132673. export var pbrDirectLightingSetupFunctions: {
  132674. name: string;
  132675. shader: string;
  132676. };
  132677. }
  132678. declare module BABYLON {
  132679. /** @hidden */
  132680. export var pbrDirectLightingFalloffFunctions: {
  132681. name: string;
  132682. shader: string;
  132683. };
  132684. }
  132685. declare module BABYLON {
  132686. /** @hidden */
  132687. export var pbrBRDFFunctions: {
  132688. name: string;
  132689. shader: string;
  132690. };
  132691. }
  132692. declare module BABYLON {
  132693. /** @hidden */
  132694. export var hdrFilteringFunctions: {
  132695. name: string;
  132696. shader: string;
  132697. };
  132698. }
  132699. declare module BABYLON {
  132700. /** @hidden */
  132701. export var pbrDirectLightingFunctions: {
  132702. name: string;
  132703. shader: string;
  132704. };
  132705. }
  132706. declare module BABYLON {
  132707. /** @hidden */
  132708. export var pbrIBLFunctions: {
  132709. name: string;
  132710. shader: string;
  132711. };
  132712. }
  132713. declare module BABYLON {
  132714. /** @hidden */
  132715. export var pbrBlockAlbedoOpacity: {
  132716. name: string;
  132717. shader: string;
  132718. };
  132719. }
  132720. declare module BABYLON {
  132721. /** @hidden */
  132722. export var pbrBlockReflectivity: {
  132723. name: string;
  132724. shader: string;
  132725. };
  132726. }
  132727. declare module BABYLON {
  132728. /** @hidden */
  132729. export var pbrBlockAmbientOcclusion: {
  132730. name: string;
  132731. shader: string;
  132732. };
  132733. }
  132734. declare module BABYLON {
  132735. /** @hidden */
  132736. export var pbrBlockAlphaFresnel: {
  132737. name: string;
  132738. shader: string;
  132739. };
  132740. }
  132741. declare module BABYLON {
  132742. /** @hidden */
  132743. export var pbrBlockAnisotropic: {
  132744. name: string;
  132745. shader: string;
  132746. };
  132747. }
  132748. declare module BABYLON {
  132749. /** @hidden */
  132750. export var pbrBlockReflection: {
  132751. name: string;
  132752. shader: string;
  132753. };
  132754. }
  132755. declare module BABYLON {
  132756. /** @hidden */
  132757. export var pbrBlockSheen: {
  132758. name: string;
  132759. shader: string;
  132760. };
  132761. }
  132762. declare module BABYLON {
  132763. /** @hidden */
  132764. export var pbrBlockClearcoat: {
  132765. name: string;
  132766. shader: string;
  132767. };
  132768. }
  132769. declare module BABYLON {
  132770. /** @hidden */
  132771. export var pbrBlockSubSurface: {
  132772. name: string;
  132773. shader: string;
  132774. };
  132775. }
  132776. declare module BABYLON {
  132777. /** @hidden */
  132778. export var pbrBlockNormalGeometric: {
  132779. name: string;
  132780. shader: string;
  132781. };
  132782. }
  132783. declare module BABYLON {
  132784. /** @hidden */
  132785. export var pbrBlockNormalFinal: {
  132786. name: string;
  132787. shader: string;
  132788. };
  132789. }
  132790. declare module BABYLON {
  132791. /** @hidden */
  132792. export var pbrBlockGeometryInfo: {
  132793. name: string;
  132794. shader: string;
  132795. };
  132796. }
  132797. declare module BABYLON {
  132798. /** @hidden */
  132799. export var pbrBlockReflectance0: {
  132800. name: string;
  132801. shader: string;
  132802. };
  132803. }
  132804. declare module BABYLON {
  132805. /** @hidden */
  132806. export var pbrBlockReflectance: {
  132807. name: string;
  132808. shader: string;
  132809. };
  132810. }
  132811. declare module BABYLON {
  132812. /** @hidden */
  132813. export var pbrBlockDirectLighting: {
  132814. name: string;
  132815. shader: string;
  132816. };
  132817. }
  132818. declare module BABYLON {
  132819. /** @hidden */
  132820. export var pbrBlockFinalLitComponents: {
  132821. name: string;
  132822. shader: string;
  132823. };
  132824. }
  132825. declare module BABYLON {
  132826. /** @hidden */
  132827. export var pbrBlockFinalUnlitComponents: {
  132828. name: string;
  132829. shader: string;
  132830. };
  132831. }
  132832. declare module BABYLON {
  132833. /** @hidden */
  132834. export var pbrBlockFinalColorComposition: {
  132835. name: string;
  132836. shader: string;
  132837. };
  132838. }
  132839. declare module BABYLON {
  132840. /** @hidden */
  132841. export var pbrBlockImageProcessing: {
  132842. name: string;
  132843. shader: string;
  132844. };
  132845. }
  132846. declare module BABYLON {
  132847. /** @hidden */
  132848. export var pbrDebug: {
  132849. name: string;
  132850. shader: string;
  132851. };
  132852. }
  132853. declare module BABYLON {
  132854. /** @hidden */
  132855. export var pbrPixelShader: {
  132856. name: string;
  132857. shader: string;
  132858. };
  132859. }
  132860. declare module BABYLON {
  132861. /** @hidden */
  132862. export var pbrVertexDeclaration: {
  132863. name: string;
  132864. shader: string;
  132865. };
  132866. }
  132867. declare module BABYLON {
  132868. /** @hidden */
  132869. export var pbrVertexShader: {
  132870. name: string;
  132871. shader: string;
  132872. };
  132873. }
  132874. declare module BABYLON {
  132875. /**
  132876. * Manages the defines for the PBR Material.
  132877. * @hidden
  132878. */
  132879. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  132880. PBR: boolean;
  132881. NUM_SAMPLES: string;
  132882. REALTIME_FILTERING: boolean;
  132883. MAINUV1: boolean;
  132884. MAINUV2: boolean;
  132885. UV1: boolean;
  132886. UV2: boolean;
  132887. ALBEDO: boolean;
  132888. GAMMAALBEDO: boolean;
  132889. ALBEDODIRECTUV: number;
  132890. VERTEXCOLOR: boolean;
  132891. DETAIL: boolean;
  132892. DETAILDIRECTUV: number;
  132893. DETAIL_NORMALBLENDMETHOD: number;
  132894. AMBIENT: boolean;
  132895. AMBIENTDIRECTUV: number;
  132896. AMBIENTINGRAYSCALE: boolean;
  132897. OPACITY: boolean;
  132898. VERTEXALPHA: boolean;
  132899. OPACITYDIRECTUV: number;
  132900. OPACITYRGB: boolean;
  132901. ALPHATEST: boolean;
  132902. DEPTHPREPASS: boolean;
  132903. ALPHABLEND: boolean;
  132904. ALPHAFROMALBEDO: boolean;
  132905. ALPHATESTVALUE: string;
  132906. SPECULAROVERALPHA: boolean;
  132907. RADIANCEOVERALPHA: boolean;
  132908. ALPHAFRESNEL: boolean;
  132909. LINEARALPHAFRESNEL: boolean;
  132910. PREMULTIPLYALPHA: boolean;
  132911. EMISSIVE: boolean;
  132912. EMISSIVEDIRECTUV: number;
  132913. REFLECTIVITY: boolean;
  132914. REFLECTIVITYDIRECTUV: number;
  132915. SPECULARTERM: boolean;
  132916. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  132917. MICROSURFACEAUTOMATIC: boolean;
  132918. LODBASEDMICROSFURACE: boolean;
  132919. MICROSURFACEMAP: boolean;
  132920. MICROSURFACEMAPDIRECTUV: number;
  132921. METALLICWORKFLOW: boolean;
  132922. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  132923. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  132924. METALLNESSSTOREINMETALMAPBLUE: boolean;
  132925. AOSTOREINMETALMAPRED: boolean;
  132926. METALLIC_REFLECTANCE: boolean;
  132927. METALLIC_REFLECTANCEDIRECTUV: number;
  132928. ENVIRONMENTBRDF: boolean;
  132929. ENVIRONMENTBRDF_RGBD: boolean;
  132930. NORMAL: boolean;
  132931. TANGENT: boolean;
  132932. BUMP: boolean;
  132933. BUMPDIRECTUV: number;
  132934. OBJECTSPACE_NORMALMAP: boolean;
  132935. PARALLAX: boolean;
  132936. PARALLAXOCCLUSION: boolean;
  132937. NORMALXYSCALE: boolean;
  132938. LIGHTMAP: boolean;
  132939. LIGHTMAPDIRECTUV: number;
  132940. USELIGHTMAPASSHADOWMAP: boolean;
  132941. GAMMALIGHTMAP: boolean;
  132942. RGBDLIGHTMAP: boolean;
  132943. REFLECTION: boolean;
  132944. REFLECTIONMAP_3D: boolean;
  132945. REFLECTIONMAP_SPHERICAL: boolean;
  132946. REFLECTIONMAP_PLANAR: boolean;
  132947. REFLECTIONMAP_CUBIC: boolean;
  132948. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  132949. REFLECTIONMAP_PROJECTION: boolean;
  132950. REFLECTIONMAP_SKYBOX: boolean;
  132951. REFLECTIONMAP_EXPLICIT: boolean;
  132952. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  132953. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  132954. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  132955. INVERTCUBICMAP: boolean;
  132956. USESPHERICALFROMREFLECTIONMAP: boolean;
  132957. USEIRRADIANCEMAP: boolean;
  132958. SPHERICAL_HARMONICS: boolean;
  132959. USESPHERICALINVERTEX: boolean;
  132960. REFLECTIONMAP_OPPOSITEZ: boolean;
  132961. LODINREFLECTIONALPHA: boolean;
  132962. GAMMAREFLECTION: boolean;
  132963. RGBDREFLECTION: boolean;
  132964. LINEARSPECULARREFLECTION: boolean;
  132965. RADIANCEOCCLUSION: boolean;
  132966. HORIZONOCCLUSION: boolean;
  132967. INSTANCES: boolean;
  132968. THIN_INSTANCES: boolean;
  132969. NUM_BONE_INFLUENCERS: number;
  132970. BonesPerMesh: number;
  132971. BONETEXTURE: boolean;
  132972. NONUNIFORMSCALING: boolean;
  132973. MORPHTARGETS: boolean;
  132974. MORPHTARGETS_NORMAL: boolean;
  132975. MORPHTARGETS_TANGENT: boolean;
  132976. MORPHTARGETS_UV: boolean;
  132977. NUM_MORPH_INFLUENCERS: number;
  132978. IMAGEPROCESSING: boolean;
  132979. VIGNETTE: boolean;
  132980. VIGNETTEBLENDMODEMULTIPLY: boolean;
  132981. VIGNETTEBLENDMODEOPAQUE: boolean;
  132982. TONEMAPPING: boolean;
  132983. TONEMAPPING_ACES: boolean;
  132984. CONTRAST: boolean;
  132985. COLORCURVES: boolean;
  132986. COLORGRADING: boolean;
  132987. COLORGRADING3D: boolean;
  132988. SAMPLER3DGREENDEPTH: boolean;
  132989. SAMPLER3DBGRMAP: boolean;
  132990. IMAGEPROCESSINGPOSTPROCESS: boolean;
  132991. EXPOSURE: boolean;
  132992. MULTIVIEW: boolean;
  132993. USEPHYSICALLIGHTFALLOFF: boolean;
  132994. USEGLTFLIGHTFALLOFF: boolean;
  132995. TWOSIDEDLIGHTING: boolean;
  132996. SHADOWFLOAT: boolean;
  132997. CLIPPLANE: boolean;
  132998. CLIPPLANE2: boolean;
  132999. CLIPPLANE3: boolean;
  133000. CLIPPLANE4: boolean;
  133001. CLIPPLANE5: boolean;
  133002. CLIPPLANE6: boolean;
  133003. POINTSIZE: boolean;
  133004. FOG: boolean;
  133005. LOGARITHMICDEPTH: boolean;
  133006. FORCENORMALFORWARD: boolean;
  133007. SPECULARAA: boolean;
  133008. CLEARCOAT: boolean;
  133009. CLEARCOAT_DEFAULTIOR: boolean;
  133010. CLEARCOAT_TEXTURE: boolean;
  133011. CLEARCOAT_TEXTUREDIRECTUV: number;
  133012. CLEARCOAT_BUMP: boolean;
  133013. CLEARCOAT_BUMPDIRECTUV: number;
  133014. CLEARCOAT_TINT: boolean;
  133015. CLEARCOAT_TINT_TEXTURE: boolean;
  133016. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  133017. ANISOTROPIC: boolean;
  133018. ANISOTROPIC_TEXTURE: boolean;
  133019. ANISOTROPIC_TEXTUREDIRECTUV: number;
  133020. BRDF_V_HEIGHT_CORRELATED: boolean;
  133021. MS_BRDF_ENERGY_CONSERVATION: boolean;
  133022. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  133023. SHEEN: boolean;
  133024. SHEEN_TEXTURE: boolean;
  133025. SHEEN_TEXTUREDIRECTUV: number;
  133026. SHEEN_LINKWITHALBEDO: boolean;
  133027. SHEEN_ROUGHNESS: boolean;
  133028. SHEEN_ALBEDOSCALING: boolean;
  133029. SUBSURFACE: boolean;
  133030. SS_REFRACTION: boolean;
  133031. SS_TRANSLUCENCY: boolean;
  133032. SS_SCATTERING: boolean;
  133033. SS_THICKNESSANDMASK_TEXTURE: boolean;
  133034. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  133035. SS_REFRACTIONMAP_3D: boolean;
  133036. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  133037. SS_LODINREFRACTIONALPHA: boolean;
  133038. SS_GAMMAREFRACTION: boolean;
  133039. SS_RGBDREFRACTION: boolean;
  133040. SS_LINEARSPECULARREFRACTION: boolean;
  133041. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  133042. SS_ALBEDOFORREFRACTIONTINT: boolean;
  133043. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  133044. UNLIT: boolean;
  133045. DEBUGMODE: number;
  133046. /**
  133047. * Initializes the PBR Material defines.
  133048. */
  133049. constructor();
  133050. /**
  133051. * Resets the PBR Material defines.
  133052. */
  133053. reset(): void;
  133054. }
  133055. /**
  133056. * The Physically based material base class of BJS.
  133057. *
  133058. * This offers the main features of a standard PBR material.
  133059. * For more information, please refer to the documentation :
  133060. * https://doc.babylonjs.com/how_to/physically_based_rendering
  133061. */
  133062. export abstract class PBRBaseMaterial extends PushMaterial {
  133063. /**
  133064. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  133065. */
  133066. static readonly PBRMATERIAL_OPAQUE: number;
  133067. /**
  133068. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  133069. */
  133070. static readonly PBRMATERIAL_ALPHATEST: number;
  133071. /**
  133072. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  133073. */
  133074. static readonly PBRMATERIAL_ALPHABLEND: number;
  133075. /**
  133076. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  133077. * They are also discarded below the alpha cutoff threshold to improve performances.
  133078. */
  133079. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  133080. /**
  133081. * Defines the default value of how much AO map is occluding the analytical lights
  133082. * (point spot...).
  133083. */
  133084. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  133085. /**
  133086. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  133087. */
  133088. static readonly LIGHTFALLOFF_PHYSICAL: number;
  133089. /**
  133090. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  133091. * to enhance interoperability with other engines.
  133092. */
  133093. static readonly LIGHTFALLOFF_GLTF: number;
  133094. /**
  133095. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  133096. * to enhance interoperability with other materials.
  133097. */
  133098. static readonly LIGHTFALLOFF_STANDARD: number;
  133099. /**
  133100. * Intensity of the direct lights e.g. the four lights available in your scene.
  133101. * This impacts both the direct diffuse and specular highlights.
  133102. */
  133103. protected _directIntensity: number;
  133104. /**
  133105. * Intensity of the emissive part of the material.
  133106. * This helps controlling the emissive effect without modifying the emissive color.
  133107. */
  133108. protected _emissiveIntensity: number;
  133109. /**
  133110. * Intensity of the environment e.g. how much the environment will light the object
  133111. * either through harmonics for rough material or through the refelction for shiny ones.
  133112. */
  133113. protected _environmentIntensity: number;
  133114. /**
  133115. * This is a special control allowing the reduction of the specular highlights coming from the
  133116. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  133117. */
  133118. protected _specularIntensity: number;
  133119. /**
  133120. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  133121. */
  133122. private _lightingInfos;
  133123. /**
  133124. * Debug Control allowing disabling the bump map on this material.
  133125. */
  133126. protected _disableBumpMap: boolean;
  133127. /**
  133128. * AKA Diffuse Texture in standard nomenclature.
  133129. */
  133130. protected _albedoTexture: Nullable<BaseTexture>;
  133131. /**
  133132. * AKA Occlusion Texture in other nomenclature.
  133133. */
  133134. protected _ambientTexture: Nullable<BaseTexture>;
  133135. /**
  133136. * AKA Occlusion Texture Intensity in other nomenclature.
  133137. */
  133138. protected _ambientTextureStrength: number;
  133139. /**
  133140. * Defines how much the AO map is occluding the analytical lights (point spot...).
  133141. * 1 means it completely occludes it
  133142. * 0 mean it has no impact
  133143. */
  133144. protected _ambientTextureImpactOnAnalyticalLights: number;
  133145. /**
  133146. * Stores the alpha values in a texture.
  133147. */
  133148. protected _opacityTexture: Nullable<BaseTexture>;
  133149. /**
  133150. * Stores the reflection values in a texture.
  133151. */
  133152. protected _reflectionTexture: Nullable<BaseTexture>;
  133153. /**
  133154. * Stores the emissive values in a texture.
  133155. */
  133156. protected _emissiveTexture: Nullable<BaseTexture>;
  133157. /**
  133158. * AKA Specular texture in other nomenclature.
  133159. */
  133160. protected _reflectivityTexture: Nullable<BaseTexture>;
  133161. /**
  133162. * Used to switch from specular/glossiness to metallic/roughness workflow.
  133163. */
  133164. protected _metallicTexture: Nullable<BaseTexture>;
  133165. /**
  133166. * Specifies the metallic scalar of the metallic/roughness workflow.
  133167. * Can also be used to scale the metalness values of the metallic texture.
  133168. */
  133169. protected _metallic: Nullable<number>;
  133170. /**
  133171. * Specifies the roughness scalar of the metallic/roughness workflow.
  133172. * Can also be used to scale the roughness values of the metallic texture.
  133173. */
  133174. protected _roughness: Nullable<number>;
  133175. /**
  133176. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  133177. * By default the indexOfrefraction is used to compute F0;
  133178. *
  133179. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  133180. *
  133181. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  133182. * F90 = metallicReflectanceColor;
  133183. */
  133184. protected _metallicF0Factor: number;
  133185. /**
  133186. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  133187. * By default the F90 is always 1;
  133188. *
  133189. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  133190. *
  133191. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  133192. * F90 = metallicReflectanceColor;
  133193. */
  133194. protected _metallicReflectanceColor: Color3;
  133195. /**
  133196. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  133197. * This is multiply against the scalar values defined in the material.
  133198. */
  133199. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  133200. /**
  133201. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  133202. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  133203. */
  133204. protected _microSurfaceTexture: Nullable<BaseTexture>;
  133205. /**
  133206. * Stores surface normal data used to displace a mesh in a texture.
  133207. */
  133208. protected _bumpTexture: Nullable<BaseTexture>;
  133209. /**
  133210. * Stores the pre-calculated light information of a mesh in a texture.
  133211. */
  133212. protected _lightmapTexture: Nullable<BaseTexture>;
  133213. /**
  133214. * The color of a material in ambient lighting.
  133215. */
  133216. protected _ambientColor: Color3;
  133217. /**
  133218. * AKA Diffuse Color in other nomenclature.
  133219. */
  133220. protected _albedoColor: Color3;
  133221. /**
  133222. * AKA Specular Color in other nomenclature.
  133223. */
  133224. protected _reflectivityColor: Color3;
  133225. /**
  133226. * The color applied when light is reflected from a material.
  133227. */
  133228. protected _reflectionColor: Color3;
  133229. /**
  133230. * The color applied when light is emitted from a material.
  133231. */
  133232. protected _emissiveColor: Color3;
  133233. /**
  133234. * AKA Glossiness in other nomenclature.
  133235. */
  133236. protected _microSurface: number;
  133237. /**
  133238. * Specifies that the material will use the light map as a show map.
  133239. */
  133240. protected _useLightmapAsShadowmap: boolean;
  133241. /**
  133242. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  133243. * makes the reflect vector face the model (under horizon).
  133244. */
  133245. protected _useHorizonOcclusion: boolean;
  133246. /**
  133247. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  133248. * too much the area relying on ambient texture to define their ambient occlusion.
  133249. */
  133250. protected _useRadianceOcclusion: boolean;
  133251. /**
  133252. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  133253. */
  133254. protected _useAlphaFromAlbedoTexture: boolean;
  133255. /**
  133256. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  133257. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  133258. */
  133259. protected _useSpecularOverAlpha: boolean;
  133260. /**
  133261. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  133262. */
  133263. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  133264. /**
  133265. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  133266. */
  133267. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  133268. /**
  133269. * Specifies if the metallic texture contains the roughness information in its green channel.
  133270. */
  133271. protected _useRoughnessFromMetallicTextureGreen: boolean;
  133272. /**
  133273. * Specifies if the metallic texture contains the metallness information in its blue channel.
  133274. */
  133275. protected _useMetallnessFromMetallicTextureBlue: boolean;
  133276. /**
  133277. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  133278. */
  133279. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  133280. /**
  133281. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  133282. */
  133283. protected _useAmbientInGrayScale: boolean;
  133284. /**
  133285. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  133286. * The material will try to infer what glossiness each pixel should be.
  133287. */
  133288. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  133289. /**
  133290. * Defines the falloff type used in this material.
  133291. * It by default is Physical.
  133292. */
  133293. protected _lightFalloff: number;
  133294. /**
  133295. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  133296. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  133297. */
  133298. protected _useRadianceOverAlpha: boolean;
  133299. /**
  133300. * Allows using an object space normal map (instead of tangent space).
  133301. */
  133302. protected _useObjectSpaceNormalMap: boolean;
  133303. /**
  133304. * Allows using the bump map in parallax mode.
  133305. */
  133306. protected _useParallax: boolean;
  133307. /**
  133308. * Allows using the bump map in parallax occlusion mode.
  133309. */
  133310. protected _useParallaxOcclusion: boolean;
  133311. /**
  133312. * Controls the scale bias of the parallax mode.
  133313. */
  133314. protected _parallaxScaleBias: number;
  133315. /**
  133316. * If sets to true, disables all the lights affecting the material.
  133317. */
  133318. protected _disableLighting: boolean;
  133319. /**
  133320. * Number of Simultaneous lights allowed on the material.
  133321. */
  133322. protected _maxSimultaneousLights: number;
  133323. /**
  133324. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  133325. */
  133326. protected _invertNormalMapX: boolean;
  133327. /**
  133328. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  133329. */
  133330. protected _invertNormalMapY: boolean;
  133331. /**
  133332. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  133333. */
  133334. protected _twoSidedLighting: boolean;
  133335. /**
  133336. * Defines the alpha limits in alpha test mode.
  133337. */
  133338. protected _alphaCutOff: number;
  133339. /**
  133340. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  133341. */
  133342. protected _forceAlphaTest: boolean;
  133343. /**
  133344. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  133345. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  133346. */
  133347. protected _useAlphaFresnel: boolean;
  133348. /**
  133349. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  133350. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  133351. */
  133352. protected _useLinearAlphaFresnel: boolean;
  133353. /**
  133354. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  133355. * from cos thetav and roughness:
  133356. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  133357. */
  133358. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  133359. /**
  133360. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  133361. */
  133362. protected _forceIrradianceInFragment: boolean;
  133363. private _realTimeFiltering;
  133364. /**
  133365. * Enables realtime filtering on the texture.
  133366. */
  133367. get realTimeFiltering(): boolean;
  133368. set realTimeFiltering(b: boolean);
  133369. private _realTimeFilteringQuality;
  133370. /**
  133371. * Quality switch for realtime filtering
  133372. */
  133373. get realTimeFilteringQuality(): number;
  133374. set realTimeFilteringQuality(n: number);
  133375. /**
  133376. * Force normal to face away from face.
  133377. */
  133378. protected _forceNormalForward: boolean;
  133379. /**
  133380. * Enables specular anti aliasing in the PBR shader.
  133381. * It will both interacts on the Geometry for analytical and IBL lighting.
  133382. * It also prefilter the roughness map based on the bump values.
  133383. */
  133384. protected _enableSpecularAntiAliasing: boolean;
  133385. /**
  133386. * Default configuration related to image processing available in the PBR Material.
  133387. */
  133388. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  133389. /**
  133390. * Keep track of the image processing observer to allow dispose and replace.
  133391. */
  133392. private _imageProcessingObserver;
  133393. /**
  133394. * Attaches a new image processing configuration to the PBR Material.
  133395. * @param configuration
  133396. */
  133397. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  133398. /**
  133399. * Stores the available render targets.
  133400. */
  133401. private _renderTargets;
  133402. /**
  133403. * Sets the global ambient color for the material used in lighting calculations.
  133404. */
  133405. private _globalAmbientColor;
  133406. /**
  133407. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  133408. */
  133409. private _useLogarithmicDepth;
  133410. /**
  133411. * If set to true, no lighting calculations will be applied.
  133412. */
  133413. private _unlit;
  133414. private _debugMode;
  133415. /**
  133416. * @hidden
  133417. * This is reserved for the inspector.
  133418. * Defines the material debug mode.
  133419. * It helps seeing only some components of the material while troubleshooting.
  133420. */
  133421. debugMode: number;
  133422. /**
  133423. * @hidden
  133424. * This is reserved for the inspector.
  133425. * Specify from where on screen the debug mode should start.
  133426. * The value goes from -1 (full screen) to 1 (not visible)
  133427. * It helps with side by side comparison against the final render
  133428. * This defaults to -1
  133429. */
  133430. private debugLimit;
  133431. /**
  133432. * @hidden
  133433. * This is reserved for the inspector.
  133434. * As the default viewing range might not be enough (if the ambient is really small for instance)
  133435. * You can use the factor to better multiply the final value.
  133436. */
  133437. private debugFactor;
  133438. /**
  133439. * Defines the clear coat layer parameters for the material.
  133440. */
  133441. readonly clearCoat: PBRClearCoatConfiguration;
  133442. /**
  133443. * Defines the anisotropic parameters for the material.
  133444. */
  133445. readonly anisotropy: PBRAnisotropicConfiguration;
  133446. /**
  133447. * Defines the BRDF parameters for the material.
  133448. */
  133449. readonly brdf: PBRBRDFConfiguration;
  133450. /**
  133451. * Defines the Sheen parameters for the material.
  133452. */
  133453. readonly sheen: PBRSheenConfiguration;
  133454. /**
  133455. * Defines the SubSurface parameters for the material.
  133456. */
  133457. readonly subSurface: PBRSubSurfaceConfiguration;
  133458. /**
  133459. * Defines the detail map parameters for the material.
  133460. */
  133461. readonly detailMap: DetailMapConfiguration;
  133462. protected _rebuildInParallel: boolean;
  133463. /**
  133464. * Instantiates a new PBRMaterial instance.
  133465. *
  133466. * @param name The material name
  133467. * @param scene The scene the material will be use in.
  133468. */
  133469. constructor(name: string, scene: Scene);
  133470. /**
  133471. * Gets a boolean indicating that current material needs to register RTT
  133472. */
  133473. get hasRenderTargetTextures(): boolean;
  133474. /**
  133475. * Gets the name of the material class.
  133476. */
  133477. getClassName(): string;
  133478. /**
  133479. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  133480. */
  133481. get useLogarithmicDepth(): boolean;
  133482. /**
  133483. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  133484. */
  133485. set useLogarithmicDepth(value: boolean);
  133486. /**
  133487. * Returns true if alpha blending should be disabled.
  133488. */
  133489. protected get _disableAlphaBlending(): boolean;
  133490. /**
  133491. * Specifies whether or not this material should be rendered in alpha blend mode.
  133492. */
  133493. needAlphaBlending(): boolean;
  133494. /**
  133495. * Specifies whether or not this material should be rendered in alpha test mode.
  133496. */
  133497. needAlphaTesting(): boolean;
  133498. /**
  133499. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  133500. */
  133501. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  133502. /**
  133503. * Gets the texture used for the alpha test.
  133504. */
  133505. getAlphaTestTexture(): Nullable<BaseTexture>;
  133506. /**
  133507. * Specifies that the submesh is ready to be used.
  133508. * @param mesh - BJS mesh.
  133509. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  133510. * @param useInstances - Specifies that instances should be used.
  133511. * @returns - boolean indicating that the submesh is ready or not.
  133512. */
  133513. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  133514. /**
  133515. * Specifies if the material uses metallic roughness workflow.
  133516. * @returns boolean specifiying if the material uses metallic roughness workflow.
  133517. */
  133518. isMetallicWorkflow(): boolean;
  133519. private _prepareEffect;
  133520. private _prepareDefines;
  133521. /**
  133522. * Force shader compilation
  133523. */
  133524. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  133525. /**
  133526. * Initializes the uniform buffer layout for the shader.
  133527. */
  133528. buildUniformLayout(): void;
  133529. /**
  133530. * Unbinds the material from the mesh
  133531. */
  133532. unbind(): void;
  133533. /**
  133534. * Binds the submesh data.
  133535. * @param world - The world matrix.
  133536. * @param mesh - The BJS mesh.
  133537. * @param subMesh - A submesh of the BJS mesh.
  133538. */
  133539. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  133540. /**
  133541. * Returns the animatable textures.
  133542. * @returns - Array of animatable textures.
  133543. */
  133544. getAnimatables(): IAnimatable[];
  133545. /**
  133546. * Returns the texture used for reflections.
  133547. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  133548. */
  133549. private _getReflectionTexture;
  133550. /**
  133551. * Returns an array of the actively used textures.
  133552. * @returns - Array of BaseTextures
  133553. */
  133554. getActiveTextures(): BaseTexture[];
  133555. /**
  133556. * Checks to see if a texture is used in the material.
  133557. * @param texture - Base texture to use.
  133558. * @returns - Boolean specifying if a texture is used in the material.
  133559. */
  133560. hasTexture(texture: BaseTexture): boolean;
  133561. /**
  133562. * Disposes the resources of the material.
  133563. * @param forceDisposeEffect - Forces the disposal of effects.
  133564. * @param forceDisposeTextures - Forces the disposal of all textures.
  133565. */
  133566. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  133567. }
  133568. }
  133569. declare module BABYLON {
  133570. /**
  133571. * The Physically based material of BJS.
  133572. *
  133573. * This offers the main features of a standard PBR material.
  133574. * For more information, please refer to the documentation :
  133575. * https://doc.babylonjs.com/how_to/physically_based_rendering
  133576. */
  133577. export class PBRMaterial extends PBRBaseMaterial {
  133578. /**
  133579. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  133580. */
  133581. static readonly PBRMATERIAL_OPAQUE: number;
  133582. /**
  133583. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  133584. */
  133585. static readonly PBRMATERIAL_ALPHATEST: number;
  133586. /**
  133587. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  133588. */
  133589. static readonly PBRMATERIAL_ALPHABLEND: number;
  133590. /**
  133591. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  133592. * They are also discarded below the alpha cutoff threshold to improve performances.
  133593. */
  133594. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  133595. /**
  133596. * Defines the default value of how much AO map is occluding the analytical lights
  133597. * (point spot...).
  133598. */
  133599. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  133600. /**
  133601. * Intensity of the direct lights e.g. the four lights available in your scene.
  133602. * This impacts both the direct diffuse and specular highlights.
  133603. */
  133604. directIntensity: number;
  133605. /**
  133606. * Intensity of the emissive part of the material.
  133607. * This helps controlling the emissive effect without modifying the emissive color.
  133608. */
  133609. emissiveIntensity: number;
  133610. /**
  133611. * Intensity of the environment e.g. how much the environment will light the object
  133612. * either through harmonics for rough material or through the refelction for shiny ones.
  133613. */
  133614. environmentIntensity: number;
  133615. /**
  133616. * This is a special control allowing the reduction of the specular highlights coming from the
  133617. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  133618. */
  133619. specularIntensity: number;
  133620. /**
  133621. * Debug Control allowing disabling the bump map on this material.
  133622. */
  133623. disableBumpMap: boolean;
  133624. /**
  133625. * AKA Diffuse Texture in standard nomenclature.
  133626. */
  133627. albedoTexture: BaseTexture;
  133628. /**
  133629. * AKA Occlusion Texture in other nomenclature.
  133630. */
  133631. ambientTexture: BaseTexture;
  133632. /**
  133633. * AKA Occlusion Texture Intensity in other nomenclature.
  133634. */
  133635. ambientTextureStrength: number;
  133636. /**
  133637. * Defines how much the AO map is occluding the analytical lights (point spot...).
  133638. * 1 means it completely occludes it
  133639. * 0 mean it has no impact
  133640. */
  133641. ambientTextureImpactOnAnalyticalLights: number;
  133642. /**
  133643. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  133644. */
  133645. opacityTexture: BaseTexture;
  133646. /**
  133647. * Stores the reflection values in a texture.
  133648. */
  133649. reflectionTexture: Nullable<BaseTexture>;
  133650. /**
  133651. * Stores the emissive values in a texture.
  133652. */
  133653. emissiveTexture: BaseTexture;
  133654. /**
  133655. * AKA Specular texture in other nomenclature.
  133656. */
  133657. reflectivityTexture: BaseTexture;
  133658. /**
  133659. * Used to switch from specular/glossiness to metallic/roughness workflow.
  133660. */
  133661. metallicTexture: BaseTexture;
  133662. /**
  133663. * Specifies the metallic scalar of the metallic/roughness workflow.
  133664. * Can also be used to scale the metalness values of the metallic texture.
  133665. */
  133666. metallic: Nullable<number>;
  133667. /**
  133668. * Specifies the roughness scalar of the metallic/roughness workflow.
  133669. * Can also be used to scale the roughness values of the metallic texture.
  133670. */
  133671. roughness: Nullable<number>;
  133672. /**
  133673. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  133674. * By default the indexOfrefraction is used to compute F0;
  133675. *
  133676. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  133677. *
  133678. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  133679. * F90 = metallicReflectanceColor;
  133680. */
  133681. metallicF0Factor: number;
  133682. /**
  133683. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  133684. * By default the F90 is always 1;
  133685. *
  133686. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  133687. *
  133688. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  133689. * F90 = metallicReflectanceColor;
  133690. */
  133691. metallicReflectanceColor: Color3;
  133692. /**
  133693. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  133694. * This is multiply against the scalar values defined in the material.
  133695. */
  133696. metallicReflectanceTexture: Nullable<BaseTexture>;
  133697. /**
  133698. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  133699. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  133700. */
  133701. microSurfaceTexture: BaseTexture;
  133702. /**
  133703. * Stores surface normal data used to displace a mesh in a texture.
  133704. */
  133705. bumpTexture: BaseTexture;
  133706. /**
  133707. * Stores the pre-calculated light information of a mesh in a texture.
  133708. */
  133709. lightmapTexture: BaseTexture;
  133710. /**
  133711. * Stores the refracted light information in a texture.
  133712. */
  133713. get refractionTexture(): Nullable<BaseTexture>;
  133714. set refractionTexture(value: Nullable<BaseTexture>);
  133715. /**
  133716. * The color of a material in ambient lighting.
  133717. */
  133718. ambientColor: Color3;
  133719. /**
  133720. * AKA Diffuse Color in other nomenclature.
  133721. */
  133722. albedoColor: Color3;
  133723. /**
  133724. * AKA Specular Color in other nomenclature.
  133725. */
  133726. reflectivityColor: Color3;
  133727. /**
  133728. * The color reflected from the material.
  133729. */
  133730. reflectionColor: Color3;
  133731. /**
  133732. * The color emitted from the material.
  133733. */
  133734. emissiveColor: Color3;
  133735. /**
  133736. * AKA Glossiness in other nomenclature.
  133737. */
  133738. microSurface: number;
  133739. /**
  133740. * Index of refraction of the material base layer.
  133741. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  133742. *
  133743. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  133744. *
  133745. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  133746. */
  133747. get indexOfRefraction(): number;
  133748. set indexOfRefraction(value: number);
  133749. /**
  133750. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  133751. */
  133752. get invertRefractionY(): boolean;
  133753. set invertRefractionY(value: boolean);
  133754. /**
  133755. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  133756. * Materials half opaque for instance using refraction could benefit from this control.
  133757. */
  133758. get linkRefractionWithTransparency(): boolean;
  133759. set linkRefractionWithTransparency(value: boolean);
  133760. /**
  133761. * If true, the light map contains occlusion information instead of lighting info.
  133762. */
  133763. useLightmapAsShadowmap: boolean;
  133764. /**
  133765. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  133766. */
  133767. useAlphaFromAlbedoTexture: boolean;
  133768. /**
  133769. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  133770. */
  133771. forceAlphaTest: boolean;
  133772. /**
  133773. * Defines the alpha limits in alpha test mode.
  133774. */
  133775. alphaCutOff: number;
  133776. /**
  133777. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  133778. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  133779. */
  133780. useSpecularOverAlpha: boolean;
  133781. /**
  133782. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  133783. */
  133784. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  133785. /**
  133786. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  133787. */
  133788. useRoughnessFromMetallicTextureAlpha: boolean;
  133789. /**
  133790. * Specifies if the metallic texture contains the roughness information in its green channel.
  133791. */
  133792. useRoughnessFromMetallicTextureGreen: boolean;
  133793. /**
  133794. * Specifies if the metallic texture contains the metallness information in its blue channel.
  133795. */
  133796. useMetallnessFromMetallicTextureBlue: boolean;
  133797. /**
  133798. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  133799. */
  133800. useAmbientOcclusionFromMetallicTextureRed: boolean;
  133801. /**
  133802. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  133803. */
  133804. useAmbientInGrayScale: boolean;
  133805. /**
  133806. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  133807. * The material will try to infer what glossiness each pixel should be.
  133808. */
  133809. useAutoMicroSurfaceFromReflectivityMap: boolean;
  133810. /**
  133811. * BJS is using an harcoded light falloff based on a manually sets up range.
  133812. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  133813. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  133814. */
  133815. get usePhysicalLightFalloff(): boolean;
  133816. /**
  133817. * BJS is using an harcoded light falloff based on a manually sets up range.
  133818. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  133819. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  133820. */
  133821. set usePhysicalLightFalloff(value: boolean);
  133822. /**
  133823. * In order to support the falloff compatibility with gltf, a special mode has been added
  133824. * to reproduce the gltf light falloff.
  133825. */
  133826. get useGLTFLightFalloff(): boolean;
  133827. /**
  133828. * In order to support the falloff compatibility with gltf, a special mode has been added
  133829. * to reproduce the gltf light falloff.
  133830. */
  133831. set useGLTFLightFalloff(value: boolean);
  133832. /**
  133833. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  133834. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  133835. */
  133836. useRadianceOverAlpha: boolean;
  133837. /**
  133838. * Allows using an object space normal map (instead of tangent space).
  133839. */
  133840. useObjectSpaceNormalMap: boolean;
  133841. /**
  133842. * Allows using the bump map in parallax mode.
  133843. */
  133844. useParallax: boolean;
  133845. /**
  133846. * Allows using the bump map in parallax occlusion mode.
  133847. */
  133848. useParallaxOcclusion: boolean;
  133849. /**
  133850. * Controls the scale bias of the parallax mode.
  133851. */
  133852. parallaxScaleBias: number;
  133853. /**
  133854. * If sets to true, disables all the lights affecting the material.
  133855. */
  133856. disableLighting: boolean;
  133857. /**
  133858. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  133859. */
  133860. forceIrradianceInFragment: boolean;
  133861. /**
  133862. * Number of Simultaneous lights allowed on the material.
  133863. */
  133864. maxSimultaneousLights: number;
  133865. /**
  133866. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  133867. */
  133868. invertNormalMapX: boolean;
  133869. /**
  133870. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  133871. */
  133872. invertNormalMapY: boolean;
  133873. /**
  133874. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  133875. */
  133876. twoSidedLighting: boolean;
  133877. /**
  133878. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  133879. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  133880. */
  133881. useAlphaFresnel: boolean;
  133882. /**
  133883. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  133884. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  133885. */
  133886. useLinearAlphaFresnel: boolean;
  133887. /**
  133888. * Let user defines the brdf lookup texture used for IBL.
  133889. * A default 8bit version is embedded but you could point at :
  133890. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  133891. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  133892. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  133893. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  133894. */
  133895. environmentBRDFTexture: Nullable<BaseTexture>;
  133896. /**
  133897. * Force normal to face away from face.
  133898. */
  133899. forceNormalForward: boolean;
  133900. /**
  133901. * Enables specular anti aliasing in the PBR shader.
  133902. * It will both interacts on the Geometry for analytical and IBL lighting.
  133903. * It also prefilter the roughness map based on the bump values.
  133904. */
  133905. enableSpecularAntiAliasing: boolean;
  133906. /**
  133907. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  133908. * makes the reflect vector face the model (under horizon).
  133909. */
  133910. useHorizonOcclusion: boolean;
  133911. /**
  133912. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  133913. * too much the area relying on ambient texture to define their ambient occlusion.
  133914. */
  133915. useRadianceOcclusion: boolean;
  133916. /**
  133917. * If set to true, no lighting calculations will be applied.
  133918. */
  133919. unlit: boolean;
  133920. /**
  133921. * Gets the image processing configuration used either in this material.
  133922. */
  133923. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  133924. /**
  133925. * Sets the Default image processing configuration used either in the this material.
  133926. *
  133927. * If sets to null, the scene one is in use.
  133928. */
  133929. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  133930. /**
  133931. * Gets wether the color curves effect is enabled.
  133932. */
  133933. get cameraColorCurvesEnabled(): boolean;
  133934. /**
  133935. * Sets wether the color curves effect is enabled.
  133936. */
  133937. set cameraColorCurvesEnabled(value: boolean);
  133938. /**
  133939. * Gets wether the color grading effect is enabled.
  133940. */
  133941. get cameraColorGradingEnabled(): boolean;
  133942. /**
  133943. * Gets wether the color grading effect is enabled.
  133944. */
  133945. set cameraColorGradingEnabled(value: boolean);
  133946. /**
  133947. * Gets wether tonemapping is enabled or not.
  133948. */
  133949. get cameraToneMappingEnabled(): boolean;
  133950. /**
  133951. * Sets wether tonemapping is enabled or not
  133952. */
  133953. set cameraToneMappingEnabled(value: boolean);
  133954. /**
  133955. * The camera exposure used on this material.
  133956. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  133957. * This corresponds to a photographic exposure.
  133958. */
  133959. get cameraExposure(): number;
  133960. /**
  133961. * The camera exposure used on this material.
  133962. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  133963. * This corresponds to a photographic exposure.
  133964. */
  133965. set cameraExposure(value: number);
  133966. /**
  133967. * Gets The camera contrast used on this material.
  133968. */
  133969. get cameraContrast(): number;
  133970. /**
  133971. * Sets The camera contrast used on this material.
  133972. */
  133973. set cameraContrast(value: number);
  133974. /**
  133975. * Gets the Color Grading 2D Lookup Texture.
  133976. */
  133977. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  133978. /**
  133979. * Sets the Color Grading 2D Lookup Texture.
  133980. */
  133981. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  133982. /**
  133983. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  133984. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  133985. * 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;
  133986. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  133987. */
  133988. get cameraColorCurves(): Nullable<ColorCurves>;
  133989. /**
  133990. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  133991. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  133992. * 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;
  133993. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  133994. */
  133995. set cameraColorCurves(value: Nullable<ColorCurves>);
  133996. /**
  133997. * Instantiates a new PBRMaterial instance.
  133998. *
  133999. * @param name The material name
  134000. * @param scene The scene the material will be use in.
  134001. */
  134002. constructor(name: string, scene: Scene);
  134003. /**
  134004. * Returns the name of this material class.
  134005. */
  134006. getClassName(): string;
  134007. /**
  134008. * Makes a duplicate of the current material.
  134009. * @param name - name to use for the new material.
  134010. */
  134011. clone(name: string): PBRMaterial;
  134012. /**
  134013. * Serializes this PBR Material.
  134014. * @returns - An object with the serialized material.
  134015. */
  134016. serialize(): any;
  134017. /**
  134018. * Parses a PBR Material from a serialized object.
  134019. * @param source - Serialized object.
  134020. * @param scene - BJS scene instance.
  134021. * @param rootUrl - url for the scene object
  134022. * @returns - PBRMaterial
  134023. */
  134024. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  134025. }
  134026. }
  134027. declare module BABYLON {
  134028. /**
  134029. * Direct draw surface info
  134030. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  134031. */
  134032. export interface DDSInfo {
  134033. /**
  134034. * Width of the texture
  134035. */
  134036. width: number;
  134037. /**
  134038. * Width of the texture
  134039. */
  134040. height: number;
  134041. /**
  134042. * Number of Mipmaps for the texture
  134043. * @see https://en.wikipedia.org/wiki/Mipmap
  134044. */
  134045. mipmapCount: number;
  134046. /**
  134047. * If the textures format is a known fourCC format
  134048. * @see https://www.fourcc.org/
  134049. */
  134050. isFourCC: boolean;
  134051. /**
  134052. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  134053. */
  134054. isRGB: boolean;
  134055. /**
  134056. * If the texture is a lumincance format
  134057. */
  134058. isLuminance: boolean;
  134059. /**
  134060. * If this is a cube texture
  134061. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  134062. */
  134063. isCube: boolean;
  134064. /**
  134065. * If the texture is a compressed format eg. FOURCC_DXT1
  134066. */
  134067. isCompressed: boolean;
  134068. /**
  134069. * The dxgiFormat of the texture
  134070. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  134071. */
  134072. dxgiFormat: number;
  134073. /**
  134074. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  134075. */
  134076. textureType: number;
  134077. /**
  134078. * Sphericle polynomial created for the dds texture
  134079. */
  134080. sphericalPolynomial?: SphericalPolynomial;
  134081. }
  134082. /**
  134083. * Class used to provide DDS decompression tools
  134084. */
  134085. export class DDSTools {
  134086. /**
  134087. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  134088. */
  134089. static StoreLODInAlphaChannel: boolean;
  134090. /**
  134091. * Gets DDS information from an array buffer
  134092. * @param data defines the array buffer view to read data from
  134093. * @returns the DDS information
  134094. */
  134095. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  134096. private static _FloatView;
  134097. private static _Int32View;
  134098. private static _ToHalfFloat;
  134099. private static _FromHalfFloat;
  134100. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  134101. private static _GetHalfFloatRGBAArrayBuffer;
  134102. private static _GetFloatRGBAArrayBuffer;
  134103. private static _GetFloatAsUIntRGBAArrayBuffer;
  134104. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  134105. private static _GetRGBAArrayBuffer;
  134106. private static _ExtractLongWordOrder;
  134107. private static _GetRGBArrayBuffer;
  134108. private static _GetLuminanceArrayBuffer;
  134109. /**
  134110. * Uploads DDS Levels to a Babylon Texture
  134111. * @hidden
  134112. */
  134113. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  134114. }
  134115. interface ThinEngine {
  134116. /**
  134117. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  134118. * @param rootUrl defines the url where the file to load is located
  134119. * @param scene defines the current scene
  134120. * @param lodScale defines scale to apply to the mip map selection
  134121. * @param lodOffset defines offset to apply to the mip map selection
  134122. * @param onLoad defines an optional callback raised when the texture is loaded
  134123. * @param onError defines an optional callback raised if there is an issue to load the texture
  134124. * @param format defines the format of the data
  134125. * @param forcedExtension defines the extension to use to pick the right loader
  134126. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  134127. * @returns the cube texture as an InternalTexture
  134128. */
  134129. 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;
  134130. }
  134131. }
  134132. declare module BABYLON {
  134133. /**
  134134. * Implementation of the DDS Texture Loader.
  134135. * @hidden
  134136. */
  134137. export class _DDSTextureLoader implements IInternalTextureLoader {
  134138. /**
  134139. * Defines wether the loader supports cascade loading the different faces.
  134140. */
  134141. readonly supportCascades: boolean;
  134142. /**
  134143. * This returns if the loader support the current file information.
  134144. * @param extension defines the file extension of the file being loaded
  134145. * @returns true if the loader can load the specified file
  134146. */
  134147. canLoad(extension: string): boolean;
  134148. /**
  134149. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  134150. * @param data contains the texture data
  134151. * @param texture defines the BabylonJS internal texture
  134152. * @param createPolynomials will be true if polynomials have been requested
  134153. * @param onLoad defines the callback to trigger once the texture is ready
  134154. * @param onError defines the callback to trigger in case of error
  134155. */
  134156. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  134157. /**
  134158. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  134159. * @param data contains the texture data
  134160. * @param texture defines the BabylonJS internal texture
  134161. * @param callback defines the method to call once ready to upload
  134162. */
  134163. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  134164. }
  134165. }
  134166. declare module BABYLON {
  134167. /**
  134168. * Implementation of the ENV Texture Loader.
  134169. * @hidden
  134170. */
  134171. export class _ENVTextureLoader implements IInternalTextureLoader {
  134172. /**
  134173. * Defines wether the loader supports cascade loading the different faces.
  134174. */
  134175. readonly supportCascades: boolean;
  134176. /**
  134177. * This returns if the loader support the current file information.
  134178. * @param extension defines the file extension of the file being loaded
  134179. * @returns true if the loader can load the specified file
  134180. */
  134181. canLoad(extension: string): boolean;
  134182. /**
  134183. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  134184. * @param data contains the texture data
  134185. * @param texture defines the BabylonJS internal texture
  134186. * @param createPolynomials will be true if polynomials have been requested
  134187. * @param onLoad defines the callback to trigger once the texture is ready
  134188. * @param onError defines the callback to trigger in case of error
  134189. */
  134190. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  134191. /**
  134192. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  134193. * @param data contains the texture data
  134194. * @param texture defines the BabylonJS internal texture
  134195. * @param callback defines the method to call once ready to upload
  134196. */
  134197. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  134198. }
  134199. }
  134200. declare module BABYLON {
  134201. /**
  134202. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  134203. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  134204. */
  134205. export class KhronosTextureContainer {
  134206. /** contents of the KTX container file */
  134207. data: ArrayBufferView;
  134208. private static HEADER_LEN;
  134209. private static COMPRESSED_2D;
  134210. private static COMPRESSED_3D;
  134211. private static TEX_2D;
  134212. private static TEX_3D;
  134213. /**
  134214. * Gets the openGL type
  134215. */
  134216. glType: number;
  134217. /**
  134218. * Gets the openGL type size
  134219. */
  134220. glTypeSize: number;
  134221. /**
  134222. * Gets the openGL format
  134223. */
  134224. glFormat: number;
  134225. /**
  134226. * Gets the openGL internal format
  134227. */
  134228. glInternalFormat: number;
  134229. /**
  134230. * Gets the base internal format
  134231. */
  134232. glBaseInternalFormat: number;
  134233. /**
  134234. * Gets image width in pixel
  134235. */
  134236. pixelWidth: number;
  134237. /**
  134238. * Gets image height in pixel
  134239. */
  134240. pixelHeight: number;
  134241. /**
  134242. * Gets image depth in pixels
  134243. */
  134244. pixelDepth: number;
  134245. /**
  134246. * Gets the number of array elements
  134247. */
  134248. numberOfArrayElements: number;
  134249. /**
  134250. * Gets the number of faces
  134251. */
  134252. numberOfFaces: number;
  134253. /**
  134254. * Gets the number of mipmap levels
  134255. */
  134256. numberOfMipmapLevels: number;
  134257. /**
  134258. * Gets the bytes of key value data
  134259. */
  134260. bytesOfKeyValueData: number;
  134261. /**
  134262. * Gets the load type
  134263. */
  134264. loadType: number;
  134265. /**
  134266. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  134267. */
  134268. isInvalid: boolean;
  134269. /**
  134270. * Creates a new KhronosTextureContainer
  134271. * @param data contents of the KTX container file
  134272. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  134273. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  134274. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  134275. */
  134276. constructor(
  134277. /** contents of the KTX container file */
  134278. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  134279. /**
  134280. * Uploads KTX content to a Babylon Texture.
  134281. * It is assumed that the texture has already been created & is currently bound
  134282. * @hidden
  134283. */
  134284. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  134285. private _upload2DCompressedLevels;
  134286. /**
  134287. * Checks if the given data starts with a KTX file identifier.
  134288. * @param data the data to check
  134289. * @returns true if the data is a KTX file or false otherwise
  134290. */
  134291. static IsValid(data: ArrayBufferView): boolean;
  134292. }
  134293. }
  134294. declare module BABYLON {
  134295. /**
  134296. * Class for loading KTX2 files
  134297. * !!! Experimental Extension Subject to Changes !!!
  134298. * @hidden
  134299. */
  134300. export class KhronosTextureContainer2 {
  134301. private static _ModulePromise;
  134302. private static _TranscodeFormat;
  134303. constructor(engine: ThinEngine);
  134304. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  134305. private _determineTranscodeFormat;
  134306. /**
  134307. * Checks if the given data starts with a KTX2 file identifier.
  134308. * @param data the data to check
  134309. * @returns true if the data is a KTX2 file or false otherwise
  134310. */
  134311. static IsValid(data: ArrayBufferView): boolean;
  134312. }
  134313. }
  134314. declare module BABYLON {
  134315. /**
  134316. * Implementation of the KTX Texture Loader.
  134317. * @hidden
  134318. */
  134319. export class _KTXTextureLoader implements IInternalTextureLoader {
  134320. /**
  134321. * Defines wether the loader supports cascade loading the different faces.
  134322. */
  134323. readonly supportCascades: boolean;
  134324. /**
  134325. * This returns if the loader support the current file information.
  134326. * @param extension defines the file extension of the file being loaded
  134327. * @returns true if the loader can load the specified file
  134328. */
  134329. canLoad(extension: string): boolean;
  134330. /**
  134331. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  134332. * @param data contains the texture data
  134333. * @param texture defines the BabylonJS internal texture
  134334. * @param createPolynomials will be true if polynomials have been requested
  134335. * @param onLoad defines the callback to trigger once the texture is ready
  134336. * @param onError defines the callback to trigger in case of error
  134337. */
  134338. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  134339. /**
  134340. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  134341. * @param data contains the texture data
  134342. * @param texture defines the BabylonJS internal texture
  134343. * @param callback defines the method to call once ready to upload
  134344. */
  134345. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  134346. }
  134347. }
  134348. declare module BABYLON {
  134349. /** @hidden */
  134350. export var _forceSceneHelpersToBundle: boolean;
  134351. interface Scene {
  134352. /**
  134353. * Creates a default light for the scene.
  134354. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  134355. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  134356. */
  134357. createDefaultLight(replace?: boolean): void;
  134358. /**
  134359. * Creates a default camera for the scene.
  134360. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  134361. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  134362. * @param replace has default false, when true replaces the active camera in the scene
  134363. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  134364. */
  134365. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  134366. /**
  134367. * Creates a default camera and a default light.
  134368. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  134369. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  134370. * @param replace has the default false, when true replaces the active camera/light in the scene
  134371. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  134372. */
  134373. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  134374. /**
  134375. * Creates a new sky box
  134376. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  134377. * @param environmentTexture defines the texture to use as environment texture
  134378. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  134379. * @param scale defines the overall scale of the skybox
  134380. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  134381. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  134382. * @returns a new mesh holding the sky box
  134383. */
  134384. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  134385. /**
  134386. * Creates a new environment
  134387. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  134388. * @param options defines the options you can use to configure the environment
  134389. * @returns the new EnvironmentHelper
  134390. */
  134391. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  134392. /**
  134393. * Creates a new VREXperienceHelper
  134394. * @see http://doc.babylonjs.com/how_to/webvr_helper
  134395. * @param webVROptions defines the options used to create the new VREXperienceHelper
  134396. * @returns a new VREXperienceHelper
  134397. */
  134398. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  134399. /**
  134400. * Creates a new WebXRDefaultExperience
  134401. * @see http://doc.babylonjs.com/how_to/webxr
  134402. * @param options experience options
  134403. * @returns a promise for a new WebXRDefaultExperience
  134404. */
  134405. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  134406. }
  134407. }
  134408. declare module BABYLON {
  134409. /**
  134410. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  134411. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  134412. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  134413. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134414. */
  134415. export class VideoDome extends TransformNode {
  134416. /**
  134417. * Define the video source as a Monoscopic panoramic 360 video.
  134418. */
  134419. static readonly MODE_MONOSCOPIC: number;
  134420. /**
  134421. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  134422. */
  134423. static readonly MODE_TOPBOTTOM: number;
  134424. /**
  134425. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  134426. */
  134427. static readonly MODE_SIDEBYSIDE: number;
  134428. private _halfDome;
  134429. private _useDirectMapping;
  134430. /**
  134431. * The video texture being displayed on the sphere
  134432. */
  134433. protected _videoTexture: VideoTexture;
  134434. /**
  134435. * Gets the video texture being displayed on the sphere
  134436. */
  134437. get videoTexture(): VideoTexture;
  134438. /**
  134439. * The skybox material
  134440. */
  134441. protected _material: BackgroundMaterial;
  134442. /**
  134443. * The surface used for the skybox
  134444. */
  134445. protected _mesh: Mesh;
  134446. /**
  134447. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  134448. */
  134449. private _halfDomeMask;
  134450. /**
  134451. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134452. * Also see the options.resolution property.
  134453. */
  134454. get fovMultiplier(): number;
  134455. set fovMultiplier(value: number);
  134456. private _videoMode;
  134457. /**
  134458. * Gets or set the current video mode for the video. It can be:
  134459. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  134460. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  134461. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  134462. */
  134463. get videoMode(): number;
  134464. set videoMode(value: number);
  134465. /**
  134466. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  134467. *
  134468. */
  134469. get halfDome(): boolean;
  134470. /**
  134471. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  134472. */
  134473. set halfDome(enabled: boolean);
  134474. /**
  134475. * Oberserver used in Stereoscopic VR Mode.
  134476. */
  134477. private _onBeforeCameraRenderObserver;
  134478. /**
  134479. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  134480. * @param name Element's name, child elements will append suffixes for their own names.
  134481. * @param urlsOrVideo defines the url(s) or the video element to use
  134482. * @param options An object containing optional or exposed sub element properties
  134483. */
  134484. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  134485. resolution?: number;
  134486. clickToPlay?: boolean;
  134487. autoPlay?: boolean;
  134488. loop?: boolean;
  134489. size?: number;
  134490. poster?: string;
  134491. faceForward?: boolean;
  134492. useDirectMapping?: boolean;
  134493. halfDomeMode?: boolean;
  134494. }, scene: Scene);
  134495. private _changeVideoMode;
  134496. /**
  134497. * Releases resources associated with this node.
  134498. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134499. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134500. */
  134501. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134502. }
  134503. }
  134504. declare module BABYLON {
  134505. /**
  134506. * This class can be used to get instrumentation data from a Babylon engine
  134507. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  134508. */
  134509. export class EngineInstrumentation implements IDisposable {
  134510. /**
  134511. * Define the instrumented engine.
  134512. */
  134513. engine: Engine;
  134514. private _captureGPUFrameTime;
  134515. private _gpuFrameTimeToken;
  134516. private _gpuFrameTime;
  134517. private _captureShaderCompilationTime;
  134518. private _shaderCompilationTime;
  134519. private _onBeginFrameObserver;
  134520. private _onEndFrameObserver;
  134521. private _onBeforeShaderCompilationObserver;
  134522. private _onAfterShaderCompilationObserver;
  134523. /**
  134524. * Gets the perf counter used for GPU frame time
  134525. */
  134526. get gpuFrameTimeCounter(): PerfCounter;
  134527. /**
  134528. * Gets the GPU frame time capture status
  134529. */
  134530. get captureGPUFrameTime(): boolean;
  134531. /**
  134532. * Enable or disable the GPU frame time capture
  134533. */
  134534. set captureGPUFrameTime(value: boolean);
  134535. /**
  134536. * Gets the perf counter used for shader compilation time
  134537. */
  134538. get shaderCompilationTimeCounter(): PerfCounter;
  134539. /**
  134540. * Gets the shader compilation time capture status
  134541. */
  134542. get captureShaderCompilationTime(): boolean;
  134543. /**
  134544. * Enable or disable the shader compilation time capture
  134545. */
  134546. set captureShaderCompilationTime(value: boolean);
  134547. /**
  134548. * Instantiates a new engine instrumentation.
  134549. * This class can be used to get instrumentation data from a Babylon engine
  134550. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  134551. * @param engine Defines the engine to instrument
  134552. */
  134553. constructor(
  134554. /**
  134555. * Define the instrumented engine.
  134556. */
  134557. engine: Engine);
  134558. /**
  134559. * Dispose and release associated resources.
  134560. */
  134561. dispose(): void;
  134562. }
  134563. }
  134564. declare module BABYLON {
  134565. /**
  134566. * This class can be used to get instrumentation data from a Babylon engine
  134567. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  134568. */
  134569. export class SceneInstrumentation implements IDisposable {
  134570. /**
  134571. * Defines the scene to instrument
  134572. */
  134573. scene: Scene;
  134574. private _captureActiveMeshesEvaluationTime;
  134575. private _activeMeshesEvaluationTime;
  134576. private _captureRenderTargetsRenderTime;
  134577. private _renderTargetsRenderTime;
  134578. private _captureFrameTime;
  134579. private _frameTime;
  134580. private _captureRenderTime;
  134581. private _renderTime;
  134582. private _captureInterFrameTime;
  134583. private _interFrameTime;
  134584. private _captureParticlesRenderTime;
  134585. private _particlesRenderTime;
  134586. private _captureSpritesRenderTime;
  134587. private _spritesRenderTime;
  134588. private _capturePhysicsTime;
  134589. private _physicsTime;
  134590. private _captureAnimationsTime;
  134591. private _animationsTime;
  134592. private _captureCameraRenderTime;
  134593. private _cameraRenderTime;
  134594. private _onBeforeActiveMeshesEvaluationObserver;
  134595. private _onAfterActiveMeshesEvaluationObserver;
  134596. private _onBeforeRenderTargetsRenderObserver;
  134597. private _onAfterRenderTargetsRenderObserver;
  134598. private _onAfterRenderObserver;
  134599. private _onBeforeDrawPhaseObserver;
  134600. private _onAfterDrawPhaseObserver;
  134601. private _onBeforeAnimationsObserver;
  134602. private _onBeforeParticlesRenderingObserver;
  134603. private _onAfterParticlesRenderingObserver;
  134604. private _onBeforeSpritesRenderingObserver;
  134605. private _onAfterSpritesRenderingObserver;
  134606. private _onBeforePhysicsObserver;
  134607. private _onAfterPhysicsObserver;
  134608. private _onAfterAnimationsObserver;
  134609. private _onBeforeCameraRenderObserver;
  134610. private _onAfterCameraRenderObserver;
  134611. /**
  134612. * Gets the perf counter used for active meshes evaluation time
  134613. */
  134614. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  134615. /**
  134616. * Gets the active meshes evaluation time capture status
  134617. */
  134618. get captureActiveMeshesEvaluationTime(): boolean;
  134619. /**
  134620. * Enable or disable the active meshes evaluation time capture
  134621. */
  134622. set captureActiveMeshesEvaluationTime(value: boolean);
  134623. /**
  134624. * Gets the perf counter used for render targets render time
  134625. */
  134626. get renderTargetsRenderTimeCounter(): PerfCounter;
  134627. /**
  134628. * Gets the render targets render time capture status
  134629. */
  134630. get captureRenderTargetsRenderTime(): boolean;
  134631. /**
  134632. * Enable or disable the render targets render time capture
  134633. */
  134634. set captureRenderTargetsRenderTime(value: boolean);
  134635. /**
  134636. * Gets the perf counter used for particles render time
  134637. */
  134638. get particlesRenderTimeCounter(): PerfCounter;
  134639. /**
  134640. * Gets the particles render time capture status
  134641. */
  134642. get captureParticlesRenderTime(): boolean;
  134643. /**
  134644. * Enable or disable the particles render time capture
  134645. */
  134646. set captureParticlesRenderTime(value: boolean);
  134647. /**
  134648. * Gets the perf counter used for sprites render time
  134649. */
  134650. get spritesRenderTimeCounter(): PerfCounter;
  134651. /**
  134652. * Gets the sprites render time capture status
  134653. */
  134654. get captureSpritesRenderTime(): boolean;
  134655. /**
  134656. * Enable or disable the sprites render time capture
  134657. */
  134658. set captureSpritesRenderTime(value: boolean);
  134659. /**
  134660. * Gets the perf counter used for physics time
  134661. */
  134662. get physicsTimeCounter(): PerfCounter;
  134663. /**
  134664. * Gets the physics time capture status
  134665. */
  134666. get capturePhysicsTime(): boolean;
  134667. /**
  134668. * Enable or disable the physics time capture
  134669. */
  134670. set capturePhysicsTime(value: boolean);
  134671. /**
  134672. * Gets the perf counter used for animations time
  134673. */
  134674. get animationsTimeCounter(): PerfCounter;
  134675. /**
  134676. * Gets the animations time capture status
  134677. */
  134678. get captureAnimationsTime(): boolean;
  134679. /**
  134680. * Enable or disable the animations time capture
  134681. */
  134682. set captureAnimationsTime(value: boolean);
  134683. /**
  134684. * Gets the perf counter used for frame time capture
  134685. */
  134686. get frameTimeCounter(): PerfCounter;
  134687. /**
  134688. * Gets the frame time capture status
  134689. */
  134690. get captureFrameTime(): boolean;
  134691. /**
  134692. * Enable or disable the frame time capture
  134693. */
  134694. set captureFrameTime(value: boolean);
  134695. /**
  134696. * Gets the perf counter used for inter-frames time capture
  134697. */
  134698. get interFrameTimeCounter(): PerfCounter;
  134699. /**
  134700. * Gets the inter-frames time capture status
  134701. */
  134702. get captureInterFrameTime(): boolean;
  134703. /**
  134704. * Enable or disable the inter-frames time capture
  134705. */
  134706. set captureInterFrameTime(value: boolean);
  134707. /**
  134708. * Gets the perf counter used for render time capture
  134709. */
  134710. get renderTimeCounter(): PerfCounter;
  134711. /**
  134712. * Gets the render time capture status
  134713. */
  134714. get captureRenderTime(): boolean;
  134715. /**
  134716. * Enable or disable the render time capture
  134717. */
  134718. set captureRenderTime(value: boolean);
  134719. /**
  134720. * Gets the perf counter used for camera render time capture
  134721. */
  134722. get cameraRenderTimeCounter(): PerfCounter;
  134723. /**
  134724. * Gets the camera render time capture status
  134725. */
  134726. get captureCameraRenderTime(): boolean;
  134727. /**
  134728. * Enable or disable the camera render time capture
  134729. */
  134730. set captureCameraRenderTime(value: boolean);
  134731. /**
  134732. * Gets the perf counter used for draw calls
  134733. */
  134734. get drawCallsCounter(): PerfCounter;
  134735. /**
  134736. * Instantiates a new scene instrumentation.
  134737. * This class can be used to get instrumentation data from a Babylon engine
  134738. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  134739. * @param scene Defines the scene to instrument
  134740. */
  134741. constructor(
  134742. /**
  134743. * Defines the scene to instrument
  134744. */
  134745. scene: Scene);
  134746. /**
  134747. * Dispose and release associated resources.
  134748. */
  134749. dispose(): void;
  134750. }
  134751. }
  134752. declare module BABYLON {
  134753. /** @hidden */
  134754. export var glowMapGenerationPixelShader: {
  134755. name: string;
  134756. shader: string;
  134757. };
  134758. }
  134759. declare module BABYLON {
  134760. /** @hidden */
  134761. export var glowMapGenerationVertexShader: {
  134762. name: string;
  134763. shader: string;
  134764. };
  134765. }
  134766. declare module BABYLON {
  134767. /**
  134768. * Effect layer options. This helps customizing the behaviour
  134769. * of the effect layer.
  134770. */
  134771. export interface IEffectLayerOptions {
  134772. /**
  134773. * Multiplication factor apply to the canvas size to compute the render target size
  134774. * used to generated the objects (the smaller the faster).
  134775. */
  134776. mainTextureRatio: number;
  134777. /**
  134778. * Enforces a fixed size texture to ensure effect stability across devices.
  134779. */
  134780. mainTextureFixedSize?: number;
  134781. /**
  134782. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  134783. */
  134784. alphaBlendingMode: number;
  134785. /**
  134786. * The camera attached to the layer.
  134787. */
  134788. camera: Nullable<Camera>;
  134789. /**
  134790. * The rendering group to draw the layer in.
  134791. */
  134792. renderingGroupId: number;
  134793. }
  134794. /**
  134795. * The effect layer Helps adding post process effect blended with the main pass.
  134796. *
  134797. * This can be for instance use to generate glow or higlight effects on the scene.
  134798. *
  134799. * The effect layer class can not be used directly and is intented to inherited from to be
  134800. * customized per effects.
  134801. */
  134802. export abstract class EffectLayer {
  134803. private _vertexBuffers;
  134804. private _indexBuffer;
  134805. private _cachedDefines;
  134806. private _effectLayerMapGenerationEffect;
  134807. private _effectLayerOptions;
  134808. private _mergeEffect;
  134809. protected _scene: Scene;
  134810. protected _engine: Engine;
  134811. protected _maxSize: number;
  134812. protected _mainTextureDesiredSize: ISize;
  134813. protected _mainTexture: RenderTargetTexture;
  134814. protected _shouldRender: boolean;
  134815. protected _postProcesses: PostProcess[];
  134816. protected _textures: BaseTexture[];
  134817. protected _emissiveTextureAndColor: {
  134818. texture: Nullable<BaseTexture>;
  134819. color: Color4;
  134820. };
  134821. /**
  134822. * The name of the layer
  134823. */
  134824. name: string;
  134825. /**
  134826. * The clear color of the texture used to generate the glow map.
  134827. */
  134828. neutralColor: Color4;
  134829. /**
  134830. * Specifies whether the highlight layer is enabled or not.
  134831. */
  134832. isEnabled: boolean;
  134833. /**
  134834. * Gets the camera attached to the layer.
  134835. */
  134836. get camera(): Nullable<Camera>;
  134837. /**
  134838. * Gets the rendering group id the layer should render in.
  134839. */
  134840. get renderingGroupId(): number;
  134841. set renderingGroupId(renderingGroupId: number);
  134842. /**
  134843. * An event triggered when the effect layer has been disposed.
  134844. */
  134845. onDisposeObservable: Observable<EffectLayer>;
  134846. /**
  134847. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  134848. */
  134849. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  134850. /**
  134851. * An event triggered when the generated texture is being merged in the scene.
  134852. */
  134853. onBeforeComposeObservable: Observable<EffectLayer>;
  134854. /**
  134855. * An event triggered when the mesh is rendered into the effect render target.
  134856. */
  134857. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  134858. /**
  134859. * An event triggered after the mesh has been rendered into the effect render target.
  134860. */
  134861. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  134862. /**
  134863. * An event triggered when the generated texture has been merged in the scene.
  134864. */
  134865. onAfterComposeObservable: Observable<EffectLayer>;
  134866. /**
  134867. * An event triggered when the efffect layer changes its size.
  134868. */
  134869. onSizeChangedObservable: Observable<EffectLayer>;
  134870. /** @hidden */
  134871. static _SceneComponentInitialization: (scene: Scene) => void;
  134872. /**
  134873. * Instantiates a new effect Layer and references it in the scene.
  134874. * @param name The name of the layer
  134875. * @param scene The scene to use the layer in
  134876. */
  134877. constructor(
  134878. /** The Friendly of the effect in the scene */
  134879. name: string, scene: Scene);
  134880. /**
  134881. * Get the effect name of the layer.
  134882. * @return The effect name
  134883. */
  134884. abstract getEffectName(): string;
  134885. /**
  134886. * Checks for the readiness of the element composing the layer.
  134887. * @param subMesh the mesh to check for
  134888. * @param useInstances specify whether or not to use instances to render the mesh
  134889. * @return true if ready otherwise, false
  134890. */
  134891. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  134892. /**
  134893. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  134894. * @returns true if the effect requires stencil during the main canvas render pass.
  134895. */
  134896. abstract needStencil(): boolean;
  134897. /**
  134898. * Create the merge effect. This is the shader use to blit the information back
  134899. * to the main canvas at the end of the scene rendering.
  134900. * @returns The effect containing the shader used to merge the effect on the main canvas
  134901. */
  134902. protected abstract _createMergeEffect(): Effect;
  134903. /**
  134904. * Creates the render target textures and post processes used in the effect layer.
  134905. */
  134906. protected abstract _createTextureAndPostProcesses(): void;
  134907. /**
  134908. * Implementation specific of rendering the generating effect on the main canvas.
  134909. * @param effect The effect used to render through
  134910. */
  134911. protected abstract _internalRender(effect: Effect): void;
  134912. /**
  134913. * Sets the required values for both the emissive texture and and the main color.
  134914. */
  134915. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  134916. /**
  134917. * Free any resources and references associated to a mesh.
  134918. * Internal use
  134919. * @param mesh The mesh to free.
  134920. */
  134921. abstract _disposeMesh(mesh: Mesh): void;
  134922. /**
  134923. * Serializes this layer (Glow or Highlight for example)
  134924. * @returns a serialized layer object
  134925. */
  134926. abstract serialize?(): any;
  134927. /**
  134928. * Initializes the effect layer with the required options.
  134929. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  134930. */
  134931. protected _init(options: Partial<IEffectLayerOptions>): void;
  134932. /**
  134933. * Generates the index buffer of the full screen quad blending to the main canvas.
  134934. */
  134935. private _generateIndexBuffer;
  134936. /**
  134937. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  134938. */
  134939. private _generateVertexBuffer;
  134940. /**
  134941. * Sets the main texture desired size which is the closest power of two
  134942. * of the engine canvas size.
  134943. */
  134944. private _setMainTextureSize;
  134945. /**
  134946. * Creates the main texture for the effect layer.
  134947. */
  134948. protected _createMainTexture(): void;
  134949. /**
  134950. * Adds specific effects defines.
  134951. * @param defines The defines to add specifics to.
  134952. */
  134953. protected _addCustomEffectDefines(defines: string[]): void;
  134954. /**
  134955. * Checks for the readiness of the element composing the layer.
  134956. * @param subMesh the mesh to check for
  134957. * @param useInstances specify whether or not to use instances to render the mesh
  134958. * @param emissiveTexture the associated emissive texture used to generate the glow
  134959. * @return true if ready otherwise, false
  134960. */
  134961. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  134962. /**
  134963. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  134964. */
  134965. render(): void;
  134966. /**
  134967. * Determine if a given mesh will be used in the current effect.
  134968. * @param mesh mesh to test
  134969. * @returns true if the mesh will be used
  134970. */
  134971. hasMesh(mesh: AbstractMesh): boolean;
  134972. /**
  134973. * Returns true if the layer contains information to display, otherwise false.
  134974. * @returns true if the glow layer should be rendered
  134975. */
  134976. shouldRender(): boolean;
  134977. /**
  134978. * Returns true if the mesh should render, otherwise false.
  134979. * @param mesh The mesh to render
  134980. * @returns true if it should render otherwise false
  134981. */
  134982. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  134983. /**
  134984. * Returns true if the mesh can be rendered, otherwise false.
  134985. * @param mesh The mesh to render
  134986. * @param material The material used on the mesh
  134987. * @returns true if it can be rendered otherwise false
  134988. */
  134989. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  134990. /**
  134991. * Returns true if the mesh should render, otherwise false.
  134992. * @param mesh The mesh to render
  134993. * @returns true if it should render otherwise false
  134994. */
  134995. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  134996. /**
  134997. * Renders the submesh passed in parameter to the generation map.
  134998. */
  134999. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  135000. /**
  135001. * Defines whether the current material of the mesh should be use to render the effect.
  135002. * @param mesh defines the current mesh to render
  135003. */
  135004. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  135005. /**
  135006. * Rebuild the required buffers.
  135007. * @hidden Internal use only.
  135008. */
  135009. _rebuild(): void;
  135010. /**
  135011. * Dispose only the render target textures and post process.
  135012. */
  135013. private _disposeTextureAndPostProcesses;
  135014. /**
  135015. * Dispose the highlight layer and free resources.
  135016. */
  135017. dispose(): void;
  135018. /**
  135019. * Gets the class name of the effect layer
  135020. * @returns the string with the class name of the effect layer
  135021. */
  135022. getClassName(): string;
  135023. /**
  135024. * Creates an effect layer from parsed effect layer data
  135025. * @param parsedEffectLayer defines effect layer data
  135026. * @param scene defines the current scene
  135027. * @param rootUrl defines the root URL containing the effect layer information
  135028. * @returns a parsed effect Layer
  135029. */
  135030. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  135031. }
  135032. }
  135033. declare module BABYLON {
  135034. interface AbstractScene {
  135035. /**
  135036. * The list of effect layers (highlights/glow) added to the scene
  135037. * @see http://doc.babylonjs.com/how_to/highlight_layer
  135038. * @see http://doc.babylonjs.com/how_to/glow_layer
  135039. */
  135040. effectLayers: Array<EffectLayer>;
  135041. /**
  135042. * Removes the given effect layer from this scene.
  135043. * @param toRemove defines the effect layer to remove
  135044. * @returns the index of the removed effect layer
  135045. */
  135046. removeEffectLayer(toRemove: EffectLayer): number;
  135047. /**
  135048. * Adds the given effect layer to this scene
  135049. * @param newEffectLayer defines the effect layer to add
  135050. */
  135051. addEffectLayer(newEffectLayer: EffectLayer): void;
  135052. }
  135053. /**
  135054. * Defines the layer scene component responsible to manage any effect layers
  135055. * in a given scene.
  135056. */
  135057. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  135058. /**
  135059. * The component name helpfull to identify the component in the list of scene components.
  135060. */
  135061. readonly name: string;
  135062. /**
  135063. * The scene the component belongs to.
  135064. */
  135065. scene: Scene;
  135066. private _engine;
  135067. private _renderEffects;
  135068. private _needStencil;
  135069. private _previousStencilState;
  135070. /**
  135071. * Creates a new instance of the component for the given scene
  135072. * @param scene Defines the scene to register the component in
  135073. */
  135074. constructor(scene: Scene);
  135075. /**
  135076. * Registers the component in a given scene
  135077. */
  135078. register(): void;
  135079. /**
  135080. * Rebuilds the elements related to this component in case of
  135081. * context lost for instance.
  135082. */
  135083. rebuild(): void;
  135084. /**
  135085. * Serializes the component data to the specified json object
  135086. * @param serializationObject The object to serialize to
  135087. */
  135088. serialize(serializationObject: any): void;
  135089. /**
  135090. * Adds all the elements from the container to the scene
  135091. * @param container the container holding the elements
  135092. */
  135093. addFromContainer(container: AbstractScene): void;
  135094. /**
  135095. * Removes all the elements in the container from the scene
  135096. * @param container contains the elements to remove
  135097. * @param dispose if the removed element should be disposed (default: false)
  135098. */
  135099. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  135100. /**
  135101. * Disposes the component and the associated ressources.
  135102. */
  135103. dispose(): void;
  135104. private _isReadyForMesh;
  135105. private _renderMainTexture;
  135106. private _setStencil;
  135107. private _setStencilBack;
  135108. private _draw;
  135109. private _drawCamera;
  135110. private _drawRenderingGroup;
  135111. }
  135112. }
  135113. declare module BABYLON {
  135114. /** @hidden */
  135115. export var glowMapMergePixelShader: {
  135116. name: string;
  135117. shader: string;
  135118. };
  135119. }
  135120. declare module BABYLON {
  135121. /** @hidden */
  135122. export var glowMapMergeVertexShader: {
  135123. name: string;
  135124. shader: string;
  135125. };
  135126. }
  135127. declare module BABYLON {
  135128. interface AbstractScene {
  135129. /**
  135130. * Return a the first highlight layer of the scene with a given name.
  135131. * @param name The name of the highlight layer to look for.
  135132. * @return The highlight layer if found otherwise null.
  135133. */
  135134. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  135135. }
  135136. /**
  135137. * Glow layer options. This helps customizing the behaviour
  135138. * of the glow layer.
  135139. */
  135140. export interface IGlowLayerOptions {
  135141. /**
  135142. * Multiplication factor apply to the canvas size to compute the render target size
  135143. * used to generated the glowing objects (the smaller the faster).
  135144. */
  135145. mainTextureRatio: number;
  135146. /**
  135147. * Enforces a fixed size texture to ensure resize independant blur.
  135148. */
  135149. mainTextureFixedSize?: number;
  135150. /**
  135151. * How big is the kernel of the blur texture.
  135152. */
  135153. blurKernelSize: number;
  135154. /**
  135155. * The camera attached to the layer.
  135156. */
  135157. camera: Nullable<Camera>;
  135158. /**
  135159. * Enable MSAA by chosing the number of samples.
  135160. */
  135161. mainTextureSamples?: number;
  135162. /**
  135163. * The rendering group to draw the layer in.
  135164. */
  135165. renderingGroupId: number;
  135166. }
  135167. /**
  135168. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  135169. *
  135170. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  135171. *
  135172. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  135173. */
  135174. export class GlowLayer extends EffectLayer {
  135175. /**
  135176. * Effect Name of the layer.
  135177. */
  135178. static readonly EffectName: string;
  135179. /**
  135180. * The default blur kernel size used for the glow.
  135181. */
  135182. static DefaultBlurKernelSize: number;
  135183. /**
  135184. * The default texture size ratio used for the glow.
  135185. */
  135186. static DefaultTextureRatio: number;
  135187. /**
  135188. * Sets the kernel size of the blur.
  135189. */
  135190. set blurKernelSize(value: number);
  135191. /**
  135192. * Gets the kernel size of the blur.
  135193. */
  135194. get blurKernelSize(): number;
  135195. /**
  135196. * Sets the glow intensity.
  135197. */
  135198. set intensity(value: number);
  135199. /**
  135200. * Gets the glow intensity.
  135201. */
  135202. get intensity(): number;
  135203. private _options;
  135204. private _intensity;
  135205. private _horizontalBlurPostprocess1;
  135206. private _verticalBlurPostprocess1;
  135207. private _horizontalBlurPostprocess2;
  135208. private _verticalBlurPostprocess2;
  135209. private _blurTexture1;
  135210. private _blurTexture2;
  135211. private _postProcesses1;
  135212. private _postProcesses2;
  135213. private _includedOnlyMeshes;
  135214. private _excludedMeshes;
  135215. private _meshesUsingTheirOwnMaterials;
  135216. /**
  135217. * Callback used to let the user override the color selection on a per mesh basis
  135218. */
  135219. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  135220. /**
  135221. * Callback used to let the user override the texture selection on a per mesh basis
  135222. */
  135223. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  135224. /**
  135225. * Instantiates a new glow Layer and references it to the scene.
  135226. * @param name The name of the layer
  135227. * @param scene The scene to use the layer in
  135228. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  135229. */
  135230. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  135231. /**
  135232. * Get the effect name of the layer.
  135233. * @return The effect name
  135234. */
  135235. getEffectName(): string;
  135236. /**
  135237. * Create the merge effect. This is the shader use to blit the information back
  135238. * to the main canvas at the end of the scene rendering.
  135239. */
  135240. protected _createMergeEffect(): Effect;
  135241. /**
  135242. * Creates the render target textures and post processes used in the glow layer.
  135243. */
  135244. protected _createTextureAndPostProcesses(): void;
  135245. /**
  135246. * Checks for the readiness of the element composing the layer.
  135247. * @param subMesh the mesh to check for
  135248. * @param useInstances specify wether or not to use instances to render the mesh
  135249. * @param emissiveTexture the associated emissive texture used to generate the glow
  135250. * @return true if ready otherwise, false
  135251. */
  135252. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  135253. /**
  135254. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  135255. */
  135256. needStencil(): boolean;
  135257. /**
  135258. * Returns true if the mesh can be rendered, otherwise false.
  135259. * @param mesh The mesh to render
  135260. * @param material The material used on the mesh
  135261. * @returns true if it can be rendered otherwise false
  135262. */
  135263. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  135264. /**
  135265. * Implementation specific of rendering the generating effect on the main canvas.
  135266. * @param effect The effect used to render through
  135267. */
  135268. protected _internalRender(effect: Effect): void;
  135269. /**
  135270. * Sets the required values for both the emissive texture and and the main color.
  135271. */
  135272. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  135273. /**
  135274. * Returns true if the mesh should render, otherwise false.
  135275. * @param mesh The mesh to render
  135276. * @returns true if it should render otherwise false
  135277. */
  135278. protected _shouldRenderMesh(mesh: Mesh): boolean;
  135279. /**
  135280. * Adds specific effects defines.
  135281. * @param defines The defines to add specifics to.
  135282. */
  135283. protected _addCustomEffectDefines(defines: string[]): void;
  135284. /**
  135285. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  135286. * @param mesh The mesh to exclude from the glow layer
  135287. */
  135288. addExcludedMesh(mesh: Mesh): void;
  135289. /**
  135290. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  135291. * @param mesh The mesh to remove
  135292. */
  135293. removeExcludedMesh(mesh: Mesh): void;
  135294. /**
  135295. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  135296. * @param mesh The mesh to include in the glow layer
  135297. */
  135298. addIncludedOnlyMesh(mesh: Mesh): void;
  135299. /**
  135300. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  135301. * @param mesh The mesh to remove
  135302. */
  135303. removeIncludedOnlyMesh(mesh: Mesh): void;
  135304. /**
  135305. * Determine if a given mesh will be used in the glow layer
  135306. * @param mesh The mesh to test
  135307. * @returns true if the mesh will be highlighted by the current glow layer
  135308. */
  135309. hasMesh(mesh: AbstractMesh): boolean;
  135310. /**
  135311. * Defines whether the current material of the mesh should be use to render the effect.
  135312. * @param mesh defines the current mesh to render
  135313. */
  135314. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  135315. /**
  135316. * Add a mesh to be rendered through its own material and not with emissive only.
  135317. * @param mesh The mesh for which we need to use its material
  135318. */
  135319. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  135320. /**
  135321. * Remove a mesh from being rendered through its own material and not with emissive only.
  135322. * @param mesh The mesh for which we need to not use its material
  135323. */
  135324. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  135325. /**
  135326. * Free any resources and references associated to a mesh.
  135327. * Internal use
  135328. * @param mesh The mesh to free.
  135329. * @hidden
  135330. */
  135331. _disposeMesh(mesh: Mesh): void;
  135332. /**
  135333. * Gets the class name of the effect layer
  135334. * @returns the string with the class name of the effect layer
  135335. */
  135336. getClassName(): string;
  135337. /**
  135338. * Serializes this glow layer
  135339. * @returns a serialized glow layer object
  135340. */
  135341. serialize(): any;
  135342. /**
  135343. * Creates a Glow Layer from parsed glow layer data
  135344. * @param parsedGlowLayer defines glow layer data
  135345. * @param scene defines the current scene
  135346. * @param rootUrl defines the root URL containing the glow layer information
  135347. * @returns a parsed Glow Layer
  135348. */
  135349. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  135350. }
  135351. }
  135352. declare module BABYLON {
  135353. /** @hidden */
  135354. export var glowBlurPostProcessPixelShader: {
  135355. name: string;
  135356. shader: string;
  135357. };
  135358. }
  135359. declare module BABYLON {
  135360. interface AbstractScene {
  135361. /**
  135362. * Return a the first highlight layer of the scene with a given name.
  135363. * @param name The name of the highlight layer to look for.
  135364. * @return The highlight layer if found otherwise null.
  135365. */
  135366. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  135367. }
  135368. /**
  135369. * Highlight layer options. This helps customizing the behaviour
  135370. * of the highlight layer.
  135371. */
  135372. export interface IHighlightLayerOptions {
  135373. /**
  135374. * Multiplication factor apply to the canvas size to compute the render target size
  135375. * used to generated the glowing objects (the smaller the faster).
  135376. */
  135377. mainTextureRatio: number;
  135378. /**
  135379. * Enforces a fixed size texture to ensure resize independant blur.
  135380. */
  135381. mainTextureFixedSize?: number;
  135382. /**
  135383. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  135384. * of the picture to blur (the smaller the faster).
  135385. */
  135386. blurTextureSizeRatio: number;
  135387. /**
  135388. * How big in texel of the blur texture is the vertical blur.
  135389. */
  135390. blurVerticalSize: number;
  135391. /**
  135392. * How big in texel of the blur texture is the horizontal blur.
  135393. */
  135394. blurHorizontalSize: number;
  135395. /**
  135396. * Alpha blending mode used to apply the blur. Default is combine.
  135397. */
  135398. alphaBlendingMode: number;
  135399. /**
  135400. * The camera attached to the layer.
  135401. */
  135402. camera: Nullable<Camera>;
  135403. /**
  135404. * Should we display highlight as a solid stroke?
  135405. */
  135406. isStroke?: boolean;
  135407. /**
  135408. * The rendering group to draw the layer in.
  135409. */
  135410. renderingGroupId: number;
  135411. }
  135412. /**
  135413. * The highlight layer Helps adding a glow effect around a mesh.
  135414. *
  135415. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  135416. * glowy meshes to your scene.
  135417. *
  135418. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  135419. */
  135420. export class HighlightLayer extends EffectLayer {
  135421. name: string;
  135422. /**
  135423. * Effect Name of the highlight layer.
  135424. */
  135425. static readonly EffectName: string;
  135426. /**
  135427. * The neutral color used during the preparation of the glow effect.
  135428. * This is black by default as the blend operation is a blend operation.
  135429. */
  135430. static NeutralColor: Color4;
  135431. /**
  135432. * Stencil value used for glowing meshes.
  135433. */
  135434. static GlowingMeshStencilReference: number;
  135435. /**
  135436. * Stencil value used for the other meshes in the scene.
  135437. */
  135438. static NormalMeshStencilReference: number;
  135439. /**
  135440. * Specifies whether or not the inner glow is ACTIVE in the layer.
  135441. */
  135442. innerGlow: boolean;
  135443. /**
  135444. * Specifies whether or not the outer glow is ACTIVE in the layer.
  135445. */
  135446. outerGlow: boolean;
  135447. /**
  135448. * Specifies the horizontal size of the blur.
  135449. */
  135450. set blurHorizontalSize(value: number);
  135451. /**
  135452. * Specifies the vertical size of the blur.
  135453. */
  135454. set blurVerticalSize(value: number);
  135455. /**
  135456. * Gets the horizontal size of the blur.
  135457. */
  135458. get blurHorizontalSize(): number;
  135459. /**
  135460. * Gets the vertical size of the blur.
  135461. */
  135462. get blurVerticalSize(): number;
  135463. /**
  135464. * An event triggered when the highlight layer is being blurred.
  135465. */
  135466. onBeforeBlurObservable: Observable<HighlightLayer>;
  135467. /**
  135468. * An event triggered when the highlight layer has been blurred.
  135469. */
  135470. onAfterBlurObservable: Observable<HighlightLayer>;
  135471. private _instanceGlowingMeshStencilReference;
  135472. private _options;
  135473. private _downSamplePostprocess;
  135474. private _horizontalBlurPostprocess;
  135475. private _verticalBlurPostprocess;
  135476. private _blurTexture;
  135477. private _meshes;
  135478. private _excludedMeshes;
  135479. /**
  135480. * Instantiates a new highlight Layer and references it to the scene..
  135481. * @param name The name of the layer
  135482. * @param scene The scene to use the layer in
  135483. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  135484. */
  135485. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  135486. /**
  135487. * Get the effect name of the layer.
  135488. * @return The effect name
  135489. */
  135490. getEffectName(): string;
  135491. /**
  135492. * Create the merge effect. This is the shader use to blit the information back
  135493. * to the main canvas at the end of the scene rendering.
  135494. */
  135495. protected _createMergeEffect(): Effect;
  135496. /**
  135497. * Creates the render target textures and post processes used in the highlight layer.
  135498. */
  135499. protected _createTextureAndPostProcesses(): void;
  135500. /**
  135501. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  135502. */
  135503. needStencil(): boolean;
  135504. /**
  135505. * Checks for the readiness of the element composing the layer.
  135506. * @param subMesh the mesh to check for
  135507. * @param useInstances specify wether or not to use instances to render the mesh
  135508. * @param emissiveTexture the associated emissive texture used to generate the glow
  135509. * @return true if ready otherwise, false
  135510. */
  135511. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  135512. /**
  135513. * Implementation specific of rendering the generating effect on the main canvas.
  135514. * @param effect The effect used to render through
  135515. */
  135516. protected _internalRender(effect: Effect): void;
  135517. /**
  135518. * Returns true if the layer contains information to display, otherwise false.
  135519. */
  135520. shouldRender(): boolean;
  135521. /**
  135522. * Returns true if the mesh should render, otherwise false.
  135523. * @param mesh The mesh to render
  135524. * @returns true if it should render otherwise false
  135525. */
  135526. protected _shouldRenderMesh(mesh: Mesh): boolean;
  135527. /**
  135528. * Adds specific effects defines.
  135529. * @param defines The defines to add specifics to.
  135530. */
  135531. protected _addCustomEffectDefines(defines: string[]): void;
  135532. /**
  135533. * Sets the required values for both the emissive texture and and the main color.
  135534. */
  135535. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  135536. /**
  135537. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  135538. * @param mesh The mesh to exclude from the highlight layer
  135539. */
  135540. addExcludedMesh(mesh: Mesh): void;
  135541. /**
  135542. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  135543. * @param mesh The mesh to highlight
  135544. */
  135545. removeExcludedMesh(mesh: Mesh): void;
  135546. /**
  135547. * Determine if a given mesh will be highlighted by the current HighlightLayer
  135548. * @param mesh mesh to test
  135549. * @returns true if the mesh will be highlighted by the current HighlightLayer
  135550. */
  135551. hasMesh(mesh: AbstractMesh): boolean;
  135552. /**
  135553. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  135554. * @param mesh The mesh to highlight
  135555. * @param color The color of the highlight
  135556. * @param glowEmissiveOnly Extract the glow from the emissive texture
  135557. */
  135558. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  135559. /**
  135560. * Remove a mesh from the highlight layer in order to make it stop glowing.
  135561. * @param mesh The mesh to highlight
  135562. */
  135563. removeMesh(mesh: Mesh): void;
  135564. /**
  135565. * Remove all the meshes currently referenced in the highlight layer
  135566. */
  135567. removeAllMeshes(): void;
  135568. /**
  135569. * Force the stencil to the normal expected value for none glowing parts
  135570. */
  135571. private _defaultStencilReference;
  135572. /**
  135573. * Free any resources and references associated to a mesh.
  135574. * Internal use
  135575. * @param mesh The mesh to free.
  135576. * @hidden
  135577. */
  135578. _disposeMesh(mesh: Mesh): void;
  135579. /**
  135580. * Dispose the highlight layer and free resources.
  135581. */
  135582. dispose(): void;
  135583. /**
  135584. * Gets the class name of the effect layer
  135585. * @returns the string with the class name of the effect layer
  135586. */
  135587. getClassName(): string;
  135588. /**
  135589. * Serializes this Highlight layer
  135590. * @returns a serialized Highlight layer object
  135591. */
  135592. serialize(): any;
  135593. /**
  135594. * Creates a Highlight layer from parsed Highlight layer data
  135595. * @param parsedHightlightLayer defines the Highlight layer data
  135596. * @param scene defines the current scene
  135597. * @param rootUrl defines the root URL containing the Highlight layer information
  135598. * @returns a parsed Highlight layer
  135599. */
  135600. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  135601. }
  135602. }
  135603. declare module BABYLON {
  135604. interface AbstractScene {
  135605. /**
  135606. * The list of layers (background and foreground) of the scene
  135607. */
  135608. layers: Array<Layer>;
  135609. }
  135610. /**
  135611. * Defines the layer scene component responsible to manage any layers
  135612. * in a given scene.
  135613. */
  135614. export class LayerSceneComponent implements ISceneComponent {
  135615. /**
  135616. * The component name helpfull to identify the component in the list of scene components.
  135617. */
  135618. readonly name: string;
  135619. /**
  135620. * The scene the component belongs to.
  135621. */
  135622. scene: Scene;
  135623. private _engine;
  135624. /**
  135625. * Creates a new instance of the component for the given scene
  135626. * @param scene Defines the scene to register the component in
  135627. */
  135628. constructor(scene: Scene);
  135629. /**
  135630. * Registers the component in a given scene
  135631. */
  135632. register(): void;
  135633. /**
  135634. * Rebuilds the elements related to this component in case of
  135635. * context lost for instance.
  135636. */
  135637. rebuild(): void;
  135638. /**
  135639. * Disposes the component and the associated ressources.
  135640. */
  135641. dispose(): void;
  135642. private _draw;
  135643. private _drawCameraPredicate;
  135644. private _drawCameraBackground;
  135645. private _drawCameraForeground;
  135646. private _drawRenderTargetPredicate;
  135647. private _drawRenderTargetBackground;
  135648. private _drawRenderTargetForeground;
  135649. /**
  135650. * Adds all the elements from the container to the scene
  135651. * @param container the container holding the elements
  135652. */
  135653. addFromContainer(container: AbstractScene): void;
  135654. /**
  135655. * Removes all the elements in the container from the scene
  135656. * @param container contains the elements to remove
  135657. * @param dispose if the removed element should be disposed (default: false)
  135658. */
  135659. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  135660. }
  135661. }
  135662. declare module BABYLON {
  135663. /** @hidden */
  135664. export var layerPixelShader: {
  135665. name: string;
  135666. shader: string;
  135667. };
  135668. }
  135669. declare module BABYLON {
  135670. /** @hidden */
  135671. export var layerVertexShader: {
  135672. name: string;
  135673. shader: string;
  135674. };
  135675. }
  135676. declare module BABYLON {
  135677. /**
  135678. * This represents a full screen 2d layer.
  135679. * This can be useful to display a picture in the background of your scene for instance.
  135680. * @see https://www.babylonjs-playground.com/#08A2BS#1
  135681. */
  135682. export class Layer {
  135683. /**
  135684. * Define the name of the layer.
  135685. */
  135686. name: string;
  135687. /**
  135688. * Define the texture the layer should display.
  135689. */
  135690. texture: Nullable<Texture>;
  135691. /**
  135692. * Is the layer in background or foreground.
  135693. */
  135694. isBackground: boolean;
  135695. /**
  135696. * Define the color of the layer (instead of texture).
  135697. */
  135698. color: Color4;
  135699. /**
  135700. * Define the scale of the layer in order to zoom in out of the texture.
  135701. */
  135702. scale: Vector2;
  135703. /**
  135704. * Define an offset for the layer in order to shift the texture.
  135705. */
  135706. offset: Vector2;
  135707. /**
  135708. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  135709. */
  135710. alphaBlendingMode: number;
  135711. /**
  135712. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  135713. * Alpha test will not mix with the background color in case of transparency.
  135714. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  135715. */
  135716. alphaTest: boolean;
  135717. /**
  135718. * Define a mask to restrict the layer to only some of the scene cameras.
  135719. */
  135720. layerMask: number;
  135721. /**
  135722. * Define the list of render target the layer is visible into.
  135723. */
  135724. renderTargetTextures: RenderTargetTexture[];
  135725. /**
  135726. * Define if the layer is only used in renderTarget or if it also
  135727. * renders in the main frame buffer of the canvas.
  135728. */
  135729. renderOnlyInRenderTargetTextures: boolean;
  135730. private _scene;
  135731. private _vertexBuffers;
  135732. private _indexBuffer;
  135733. private _effect;
  135734. private _previousDefines;
  135735. /**
  135736. * An event triggered when the layer is disposed.
  135737. */
  135738. onDisposeObservable: Observable<Layer>;
  135739. private _onDisposeObserver;
  135740. /**
  135741. * Back compatibility with callback before the onDisposeObservable existed.
  135742. * The set callback will be triggered when the layer has been disposed.
  135743. */
  135744. set onDispose(callback: () => void);
  135745. /**
  135746. * An event triggered before rendering the scene
  135747. */
  135748. onBeforeRenderObservable: Observable<Layer>;
  135749. private _onBeforeRenderObserver;
  135750. /**
  135751. * Back compatibility with callback before the onBeforeRenderObservable existed.
  135752. * The set callback will be triggered just before rendering the layer.
  135753. */
  135754. set onBeforeRender(callback: () => void);
  135755. /**
  135756. * An event triggered after rendering the scene
  135757. */
  135758. onAfterRenderObservable: Observable<Layer>;
  135759. private _onAfterRenderObserver;
  135760. /**
  135761. * Back compatibility with callback before the onAfterRenderObservable existed.
  135762. * The set callback will be triggered just after rendering the layer.
  135763. */
  135764. set onAfterRender(callback: () => void);
  135765. /**
  135766. * Instantiates a new layer.
  135767. * This represents a full screen 2d layer.
  135768. * This can be useful to display a picture in the background of your scene for instance.
  135769. * @see https://www.babylonjs-playground.com/#08A2BS#1
  135770. * @param name Define the name of the layer in the scene
  135771. * @param imgUrl Define the url of the texture to display in the layer
  135772. * @param scene Define the scene the layer belongs to
  135773. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  135774. * @param color Defines a color for the layer
  135775. */
  135776. constructor(
  135777. /**
  135778. * Define the name of the layer.
  135779. */
  135780. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  135781. private _createIndexBuffer;
  135782. /** @hidden */
  135783. _rebuild(): void;
  135784. /**
  135785. * Renders the layer in the scene.
  135786. */
  135787. render(): void;
  135788. /**
  135789. * Disposes and releases the associated ressources.
  135790. */
  135791. dispose(): void;
  135792. }
  135793. }
  135794. declare module BABYLON {
  135795. /** @hidden */
  135796. export var lensFlarePixelShader: {
  135797. name: string;
  135798. shader: string;
  135799. };
  135800. }
  135801. declare module BABYLON {
  135802. /** @hidden */
  135803. export var lensFlareVertexShader: {
  135804. name: string;
  135805. shader: string;
  135806. };
  135807. }
  135808. declare module BABYLON {
  135809. /**
  135810. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  135811. * It is usually composed of several `lensFlare`.
  135812. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  135813. */
  135814. export class LensFlareSystem {
  135815. /**
  135816. * Define the name of the lens flare system
  135817. */
  135818. name: string;
  135819. /**
  135820. * List of lens flares used in this system.
  135821. */
  135822. lensFlares: LensFlare[];
  135823. /**
  135824. * Define a limit from the border the lens flare can be visible.
  135825. */
  135826. borderLimit: number;
  135827. /**
  135828. * Define a viewport border we do not want to see the lens flare in.
  135829. */
  135830. viewportBorder: number;
  135831. /**
  135832. * Define a predicate which could limit the list of meshes able to occlude the effect.
  135833. */
  135834. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  135835. /**
  135836. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  135837. */
  135838. layerMask: number;
  135839. /**
  135840. * Define the id of the lens flare system in the scene.
  135841. * (equal to name by default)
  135842. */
  135843. id: string;
  135844. private _scene;
  135845. private _emitter;
  135846. private _vertexBuffers;
  135847. private _indexBuffer;
  135848. private _effect;
  135849. private _positionX;
  135850. private _positionY;
  135851. private _isEnabled;
  135852. /** @hidden */
  135853. static _SceneComponentInitialization: (scene: Scene) => void;
  135854. /**
  135855. * Instantiates a lens flare system.
  135856. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  135857. * It is usually composed of several `lensFlare`.
  135858. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  135859. * @param name Define the name of the lens flare system in the scene
  135860. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  135861. * @param scene Define the scene the lens flare system belongs to
  135862. */
  135863. constructor(
  135864. /**
  135865. * Define the name of the lens flare system
  135866. */
  135867. name: string, emitter: any, scene: Scene);
  135868. /**
  135869. * Define if the lens flare system is enabled.
  135870. */
  135871. get isEnabled(): boolean;
  135872. set isEnabled(value: boolean);
  135873. /**
  135874. * Get the scene the effects belongs to.
  135875. * @returns the scene holding the lens flare system
  135876. */
  135877. getScene(): Scene;
  135878. /**
  135879. * Get the emitter of the lens flare system.
  135880. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  135881. * @returns the emitter of the lens flare system
  135882. */
  135883. getEmitter(): any;
  135884. /**
  135885. * Set the emitter of the lens flare system.
  135886. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  135887. * @param newEmitter Define the new emitter of the system
  135888. */
  135889. setEmitter(newEmitter: any): void;
  135890. /**
  135891. * Get the lens flare system emitter position.
  135892. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  135893. * @returns the position
  135894. */
  135895. getEmitterPosition(): Vector3;
  135896. /**
  135897. * @hidden
  135898. */
  135899. computeEffectivePosition(globalViewport: Viewport): boolean;
  135900. /** @hidden */
  135901. _isVisible(): boolean;
  135902. /**
  135903. * @hidden
  135904. */
  135905. render(): boolean;
  135906. /**
  135907. * Dispose and release the lens flare with its associated resources.
  135908. */
  135909. dispose(): void;
  135910. /**
  135911. * Parse a lens flare system from a JSON repressentation
  135912. * @param parsedLensFlareSystem Define the JSON to parse
  135913. * @param scene Define the scene the parsed system should be instantiated in
  135914. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  135915. * @returns the parsed system
  135916. */
  135917. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  135918. /**
  135919. * Serialize the current Lens Flare System into a JSON representation.
  135920. * @returns the serialized JSON
  135921. */
  135922. serialize(): any;
  135923. }
  135924. }
  135925. declare module BABYLON {
  135926. /**
  135927. * This represents one of the lens effect in a `lensFlareSystem`.
  135928. * It controls one of the indiviual texture used in the effect.
  135929. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  135930. */
  135931. export class LensFlare {
  135932. /**
  135933. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  135934. */
  135935. size: number;
  135936. /**
  135937. * 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.
  135938. */
  135939. position: number;
  135940. /**
  135941. * Define the lens color.
  135942. */
  135943. color: Color3;
  135944. /**
  135945. * Define the lens texture.
  135946. */
  135947. texture: Nullable<Texture>;
  135948. /**
  135949. * Define the alpha mode to render this particular lens.
  135950. */
  135951. alphaMode: number;
  135952. private _system;
  135953. /**
  135954. * Creates a new Lens Flare.
  135955. * This represents one of the lens effect in a `lensFlareSystem`.
  135956. * It controls one of the indiviual texture used in the effect.
  135957. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  135958. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  135959. * @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.
  135960. * @param color Define the lens color
  135961. * @param imgUrl Define the lens texture url
  135962. * @param system Define the `lensFlareSystem` this flare is part of
  135963. * @returns The newly created Lens Flare
  135964. */
  135965. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  135966. /**
  135967. * Instantiates a new Lens Flare.
  135968. * This represents one of the lens effect in a `lensFlareSystem`.
  135969. * It controls one of the indiviual texture used in the effect.
  135970. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  135971. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  135972. * @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.
  135973. * @param color Define the lens color
  135974. * @param imgUrl Define the lens texture url
  135975. * @param system Define the `lensFlareSystem` this flare is part of
  135976. */
  135977. constructor(
  135978. /**
  135979. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  135980. */
  135981. size: number,
  135982. /**
  135983. * 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.
  135984. */
  135985. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  135986. /**
  135987. * Dispose and release the lens flare with its associated resources.
  135988. */
  135989. dispose(): void;
  135990. }
  135991. }
  135992. declare module BABYLON {
  135993. interface AbstractScene {
  135994. /**
  135995. * The list of lens flare system added to the scene
  135996. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  135997. */
  135998. lensFlareSystems: Array<LensFlareSystem>;
  135999. /**
  136000. * Removes the given lens flare system from this scene.
  136001. * @param toRemove The lens flare system to remove
  136002. * @returns The index of the removed lens flare system
  136003. */
  136004. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  136005. /**
  136006. * Adds the given lens flare system to this scene
  136007. * @param newLensFlareSystem The lens flare system to add
  136008. */
  136009. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  136010. /**
  136011. * Gets a lens flare system using its name
  136012. * @param name defines the name to look for
  136013. * @returns the lens flare system or null if not found
  136014. */
  136015. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  136016. /**
  136017. * Gets a lens flare system using its id
  136018. * @param id defines the id to look for
  136019. * @returns the lens flare system or null if not found
  136020. */
  136021. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  136022. }
  136023. /**
  136024. * Defines the lens flare scene component responsible to manage any lens flares
  136025. * in a given scene.
  136026. */
  136027. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  136028. /**
  136029. * The component name helpfull to identify the component in the list of scene components.
  136030. */
  136031. readonly name: string;
  136032. /**
  136033. * The scene the component belongs to.
  136034. */
  136035. scene: Scene;
  136036. /**
  136037. * Creates a new instance of the component for the given scene
  136038. * @param scene Defines the scene to register the component in
  136039. */
  136040. constructor(scene: Scene);
  136041. /**
  136042. * Registers the component in a given scene
  136043. */
  136044. register(): void;
  136045. /**
  136046. * Rebuilds the elements related to this component in case of
  136047. * context lost for instance.
  136048. */
  136049. rebuild(): void;
  136050. /**
  136051. * Adds all the elements from the container to the scene
  136052. * @param container the container holding the elements
  136053. */
  136054. addFromContainer(container: AbstractScene): void;
  136055. /**
  136056. * Removes all the elements in the container from the scene
  136057. * @param container contains the elements to remove
  136058. * @param dispose if the removed element should be disposed (default: false)
  136059. */
  136060. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  136061. /**
  136062. * Serializes the component data to the specified json object
  136063. * @param serializationObject The object to serialize to
  136064. */
  136065. serialize(serializationObject: any): void;
  136066. /**
  136067. * Disposes the component and the associated ressources.
  136068. */
  136069. dispose(): void;
  136070. private _draw;
  136071. }
  136072. }
  136073. declare module BABYLON {
  136074. /** @hidden */
  136075. export var depthPixelShader: {
  136076. name: string;
  136077. shader: string;
  136078. };
  136079. }
  136080. declare module BABYLON {
  136081. /** @hidden */
  136082. export var depthVertexShader: {
  136083. name: string;
  136084. shader: string;
  136085. };
  136086. }
  136087. declare module BABYLON {
  136088. /**
  136089. * This represents a depth renderer in Babylon.
  136090. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  136091. */
  136092. export class DepthRenderer {
  136093. private _scene;
  136094. private _depthMap;
  136095. private _effect;
  136096. private readonly _storeNonLinearDepth;
  136097. private readonly _clearColor;
  136098. /** Get if the depth renderer is using packed depth or not */
  136099. readonly isPacked: boolean;
  136100. private _cachedDefines;
  136101. private _camera;
  136102. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  136103. enabled: boolean;
  136104. /**
  136105. * Specifiess that the depth renderer will only be used within
  136106. * the camera it is created for.
  136107. * This can help forcing its rendering during the camera processing.
  136108. */
  136109. useOnlyInActiveCamera: boolean;
  136110. /** @hidden */
  136111. static _SceneComponentInitialization: (scene: Scene) => void;
  136112. /**
  136113. * Instantiates a depth renderer
  136114. * @param scene The scene the renderer belongs to
  136115. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  136116. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  136117. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  136118. */
  136119. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  136120. /**
  136121. * Creates the depth rendering effect and checks if the effect is ready.
  136122. * @param subMesh The submesh to be used to render the depth map of
  136123. * @param useInstances If multiple world instances should be used
  136124. * @returns if the depth renderer is ready to render the depth map
  136125. */
  136126. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  136127. /**
  136128. * Gets the texture which the depth map will be written to.
  136129. * @returns The depth map texture
  136130. */
  136131. getDepthMap(): RenderTargetTexture;
  136132. /**
  136133. * Disposes of the depth renderer.
  136134. */
  136135. dispose(): void;
  136136. }
  136137. }
  136138. declare module BABYLON {
  136139. /** @hidden */
  136140. export var minmaxReduxPixelShader: {
  136141. name: string;
  136142. shader: string;
  136143. };
  136144. }
  136145. declare module BABYLON {
  136146. /**
  136147. * This class computes a min/max reduction from a texture: it means it computes the minimum
  136148. * and maximum values from all values of the texture.
  136149. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  136150. * The source values are read from the red channel of the texture.
  136151. */
  136152. export class MinMaxReducer {
  136153. /**
  136154. * Observable triggered when the computation has been performed
  136155. */
  136156. onAfterReductionPerformed: Observable<{
  136157. min: number;
  136158. max: number;
  136159. }>;
  136160. protected _camera: Camera;
  136161. protected _sourceTexture: Nullable<RenderTargetTexture>;
  136162. protected _reductionSteps: Nullable<Array<PostProcess>>;
  136163. protected _postProcessManager: PostProcessManager;
  136164. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  136165. protected _forceFullscreenViewport: boolean;
  136166. /**
  136167. * Creates a min/max reducer
  136168. * @param camera The camera to use for the post processes
  136169. */
  136170. constructor(camera: Camera);
  136171. /**
  136172. * Gets the texture used to read the values from.
  136173. */
  136174. get sourceTexture(): Nullable<RenderTargetTexture>;
  136175. /**
  136176. * Sets the source texture to read the values from.
  136177. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  136178. * because in such textures '1' value must not be taken into account to compute the maximum
  136179. * as this value is used to clear the texture.
  136180. * Note that the computation is not activated by calling this function, you must call activate() for that!
  136181. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  136182. * @param depthRedux Indicates if the texture is a depth texture or not
  136183. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  136184. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  136185. */
  136186. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  136187. /**
  136188. * Defines the refresh rate of the computation.
  136189. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  136190. */
  136191. get refreshRate(): number;
  136192. set refreshRate(value: number);
  136193. protected _activated: boolean;
  136194. /**
  136195. * Gets the activation status of the reducer
  136196. */
  136197. get activated(): boolean;
  136198. /**
  136199. * Activates the reduction computation.
  136200. * When activated, the observers registered in onAfterReductionPerformed are
  136201. * called after the compuation is performed
  136202. */
  136203. activate(): void;
  136204. /**
  136205. * Deactivates the reduction computation.
  136206. */
  136207. deactivate(): void;
  136208. /**
  136209. * Disposes the min/max reducer
  136210. * @param disposeAll true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
  136211. */
  136212. dispose(disposeAll?: boolean): void;
  136213. }
  136214. }
  136215. declare module BABYLON {
  136216. /**
  136217. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  136218. */
  136219. export class DepthReducer extends MinMaxReducer {
  136220. private _depthRenderer;
  136221. private _depthRendererId;
  136222. /**
  136223. * Gets the depth renderer used for the computation.
  136224. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  136225. */
  136226. get depthRenderer(): Nullable<DepthRenderer>;
  136227. /**
  136228. * Creates a depth reducer
  136229. * @param camera The camera used to render the depth texture
  136230. */
  136231. constructor(camera: Camera);
  136232. /**
  136233. * Sets the depth renderer to use to generate the depth map
  136234. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  136235. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  136236. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  136237. */
  136238. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  136239. /** @hidden */
  136240. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  136241. /**
  136242. * Activates the reduction computation.
  136243. * When activated, the observers registered in onAfterReductionPerformed are
  136244. * called after the compuation is performed
  136245. */
  136246. activate(): void;
  136247. /**
  136248. * Deactivates the reduction computation.
  136249. */
  136250. deactivate(): void;
  136251. /**
  136252. * Disposes the depth reducer
  136253. * @param disposeAll true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
  136254. */
  136255. dispose(disposeAll?: boolean): void;
  136256. }
  136257. }
  136258. declare module BABYLON {
  136259. /**
  136260. * A CSM implementation allowing casting shadows on large scenes.
  136261. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  136262. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  136263. */
  136264. export class CascadedShadowGenerator extends ShadowGenerator {
  136265. private static readonly frustumCornersNDCSpace;
  136266. /**
  136267. * Name of the CSM class
  136268. */
  136269. static CLASSNAME: string;
  136270. /**
  136271. * Defines the default number of cascades used by the CSM.
  136272. */
  136273. static readonly DEFAULT_CASCADES_COUNT: number;
  136274. /**
  136275. * Defines the minimum number of cascades used by the CSM.
  136276. */
  136277. static readonly MIN_CASCADES_COUNT: number;
  136278. /**
  136279. * Defines the maximum number of cascades used by the CSM.
  136280. */
  136281. static readonly MAX_CASCADES_COUNT: number;
  136282. protected _validateFilter(filter: number): number;
  136283. /**
  136284. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  136285. */
  136286. penumbraDarkness: number;
  136287. private _numCascades;
  136288. /**
  136289. * Gets or set the number of cascades used by the CSM.
  136290. */
  136291. get numCascades(): number;
  136292. set numCascades(value: number);
  136293. /**
  136294. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  136295. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  136296. */
  136297. stabilizeCascades: boolean;
  136298. private _freezeShadowCastersBoundingInfo;
  136299. private _freezeShadowCastersBoundingInfoObservable;
  136300. /**
  136301. * Enables or disables the shadow casters bounding info computation.
  136302. * If your shadow casters don't move, you can disable this feature.
  136303. * If it is enabled, the bounding box computation is done every frame.
  136304. */
  136305. get freezeShadowCastersBoundingInfo(): boolean;
  136306. set freezeShadowCastersBoundingInfo(freeze: boolean);
  136307. private _scbiMin;
  136308. private _scbiMax;
  136309. protected _computeShadowCastersBoundingInfo(): void;
  136310. protected _shadowCastersBoundingInfo: BoundingInfo;
  136311. /**
  136312. * Gets or sets the shadow casters bounding info.
  136313. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  136314. * so that the system won't overwrite the bounds you provide
  136315. */
  136316. get shadowCastersBoundingInfo(): BoundingInfo;
  136317. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  136318. protected _breaksAreDirty: boolean;
  136319. protected _minDistance: number;
  136320. protected _maxDistance: number;
  136321. /**
  136322. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  136323. *
  136324. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  136325. * If you don't know these values, simply leave them to their defaults and don't call this function.
  136326. * @param min minimal distance for the breaks (default to 0.)
  136327. * @param max maximal distance for the breaks (default to 1.)
  136328. */
  136329. setMinMaxDistance(min: number, max: number): void;
  136330. /** Gets the minimal distance used in the cascade break computation */
  136331. get minDistance(): number;
  136332. /** Gets the maximal distance used in the cascade break computation */
  136333. get maxDistance(): number;
  136334. /**
  136335. * Gets the class name of that object
  136336. * @returns "CascadedShadowGenerator"
  136337. */
  136338. getClassName(): string;
  136339. private _cascadeMinExtents;
  136340. private _cascadeMaxExtents;
  136341. /**
  136342. * Gets a cascade minimum extents
  136343. * @param cascadeIndex index of the cascade
  136344. * @returns the minimum cascade extents
  136345. */
  136346. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  136347. /**
  136348. * Gets a cascade maximum extents
  136349. * @param cascadeIndex index of the cascade
  136350. * @returns the maximum cascade extents
  136351. */
  136352. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  136353. private _cascades;
  136354. private _currentLayer;
  136355. private _viewSpaceFrustumsZ;
  136356. private _viewMatrices;
  136357. private _projectionMatrices;
  136358. private _transformMatrices;
  136359. private _transformMatricesAsArray;
  136360. private _frustumLengths;
  136361. private _lightSizeUVCorrection;
  136362. private _depthCorrection;
  136363. private _frustumCornersWorldSpace;
  136364. private _frustumCenter;
  136365. private _shadowCameraPos;
  136366. private _shadowMaxZ;
  136367. /**
  136368. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  136369. * It defaults to camera.maxZ
  136370. */
  136371. get shadowMaxZ(): number;
  136372. /**
  136373. * Sets the shadow max z distance.
  136374. */
  136375. set shadowMaxZ(value: number);
  136376. protected _debug: boolean;
  136377. /**
  136378. * Gets or sets the debug flag.
  136379. * When enabled, the cascades are materialized by different colors on the screen.
  136380. */
  136381. get debug(): boolean;
  136382. set debug(dbg: boolean);
  136383. private _depthClamp;
  136384. /**
  136385. * Gets or sets the depth clamping value.
  136386. *
  136387. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  136388. * to account for the shadow casters far away.
  136389. *
  136390. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  136391. */
  136392. get depthClamp(): boolean;
  136393. set depthClamp(value: boolean);
  136394. private _cascadeBlendPercentage;
  136395. /**
  136396. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  136397. * It defaults to 0.1 (10% blending).
  136398. */
  136399. get cascadeBlendPercentage(): number;
  136400. set cascadeBlendPercentage(value: number);
  136401. private _lambda;
  136402. /**
  136403. * Gets or set the lambda parameter.
  136404. * This parameter is used to split the camera frustum and create the cascades.
  136405. * It's a value between 0. and 1.: If 0, the split is a uniform split of the frustum, if 1 it is a logarithmic split.
  136406. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  136407. */
  136408. get lambda(): number;
  136409. set lambda(value: number);
  136410. /**
  136411. * Gets the view matrix corresponding to a given cascade
  136412. * @param cascadeNum cascade to retrieve the view matrix from
  136413. * @returns the cascade view matrix
  136414. */
  136415. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  136416. /**
  136417. * Gets the projection matrix corresponding to a given cascade
  136418. * @param cascadeNum cascade to retrieve the projection matrix from
  136419. * @returns the cascade projection matrix
  136420. */
  136421. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  136422. /**
  136423. * Gets the transformation matrix corresponding to a given cascade
  136424. * @param cascadeNum cascade to retrieve the transformation matrix from
  136425. * @returns the cascade transformation matrix
  136426. */
  136427. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  136428. private _depthRenderer;
  136429. /**
  136430. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  136431. *
  136432. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  136433. *
  136434. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  136435. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  136436. * @param depthRenderer The depth renderer to use when autoCalcDepthBounds is enabled. If you pass null or don't call this function at all, a depth renderer will be automatically created
  136437. */
  136438. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  136439. private _depthReducer;
  136440. private _autoCalcDepthBounds;
  136441. /**
  136442. * Gets or sets the autoCalcDepthBounds property.
  136443. *
  136444. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  136445. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  136446. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  136447. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  136448. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  136449. */
  136450. get autoCalcDepthBounds(): boolean;
  136451. set autoCalcDepthBounds(value: boolean);
  136452. /**
  136453. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  136454. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  136455. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  136456. * for setting the refresh rate on the renderer yourself!
  136457. */
  136458. get autoCalcDepthBoundsRefreshRate(): number;
  136459. set autoCalcDepthBoundsRefreshRate(value: number);
  136460. /**
  136461. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  136462. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  136463. * you change the camera near/far planes!
  136464. */
  136465. splitFrustum(): void;
  136466. private _splitFrustum;
  136467. private _computeMatrices;
  136468. private _computeFrustumInWorldSpace;
  136469. private _computeCascadeFrustum;
  136470. /**
  136471. * Support test.
  136472. */
  136473. static get IsSupported(): boolean;
  136474. /** @hidden */
  136475. static _SceneComponentInitialization: (scene: Scene) => void;
  136476. /**
  136477. * Creates a Cascaded Shadow Generator object.
  136478. * A ShadowGenerator is the required tool to use the shadows.
  136479. * Each directional light casting shadows needs to use its own ShadowGenerator.
  136480. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  136481. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  136482. * @param light The directional light object generating the shadows.
  136483. * @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.
  136484. */
  136485. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  136486. protected _initializeGenerator(): void;
  136487. protected _createTargetRenderTexture(): void;
  136488. protected _initializeShadowMap(): void;
  136489. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  136490. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  136491. /**
  136492. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  136493. * @param defines Defines of the material we want to update
  136494. * @param lightIndex Index of the light in the enabled light list of the material
  136495. */
  136496. prepareDefines(defines: any, lightIndex: number): void;
  136497. /**
  136498. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  136499. * defined in the generator but impacting the effect).
  136500. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  136501. * @param effect The effect we are binfing the information for
  136502. */
  136503. bindShadowLight(lightIndex: string, effect: Effect): void;
  136504. /**
  136505. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  136506. * (eq to view projection * shadow projection matrices)
  136507. * @returns The transform matrix used to create the shadow map
  136508. */
  136509. getTransformMatrix(): Matrix;
  136510. /**
  136511. * Disposes the ShadowGenerator.
  136512. * Returns nothing.
  136513. */
  136514. dispose(): void;
  136515. /**
  136516. * Serializes the shadow generator setup to a json object.
  136517. * @returns The serialized JSON object
  136518. */
  136519. serialize(): any;
  136520. /**
  136521. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  136522. * @param parsedShadowGenerator The JSON object to parse
  136523. * @param scene The scene to create the shadow map for
  136524. * @returns The parsed shadow generator
  136525. */
  136526. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  136527. }
  136528. }
  136529. declare module BABYLON {
  136530. /**
  136531. * Defines the shadow generator component responsible to manage any shadow generators
  136532. * in a given scene.
  136533. */
  136534. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  136535. /**
  136536. * The component name helpfull to identify the component in the list of scene components.
  136537. */
  136538. readonly name: string;
  136539. /**
  136540. * The scene the component belongs to.
  136541. */
  136542. scene: Scene;
  136543. /**
  136544. * Creates a new instance of the component for the given scene
  136545. * @param scene Defines the scene to register the component in
  136546. */
  136547. constructor(scene: Scene);
  136548. /**
  136549. * Registers the component in a given scene
  136550. */
  136551. register(): void;
  136552. /**
  136553. * Rebuilds the elements related to this component in case of
  136554. * context lost for instance.
  136555. */
  136556. rebuild(): void;
  136557. /**
  136558. * Serializes the component data to the specified json object
  136559. * @param serializationObject The object to serialize to
  136560. */
  136561. serialize(serializationObject: any): void;
  136562. /**
  136563. * Adds all the elements from the container to the scene
  136564. * @param container the container holding the elements
  136565. */
  136566. addFromContainer(container: AbstractScene): void;
  136567. /**
  136568. * Removes all the elements in the container from the scene
  136569. * @param container contains the elements to remove
  136570. * @param dispose if the removed element should be disposed (default: false)
  136571. */
  136572. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  136573. /**
  136574. * Rebuilds the elements related to this component in case of
  136575. * context lost for instance.
  136576. */
  136577. dispose(): void;
  136578. private _gatherRenderTargets;
  136579. }
  136580. }
  136581. declare module BABYLON {
  136582. /**
  136583. * A point light is a light defined by an unique point in world space.
  136584. * The light is emitted in every direction from this point.
  136585. * A good example of a point light is a standard light bulb.
  136586. * Documentation: https://doc.babylonjs.com/babylon101/lights
  136587. */
  136588. export class PointLight extends ShadowLight {
  136589. private _shadowAngle;
  136590. /**
  136591. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  136592. * This specifies what angle the shadow will use to be created.
  136593. *
  136594. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  136595. */
  136596. get shadowAngle(): number;
  136597. /**
  136598. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  136599. * This specifies what angle the shadow will use to be created.
  136600. *
  136601. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  136602. */
  136603. set shadowAngle(value: number);
  136604. /**
  136605. * Gets the direction if it has been set.
  136606. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  136607. */
  136608. get direction(): Vector3;
  136609. /**
  136610. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  136611. */
  136612. set direction(value: Vector3);
  136613. /**
  136614. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  136615. * A PointLight emits the light in every direction.
  136616. * It can cast shadows.
  136617. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  136618. * ```javascript
  136619. * var pointLight = new PointLight("pl", camera.position, scene);
  136620. * ```
  136621. * Documentation : https://doc.babylonjs.com/babylon101/lights
  136622. * @param name The light friendly name
  136623. * @param position The position of the point light in the scene
  136624. * @param scene The scene the lights belongs to
  136625. */
  136626. constructor(name: string, position: Vector3, scene: Scene);
  136627. /**
  136628. * Returns the string "PointLight"
  136629. * @returns the class name
  136630. */
  136631. getClassName(): string;
  136632. /**
  136633. * Returns the integer 0.
  136634. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  136635. */
  136636. getTypeID(): number;
  136637. /**
  136638. * Specifies wether or not the shadowmap should be a cube texture.
  136639. * @returns true if the shadowmap needs to be a cube texture.
  136640. */
  136641. needCube(): boolean;
  136642. /**
  136643. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  136644. * @param faceIndex The index of the face we are computed the direction to generate shadow
  136645. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  136646. */
  136647. getShadowDirection(faceIndex?: number): Vector3;
  136648. /**
  136649. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  136650. * - fov = PI / 2
  136651. * - aspect ratio : 1.0
  136652. * - z-near and far equal to the active camera minZ and maxZ.
  136653. * Returns the PointLight.
  136654. */
  136655. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  136656. protected _buildUniformLayout(): void;
  136657. /**
  136658. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  136659. * @param effect The effect to update
  136660. * @param lightIndex The index of the light in the effect to update
  136661. * @returns The point light
  136662. */
  136663. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  136664. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  136665. /**
  136666. * Prepares the list of defines specific to the light type.
  136667. * @param defines the list of defines
  136668. * @param lightIndex defines the index of the light for the effect
  136669. */
  136670. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  136671. }
  136672. }
  136673. declare module BABYLON {
  136674. /**
  136675. * Header information of HDR texture files.
  136676. */
  136677. export interface HDRInfo {
  136678. /**
  136679. * The height of the texture in pixels.
  136680. */
  136681. height: number;
  136682. /**
  136683. * The width of the texture in pixels.
  136684. */
  136685. width: number;
  136686. /**
  136687. * The index of the beginning of the data in the binary file.
  136688. */
  136689. dataPosition: number;
  136690. }
  136691. /**
  136692. * This groups tools to convert HDR texture to native colors array.
  136693. */
  136694. export class HDRTools {
  136695. private static Ldexp;
  136696. private static Rgbe2float;
  136697. private static readStringLine;
  136698. /**
  136699. * Reads header information from an RGBE texture stored in a native array.
  136700. * More information on this format are available here:
  136701. * https://en.wikipedia.org/wiki/RGBE_image_format
  136702. *
  136703. * @param uint8array The binary file stored in native array.
  136704. * @return The header information.
  136705. */
  136706. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  136707. /**
  136708. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  136709. * This RGBE texture needs to store the information as a panorama.
  136710. *
  136711. * More information on this format are available here:
  136712. * https://en.wikipedia.org/wiki/RGBE_image_format
  136713. *
  136714. * @param buffer The binary file stored in an array buffer.
  136715. * @param size The expected size of the extracted cubemap.
  136716. * @return The Cube Map information.
  136717. */
  136718. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  136719. /**
  136720. * Returns the pixels data extracted from an RGBE texture.
  136721. * This pixels will be stored left to right up to down in the R G B order in one array.
  136722. *
  136723. * More information on this format are available here:
  136724. * https://en.wikipedia.org/wiki/RGBE_image_format
  136725. *
  136726. * @param uint8array The binary file stored in an array buffer.
  136727. * @param hdrInfo The header information of the file.
  136728. * @return The pixels data in RGB right to left up to down order.
  136729. */
  136730. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  136731. private static RGBE_ReadPixels_RLE;
  136732. }
  136733. }
  136734. declare module BABYLON {
  136735. /**
  136736. * Effect Render Options
  136737. */
  136738. export interface IEffectRendererOptions {
  136739. /**
  136740. * Defines the vertices positions.
  136741. */
  136742. positions?: number[];
  136743. /**
  136744. * Defines the indices.
  136745. */
  136746. indices?: number[];
  136747. }
  136748. /**
  136749. * Helper class to render one or more effects.
  136750. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  136751. */
  136752. export class EffectRenderer {
  136753. private engine;
  136754. private static _DefaultOptions;
  136755. private _vertexBuffers;
  136756. private _indexBuffer;
  136757. private _fullscreenViewport;
  136758. /**
  136759. * Creates an effect renderer
  136760. * @param engine the engine to use for rendering
  136761. * @param options defines the options of the effect renderer
  136762. */
  136763. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  136764. /**
  136765. * Sets the current viewport in normalized coordinates 0-1
  136766. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  136767. */
  136768. setViewport(viewport?: Viewport): void;
  136769. /**
  136770. * Binds the embedded attributes buffer to the effect.
  136771. * @param effect Defines the effect to bind the attributes for
  136772. */
  136773. bindBuffers(effect: Effect): void;
  136774. /**
  136775. * Sets the current effect wrapper to use during draw.
  136776. * The effect needs to be ready before calling this api.
  136777. * This also sets the default full screen position attribute.
  136778. * @param effectWrapper Defines the effect to draw with
  136779. */
  136780. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  136781. /**
  136782. * Restores engine states
  136783. */
  136784. restoreStates(): void;
  136785. /**
  136786. * Draws a full screen quad.
  136787. */
  136788. draw(): void;
  136789. private isRenderTargetTexture;
  136790. /**
  136791. * renders one or more effects to a specified texture
  136792. * @param effectWrapper the effect to renderer
  136793. * @param outputTexture texture to draw to, if null it will render to the screen.
  136794. */
  136795. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  136796. /**
  136797. * Disposes of the effect renderer
  136798. */
  136799. dispose(): void;
  136800. }
  136801. /**
  136802. * Options to create an EffectWrapper
  136803. */
  136804. interface EffectWrapperCreationOptions {
  136805. /**
  136806. * Engine to use to create the effect
  136807. */
  136808. engine: ThinEngine;
  136809. /**
  136810. * Fragment shader for the effect
  136811. */
  136812. fragmentShader: string;
  136813. /**
  136814. * Use the shader store instead of direct source code
  136815. */
  136816. useShaderStore?: boolean;
  136817. /**
  136818. * Vertex shader for the effect
  136819. */
  136820. vertexShader?: string;
  136821. /**
  136822. * Attributes to use in the shader
  136823. */
  136824. attributeNames?: Array<string>;
  136825. /**
  136826. * Uniforms to use in the shader
  136827. */
  136828. uniformNames?: Array<string>;
  136829. /**
  136830. * Texture sampler names to use in the shader
  136831. */
  136832. samplerNames?: Array<string>;
  136833. /**
  136834. * Defines to use in the shader
  136835. */
  136836. defines?: Array<string>;
  136837. /**
  136838. * Callback when effect is compiled
  136839. */
  136840. onCompiled?: Nullable<(effect: Effect) => void>;
  136841. /**
  136842. * The friendly name of the effect displayed in Spector.
  136843. */
  136844. name?: string;
  136845. }
  136846. /**
  136847. * Wraps an effect to be used for rendering
  136848. */
  136849. export class EffectWrapper {
  136850. /**
  136851. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  136852. */
  136853. onApplyObservable: Observable<{}>;
  136854. /**
  136855. * The underlying effect
  136856. */
  136857. effect: Effect;
  136858. /**
  136859. * Creates an effect to be renderer
  136860. * @param creationOptions options to create the effect
  136861. */
  136862. constructor(creationOptions: EffectWrapperCreationOptions);
  136863. /**
  136864. * Disposes of the effect wrapper
  136865. */
  136866. dispose(): void;
  136867. }
  136868. }
  136869. declare module BABYLON {
  136870. /** @hidden */
  136871. export var hdrFilteringVertexShader: {
  136872. name: string;
  136873. shader: string;
  136874. };
  136875. }
  136876. declare module BABYLON {
  136877. /** @hidden */
  136878. export var hdrFilteringPixelShader: {
  136879. name: string;
  136880. shader: string;
  136881. };
  136882. }
  136883. declare module BABYLON {
  136884. /**
  136885. * Options for texture filtering
  136886. */
  136887. interface IHDRFilteringOptions {
  136888. /**
  136889. * Scales pixel intensity for the input HDR map.
  136890. */
  136891. hdrScale?: number;
  136892. /**
  136893. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  136894. */
  136895. quality?: number;
  136896. }
  136897. /**
  136898. * Filters HDR maps to get correct renderings of PBR reflections
  136899. */
  136900. export class HDRFiltering {
  136901. private _engine;
  136902. private _effectRenderer;
  136903. private _effectWrapper;
  136904. private _lodGenerationOffset;
  136905. private _lodGenerationScale;
  136906. /**
  136907. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  136908. * you care about baking speed.
  136909. */
  136910. quality: number;
  136911. /**
  136912. * Scales pixel intensity for the input HDR map.
  136913. */
  136914. hdrScale: number;
  136915. /**
  136916. * Instantiates HDR filter for reflection maps
  136917. *
  136918. * @param engine Thin engine
  136919. * @param options Options
  136920. */
  136921. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  136922. private _createRenderTarget;
  136923. private _prefilterInternal;
  136924. private _createEffect;
  136925. /**
  136926. * Get a value indicating if the filter is ready to be used
  136927. * @param texture Texture to filter
  136928. * @returns true if the filter is ready
  136929. */
  136930. isReady(texture: BaseTexture): boolean;
  136931. /**
  136932. * Prefilters a cube texture to have mipmap levels representing roughness values.
  136933. * Prefiltering will be invoked at the end of next rendering pass.
  136934. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  136935. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  136936. * @param texture Texture to filter
  136937. * @param onFinished Callback when filtering is done
  136938. * @return Promise called when prefiltering is done
  136939. */
  136940. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  136941. }
  136942. }
  136943. declare module BABYLON {
  136944. /**
  136945. * This represents a texture coming from an HDR input.
  136946. *
  136947. * The only supported format is currently panorama picture stored in RGBE format.
  136948. * Example of such files can be found on HDRLib: http://hdrlib.com/
  136949. */
  136950. export class HDRCubeTexture extends BaseTexture {
  136951. private static _facesMapping;
  136952. private _generateHarmonics;
  136953. private _noMipmap;
  136954. private _prefilterOnLoad;
  136955. private _textureMatrix;
  136956. private _size;
  136957. private _onLoad;
  136958. private _onError;
  136959. /**
  136960. * The texture URL.
  136961. */
  136962. url: string;
  136963. /**
  136964. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  136965. */
  136966. coordinatesMode: number;
  136967. protected _isBlocking: boolean;
  136968. /**
  136969. * Sets wether or not the texture is blocking during loading.
  136970. */
  136971. set isBlocking(value: boolean);
  136972. /**
  136973. * Gets wether or not the texture is blocking during loading.
  136974. */
  136975. get isBlocking(): boolean;
  136976. protected _rotationY: number;
  136977. /**
  136978. * Sets texture matrix rotation angle around Y axis in radians.
  136979. */
  136980. set rotationY(value: number);
  136981. /**
  136982. * Gets texture matrix rotation angle around Y axis radians.
  136983. */
  136984. get rotationY(): number;
  136985. /**
  136986. * Gets or sets the center of the bounding box associated with the cube texture
  136987. * It must define where the camera used to render the texture was set
  136988. */
  136989. boundingBoxPosition: Vector3;
  136990. private _boundingBoxSize;
  136991. /**
  136992. * Gets or sets the size of the bounding box associated with the cube texture
  136993. * When defined, the cubemap will switch to local mode
  136994. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  136995. * @example https://www.babylonjs-playground.com/#RNASML
  136996. */
  136997. set boundingBoxSize(value: Vector3);
  136998. get boundingBoxSize(): Vector3;
  136999. /**
  137000. * Instantiates an HDRTexture from the following parameters.
  137001. *
  137002. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  137003. * @param sceneOrEngine The scene or engine the texture will be used in
  137004. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  137005. * @param noMipmap Forces to not generate the mipmap if true
  137006. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  137007. * @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)
  137008. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  137009. */
  137010. constructor(url: string, sceneOrEngine: Scene | ThinEngine, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, prefilterOnLoad?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  137011. /**
  137012. * Get the current class name of the texture useful for serialization or dynamic coding.
  137013. * @returns "HDRCubeTexture"
  137014. */
  137015. getClassName(): string;
  137016. /**
  137017. * Occurs when the file is raw .hdr file.
  137018. */
  137019. private loadTexture;
  137020. clone(): HDRCubeTexture;
  137021. delayLoad(): void;
  137022. /**
  137023. * Get the texture reflection matrix used to rotate/transform the reflection.
  137024. * @returns the reflection matrix
  137025. */
  137026. getReflectionTextureMatrix(): Matrix;
  137027. /**
  137028. * Set the texture reflection matrix used to rotate/transform the reflection.
  137029. * @param value Define the reflection matrix to set
  137030. */
  137031. setReflectionTextureMatrix(value: Matrix): void;
  137032. /**
  137033. * Parses a JSON representation of an HDR Texture in order to create the texture
  137034. * @param parsedTexture Define the JSON representation
  137035. * @param scene Define the scene the texture should be created in
  137036. * @param rootUrl Define the root url in case we need to load relative dependencies
  137037. * @returns the newly created texture after parsing
  137038. */
  137039. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  137040. serialize(): any;
  137041. }
  137042. }
  137043. declare module BABYLON {
  137044. /**
  137045. * Class used to control physics engine
  137046. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  137047. */
  137048. export class PhysicsEngine implements IPhysicsEngine {
  137049. private _physicsPlugin;
  137050. /**
  137051. * Global value used to control the smallest number supported by the simulation
  137052. */
  137053. static Epsilon: number;
  137054. private _impostors;
  137055. private _joints;
  137056. private _subTimeStep;
  137057. /**
  137058. * Gets the gravity vector used by the simulation
  137059. */
  137060. gravity: Vector3;
  137061. /**
  137062. * Factory used to create the default physics plugin.
  137063. * @returns The default physics plugin
  137064. */
  137065. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  137066. /**
  137067. * Creates a new Physics Engine
  137068. * @param gravity defines the gravity vector used by the simulation
  137069. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  137070. */
  137071. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  137072. /**
  137073. * Sets the gravity vector used by the simulation
  137074. * @param gravity defines the gravity vector to use
  137075. */
  137076. setGravity(gravity: Vector3): void;
  137077. /**
  137078. * Set the time step of the physics engine.
  137079. * Default is 1/60.
  137080. * To slow it down, enter 1/600 for example.
  137081. * To speed it up, 1/30
  137082. * @param newTimeStep defines the new timestep to apply to this world.
  137083. */
  137084. setTimeStep(newTimeStep?: number): void;
  137085. /**
  137086. * Get the time step of the physics engine.
  137087. * @returns the current time step
  137088. */
  137089. getTimeStep(): number;
  137090. /**
  137091. * Set the sub time step of the physics engine.
  137092. * Default is 0 meaning there is no sub steps
  137093. * To increase physics resolution precision, set a small value (like 1 ms)
  137094. * @param subTimeStep defines the new sub timestep used for physics resolution.
  137095. */
  137096. setSubTimeStep(subTimeStep?: number): void;
  137097. /**
  137098. * Get the sub time step of the physics engine.
  137099. * @returns the current sub time step
  137100. */
  137101. getSubTimeStep(): number;
  137102. /**
  137103. * Release all resources
  137104. */
  137105. dispose(): void;
  137106. /**
  137107. * Gets the name of the current physics plugin
  137108. * @returns the name of the plugin
  137109. */
  137110. getPhysicsPluginName(): string;
  137111. /**
  137112. * Adding a new impostor for the impostor tracking.
  137113. * This will be done by the impostor itself.
  137114. * @param impostor the impostor to add
  137115. */
  137116. addImpostor(impostor: PhysicsImpostor): void;
  137117. /**
  137118. * Remove an impostor from the engine.
  137119. * This impostor and its mesh will not longer be updated by the physics engine.
  137120. * @param impostor the impostor to remove
  137121. */
  137122. removeImpostor(impostor: PhysicsImpostor): void;
  137123. /**
  137124. * Add a joint to the physics engine
  137125. * @param mainImpostor defines the main impostor to which the joint is added.
  137126. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  137127. * @param joint defines the joint that will connect both impostors.
  137128. */
  137129. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  137130. /**
  137131. * Removes a joint from the simulation
  137132. * @param mainImpostor defines the impostor used with the joint
  137133. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  137134. * @param joint defines the joint to remove
  137135. */
  137136. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  137137. /**
  137138. * Called by the scene. No need to call it.
  137139. * @param delta defines the timespam between frames
  137140. */
  137141. _step(delta: number): void;
  137142. /**
  137143. * Gets the current plugin used to run the simulation
  137144. * @returns current plugin
  137145. */
  137146. getPhysicsPlugin(): IPhysicsEnginePlugin;
  137147. /**
  137148. * Gets the list of physic impostors
  137149. * @returns an array of PhysicsImpostor
  137150. */
  137151. getImpostors(): Array<PhysicsImpostor>;
  137152. /**
  137153. * Gets the impostor for a physics enabled object
  137154. * @param object defines the object impersonated by the impostor
  137155. * @returns the PhysicsImpostor or null if not found
  137156. */
  137157. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  137158. /**
  137159. * Gets the impostor for a physics body object
  137160. * @param body defines physics body used by the impostor
  137161. * @returns the PhysicsImpostor or null if not found
  137162. */
  137163. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  137164. /**
  137165. * Does a raycast in the physics world
  137166. * @param from when should the ray start?
  137167. * @param to when should the ray end?
  137168. * @returns PhysicsRaycastResult
  137169. */
  137170. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  137171. }
  137172. }
  137173. declare module BABYLON {
  137174. /** @hidden */
  137175. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  137176. private _useDeltaForWorldStep;
  137177. world: any;
  137178. name: string;
  137179. private _physicsMaterials;
  137180. private _fixedTimeStep;
  137181. private _cannonRaycastResult;
  137182. private _raycastResult;
  137183. private _physicsBodysToRemoveAfterStep;
  137184. private _firstFrame;
  137185. BJSCANNON: any;
  137186. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  137187. setGravity(gravity: Vector3): void;
  137188. setTimeStep(timeStep: number): void;
  137189. getTimeStep(): number;
  137190. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  137191. private _removeMarkedPhysicsBodiesFromWorld;
  137192. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  137193. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  137194. generatePhysicsBody(impostor: PhysicsImpostor): void;
  137195. private _processChildMeshes;
  137196. removePhysicsBody(impostor: PhysicsImpostor): void;
  137197. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  137198. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  137199. private _addMaterial;
  137200. private _checkWithEpsilon;
  137201. private _createShape;
  137202. private _createHeightmap;
  137203. private _minus90X;
  137204. private _plus90X;
  137205. private _tmpPosition;
  137206. private _tmpDeltaPosition;
  137207. private _tmpUnityRotation;
  137208. private _updatePhysicsBodyTransformation;
  137209. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  137210. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  137211. isSupported(): boolean;
  137212. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  137213. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  137214. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  137215. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  137216. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  137217. getBodyMass(impostor: PhysicsImpostor): number;
  137218. getBodyFriction(impostor: PhysicsImpostor): number;
  137219. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  137220. getBodyRestitution(impostor: PhysicsImpostor): number;
  137221. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  137222. sleepBody(impostor: PhysicsImpostor): void;
  137223. wakeUpBody(impostor: PhysicsImpostor): void;
  137224. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  137225. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  137226. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  137227. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  137228. getRadius(impostor: PhysicsImpostor): number;
  137229. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  137230. dispose(): void;
  137231. private _extendNamespace;
  137232. /**
  137233. * Does a raycast in the physics world
  137234. * @param from when should the ray start?
  137235. * @param to when should the ray end?
  137236. * @returns PhysicsRaycastResult
  137237. */
  137238. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  137239. }
  137240. }
  137241. declare module BABYLON {
  137242. /** @hidden */
  137243. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  137244. private _useDeltaForWorldStep;
  137245. world: any;
  137246. name: string;
  137247. BJSOIMO: any;
  137248. private _raycastResult;
  137249. private _fixedTimeStep;
  137250. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  137251. setGravity(gravity: Vector3): void;
  137252. setTimeStep(timeStep: number): void;
  137253. getTimeStep(): number;
  137254. private _tmpImpostorsArray;
  137255. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  137256. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  137257. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  137258. generatePhysicsBody(impostor: PhysicsImpostor): void;
  137259. private _tmpPositionVector;
  137260. removePhysicsBody(impostor: PhysicsImpostor): void;
  137261. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  137262. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  137263. isSupported(): boolean;
  137264. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  137265. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  137266. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  137267. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  137268. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  137269. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  137270. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  137271. getBodyMass(impostor: PhysicsImpostor): number;
  137272. getBodyFriction(impostor: PhysicsImpostor): number;
  137273. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  137274. getBodyRestitution(impostor: PhysicsImpostor): number;
  137275. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  137276. sleepBody(impostor: PhysicsImpostor): void;
  137277. wakeUpBody(impostor: PhysicsImpostor): void;
  137278. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  137279. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  137280. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  137281. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  137282. getRadius(impostor: PhysicsImpostor): number;
  137283. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  137284. dispose(): void;
  137285. /**
  137286. * Does a raycast in the physics world
  137287. * @param from when should the ray start?
  137288. * @param to when should the ray end?
  137289. * @returns PhysicsRaycastResult
  137290. */
  137291. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  137292. }
  137293. }
  137294. declare module BABYLON {
  137295. /**
  137296. * Class containing static functions to help procedurally build meshes
  137297. */
  137298. export class RibbonBuilder {
  137299. /**
  137300. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  137301. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  137302. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  137303. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  137304. * * 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
  137305. * * 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
  137306. * * 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
  137307. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  137308. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  137309. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  137310. * * 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
  137311. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  137312. * * 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
  137313. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  137314. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  137315. * @param name defines the name of the mesh
  137316. * @param options defines the options used to create the mesh
  137317. * @param scene defines the hosting scene
  137318. * @returns the ribbon mesh
  137319. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  137320. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  137321. */
  137322. static CreateRibbon(name: string, options: {
  137323. pathArray: Vector3[][];
  137324. closeArray?: boolean;
  137325. closePath?: boolean;
  137326. offset?: number;
  137327. updatable?: boolean;
  137328. sideOrientation?: number;
  137329. frontUVs?: Vector4;
  137330. backUVs?: Vector4;
  137331. instance?: Mesh;
  137332. invertUV?: boolean;
  137333. uvs?: Vector2[];
  137334. colors?: Color4[];
  137335. }, scene?: Nullable<Scene>): Mesh;
  137336. }
  137337. }
  137338. declare module BABYLON {
  137339. /**
  137340. * Class containing static functions to help procedurally build meshes
  137341. */
  137342. export class ShapeBuilder {
  137343. /**
  137344. * 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.
  137345. * * 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.
  137346. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  137347. * * 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.
  137348. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  137349. * * 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
  137350. * * 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
  137351. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  137352. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  137353. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  137354. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  137355. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  137356. * @param name defines the name of the mesh
  137357. * @param options defines the options used to create the mesh
  137358. * @param scene defines the hosting scene
  137359. * @returns the extruded shape mesh
  137360. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  137361. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  137362. */
  137363. static ExtrudeShape(name: string, options: {
  137364. shape: Vector3[];
  137365. path: Vector3[];
  137366. scale?: number;
  137367. rotation?: number;
  137368. cap?: number;
  137369. updatable?: boolean;
  137370. sideOrientation?: number;
  137371. frontUVs?: Vector4;
  137372. backUVs?: Vector4;
  137373. instance?: Mesh;
  137374. invertUV?: boolean;
  137375. }, scene?: Nullable<Scene>): Mesh;
  137376. /**
  137377. * Creates an custom extruded shape mesh.
  137378. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  137379. * * 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.
  137380. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  137381. * * 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
  137382. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  137383. * * 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
  137384. * * It must returns a float value that will be the scale value applied to the shape on each path point
  137385. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  137386. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  137387. * * 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
  137388. * * 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
  137389. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  137390. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  137391. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  137392. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  137393. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  137394. * @param name defines the name of the mesh
  137395. * @param options defines the options used to create the mesh
  137396. * @param scene defines the hosting scene
  137397. * @returns the custom extruded shape mesh
  137398. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  137399. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  137400. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  137401. */
  137402. static ExtrudeShapeCustom(name: string, options: {
  137403. shape: Vector3[];
  137404. path: Vector3[];
  137405. scaleFunction?: any;
  137406. rotationFunction?: any;
  137407. ribbonCloseArray?: boolean;
  137408. ribbonClosePath?: boolean;
  137409. cap?: number;
  137410. updatable?: boolean;
  137411. sideOrientation?: number;
  137412. frontUVs?: Vector4;
  137413. backUVs?: Vector4;
  137414. instance?: Mesh;
  137415. invertUV?: boolean;
  137416. }, scene?: Nullable<Scene>): Mesh;
  137417. private static _ExtrudeShapeGeneric;
  137418. }
  137419. }
  137420. declare module BABYLON {
  137421. /**
  137422. * AmmoJS Physics plugin
  137423. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  137424. * @see https://github.com/kripken/ammo.js/
  137425. */
  137426. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  137427. private _useDeltaForWorldStep;
  137428. /**
  137429. * Reference to the Ammo library
  137430. */
  137431. bjsAMMO: any;
  137432. /**
  137433. * Created ammoJS world which physics bodies are added to
  137434. */
  137435. world: any;
  137436. /**
  137437. * Name of the plugin
  137438. */
  137439. name: string;
  137440. private _timeStep;
  137441. private _fixedTimeStep;
  137442. private _maxSteps;
  137443. private _tmpQuaternion;
  137444. private _tmpAmmoTransform;
  137445. private _tmpAmmoQuaternion;
  137446. private _tmpAmmoConcreteContactResultCallback;
  137447. private _collisionConfiguration;
  137448. private _dispatcher;
  137449. private _overlappingPairCache;
  137450. private _solver;
  137451. private _softBodySolver;
  137452. private _tmpAmmoVectorA;
  137453. private _tmpAmmoVectorB;
  137454. private _tmpAmmoVectorC;
  137455. private _tmpAmmoVectorD;
  137456. private _tmpContactCallbackResult;
  137457. private _tmpAmmoVectorRCA;
  137458. private _tmpAmmoVectorRCB;
  137459. private _raycastResult;
  137460. private static readonly DISABLE_COLLISION_FLAG;
  137461. private static readonly KINEMATIC_FLAG;
  137462. private static readonly DISABLE_DEACTIVATION_FLAG;
  137463. /**
  137464. * Initializes the ammoJS plugin
  137465. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  137466. * @param ammoInjection can be used to inject your own ammo reference
  137467. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  137468. */
  137469. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  137470. /**
  137471. * Sets the gravity of the physics world (m/(s^2))
  137472. * @param gravity Gravity to set
  137473. */
  137474. setGravity(gravity: Vector3): void;
  137475. /**
  137476. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  137477. * @param timeStep timestep to use in seconds
  137478. */
  137479. setTimeStep(timeStep: number): void;
  137480. /**
  137481. * 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)
  137482. * @param fixedTimeStep fixedTimeStep to use in seconds
  137483. */
  137484. setFixedTimeStep(fixedTimeStep: number): void;
  137485. /**
  137486. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  137487. * @param maxSteps the maximum number of steps by the physics engine per frame
  137488. */
  137489. setMaxSteps(maxSteps: number): void;
  137490. /**
  137491. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  137492. * @returns the current timestep in seconds
  137493. */
  137494. getTimeStep(): number;
  137495. /**
  137496. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  137497. */
  137498. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  137499. private _isImpostorInContact;
  137500. private _isImpostorPairInContact;
  137501. private _stepSimulation;
  137502. /**
  137503. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  137504. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  137505. * After the step the babylon meshes are set to the position of the physics imposters
  137506. * @param delta amount of time to step forward
  137507. * @param impostors array of imposters to update before/after the step
  137508. */
  137509. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  137510. /**
  137511. * Update babylon mesh to match physics world object
  137512. * @param impostor imposter to match
  137513. */
  137514. private _afterSoftStep;
  137515. /**
  137516. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  137517. * @param impostor imposter to match
  137518. */
  137519. private _ropeStep;
  137520. /**
  137521. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  137522. * @param impostor imposter to match
  137523. */
  137524. private _softbodyOrClothStep;
  137525. private _tmpMatrix;
  137526. /**
  137527. * Applies an impulse on the imposter
  137528. * @param impostor imposter to apply impulse to
  137529. * @param force amount of force to be applied to the imposter
  137530. * @param contactPoint the location to apply the impulse on the imposter
  137531. */
  137532. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  137533. /**
  137534. * Applies a force on the imposter
  137535. * @param impostor imposter to apply force
  137536. * @param force amount of force to be applied to the imposter
  137537. * @param contactPoint the location to apply the force on the imposter
  137538. */
  137539. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  137540. /**
  137541. * Creates a physics body using the plugin
  137542. * @param impostor the imposter to create the physics body on
  137543. */
  137544. generatePhysicsBody(impostor: PhysicsImpostor): void;
  137545. /**
  137546. * Removes the physics body from the imposter and disposes of the body's memory
  137547. * @param impostor imposter to remove the physics body from
  137548. */
  137549. removePhysicsBody(impostor: PhysicsImpostor): void;
  137550. /**
  137551. * Generates a joint
  137552. * @param impostorJoint the imposter joint to create the joint with
  137553. */
  137554. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  137555. /**
  137556. * Removes a joint
  137557. * @param impostorJoint the imposter joint to remove the joint from
  137558. */
  137559. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  137560. private _addMeshVerts;
  137561. /**
  137562. * Initialise the soft body vertices to match its object's (mesh) vertices
  137563. * Softbody vertices (nodes) are in world space and to match this
  137564. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  137565. * @param impostor to create the softbody for
  137566. */
  137567. private _softVertexData;
  137568. /**
  137569. * Create an impostor's soft body
  137570. * @param impostor to create the softbody for
  137571. */
  137572. private _createSoftbody;
  137573. /**
  137574. * Create cloth for an impostor
  137575. * @param impostor to create the softbody for
  137576. */
  137577. private _createCloth;
  137578. /**
  137579. * Create rope for an impostor
  137580. * @param impostor to create the softbody for
  137581. */
  137582. private _createRope;
  137583. /**
  137584. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  137585. * @param impostor to create the custom physics shape for
  137586. */
  137587. private _createCustom;
  137588. private _addHullVerts;
  137589. private _createShape;
  137590. /**
  137591. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  137592. * @param impostor imposter containing the physics body and babylon object
  137593. */
  137594. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  137595. /**
  137596. * Sets the babylon object's position/rotation from the physics body's position/rotation
  137597. * @param impostor imposter containing the physics body and babylon object
  137598. * @param newPosition new position
  137599. * @param newRotation new rotation
  137600. */
  137601. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  137602. /**
  137603. * If this plugin is supported
  137604. * @returns true if its supported
  137605. */
  137606. isSupported(): boolean;
  137607. /**
  137608. * Sets the linear velocity of the physics body
  137609. * @param impostor imposter to set the velocity on
  137610. * @param velocity velocity to set
  137611. */
  137612. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  137613. /**
  137614. * Sets the angular velocity of the physics body
  137615. * @param impostor imposter to set the velocity on
  137616. * @param velocity velocity to set
  137617. */
  137618. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  137619. /**
  137620. * gets the linear velocity
  137621. * @param impostor imposter to get linear velocity from
  137622. * @returns linear velocity
  137623. */
  137624. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  137625. /**
  137626. * gets the angular velocity
  137627. * @param impostor imposter to get angular velocity from
  137628. * @returns angular velocity
  137629. */
  137630. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  137631. /**
  137632. * Sets the mass of physics body
  137633. * @param impostor imposter to set the mass on
  137634. * @param mass mass to set
  137635. */
  137636. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  137637. /**
  137638. * Gets the mass of the physics body
  137639. * @param impostor imposter to get the mass from
  137640. * @returns mass
  137641. */
  137642. getBodyMass(impostor: PhysicsImpostor): number;
  137643. /**
  137644. * Gets friction of the impostor
  137645. * @param impostor impostor to get friction from
  137646. * @returns friction value
  137647. */
  137648. getBodyFriction(impostor: PhysicsImpostor): number;
  137649. /**
  137650. * Sets friction of the impostor
  137651. * @param impostor impostor to set friction on
  137652. * @param friction friction value
  137653. */
  137654. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  137655. /**
  137656. * Gets restitution of the impostor
  137657. * @param impostor impostor to get restitution from
  137658. * @returns restitution value
  137659. */
  137660. getBodyRestitution(impostor: PhysicsImpostor): number;
  137661. /**
  137662. * Sets resitution of the impostor
  137663. * @param impostor impostor to set resitution on
  137664. * @param restitution resitution value
  137665. */
  137666. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  137667. /**
  137668. * Gets pressure inside the impostor
  137669. * @param impostor impostor to get pressure from
  137670. * @returns pressure value
  137671. */
  137672. getBodyPressure(impostor: PhysicsImpostor): number;
  137673. /**
  137674. * Sets pressure inside a soft body impostor
  137675. * Cloth and rope must remain 0 pressure
  137676. * @param impostor impostor to set pressure on
  137677. * @param pressure pressure value
  137678. */
  137679. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  137680. /**
  137681. * Gets stiffness of the impostor
  137682. * @param impostor impostor to get stiffness from
  137683. * @returns pressure value
  137684. */
  137685. getBodyStiffness(impostor: PhysicsImpostor): number;
  137686. /**
  137687. * Sets stiffness of the impostor
  137688. * @param impostor impostor to set stiffness on
  137689. * @param stiffness stiffness value from 0 to 1
  137690. */
  137691. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  137692. /**
  137693. * Gets velocityIterations of the impostor
  137694. * @param impostor impostor to get velocity iterations from
  137695. * @returns velocityIterations value
  137696. */
  137697. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  137698. /**
  137699. * Sets velocityIterations of the impostor
  137700. * @param impostor impostor to set velocity iterations on
  137701. * @param velocityIterations velocityIterations value
  137702. */
  137703. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  137704. /**
  137705. * Gets positionIterations of the impostor
  137706. * @param impostor impostor to get position iterations from
  137707. * @returns positionIterations value
  137708. */
  137709. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  137710. /**
  137711. * Sets positionIterations of the impostor
  137712. * @param impostor impostor to set position on
  137713. * @param positionIterations positionIterations value
  137714. */
  137715. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  137716. /**
  137717. * Append an anchor to a cloth object
  137718. * @param impostor is the cloth impostor to add anchor to
  137719. * @param otherImpostor is the rigid impostor to anchor to
  137720. * @param width ratio across width from 0 to 1
  137721. * @param height ratio up height from 0 to 1
  137722. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  137723. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  137724. */
  137725. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  137726. /**
  137727. * Append an hook to a rope object
  137728. * @param impostor is the rope impostor to add hook to
  137729. * @param otherImpostor is the rigid impostor to hook to
  137730. * @param length ratio along the rope from 0 to 1
  137731. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  137732. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  137733. */
  137734. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  137735. /**
  137736. * Sleeps the physics body and stops it from being active
  137737. * @param impostor impostor to sleep
  137738. */
  137739. sleepBody(impostor: PhysicsImpostor): void;
  137740. /**
  137741. * Activates the physics body
  137742. * @param impostor impostor to activate
  137743. */
  137744. wakeUpBody(impostor: PhysicsImpostor): void;
  137745. /**
  137746. * Updates the distance parameters of the joint
  137747. * @param joint joint to update
  137748. * @param maxDistance maximum distance of the joint
  137749. * @param minDistance minimum distance of the joint
  137750. */
  137751. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  137752. /**
  137753. * Sets a motor on the joint
  137754. * @param joint joint to set motor on
  137755. * @param speed speed of the motor
  137756. * @param maxForce maximum force of the motor
  137757. * @param motorIndex index of the motor
  137758. */
  137759. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  137760. /**
  137761. * Sets the motors limit
  137762. * @param joint joint to set limit on
  137763. * @param upperLimit upper limit
  137764. * @param lowerLimit lower limit
  137765. */
  137766. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  137767. /**
  137768. * Syncs the position and rotation of a mesh with the impostor
  137769. * @param mesh mesh to sync
  137770. * @param impostor impostor to update the mesh with
  137771. */
  137772. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  137773. /**
  137774. * Gets the radius of the impostor
  137775. * @param impostor impostor to get radius from
  137776. * @returns the radius
  137777. */
  137778. getRadius(impostor: PhysicsImpostor): number;
  137779. /**
  137780. * Gets the box size of the impostor
  137781. * @param impostor impostor to get box size from
  137782. * @param result the resulting box size
  137783. */
  137784. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  137785. /**
  137786. * Disposes of the impostor
  137787. */
  137788. dispose(): void;
  137789. /**
  137790. * Does a raycast in the physics world
  137791. * @param from when should the ray start?
  137792. * @param to when should the ray end?
  137793. * @returns PhysicsRaycastResult
  137794. */
  137795. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  137796. }
  137797. }
  137798. declare module BABYLON {
  137799. interface AbstractScene {
  137800. /**
  137801. * The list of reflection probes added to the scene
  137802. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  137803. */
  137804. reflectionProbes: Array<ReflectionProbe>;
  137805. /**
  137806. * Removes the given reflection probe from this scene.
  137807. * @param toRemove The reflection probe to remove
  137808. * @returns The index of the removed reflection probe
  137809. */
  137810. removeReflectionProbe(toRemove: ReflectionProbe): number;
  137811. /**
  137812. * Adds the given reflection probe to this scene.
  137813. * @param newReflectionProbe The reflection probe to add
  137814. */
  137815. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  137816. }
  137817. /**
  137818. * Class used to generate realtime reflection / refraction cube textures
  137819. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  137820. */
  137821. export class ReflectionProbe {
  137822. /** defines the name of the probe */
  137823. name: string;
  137824. private _scene;
  137825. private _renderTargetTexture;
  137826. private _projectionMatrix;
  137827. private _viewMatrix;
  137828. private _target;
  137829. private _add;
  137830. private _attachedMesh;
  137831. private _invertYAxis;
  137832. /** Gets or sets probe position (center of the cube map) */
  137833. position: Vector3;
  137834. /**
  137835. * Creates a new reflection probe
  137836. * @param name defines the name of the probe
  137837. * @param size defines the texture resolution (for each face)
  137838. * @param scene defines the hosting scene
  137839. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  137840. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  137841. */
  137842. constructor(
  137843. /** defines the name of the probe */
  137844. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  137845. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  137846. get samples(): number;
  137847. set samples(value: number);
  137848. /** Gets or sets the refresh rate to use (on every frame by default) */
  137849. get refreshRate(): number;
  137850. set refreshRate(value: number);
  137851. /**
  137852. * Gets the hosting scene
  137853. * @returns a Scene
  137854. */
  137855. getScene(): Scene;
  137856. /** Gets the internal CubeTexture used to render to */
  137857. get cubeTexture(): RenderTargetTexture;
  137858. /** Gets the list of meshes to render */
  137859. get renderList(): Nullable<AbstractMesh[]>;
  137860. /**
  137861. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  137862. * @param mesh defines the mesh to attach to
  137863. */
  137864. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  137865. /**
  137866. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  137867. * @param renderingGroupId The rendering group id corresponding to its index
  137868. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  137869. */
  137870. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  137871. /**
  137872. * Clean all associated resources
  137873. */
  137874. dispose(): void;
  137875. /**
  137876. * Converts the reflection probe information to a readable string for debug purpose.
  137877. * @param fullDetails Supports for multiple levels of logging within scene loading
  137878. * @returns the human readable reflection probe info
  137879. */
  137880. toString(fullDetails?: boolean): string;
  137881. /**
  137882. * Get the class name of the relfection probe.
  137883. * @returns "ReflectionProbe"
  137884. */
  137885. getClassName(): string;
  137886. /**
  137887. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  137888. * @returns The JSON representation of the texture
  137889. */
  137890. serialize(): any;
  137891. /**
  137892. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  137893. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  137894. * @param scene Define the scene the parsed reflection probe should be instantiated in
  137895. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  137896. * @returns The parsed reflection probe if successful
  137897. */
  137898. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  137899. }
  137900. }
  137901. declare module BABYLON {
  137902. /** @hidden */
  137903. export var _BabylonLoaderRegistered: boolean;
  137904. /**
  137905. * Helps setting up some configuration for the babylon file loader.
  137906. */
  137907. export class BabylonFileLoaderConfiguration {
  137908. /**
  137909. * The loader does not allow injecting custom physix engine into the plugins.
  137910. * Unfortunately in ES6, we need to manually inject them into the plugin.
  137911. * So you could set this variable to your engine import to make it work.
  137912. */
  137913. static LoaderInjectedPhysicsEngine: any;
  137914. }
  137915. }
  137916. declare module BABYLON {
  137917. /**
  137918. * The Physically based simple base material of BJS.
  137919. *
  137920. * This enables better naming and convention enforcements on top of the pbrMaterial.
  137921. * It is used as the base class for both the specGloss and metalRough conventions.
  137922. */
  137923. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  137924. /**
  137925. * Number of Simultaneous lights allowed on the material.
  137926. */
  137927. maxSimultaneousLights: number;
  137928. /**
  137929. * If sets to true, disables all the lights affecting the material.
  137930. */
  137931. disableLighting: boolean;
  137932. /**
  137933. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  137934. */
  137935. environmentTexture: BaseTexture;
  137936. /**
  137937. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  137938. */
  137939. invertNormalMapX: boolean;
  137940. /**
  137941. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  137942. */
  137943. invertNormalMapY: boolean;
  137944. /**
  137945. * Normal map used in the model.
  137946. */
  137947. normalTexture: BaseTexture;
  137948. /**
  137949. * Emissivie color used to self-illuminate the model.
  137950. */
  137951. emissiveColor: Color3;
  137952. /**
  137953. * Emissivie texture used to self-illuminate the model.
  137954. */
  137955. emissiveTexture: BaseTexture;
  137956. /**
  137957. * Occlusion Channel Strenght.
  137958. */
  137959. occlusionStrength: number;
  137960. /**
  137961. * Occlusion Texture of the material (adding extra occlusion effects).
  137962. */
  137963. occlusionTexture: BaseTexture;
  137964. /**
  137965. * Defines the alpha limits in alpha test mode.
  137966. */
  137967. alphaCutOff: number;
  137968. /**
  137969. * Gets the current double sided mode.
  137970. */
  137971. get doubleSided(): boolean;
  137972. /**
  137973. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  137974. */
  137975. set doubleSided(value: boolean);
  137976. /**
  137977. * Stores the pre-calculated light information of a mesh in a texture.
  137978. */
  137979. lightmapTexture: BaseTexture;
  137980. /**
  137981. * If true, the light map contains occlusion information instead of lighting info.
  137982. */
  137983. useLightmapAsShadowmap: boolean;
  137984. /**
  137985. * Instantiates a new PBRMaterial instance.
  137986. *
  137987. * @param name The material name
  137988. * @param scene The scene the material will be use in.
  137989. */
  137990. constructor(name: string, scene: Scene);
  137991. getClassName(): string;
  137992. }
  137993. }
  137994. declare module BABYLON {
  137995. /**
  137996. * The PBR material of BJS following the metal roughness convention.
  137997. *
  137998. * This fits to the PBR convention in the GLTF definition:
  137999. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  138000. */
  138001. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  138002. /**
  138003. * The base color has two different interpretations depending on the value of metalness.
  138004. * When the material is a metal, the base color is the specific measured reflectance value
  138005. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  138006. * of the material.
  138007. */
  138008. baseColor: Color3;
  138009. /**
  138010. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  138011. * well as opacity information in the alpha channel.
  138012. */
  138013. baseTexture: BaseTexture;
  138014. /**
  138015. * Specifies the metallic scalar value of the material.
  138016. * Can also be used to scale the metalness values of the metallic texture.
  138017. */
  138018. metallic: number;
  138019. /**
  138020. * Specifies the roughness scalar value of the material.
  138021. * Can also be used to scale the roughness values of the metallic texture.
  138022. */
  138023. roughness: number;
  138024. /**
  138025. * Texture containing both the metallic value in the B channel and the
  138026. * roughness value in the G channel to keep better precision.
  138027. */
  138028. metallicRoughnessTexture: BaseTexture;
  138029. /**
  138030. * Instantiates a new PBRMetalRoughnessMaterial instance.
  138031. *
  138032. * @param name The material name
  138033. * @param scene The scene the material will be use in.
  138034. */
  138035. constructor(name: string, scene: Scene);
  138036. /**
  138037. * Return the currrent class name of the material.
  138038. */
  138039. getClassName(): string;
  138040. /**
  138041. * Makes a duplicate of the current material.
  138042. * @param name - name to use for the new material.
  138043. */
  138044. clone(name: string): PBRMetallicRoughnessMaterial;
  138045. /**
  138046. * Serialize the material to a parsable JSON object.
  138047. */
  138048. serialize(): any;
  138049. /**
  138050. * Parses a JSON object correponding to the serialize function.
  138051. */
  138052. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  138053. }
  138054. }
  138055. declare module BABYLON {
  138056. /**
  138057. * The PBR material of BJS following the specular glossiness convention.
  138058. *
  138059. * This fits to the PBR convention in the GLTF definition:
  138060. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  138061. */
  138062. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  138063. /**
  138064. * Specifies the diffuse color of the material.
  138065. */
  138066. diffuseColor: Color3;
  138067. /**
  138068. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  138069. * channel.
  138070. */
  138071. diffuseTexture: BaseTexture;
  138072. /**
  138073. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  138074. */
  138075. specularColor: Color3;
  138076. /**
  138077. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  138078. */
  138079. glossiness: number;
  138080. /**
  138081. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  138082. */
  138083. specularGlossinessTexture: BaseTexture;
  138084. /**
  138085. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  138086. *
  138087. * @param name The material name
  138088. * @param scene The scene the material will be use in.
  138089. */
  138090. constructor(name: string, scene: Scene);
  138091. /**
  138092. * Return the currrent class name of the material.
  138093. */
  138094. getClassName(): string;
  138095. /**
  138096. * Makes a duplicate of the current material.
  138097. * @param name - name to use for the new material.
  138098. */
  138099. clone(name: string): PBRSpecularGlossinessMaterial;
  138100. /**
  138101. * Serialize the material to a parsable JSON object.
  138102. */
  138103. serialize(): any;
  138104. /**
  138105. * Parses a JSON object correponding to the serialize function.
  138106. */
  138107. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  138108. }
  138109. }
  138110. declare module BABYLON {
  138111. /**
  138112. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  138113. * It can help converting any input color in a desired output one. This can then be used to create effects
  138114. * from sepia, black and white to sixties or futuristic rendering...
  138115. *
  138116. * The only supported format is currently 3dl.
  138117. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  138118. */
  138119. export class ColorGradingTexture extends BaseTexture {
  138120. /**
  138121. * The texture URL.
  138122. */
  138123. url: string;
  138124. /**
  138125. * Empty line regex stored for GC.
  138126. */
  138127. private static _noneEmptyLineRegex;
  138128. private _textureMatrix;
  138129. private _onLoad;
  138130. /**
  138131. * Instantiates a ColorGradingTexture from the following parameters.
  138132. *
  138133. * @param url The location of the color gradind data (currently only supporting 3dl)
  138134. * @param sceneOrEngine The scene or engine the texture will be used in
  138135. * @param onLoad defines a callback triggered when the texture has been loaded
  138136. */
  138137. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  138138. /**
  138139. * Fires the onload event from the constructor if requested.
  138140. */
  138141. private _triggerOnLoad;
  138142. /**
  138143. * Returns the texture matrix used in most of the material.
  138144. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  138145. */
  138146. getTextureMatrix(): Matrix;
  138147. /**
  138148. * Occurs when the file being loaded is a .3dl LUT file.
  138149. */
  138150. private load3dlTexture;
  138151. /**
  138152. * Starts the loading process of the texture.
  138153. */
  138154. private loadTexture;
  138155. /**
  138156. * Clones the color gradind texture.
  138157. */
  138158. clone(): ColorGradingTexture;
  138159. /**
  138160. * Called during delayed load for textures.
  138161. */
  138162. delayLoad(): void;
  138163. /**
  138164. * Parses a color grading texture serialized by Babylon.
  138165. * @param parsedTexture The texture information being parsedTexture
  138166. * @param scene The scene to load the texture in
  138167. * @param rootUrl The root url of the data assets to load
  138168. * @return A color gradind texture
  138169. */
  138170. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  138171. /**
  138172. * Serializes the LUT texture to json format.
  138173. */
  138174. serialize(): any;
  138175. }
  138176. }
  138177. declare module BABYLON {
  138178. /**
  138179. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  138180. */
  138181. export class EquiRectangularCubeTexture extends BaseTexture {
  138182. /** The six faces of the cube. */
  138183. private static _FacesMapping;
  138184. private _noMipmap;
  138185. private _onLoad;
  138186. private _onError;
  138187. /** The size of the cubemap. */
  138188. private _size;
  138189. /** The buffer of the image. */
  138190. private _buffer;
  138191. /** The width of the input image. */
  138192. private _width;
  138193. /** The height of the input image. */
  138194. private _height;
  138195. /** The URL to the image. */
  138196. url: string;
  138197. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  138198. coordinatesMode: number;
  138199. /**
  138200. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  138201. * @param url The location of the image
  138202. * @param scene The scene the texture will be used in
  138203. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  138204. * @param noMipmap Forces to not generate the mipmap if true
  138205. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  138206. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  138207. * @param onLoad — defines a callback called when texture is loaded
  138208. * @param onError — defines a callback called if there is an error
  138209. */
  138210. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  138211. /**
  138212. * Load the image data, by putting the image on a canvas and extracting its buffer.
  138213. */
  138214. private loadImage;
  138215. /**
  138216. * Convert the image buffer into a cubemap and create a CubeTexture.
  138217. */
  138218. private loadTexture;
  138219. /**
  138220. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  138221. * @param buffer The ArrayBuffer that should be converted.
  138222. * @returns The buffer as Float32Array.
  138223. */
  138224. private getFloat32ArrayFromArrayBuffer;
  138225. /**
  138226. * Get the current class name of the texture useful for serialization or dynamic coding.
  138227. * @returns "EquiRectangularCubeTexture"
  138228. */
  138229. getClassName(): string;
  138230. /**
  138231. * Create a clone of the current EquiRectangularCubeTexture and return it.
  138232. * @returns A clone of the current EquiRectangularCubeTexture.
  138233. */
  138234. clone(): EquiRectangularCubeTexture;
  138235. }
  138236. }
  138237. declare module BABYLON {
  138238. /**
  138239. * Defines the options related to the creation of an HtmlElementTexture
  138240. */
  138241. export interface IHtmlElementTextureOptions {
  138242. /**
  138243. * Defines wether mip maps should be created or not.
  138244. */
  138245. generateMipMaps?: boolean;
  138246. /**
  138247. * Defines the sampling mode of the texture.
  138248. */
  138249. samplingMode?: number;
  138250. /**
  138251. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  138252. */
  138253. engine: Nullable<ThinEngine>;
  138254. /**
  138255. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  138256. */
  138257. scene: Nullable<Scene>;
  138258. }
  138259. /**
  138260. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  138261. * To be as efficient as possible depending on your constraints nothing aside the first upload
  138262. * is automatically managed.
  138263. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  138264. * in your application.
  138265. *
  138266. * As the update is not automatic, you need to call them manually.
  138267. */
  138268. export class HtmlElementTexture extends BaseTexture {
  138269. /**
  138270. * The texture URL.
  138271. */
  138272. element: HTMLVideoElement | HTMLCanvasElement;
  138273. private static readonly DefaultOptions;
  138274. private _textureMatrix;
  138275. private _isVideo;
  138276. private _generateMipMaps;
  138277. private _samplingMode;
  138278. /**
  138279. * Instantiates a HtmlElementTexture from the following parameters.
  138280. *
  138281. * @param name Defines the name of the texture
  138282. * @param element Defines the video or canvas the texture is filled with
  138283. * @param options Defines the other none mandatory texture creation options
  138284. */
  138285. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  138286. private _createInternalTexture;
  138287. /**
  138288. * Returns the texture matrix used in most of the material.
  138289. */
  138290. getTextureMatrix(): Matrix;
  138291. /**
  138292. * Updates the content of the texture.
  138293. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  138294. */
  138295. update(invertY?: Nullable<boolean>): void;
  138296. }
  138297. }
  138298. declare module BABYLON {
  138299. /**
  138300. * Based on jsTGALoader - Javascript loader for TGA file
  138301. * By Vincent Thibault
  138302. * @see http://blog.robrowser.com/javascript-tga-loader.html
  138303. */
  138304. export class TGATools {
  138305. private static _TYPE_INDEXED;
  138306. private static _TYPE_RGB;
  138307. private static _TYPE_GREY;
  138308. private static _TYPE_RLE_INDEXED;
  138309. private static _TYPE_RLE_RGB;
  138310. private static _TYPE_RLE_GREY;
  138311. private static _ORIGIN_MASK;
  138312. private static _ORIGIN_SHIFT;
  138313. private static _ORIGIN_BL;
  138314. private static _ORIGIN_BR;
  138315. private static _ORIGIN_UL;
  138316. private static _ORIGIN_UR;
  138317. /**
  138318. * Gets the header of a TGA file
  138319. * @param data defines the TGA data
  138320. * @returns the header
  138321. */
  138322. static GetTGAHeader(data: Uint8Array): any;
  138323. /**
  138324. * Uploads TGA content to a Babylon Texture
  138325. * @hidden
  138326. */
  138327. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  138328. /** @hidden */
  138329. 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;
  138330. /** @hidden */
  138331. 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;
  138332. /** @hidden */
  138333. 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;
  138334. /** @hidden */
  138335. 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;
  138336. /** @hidden */
  138337. 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;
  138338. /** @hidden */
  138339. 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;
  138340. }
  138341. }
  138342. declare module BABYLON {
  138343. /**
  138344. * Implementation of the TGA Texture Loader.
  138345. * @hidden
  138346. */
  138347. export class _TGATextureLoader implements IInternalTextureLoader {
  138348. /**
  138349. * Defines wether the loader supports cascade loading the different faces.
  138350. */
  138351. readonly supportCascades: boolean;
  138352. /**
  138353. * This returns if the loader support the current file information.
  138354. * @param extension defines the file extension of the file being loaded
  138355. * @returns true if the loader can load the specified file
  138356. */
  138357. canLoad(extension: string): boolean;
  138358. /**
  138359. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  138360. * @param data contains the texture data
  138361. * @param texture defines the BabylonJS internal texture
  138362. * @param createPolynomials will be true if polynomials have been requested
  138363. * @param onLoad defines the callback to trigger once the texture is ready
  138364. * @param onError defines the callback to trigger in case of error
  138365. */
  138366. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  138367. /**
  138368. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  138369. * @param data contains the texture data
  138370. * @param texture defines the BabylonJS internal texture
  138371. * @param callback defines the method to call once ready to upload
  138372. */
  138373. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  138374. }
  138375. }
  138376. declare module BABYLON {
  138377. /**
  138378. * Info about the .basis files
  138379. */
  138380. class BasisFileInfo {
  138381. /**
  138382. * If the file has alpha
  138383. */
  138384. hasAlpha: boolean;
  138385. /**
  138386. * Info about each image of the basis file
  138387. */
  138388. images: Array<{
  138389. levels: Array<{
  138390. width: number;
  138391. height: number;
  138392. transcodedPixels: ArrayBufferView;
  138393. }>;
  138394. }>;
  138395. }
  138396. /**
  138397. * Result of transcoding a basis file
  138398. */
  138399. class TranscodeResult {
  138400. /**
  138401. * Info about the .basis file
  138402. */
  138403. fileInfo: BasisFileInfo;
  138404. /**
  138405. * Format to use when loading the file
  138406. */
  138407. format: number;
  138408. }
  138409. /**
  138410. * Configuration options for the Basis transcoder
  138411. */
  138412. export class BasisTranscodeConfiguration {
  138413. /**
  138414. * Supported compression formats used to determine the supported output format of the transcoder
  138415. */
  138416. supportedCompressionFormats?: {
  138417. /**
  138418. * etc1 compression format
  138419. */
  138420. etc1?: boolean;
  138421. /**
  138422. * s3tc compression format
  138423. */
  138424. s3tc?: boolean;
  138425. /**
  138426. * pvrtc compression format
  138427. */
  138428. pvrtc?: boolean;
  138429. /**
  138430. * etc2 compression format
  138431. */
  138432. etc2?: boolean;
  138433. };
  138434. /**
  138435. * If mipmap levels should be loaded for transcoded images (Default: true)
  138436. */
  138437. loadMipmapLevels?: boolean;
  138438. /**
  138439. * Index of a single image to load (Default: all images)
  138440. */
  138441. loadSingleImage?: number;
  138442. }
  138443. /**
  138444. * Used to load .Basis files
  138445. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  138446. */
  138447. export class BasisTools {
  138448. private static _IgnoreSupportedFormats;
  138449. /**
  138450. * URL to use when loading the basis transcoder
  138451. */
  138452. static JSModuleURL: string;
  138453. /**
  138454. * URL to use when loading the wasm module for the transcoder
  138455. */
  138456. static WasmModuleURL: string;
  138457. /**
  138458. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  138459. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  138460. * @returns internal format corresponding to the Basis format
  138461. */
  138462. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  138463. private static _WorkerPromise;
  138464. private static _Worker;
  138465. private static _actionId;
  138466. private static _CreateWorkerAsync;
  138467. /**
  138468. * Transcodes a loaded image file to compressed pixel data
  138469. * @param data image data to transcode
  138470. * @param config configuration options for the transcoding
  138471. * @returns a promise resulting in the transcoded image
  138472. */
  138473. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  138474. /**
  138475. * Loads a texture from the transcode result
  138476. * @param texture texture load to
  138477. * @param transcodeResult the result of transcoding the basis file to load from
  138478. */
  138479. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  138480. }
  138481. }
  138482. declare module BABYLON {
  138483. /**
  138484. * Loader for .basis file format
  138485. */
  138486. export class _BasisTextureLoader implements IInternalTextureLoader {
  138487. /**
  138488. * Defines whether the loader supports cascade loading the different faces.
  138489. */
  138490. readonly supportCascades: boolean;
  138491. /**
  138492. * This returns if the loader support the current file information.
  138493. * @param extension defines the file extension of the file being loaded
  138494. * @returns true if the loader can load the specified file
  138495. */
  138496. canLoad(extension: string): boolean;
  138497. /**
  138498. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  138499. * @param data contains the texture data
  138500. * @param texture defines the BabylonJS internal texture
  138501. * @param createPolynomials will be true if polynomials have been requested
  138502. * @param onLoad defines the callback to trigger once the texture is ready
  138503. * @param onError defines the callback to trigger in case of error
  138504. */
  138505. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  138506. /**
  138507. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  138508. * @param data contains the texture data
  138509. * @param texture defines the BabylonJS internal texture
  138510. * @param callback defines the method to call once ready to upload
  138511. */
  138512. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  138513. }
  138514. }
  138515. declare module BABYLON {
  138516. /**
  138517. * Defines the basic options interface of a TexturePacker Frame
  138518. */
  138519. export interface ITexturePackerFrame {
  138520. /**
  138521. * The frame ID
  138522. */
  138523. id: number;
  138524. /**
  138525. * The frames Scale
  138526. */
  138527. scale: Vector2;
  138528. /**
  138529. * The Frames offset
  138530. */
  138531. offset: Vector2;
  138532. }
  138533. /**
  138534. * This is a support class for frame Data on texture packer sets.
  138535. */
  138536. export class TexturePackerFrame implements ITexturePackerFrame {
  138537. /**
  138538. * The frame ID
  138539. */
  138540. id: number;
  138541. /**
  138542. * The frames Scale
  138543. */
  138544. scale: Vector2;
  138545. /**
  138546. * The Frames offset
  138547. */
  138548. offset: Vector2;
  138549. /**
  138550. * Initializes a texture package frame.
  138551. * @param id The numerical frame identifier
  138552. * @param scale Scalar Vector2 for UV frame
  138553. * @param offset Vector2 for the frame position in UV units.
  138554. * @returns TexturePackerFrame
  138555. */
  138556. constructor(id: number, scale: Vector2, offset: Vector2);
  138557. }
  138558. }
  138559. declare module BABYLON {
  138560. /**
  138561. * Defines the basic options interface of a TexturePacker
  138562. */
  138563. export interface ITexturePackerOptions {
  138564. /**
  138565. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  138566. */
  138567. map?: string[];
  138568. /**
  138569. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  138570. */
  138571. uvsIn?: string;
  138572. /**
  138573. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  138574. */
  138575. uvsOut?: string;
  138576. /**
  138577. * number representing the layout style. Defaults to LAYOUT_STRIP
  138578. */
  138579. layout?: number;
  138580. /**
  138581. * number of columns if using custom column count layout(2). This defaults to 4.
  138582. */
  138583. colnum?: number;
  138584. /**
  138585. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  138586. */
  138587. updateInputMeshes?: boolean;
  138588. /**
  138589. * boolean flag to dispose all the source textures. Defaults to true.
  138590. */
  138591. disposeSources?: boolean;
  138592. /**
  138593. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  138594. */
  138595. fillBlanks?: boolean;
  138596. /**
  138597. * string value representing the context fill style color. Defaults to 'black'.
  138598. */
  138599. customFillColor?: string;
  138600. /**
  138601. * Width and Height Value of each Frame in the TexturePacker Sets
  138602. */
  138603. frameSize?: number;
  138604. /**
  138605. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  138606. */
  138607. paddingRatio?: number;
  138608. /**
  138609. * Number that declares the fill method for the padding gutter.
  138610. */
  138611. paddingMode?: number;
  138612. /**
  138613. * If in SUBUV_COLOR padding mode what color to use.
  138614. */
  138615. paddingColor?: Color3 | Color4;
  138616. }
  138617. /**
  138618. * Defines the basic interface of a TexturePacker JSON File
  138619. */
  138620. export interface ITexturePackerJSON {
  138621. /**
  138622. * The frame ID
  138623. */
  138624. name: string;
  138625. /**
  138626. * The base64 channel data
  138627. */
  138628. sets: any;
  138629. /**
  138630. * The options of the Packer
  138631. */
  138632. options: ITexturePackerOptions;
  138633. /**
  138634. * The frame data of the Packer
  138635. */
  138636. frames: Array<number>;
  138637. }
  138638. /**
  138639. * This is a support class that generates a series of packed texture sets.
  138640. * @see https://doc.babylonjs.com/babylon101/materials
  138641. */
  138642. export class TexturePacker {
  138643. /** Packer Layout Constant 0 */
  138644. static readonly LAYOUT_STRIP: number;
  138645. /** Packer Layout Constant 1 */
  138646. static readonly LAYOUT_POWER2: number;
  138647. /** Packer Layout Constant 2 */
  138648. static readonly LAYOUT_COLNUM: number;
  138649. /** Packer Layout Constant 0 */
  138650. static readonly SUBUV_WRAP: number;
  138651. /** Packer Layout Constant 1 */
  138652. static readonly SUBUV_EXTEND: number;
  138653. /** Packer Layout Constant 2 */
  138654. static readonly SUBUV_COLOR: number;
  138655. /** The Name of the Texture Package */
  138656. name: string;
  138657. /** The scene scope of the TexturePacker */
  138658. scene: Scene;
  138659. /** The Meshes to target */
  138660. meshes: AbstractMesh[];
  138661. /** Arguments passed with the Constructor */
  138662. options: ITexturePackerOptions;
  138663. /** The promise that is started upon initialization */
  138664. promise: Nullable<Promise<TexturePacker | string>>;
  138665. /** The Container object for the channel sets that are generated */
  138666. sets: object;
  138667. /** The Container array for the frames that are generated */
  138668. frames: TexturePackerFrame[];
  138669. /** The expected number of textures the system is parsing. */
  138670. private _expecting;
  138671. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  138672. private _paddingValue;
  138673. /**
  138674. * Initializes a texture package series from an array of meshes or a single mesh.
  138675. * @param name The name of the package
  138676. * @param meshes The target meshes to compose the package from
  138677. * @param options The arguments that texture packer should follow while building.
  138678. * @param scene The scene which the textures are scoped to.
  138679. * @returns TexturePacker
  138680. */
  138681. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  138682. /**
  138683. * Starts the package process
  138684. * @param resolve The promises resolution function
  138685. * @returns TexturePacker
  138686. */
  138687. private _createFrames;
  138688. /**
  138689. * Calculates the Size of the Channel Sets
  138690. * @returns Vector2
  138691. */
  138692. private _calculateSize;
  138693. /**
  138694. * Calculates the UV data for the frames.
  138695. * @param baseSize the base frameSize
  138696. * @param padding the base frame padding
  138697. * @param dtSize size of the Dynamic Texture for that channel
  138698. * @param dtUnits is 1/dtSize
  138699. * @param update flag to update the input meshes
  138700. */
  138701. private _calculateMeshUVFrames;
  138702. /**
  138703. * Calculates the frames Offset.
  138704. * @param index of the frame
  138705. * @returns Vector2
  138706. */
  138707. private _getFrameOffset;
  138708. /**
  138709. * Updates a Mesh to the frame data
  138710. * @param mesh that is the target
  138711. * @param frameID or the frame index
  138712. */
  138713. private _updateMeshUV;
  138714. /**
  138715. * Updates a Meshes materials to use the texture packer channels
  138716. * @param m is the mesh to target
  138717. * @param force all channels on the packer to be set.
  138718. */
  138719. private _updateTextureReferences;
  138720. /**
  138721. * Public method to set a Mesh to a frame
  138722. * @param m that is the target
  138723. * @param frameID or the frame index
  138724. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  138725. */
  138726. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  138727. /**
  138728. * Starts the async promise to compile the texture packer.
  138729. * @returns Promise<void>
  138730. */
  138731. processAsync(): Promise<void>;
  138732. /**
  138733. * Disposes all textures associated with this packer
  138734. */
  138735. dispose(): void;
  138736. /**
  138737. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  138738. * @param imageType is the image type to use.
  138739. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  138740. */
  138741. download(imageType?: string, quality?: number): void;
  138742. /**
  138743. * Public method to load a texturePacker JSON file.
  138744. * @param data of the JSON file in string format.
  138745. */
  138746. updateFromJSON(data: string): void;
  138747. }
  138748. }
  138749. declare module BABYLON {
  138750. /**
  138751. * 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.
  138752. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  138753. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  138754. */
  138755. export class CustomProceduralTexture extends ProceduralTexture {
  138756. private _animate;
  138757. private _time;
  138758. private _config;
  138759. private _texturePath;
  138760. /**
  138761. * Instantiates a new Custom Procedural Texture.
  138762. * 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.
  138763. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  138764. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  138765. * @param name Define the name of the texture
  138766. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  138767. * @param size Define the size of the texture to create
  138768. * @param scene Define the scene the texture belongs to
  138769. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  138770. * @param generateMipMaps Define if the texture should creates mip maps or not
  138771. */
  138772. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  138773. private _loadJson;
  138774. /**
  138775. * Is the texture ready to be used ? (rendered at least once)
  138776. * @returns true if ready, otherwise, false.
  138777. */
  138778. isReady(): boolean;
  138779. /**
  138780. * Render the texture to its associated render target.
  138781. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  138782. */
  138783. render(useCameraPostProcess?: boolean): void;
  138784. /**
  138785. * Update the list of dependant textures samplers in the shader.
  138786. */
  138787. updateTextures(): void;
  138788. /**
  138789. * Update the uniform values of the procedural texture in the shader.
  138790. */
  138791. updateShaderUniforms(): void;
  138792. /**
  138793. * Define if the texture animates or not.
  138794. */
  138795. get animate(): boolean;
  138796. set animate(value: boolean);
  138797. }
  138798. }
  138799. declare module BABYLON {
  138800. /** @hidden */
  138801. export var noisePixelShader: {
  138802. name: string;
  138803. shader: string;
  138804. };
  138805. }
  138806. declare module BABYLON {
  138807. /**
  138808. * Class used to generate noise procedural textures
  138809. */
  138810. export class NoiseProceduralTexture extends ProceduralTexture {
  138811. private _time;
  138812. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  138813. brightness: number;
  138814. /** Defines the number of octaves to process */
  138815. octaves: number;
  138816. /** Defines the level of persistence (0.8 by default) */
  138817. persistence: number;
  138818. /** Gets or sets animation speed factor (default is 1) */
  138819. animationSpeedFactor: number;
  138820. /**
  138821. * Creates a new NoiseProceduralTexture
  138822. * @param name defines the name fo the texture
  138823. * @param size defines the size of the texture (default is 256)
  138824. * @param scene defines the hosting scene
  138825. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  138826. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  138827. */
  138828. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  138829. private _updateShaderUniforms;
  138830. protected _getDefines(): string;
  138831. /** Generate the current state of the procedural texture */
  138832. render(useCameraPostProcess?: boolean): void;
  138833. /**
  138834. * Serializes this noise procedural texture
  138835. * @returns a serialized noise procedural texture object
  138836. */
  138837. serialize(): any;
  138838. /**
  138839. * Clone the texture.
  138840. * @returns the cloned texture
  138841. */
  138842. clone(): NoiseProceduralTexture;
  138843. /**
  138844. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  138845. * @param parsedTexture defines parsed texture data
  138846. * @param scene defines the current scene
  138847. * @param rootUrl defines the root URL containing noise procedural texture information
  138848. * @returns a parsed NoiseProceduralTexture
  138849. */
  138850. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  138851. }
  138852. }
  138853. declare module BABYLON {
  138854. /**
  138855. * Raw cube texture where the raw buffers are passed in
  138856. */
  138857. export class RawCubeTexture extends CubeTexture {
  138858. /**
  138859. * Creates a cube texture where the raw buffers are passed in.
  138860. * @param scene defines the scene the texture is attached to
  138861. * @param data defines the array of data to use to create each face
  138862. * @param size defines the size of the textures
  138863. * @param format defines the format of the data
  138864. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  138865. * @param generateMipMaps defines if the engine should generate the mip levels
  138866. * @param invertY defines if data must be stored with Y axis inverted
  138867. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  138868. * @param compression defines the compression used (null by default)
  138869. */
  138870. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  138871. /**
  138872. * Updates the raw cube texture.
  138873. * @param data defines the data to store
  138874. * @param format defines the data format
  138875. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  138876. * @param invertY defines if data must be stored with Y axis inverted
  138877. * @param compression defines the compression used (null by default)
  138878. * @param level defines which level of the texture to update
  138879. */
  138880. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  138881. /**
  138882. * Updates a raw cube texture with RGBD encoded data.
  138883. * @param data defines the array of data [mipmap][face] to use to create each face
  138884. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  138885. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  138886. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  138887. * @returns a promsie that resolves when the operation is complete
  138888. */
  138889. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  138890. /**
  138891. * Clones the raw cube texture.
  138892. * @return a new cube texture
  138893. */
  138894. clone(): CubeTexture;
  138895. /** @hidden */
  138896. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  138897. }
  138898. }
  138899. declare module BABYLON {
  138900. /**
  138901. * Class used to store 2D array textures containing user data
  138902. */
  138903. export class RawTexture2DArray extends Texture {
  138904. /** Gets or sets the texture format to use */
  138905. format: number;
  138906. /**
  138907. * Create a new RawTexture2DArray
  138908. * @param data defines the data of the texture
  138909. * @param width defines the width of the texture
  138910. * @param height defines the height of the texture
  138911. * @param depth defines the number of layers of the texture
  138912. * @param format defines the texture format to use
  138913. * @param scene defines the hosting scene
  138914. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  138915. * @param invertY defines if texture must be stored with Y axis inverted
  138916. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  138917. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  138918. */
  138919. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  138920. /** Gets or sets the texture format to use */
  138921. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  138922. /**
  138923. * Update the texture with new data
  138924. * @param data defines the data to store in the texture
  138925. */
  138926. update(data: ArrayBufferView): void;
  138927. }
  138928. }
  138929. declare module BABYLON {
  138930. /**
  138931. * Class used to store 3D textures containing user data
  138932. */
  138933. export class RawTexture3D extends Texture {
  138934. /** Gets or sets the texture format to use */
  138935. format: number;
  138936. /**
  138937. * Create a new RawTexture3D
  138938. * @param data defines the data of the texture
  138939. * @param width defines the width of the texture
  138940. * @param height defines the height of the texture
  138941. * @param depth defines the depth of the texture
  138942. * @param format defines the texture format to use
  138943. * @param scene defines the hosting scene
  138944. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  138945. * @param invertY defines if texture must be stored with Y axis inverted
  138946. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  138947. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  138948. */
  138949. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  138950. /** Gets or sets the texture format to use */
  138951. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  138952. /**
  138953. * Update the texture with new data
  138954. * @param data defines the data to store in the texture
  138955. */
  138956. update(data: ArrayBufferView): void;
  138957. }
  138958. }
  138959. declare module BABYLON {
  138960. /**
  138961. * Creates a refraction texture used by refraction channel of the standard material.
  138962. * It is like a mirror but to see through a material.
  138963. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  138964. */
  138965. export class RefractionTexture extends RenderTargetTexture {
  138966. /**
  138967. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  138968. * 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.
  138969. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  138970. */
  138971. refractionPlane: Plane;
  138972. /**
  138973. * Define how deep under the surface we should see.
  138974. */
  138975. depth: number;
  138976. /**
  138977. * Creates a refraction texture used by refraction channel of the standard material.
  138978. * It is like a mirror but to see through a material.
  138979. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  138980. * @param name Define the texture name
  138981. * @param size Define the size of the underlying texture
  138982. * @param scene Define the scene the refraction belongs to
  138983. * @param generateMipMaps Define if we need to generate mips level for the refraction
  138984. */
  138985. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  138986. /**
  138987. * Clone the refraction texture.
  138988. * @returns the cloned texture
  138989. */
  138990. clone(): RefractionTexture;
  138991. /**
  138992. * Serialize the texture to a JSON representation you could use in Parse later on
  138993. * @returns the serialized JSON representation
  138994. */
  138995. serialize(): any;
  138996. }
  138997. }
  138998. declare module BABYLON {
  138999. /**
  139000. * Block used to add support for vertex skinning (bones)
  139001. */
  139002. export class BonesBlock extends NodeMaterialBlock {
  139003. /**
  139004. * Creates a new BonesBlock
  139005. * @param name defines the block name
  139006. */
  139007. constructor(name: string);
  139008. /**
  139009. * Initialize the block and prepare the context for build
  139010. * @param state defines the state that will be used for the build
  139011. */
  139012. initialize(state: NodeMaterialBuildState): void;
  139013. /**
  139014. * Gets the current class name
  139015. * @returns the class name
  139016. */
  139017. getClassName(): string;
  139018. /**
  139019. * Gets the matrix indices input component
  139020. */
  139021. get matricesIndices(): NodeMaterialConnectionPoint;
  139022. /**
  139023. * Gets the matrix weights input component
  139024. */
  139025. get matricesWeights(): NodeMaterialConnectionPoint;
  139026. /**
  139027. * Gets the extra matrix indices input component
  139028. */
  139029. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  139030. /**
  139031. * Gets the extra matrix weights input component
  139032. */
  139033. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  139034. /**
  139035. * Gets the world input component
  139036. */
  139037. get world(): NodeMaterialConnectionPoint;
  139038. /**
  139039. * Gets the output component
  139040. */
  139041. get output(): NodeMaterialConnectionPoint;
  139042. autoConfigure(material: NodeMaterial): void;
  139043. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  139044. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  139045. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  139046. protected _buildBlock(state: NodeMaterialBuildState): this;
  139047. }
  139048. }
  139049. declare module BABYLON {
  139050. /**
  139051. * Block used to add support for instances
  139052. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  139053. */
  139054. export class InstancesBlock extends NodeMaterialBlock {
  139055. /**
  139056. * Creates a new InstancesBlock
  139057. * @param name defines the block name
  139058. */
  139059. constructor(name: string);
  139060. /**
  139061. * Gets the current class name
  139062. * @returns the class name
  139063. */
  139064. getClassName(): string;
  139065. /**
  139066. * Gets the first world row input component
  139067. */
  139068. get world0(): NodeMaterialConnectionPoint;
  139069. /**
  139070. * Gets the second world row input component
  139071. */
  139072. get world1(): NodeMaterialConnectionPoint;
  139073. /**
  139074. * Gets the third world row input component
  139075. */
  139076. get world2(): NodeMaterialConnectionPoint;
  139077. /**
  139078. * Gets the forth world row input component
  139079. */
  139080. get world3(): NodeMaterialConnectionPoint;
  139081. /**
  139082. * Gets the world input component
  139083. */
  139084. get world(): NodeMaterialConnectionPoint;
  139085. /**
  139086. * Gets the output component
  139087. */
  139088. get output(): NodeMaterialConnectionPoint;
  139089. /**
  139090. * Gets the isntanceID component
  139091. */
  139092. get instanceID(): NodeMaterialConnectionPoint;
  139093. autoConfigure(material: NodeMaterial): void;
  139094. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  139095. protected _buildBlock(state: NodeMaterialBuildState): this;
  139096. }
  139097. }
  139098. declare module BABYLON {
  139099. /**
  139100. * Block used to add morph targets support to vertex shader
  139101. */
  139102. export class MorphTargetsBlock extends NodeMaterialBlock {
  139103. private _repeatableContentAnchor;
  139104. /**
  139105. * Create a new MorphTargetsBlock
  139106. * @param name defines the block name
  139107. */
  139108. constructor(name: string);
  139109. /**
  139110. * Gets the current class name
  139111. * @returns the class name
  139112. */
  139113. getClassName(): string;
  139114. /**
  139115. * Gets the position input component
  139116. */
  139117. get position(): NodeMaterialConnectionPoint;
  139118. /**
  139119. * Gets the normal input component
  139120. */
  139121. get normal(): NodeMaterialConnectionPoint;
  139122. /**
  139123. * Gets the tangent input component
  139124. */
  139125. get tangent(): NodeMaterialConnectionPoint;
  139126. /**
  139127. * Gets the tangent input component
  139128. */
  139129. get uv(): NodeMaterialConnectionPoint;
  139130. /**
  139131. * Gets the position output component
  139132. */
  139133. get positionOutput(): NodeMaterialConnectionPoint;
  139134. /**
  139135. * Gets the normal output component
  139136. */
  139137. get normalOutput(): NodeMaterialConnectionPoint;
  139138. /**
  139139. * Gets the tangent output component
  139140. */
  139141. get tangentOutput(): NodeMaterialConnectionPoint;
  139142. /**
  139143. * Gets the tangent output component
  139144. */
  139145. get uvOutput(): NodeMaterialConnectionPoint;
  139146. initialize(state: NodeMaterialBuildState): void;
  139147. autoConfigure(material: NodeMaterial): void;
  139148. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  139149. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  139150. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  139151. protected _buildBlock(state: NodeMaterialBuildState): this;
  139152. }
  139153. }
  139154. declare module BABYLON {
  139155. /**
  139156. * Block used to get data information from a light
  139157. */
  139158. export class LightInformationBlock extends NodeMaterialBlock {
  139159. private _lightDataUniformName;
  139160. private _lightColorUniformName;
  139161. private _lightTypeDefineName;
  139162. /**
  139163. * Gets or sets the light associated with this block
  139164. */
  139165. light: Nullable<Light>;
  139166. /**
  139167. * Creates a new LightInformationBlock
  139168. * @param name defines the block name
  139169. */
  139170. constructor(name: string);
  139171. /**
  139172. * Gets the current class name
  139173. * @returns the class name
  139174. */
  139175. getClassName(): string;
  139176. /**
  139177. * Gets the world position input component
  139178. */
  139179. get worldPosition(): NodeMaterialConnectionPoint;
  139180. /**
  139181. * Gets the direction output component
  139182. */
  139183. get direction(): NodeMaterialConnectionPoint;
  139184. /**
  139185. * Gets the direction output component
  139186. */
  139187. get color(): NodeMaterialConnectionPoint;
  139188. /**
  139189. * Gets the direction output component
  139190. */
  139191. get intensity(): NodeMaterialConnectionPoint;
  139192. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  139193. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  139194. protected _buildBlock(state: NodeMaterialBuildState): this;
  139195. serialize(): any;
  139196. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  139197. }
  139198. }
  139199. declare module BABYLON {
  139200. /**
  139201. * Block used to add image processing support to fragment shader
  139202. */
  139203. export class ImageProcessingBlock extends NodeMaterialBlock {
  139204. /**
  139205. * Create a new ImageProcessingBlock
  139206. * @param name defines the block name
  139207. */
  139208. constructor(name: string);
  139209. /**
  139210. * Gets the current class name
  139211. * @returns the class name
  139212. */
  139213. getClassName(): string;
  139214. /**
  139215. * Gets the color input component
  139216. */
  139217. get color(): NodeMaterialConnectionPoint;
  139218. /**
  139219. * Gets the output component
  139220. */
  139221. get output(): NodeMaterialConnectionPoint;
  139222. /**
  139223. * Initialize the block and prepare the context for build
  139224. * @param state defines the state that will be used for the build
  139225. */
  139226. initialize(state: NodeMaterialBuildState): void;
  139227. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  139228. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  139229. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  139230. protected _buildBlock(state: NodeMaterialBuildState): this;
  139231. }
  139232. }
  139233. declare module BABYLON {
  139234. /**
  139235. * Block used to pertub normals based on a normal map
  139236. */
  139237. export class PerturbNormalBlock extends NodeMaterialBlock {
  139238. private _tangentSpaceParameterName;
  139239. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  139240. invertX: boolean;
  139241. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  139242. invertY: boolean;
  139243. /**
  139244. * Create a new PerturbNormalBlock
  139245. * @param name defines the block name
  139246. */
  139247. constructor(name: string);
  139248. /**
  139249. * Gets the current class name
  139250. * @returns the class name
  139251. */
  139252. getClassName(): string;
  139253. /**
  139254. * Gets the world position input component
  139255. */
  139256. get worldPosition(): NodeMaterialConnectionPoint;
  139257. /**
  139258. * Gets the world normal input component
  139259. */
  139260. get worldNormal(): NodeMaterialConnectionPoint;
  139261. /**
  139262. * Gets the world tangent input component
  139263. */
  139264. get worldTangent(): NodeMaterialConnectionPoint;
  139265. /**
  139266. * Gets the uv input component
  139267. */
  139268. get uv(): NodeMaterialConnectionPoint;
  139269. /**
  139270. * Gets the normal map color input component
  139271. */
  139272. get normalMapColor(): NodeMaterialConnectionPoint;
  139273. /**
  139274. * Gets the strength input component
  139275. */
  139276. get strength(): NodeMaterialConnectionPoint;
  139277. /**
  139278. * Gets the output component
  139279. */
  139280. get output(): NodeMaterialConnectionPoint;
  139281. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  139282. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  139283. autoConfigure(material: NodeMaterial): void;
  139284. protected _buildBlock(state: NodeMaterialBuildState): this;
  139285. protected _dumpPropertiesCode(): string;
  139286. serialize(): any;
  139287. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  139288. }
  139289. }
  139290. declare module BABYLON {
  139291. /**
  139292. * Block used to discard a pixel if a value is smaller than a cutoff
  139293. */
  139294. export class DiscardBlock extends NodeMaterialBlock {
  139295. /**
  139296. * Create a new DiscardBlock
  139297. * @param name defines the block name
  139298. */
  139299. constructor(name: string);
  139300. /**
  139301. * Gets the current class name
  139302. * @returns the class name
  139303. */
  139304. getClassName(): string;
  139305. /**
  139306. * Gets the color input component
  139307. */
  139308. get value(): NodeMaterialConnectionPoint;
  139309. /**
  139310. * Gets the cutoff input component
  139311. */
  139312. get cutoff(): NodeMaterialConnectionPoint;
  139313. protected _buildBlock(state: NodeMaterialBuildState): this;
  139314. }
  139315. }
  139316. declare module BABYLON {
  139317. /**
  139318. * Block used to test if the fragment shader is front facing
  139319. */
  139320. export class FrontFacingBlock extends NodeMaterialBlock {
  139321. /**
  139322. * Creates a new FrontFacingBlock
  139323. * @param name defines the block name
  139324. */
  139325. constructor(name: string);
  139326. /**
  139327. * Gets the current class name
  139328. * @returns the class name
  139329. */
  139330. getClassName(): string;
  139331. /**
  139332. * Gets the output component
  139333. */
  139334. get output(): NodeMaterialConnectionPoint;
  139335. protected _buildBlock(state: NodeMaterialBuildState): this;
  139336. }
  139337. }
  139338. declare module BABYLON {
  139339. /**
  139340. * Block used to get the derivative value on x and y of a given input
  139341. */
  139342. export class DerivativeBlock extends NodeMaterialBlock {
  139343. /**
  139344. * Create a new DerivativeBlock
  139345. * @param name defines the block name
  139346. */
  139347. constructor(name: string);
  139348. /**
  139349. * Gets the current class name
  139350. * @returns the class name
  139351. */
  139352. getClassName(): string;
  139353. /**
  139354. * Gets the input component
  139355. */
  139356. get input(): NodeMaterialConnectionPoint;
  139357. /**
  139358. * Gets the derivative output on x
  139359. */
  139360. get dx(): NodeMaterialConnectionPoint;
  139361. /**
  139362. * Gets the derivative output on y
  139363. */
  139364. get dy(): NodeMaterialConnectionPoint;
  139365. protected _buildBlock(state: NodeMaterialBuildState): this;
  139366. }
  139367. }
  139368. declare module BABYLON {
  139369. /**
  139370. * Block used to make gl_FragCoord available
  139371. */
  139372. export class FragCoordBlock extends NodeMaterialBlock {
  139373. /**
  139374. * Creates a new FragCoordBlock
  139375. * @param name defines the block name
  139376. */
  139377. constructor(name: string);
  139378. /**
  139379. * Gets the current class name
  139380. * @returns the class name
  139381. */
  139382. getClassName(): string;
  139383. /**
  139384. * Gets the xy component
  139385. */
  139386. get xy(): NodeMaterialConnectionPoint;
  139387. /**
  139388. * Gets the xyz component
  139389. */
  139390. get xyz(): NodeMaterialConnectionPoint;
  139391. /**
  139392. * Gets the xyzw component
  139393. */
  139394. get xyzw(): NodeMaterialConnectionPoint;
  139395. /**
  139396. * Gets the x component
  139397. */
  139398. get x(): NodeMaterialConnectionPoint;
  139399. /**
  139400. * Gets the y component
  139401. */
  139402. get y(): NodeMaterialConnectionPoint;
  139403. /**
  139404. * Gets the z component
  139405. */
  139406. get z(): NodeMaterialConnectionPoint;
  139407. /**
  139408. * Gets the w component
  139409. */
  139410. get output(): NodeMaterialConnectionPoint;
  139411. protected writeOutputs(state: NodeMaterialBuildState): string;
  139412. protected _buildBlock(state: NodeMaterialBuildState): this;
  139413. }
  139414. }
  139415. declare module BABYLON {
  139416. /**
  139417. * Block used to get the screen sizes
  139418. */
  139419. export class ScreenSizeBlock extends NodeMaterialBlock {
  139420. private _varName;
  139421. private _scene;
  139422. /**
  139423. * Creates a new ScreenSizeBlock
  139424. * @param name defines the block name
  139425. */
  139426. constructor(name: string);
  139427. /**
  139428. * Gets the current class name
  139429. * @returns the class name
  139430. */
  139431. getClassName(): string;
  139432. /**
  139433. * Gets the xy component
  139434. */
  139435. get xy(): NodeMaterialConnectionPoint;
  139436. /**
  139437. * Gets the x component
  139438. */
  139439. get x(): NodeMaterialConnectionPoint;
  139440. /**
  139441. * Gets the y component
  139442. */
  139443. get y(): NodeMaterialConnectionPoint;
  139444. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  139445. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  139446. protected _buildBlock(state: NodeMaterialBuildState): this;
  139447. }
  139448. }
  139449. declare module BABYLON {
  139450. /**
  139451. * Block used to add support for scene fog
  139452. */
  139453. export class FogBlock extends NodeMaterialBlock {
  139454. private _fogDistanceName;
  139455. private _fogParameters;
  139456. /**
  139457. * Create a new FogBlock
  139458. * @param name defines the block name
  139459. */
  139460. constructor(name: string);
  139461. /**
  139462. * Gets the current class name
  139463. * @returns the class name
  139464. */
  139465. getClassName(): string;
  139466. /**
  139467. * Gets the world position input component
  139468. */
  139469. get worldPosition(): NodeMaterialConnectionPoint;
  139470. /**
  139471. * Gets the view input component
  139472. */
  139473. get view(): NodeMaterialConnectionPoint;
  139474. /**
  139475. * Gets the color input component
  139476. */
  139477. get input(): NodeMaterialConnectionPoint;
  139478. /**
  139479. * Gets the fog color input component
  139480. */
  139481. get fogColor(): NodeMaterialConnectionPoint;
  139482. /**
  139483. * Gets the output component
  139484. */
  139485. get output(): NodeMaterialConnectionPoint;
  139486. autoConfigure(material: NodeMaterial): void;
  139487. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  139488. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  139489. protected _buildBlock(state: NodeMaterialBuildState): this;
  139490. }
  139491. }
  139492. declare module BABYLON {
  139493. /**
  139494. * Block used to add light in the fragment shader
  139495. */
  139496. export class LightBlock extends NodeMaterialBlock {
  139497. private _lightId;
  139498. /**
  139499. * Gets or sets the light associated with this block
  139500. */
  139501. light: Nullable<Light>;
  139502. /**
  139503. * Create a new LightBlock
  139504. * @param name defines the block name
  139505. */
  139506. constructor(name: string);
  139507. /**
  139508. * Gets the current class name
  139509. * @returns the class name
  139510. */
  139511. getClassName(): string;
  139512. /**
  139513. * Gets the world position input component
  139514. */
  139515. get worldPosition(): NodeMaterialConnectionPoint;
  139516. /**
  139517. * Gets the world normal input component
  139518. */
  139519. get worldNormal(): NodeMaterialConnectionPoint;
  139520. /**
  139521. * Gets the camera (or eye) position component
  139522. */
  139523. get cameraPosition(): NodeMaterialConnectionPoint;
  139524. /**
  139525. * Gets the glossiness component
  139526. */
  139527. get glossiness(): NodeMaterialConnectionPoint;
  139528. /**
  139529. * Gets the glossinness power component
  139530. */
  139531. get glossPower(): NodeMaterialConnectionPoint;
  139532. /**
  139533. * Gets the diffuse color component
  139534. */
  139535. get diffuseColor(): NodeMaterialConnectionPoint;
  139536. /**
  139537. * Gets the specular color component
  139538. */
  139539. get specularColor(): NodeMaterialConnectionPoint;
  139540. /**
  139541. * Gets the diffuse output component
  139542. */
  139543. get diffuseOutput(): NodeMaterialConnectionPoint;
  139544. /**
  139545. * Gets the specular output component
  139546. */
  139547. get specularOutput(): NodeMaterialConnectionPoint;
  139548. /**
  139549. * Gets the shadow output component
  139550. */
  139551. get shadow(): NodeMaterialConnectionPoint;
  139552. autoConfigure(material: NodeMaterial): void;
  139553. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  139554. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  139555. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  139556. private _injectVertexCode;
  139557. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  139558. serialize(): any;
  139559. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  139560. }
  139561. }
  139562. declare module BABYLON {
  139563. /**
  139564. * Block used to read a reflection texture from a sampler
  139565. */
  139566. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  139567. /**
  139568. * Create a new ReflectionTextureBlock
  139569. * @param name defines the block name
  139570. */
  139571. constructor(name: string);
  139572. /**
  139573. * Gets the current class name
  139574. * @returns the class name
  139575. */
  139576. getClassName(): string;
  139577. /**
  139578. * Gets the world position input component
  139579. */
  139580. get position(): NodeMaterialConnectionPoint;
  139581. /**
  139582. * Gets the world position input component
  139583. */
  139584. get worldPosition(): NodeMaterialConnectionPoint;
  139585. /**
  139586. * Gets the world normal input component
  139587. */
  139588. get worldNormal(): NodeMaterialConnectionPoint;
  139589. /**
  139590. * Gets the world input component
  139591. */
  139592. get world(): NodeMaterialConnectionPoint;
  139593. /**
  139594. * Gets the camera (or eye) position component
  139595. */
  139596. get cameraPosition(): NodeMaterialConnectionPoint;
  139597. /**
  139598. * Gets the view input component
  139599. */
  139600. get view(): NodeMaterialConnectionPoint;
  139601. /**
  139602. * Gets the rgb output component
  139603. */
  139604. get rgb(): NodeMaterialConnectionPoint;
  139605. /**
  139606. * Gets the rgba output component
  139607. */
  139608. get rgba(): NodeMaterialConnectionPoint;
  139609. /**
  139610. * Gets the r output component
  139611. */
  139612. get r(): NodeMaterialConnectionPoint;
  139613. /**
  139614. * Gets the g output component
  139615. */
  139616. get g(): NodeMaterialConnectionPoint;
  139617. /**
  139618. * Gets the b output component
  139619. */
  139620. get b(): NodeMaterialConnectionPoint;
  139621. /**
  139622. * Gets the a output component
  139623. */
  139624. get a(): NodeMaterialConnectionPoint;
  139625. autoConfigure(material: NodeMaterial): void;
  139626. protected _buildBlock(state: NodeMaterialBuildState): this;
  139627. }
  139628. }
  139629. declare module BABYLON {
  139630. /**
  139631. * Block used to add 2 vectors
  139632. */
  139633. export class AddBlock extends NodeMaterialBlock {
  139634. /**
  139635. * Creates a new AddBlock
  139636. * @param name defines the block name
  139637. */
  139638. constructor(name: string);
  139639. /**
  139640. * Gets the current class name
  139641. * @returns the class name
  139642. */
  139643. getClassName(): string;
  139644. /**
  139645. * Gets the left operand input component
  139646. */
  139647. get left(): NodeMaterialConnectionPoint;
  139648. /**
  139649. * Gets the right operand input component
  139650. */
  139651. get right(): NodeMaterialConnectionPoint;
  139652. /**
  139653. * Gets the output component
  139654. */
  139655. get output(): NodeMaterialConnectionPoint;
  139656. protected _buildBlock(state: NodeMaterialBuildState): this;
  139657. }
  139658. }
  139659. declare module BABYLON {
  139660. /**
  139661. * Block used to scale a vector by a float
  139662. */
  139663. export class ScaleBlock extends NodeMaterialBlock {
  139664. /**
  139665. * Creates a new ScaleBlock
  139666. * @param name defines the block name
  139667. */
  139668. constructor(name: string);
  139669. /**
  139670. * Gets the current class name
  139671. * @returns the class name
  139672. */
  139673. getClassName(): string;
  139674. /**
  139675. * Gets the input component
  139676. */
  139677. get input(): NodeMaterialConnectionPoint;
  139678. /**
  139679. * Gets the factor input component
  139680. */
  139681. get factor(): NodeMaterialConnectionPoint;
  139682. /**
  139683. * Gets the output component
  139684. */
  139685. get output(): NodeMaterialConnectionPoint;
  139686. protected _buildBlock(state: NodeMaterialBuildState): this;
  139687. }
  139688. }
  139689. declare module BABYLON {
  139690. /**
  139691. * Block used to clamp a float
  139692. */
  139693. export class ClampBlock extends NodeMaterialBlock {
  139694. /** Gets or sets the minimum range */
  139695. minimum: number;
  139696. /** Gets or sets the maximum range */
  139697. maximum: number;
  139698. /**
  139699. * Creates a new ClampBlock
  139700. * @param name defines the block name
  139701. */
  139702. constructor(name: string);
  139703. /**
  139704. * Gets the current class name
  139705. * @returns the class name
  139706. */
  139707. getClassName(): string;
  139708. /**
  139709. * Gets the value input component
  139710. */
  139711. get value(): NodeMaterialConnectionPoint;
  139712. /**
  139713. * Gets the output component
  139714. */
  139715. get output(): NodeMaterialConnectionPoint;
  139716. protected _buildBlock(state: NodeMaterialBuildState): this;
  139717. protected _dumpPropertiesCode(): string;
  139718. serialize(): any;
  139719. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  139720. }
  139721. }
  139722. declare module BABYLON {
  139723. /**
  139724. * Block used to apply a cross product between 2 vectors
  139725. */
  139726. export class CrossBlock extends NodeMaterialBlock {
  139727. /**
  139728. * Creates a new CrossBlock
  139729. * @param name defines the block name
  139730. */
  139731. constructor(name: string);
  139732. /**
  139733. * Gets the current class name
  139734. * @returns the class name
  139735. */
  139736. getClassName(): string;
  139737. /**
  139738. * Gets the left operand input component
  139739. */
  139740. get left(): NodeMaterialConnectionPoint;
  139741. /**
  139742. * Gets the right operand input component
  139743. */
  139744. get right(): NodeMaterialConnectionPoint;
  139745. /**
  139746. * Gets the output component
  139747. */
  139748. get output(): NodeMaterialConnectionPoint;
  139749. protected _buildBlock(state: NodeMaterialBuildState): this;
  139750. }
  139751. }
  139752. declare module BABYLON {
  139753. /**
  139754. * Block used to apply a dot product between 2 vectors
  139755. */
  139756. export class DotBlock extends NodeMaterialBlock {
  139757. /**
  139758. * Creates a new DotBlock
  139759. * @param name defines the block name
  139760. */
  139761. constructor(name: string);
  139762. /**
  139763. * Gets the current class name
  139764. * @returns the class name
  139765. */
  139766. getClassName(): string;
  139767. /**
  139768. * Gets the left operand input component
  139769. */
  139770. get left(): NodeMaterialConnectionPoint;
  139771. /**
  139772. * Gets the right operand input component
  139773. */
  139774. get right(): NodeMaterialConnectionPoint;
  139775. /**
  139776. * Gets the output component
  139777. */
  139778. get output(): NodeMaterialConnectionPoint;
  139779. protected _buildBlock(state: NodeMaterialBuildState): this;
  139780. }
  139781. }
  139782. declare module BABYLON {
  139783. /**
  139784. * Block used to normalize a vector
  139785. */
  139786. export class NormalizeBlock extends NodeMaterialBlock {
  139787. /**
  139788. * Creates a new NormalizeBlock
  139789. * @param name defines the block name
  139790. */
  139791. constructor(name: string);
  139792. /**
  139793. * Gets the current class name
  139794. * @returns the class name
  139795. */
  139796. getClassName(): string;
  139797. /**
  139798. * Gets the input component
  139799. */
  139800. get input(): NodeMaterialConnectionPoint;
  139801. /**
  139802. * Gets the output component
  139803. */
  139804. get output(): NodeMaterialConnectionPoint;
  139805. protected _buildBlock(state: NodeMaterialBuildState): this;
  139806. }
  139807. }
  139808. declare module BABYLON {
  139809. /**
  139810. * Operations supported by the Trigonometry block
  139811. */
  139812. export enum TrigonometryBlockOperations {
  139813. /** Cos */
  139814. Cos = 0,
  139815. /** Sin */
  139816. Sin = 1,
  139817. /** Abs */
  139818. Abs = 2,
  139819. /** Exp */
  139820. Exp = 3,
  139821. /** Exp2 */
  139822. Exp2 = 4,
  139823. /** Round */
  139824. Round = 5,
  139825. /** Floor */
  139826. Floor = 6,
  139827. /** Ceiling */
  139828. Ceiling = 7,
  139829. /** Square root */
  139830. Sqrt = 8,
  139831. /** Log */
  139832. Log = 9,
  139833. /** Tangent */
  139834. Tan = 10,
  139835. /** Arc tangent */
  139836. ArcTan = 11,
  139837. /** Arc cosinus */
  139838. ArcCos = 12,
  139839. /** Arc sinus */
  139840. ArcSin = 13,
  139841. /** Fraction */
  139842. Fract = 14,
  139843. /** Sign */
  139844. Sign = 15,
  139845. /** To radians (from degrees) */
  139846. Radians = 16,
  139847. /** To degrees (from radians) */
  139848. Degrees = 17
  139849. }
  139850. /**
  139851. * Block used to apply trigonometry operation to floats
  139852. */
  139853. export class TrigonometryBlock extends NodeMaterialBlock {
  139854. /**
  139855. * Gets or sets the operation applied by the block
  139856. */
  139857. operation: TrigonometryBlockOperations;
  139858. /**
  139859. * Creates a new TrigonometryBlock
  139860. * @param name defines the block name
  139861. */
  139862. constructor(name: string);
  139863. /**
  139864. * Gets the current class name
  139865. * @returns the class name
  139866. */
  139867. getClassName(): string;
  139868. /**
  139869. * Gets the input component
  139870. */
  139871. get input(): NodeMaterialConnectionPoint;
  139872. /**
  139873. * Gets the output component
  139874. */
  139875. get output(): NodeMaterialConnectionPoint;
  139876. protected _buildBlock(state: NodeMaterialBuildState): this;
  139877. serialize(): any;
  139878. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  139879. protected _dumpPropertiesCode(): string;
  139880. }
  139881. }
  139882. declare module BABYLON {
  139883. /**
  139884. * Block used to create a Color3/4 out of individual inputs (one for each component)
  139885. */
  139886. export class ColorMergerBlock extends NodeMaterialBlock {
  139887. /**
  139888. * Create a new ColorMergerBlock
  139889. * @param name defines the block name
  139890. */
  139891. constructor(name: string);
  139892. /**
  139893. * Gets the current class name
  139894. * @returns the class name
  139895. */
  139896. getClassName(): string;
  139897. /**
  139898. * Gets the rgb component (input)
  139899. */
  139900. get rgbIn(): NodeMaterialConnectionPoint;
  139901. /**
  139902. * Gets the r component (input)
  139903. */
  139904. get r(): NodeMaterialConnectionPoint;
  139905. /**
  139906. * Gets the g component (input)
  139907. */
  139908. get g(): NodeMaterialConnectionPoint;
  139909. /**
  139910. * Gets the b component (input)
  139911. */
  139912. get b(): NodeMaterialConnectionPoint;
  139913. /**
  139914. * Gets the a component (input)
  139915. */
  139916. get a(): NodeMaterialConnectionPoint;
  139917. /**
  139918. * Gets the rgba component (output)
  139919. */
  139920. get rgba(): NodeMaterialConnectionPoint;
  139921. /**
  139922. * Gets the rgb component (output)
  139923. */
  139924. get rgbOut(): NodeMaterialConnectionPoint;
  139925. /**
  139926. * Gets the rgb component (output)
  139927. * @deprecated Please use rgbOut instead.
  139928. */
  139929. get rgb(): NodeMaterialConnectionPoint;
  139930. protected _buildBlock(state: NodeMaterialBuildState): this;
  139931. }
  139932. }
  139933. declare module BABYLON {
  139934. /**
  139935. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  139936. */
  139937. export class VectorSplitterBlock extends NodeMaterialBlock {
  139938. /**
  139939. * Create a new VectorSplitterBlock
  139940. * @param name defines the block name
  139941. */
  139942. constructor(name: string);
  139943. /**
  139944. * Gets the current class name
  139945. * @returns the class name
  139946. */
  139947. getClassName(): string;
  139948. /**
  139949. * Gets the xyzw component (input)
  139950. */
  139951. get xyzw(): NodeMaterialConnectionPoint;
  139952. /**
  139953. * Gets the xyz component (input)
  139954. */
  139955. get xyzIn(): NodeMaterialConnectionPoint;
  139956. /**
  139957. * Gets the xy component (input)
  139958. */
  139959. get xyIn(): NodeMaterialConnectionPoint;
  139960. /**
  139961. * Gets the xyz component (output)
  139962. */
  139963. get xyzOut(): NodeMaterialConnectionPoint;
  139964. /**
  139965. * Gets the xy component (output)
  139966. */
  139967. get xyOut(): NodeMaterialConnectionPoint;
  139968. /**
  139969. * Gets the x component (output)
  139970. */
  139971. get x(): NodeMaterialConnectionPoint;
  139972. /**
  139973. * Gets the y component (output)
  139974. */
  139975. get y(): NodeMaterialConnectionPoint;
  139976. /**
  139977. * Gets the z component (output)
  139978. */
  139979. get z(): NodeMaterialConnectionPoint;
  139980. /**
  139981. * Gets the w component (output)
  139982. */
  139983. get w(): NodeMaterialConnectionPoint;
  139984. protected _inputRename(name: string): string;
  139985. protected _outputRename(name: string): string;
  139986. protected _buildBlock(state: NodeMaterialBuildState): this;
  139987. }
  139988. }
  139989. declare module BABYLON {
  139990. /**
  139991. * Block used to lerp between 2 values
  139992. */
  139993. export class LerpBlock extends NodeMaterialBlock {
  139994. /**
  139995. * Creates a new LerpBlock
  139996. * @param name defines the block name
  139997. */
  139998. constructor(name: string);
  139999. /**
  140000. * Gets the current class name
  140001. * @returns the class name
  140002. */
  140003. getClassName(): string;
  140004. /**
  140005. * Gets the left operand input component
  140006. */
  140007. get left(): NodeMaterialConnectionPoint;
  140008. /**
  140009. * Gets the right operand input component
  140010. */
  140011. get right(): NodeMaterialConnectionPoint;
  140012. /**
  140013. * Gets the gradient operand input component
  140014. */
  140015. get gradient(): NodeMaterialConnectionPoint;
  140016. /**
  140017. * Gets the output component
  140018. */
  140019. get output(): NodeMaterialConnectionPoint;
  140020. protected _buildBlock(state: NodeMaterialBuildState): this;
  140021. }
  140022. }
  140023. declare module BABYLON {
  140024. /**
  140025. * Block used to divide 2 vectors
  140026. */
  140027. export class DivideBlock extends NodeMaterialBlock {
  140028. /**
  140029. * Creates a new DivideBlock
  140030. * @param name defines the block name
  140031. */
  140032. constructor(name: string);
  140033. /**
  140034. * Gets the current class name
  140035. * @returns the class name
  140036. */
  140037. getClassName(): string;
  140038. /**
  140039. * Gets the left operand input component
  140040. */
  140041. get left(): NodeMaterialConnectionPoint;
  140042. /**
  140043. * Gets the right operand input component
  140044. */
  140045. get right(): NodeMaterialConnectionPoint;
  140046. /**
  140047. * Gets the output component
  140048. */
  140049. get output(): NodeMaterialConnectionPoint;
  140050. protected _buildBlock(state: NodeMaterialBuildState): this;
  140051. }
  140052. }
  140053. declare module BABYLON {
  140054. /**
  140055. * Block used to subtract 2 vectors
  140056. */
  140057. export class SubtractBlock extends NodeMaterialBlock {
  140058. /**
  140059. * Creates a new SubtractBlock
  140060. * @param name defines the block name
  140061. */
  140062. constructor(name: string);
  140063. /**
  140064. * Gets the current class name
  140065. * @returns the class name
  140066. */
  140067. getClassName(): string;
  140068. /**
  140069. * Gets the left operand input component
  140070. */
  140071. get left(): NodeMaterialConnectionPoint;
  140072. /**
  140073. * Gets the right operand input component
  140074. */
  140075. get right(): NodeMaterialConnectionPoint;
  140076. /**
  140077. * Gets the output component
  140078. */
  140079. get output(): NodeMaterialConnectionPoint;
  140080. protected _buildBlock(state: NodeMaterialBuildState): this;
  140081. }
  140082. }
  140083. declare module BABYLON {
  140084. /**
  140085. * Block used to step a value
  140086. */
  140087. export class StepBlock extends NodeMaterialBlock {
  140088. /**
  140089. * Creates a new StepBlock
  140090. * @param name defines the block name
  140091. */
  140092. constructor(name: string);
  140093. /**
  140094. * Gets the current class name
  140095. * @returns the class name
  140096. */
  140097. getClassName(): string;
  140098. /**
  140099. * Gets the value operand input component
  140100. */
  140101. get value(): NodeMaterialConnectionPoint;
  140102. /**
  140103. * Gets the edge operand input component
  140104. */
  140105. get edge(): NodeMaterialConnectionPoint;
  140106. /**
  140107. * Gets the output component
  140108. */
  140109. get output(): NodeMaterialConnectionPoint;
  140110. protected _buildBlock(state: NodeMaterialBuildState): this;
  140111. }
  140112. }
  140113. declare module BABYLON {
  140114. /**
  140115. * Block used to get the opposite (1 - x) of a value
  140116. */
  140117. export class OneMinusBlock extends NodeMaterialBlock {
  140118. /**
  140119. * Creates a new OneMinusBlock
  140120. * @param name defines the block name
  140121. */
  140122. constructor(name: string);
  140123. /**
  140124. * Gets the current class name
  140125. * @returns the class name
  140126. */
  140127. getClassName(): string;
  140128. /**
  140129. * Gets the input component
  140130. */
  140131. get input(): NodeMaterialConnectionPoint;
  140132. /**
  140133. * Gets the output component
  140134. */
  140135. get output(): NodeMaterialConnectionPoint;
  140136. protected _buildBlock(state: NodeMaterialBuildState): this;
  140137. }
  140138. }
  140139. declare module BABYLON {
  140140. /**
  140141. * Block used to get the view direction
  140142. */
  140143. export class ViewDirectionBlock extends NodeMaterialBlock {
  140144. /**
  140145. * Creates a new ViewDirectionBlock
  140146. * @param name defines the block name
  140147. */
  140148. constructor(name: string);
  140149. /**
  140150. * Gets the current class name
  140151. * @returns the class name
  140152. */
  140153. getClassName(): string;
  140154. /**
  140155. * Gets the world position component
  140156. */
  140157. get worldPosition(): NodeMaterialConnectionPoint;
  140158. /**
  140159. * Gets the camera position component
  140160. */
  140161. get cameraPosition(): NodeMaterialConnectionPoint;
  140162. /**
  140163. * Gets the output component
  140164. */
  140165. get output(): NodeMaterialConnectionPoint;
  140166. autoConfigure(material: NodeMaterial): void;
  140167. protected _buildBlock(state: NodeMaterialBuildState): this;
  140168. }
  140169. }
  140170. declare module BABYLON {
  140171. /**
  140172. * Block used to compute fresnel value
  140173. */
  140174. export class FresnelBlock extends NodeMaterialBlock {
  140175. /**
  140176. * Create a new FresnelBlock
  140177. * @param name defines the block name
  140178. */
  140179. constructor(name: string);
  140180. /**
  140181. * Gets the current class name
  140182. * @returns the class name
  140183. */
  140184. getClassName(): string;
  140185. /**
  140186. * Gets the world normal input component
  140187. */
  140188. get worldNormal(): NodeMaterialConnectionPoint;
  140189. /**
  140190. * Gets the view direction input component
  140191. */
  140192. get viewDirection(): NodeMaterialConnectionPoint;
  140193. /**
  140194. * Gets the bias input component
  140195. */
  140196. get bias(): NodeMaterialConnectionPoint;
  140197. /**
  140198. * Gets the camera (or eye) position component
  140199. */
  140200. get power(): NodeMaterialConnectionPoint;
  140201. /**
  140202. * Gets the fresnel output component
  140203. */
  140204. get fresnel(): NodeMaterialConnectionPoint;
  140205. autoConfigure(material: NodeMaterial): void;
  140206. protected _buildBlock(state: NodeMaterialBuildState): this;
  140207. }
  140208. }
  140209. declare module BABYLON {
  140210. /**
  140211. * Block used to get the max of 2 values
  140212. */
  140213. export class MaxBlock extends NodeMaterialBlock {
  140214. /**
  140215. * Creates a new MaxBlock
  140216. * @param name defines the block name
  140217. */
  140218. constructor(name: string);
  140219. /**
  140220. * Gets the current class name
  140221. * @returns the class name
  140222. */
  140223. getClassName(): string;
  140224. /**
  140225. * Gets the left operand input component
  140226. */
  140227. get left(): NodeMaterialConnectionPoint;
  140228. /**
  140229. * Gets the right operand input component
  140230. */
  140231. get right(): NodeMaterialConnectionPoint;
  140232. /**
  140233. * Gets the output component
  140234. */
  140235. get output(): NodeMaterialConnectionPoint;
  140236. protected _buildBlock(state: NodeMaterialBuildState): this;
  140237. }
  140238. }
  140239. declare module BABYLON {
  140240. /**
  140241. * Block used to get the min of 2 values
  140242. */
  140243. export class MinBlock extends NodeMaterialBlock {
  140244. /**
  140245. * Creates a new MinBlock
  140246. * @param name defines the block name
  140247. */
  140248. constructor(name: string);
  140249. /**
  140250. * Gets the current class name
  140251. * @returns the class name
  140252. */
  140253. getClassName(): string;
  140254. /**
  140255. * Gets the left operand input component
  140256. */
  140257. get left(): NodeMaterialConnectionPoint;
  140258. /**
  140259. * Gets the right operand input component
  140260. */
  140261. get right(): NodeMaterialConnectionPoint;
  140262. /**
  140263. * Gets the output component
  140264. */
  140265. get output(): NodeMaterialConnectionPoint;
  140266. protected _buildBlock(state: NodeMaterialBuildState): this;
  140267. }
  140268. }
  140269. declare module BABYLON {
  140270. /**
  140271. * Block used to get the distance between 2 values
  140272. */
  140273. export class DistanceBlock extends NodeMaterialBlock {
  140274. /**
  140275. * Creates a new DistanceBlock
  140276. * @param name defines the block name
  140277. */
  140278. constructor(name: string);
  140279. /**
  140280. * Gets the current class name
  140281. * @returns the class name
  140282. */
  140283. getClassName(): string;
  140284. /**
  140285. * Gets the left operand input component
  140286. */
  140287. get left(): NodeMaterialConnectionPoint;
  140288. /**
  140289. * Gets the right operand input component
  140290. */
  140291. get right(): NodeMaterialConnectionPoint;
  140292. /**
  140293. * Gets the output component
  140294. */
  140295. get output(): NodeMaterialConnectionPoint;
  140296. protected _buildBlock(state: NodeMaterialBuildState): this;
  140297. }
  140298. }
  140299. declare module BABYLON {
  140300. /**
  140301. * Block used to get the length of a vector
  140302. */
  140303. export class LengthBlock extends NodeMaterialBlock {
  140304. /**
  140305. * Creates a new LengthBlock
  140306. * @param name defines the block name
  140307. */
  140308. constructor(name: string);
  140309. /**
  140310. * Gets the current class name
  140311. * @returns the class name
  140312. */
  140313. getClassName(): string;
  140314. /**
  140315. * Gets the value input component
  140316. */
  140317. get value(): NodeMaterialConnectionPoint;
  140318. /**
  140319. * Gets the output component
  140320. */
  140321. get output(): NodeMaterialConnectionPoint;
  140322. protected _buildBlock(state: NodeMaterialBuildState): this;
  140323. }
  140324. }
  140325. declare module BABYLON {
  140326. /**
  140327. * Block used to get negative version of a value (i.e. x * -1)
  140328. */
  140329. export class NegateBlock extends NodeMaterialBlock {
  140330. /**
  140331. * Creates a new NegateBlock
  140332. * @param name defines the block name
  140333. */
  140334. constructor(name: string);
  140335. /**
  140336. * Gets the current class name
  140337. * @returns the class name
  140338. */
  140339. getClassName(): string;
  140340. /**
  140341. * Gets the value input component
  140342. */
  140343. get value(): NodeMaterialConnectionPoint;
  140344. /**
  140345. * Gets the output component
  140346. */
  140347. get output(): NodeMaterialConnectionPoint;
  140348. protected _buildBlock(state: NodeMaterialBuildState): this;
  140349. }
  140350. }
  140351. declare module BABYLON {
  140352. /**
  140353. * Block used to get the value of the first parameter raised to the power of the second
  140354. */
  140355. export class PowBlock extends NodeMaterialBlock {
  140356. /**
  140357. * Creates a new PowBlock
  140358. * @param name defines the block name
  140359. */
  140360. constructor(name: string);
  140361. /**
  140362. * Gets the current class name
  140363. * @returns the class name
  140364. */
  140365. getClassName(): string;
  140366. /**
  140367. * Gets the value operand input component
  140368. */
  140369. get value(): NodeMaterialConnectionPoint;
  140370. /**
  140371. * Gets the power operand input component
  140372. */
  140373. get power(): NodeMaterialConnectionPoint;
  140374. /**
  140375. * Gets the output component
  140376. */
  140377. get output(): NodeMaterialConnectionPoint;
  140378. protected _buildBlock(state: NodeMaterialBuildState): this;
  140379. }
  140380. }
  140381. declare module BABYLON {
  140382. /**
  140383. * Block used to get a random number
  140384. */
  140385. export class RandomNumberBlock extends NodeMaterialBlock {
  140386. /**
  140387. * Creates a new RandomNumberBlock
  140388. * @param name defines the block name
  140389. */
  140390. constructor(name: string);
  140391. /**
  140392. * Gets the current class name
  140393. * @returns the class name
  140394. */
  140395. getClassName(): string;
  140396. /**
  140397. * Gets the seed input component
  140398. */
  140399. get seed(): NodeMaterialConnectionPoint;
  140400. /**
  140401. * Gets the output component
  140402. */
  140403. get output(): NodeMaterialConnectionPoint;
  140404. protected _buildBlock(state: NodeMaterialBuildState): this;
  140405. }
  140406. }
  140407. declare module BABYLON {
  140408. /**
  140409. * Block used to compute arc tangent of 2 values
  140410. */
  140411. export class ArcTan2Block extends NodeMaterialBlock {
  140412. /**
  140413. * Creates a new ArcTan2Block
  140414. * @param name defines the block name
  140415. */
  140416. constructor(name: string);
  140417. /**
  140418. * Gets the current class name
  140419. * @returns the class name
  140420. */
  140421. getClassName(): string;
  140422. /**
  140423. * Gets the x operand input component
  140424. */
  140425. get x(): NodeMaterialConnectionPoint;
  140426. /**
  140427. * Gets the y operand input component
  140428. */
  140429. get y(): NodeMaterialConnectionPoint;
  140430. /**
  140431. * Gets the output component
  140432. */
  140433. get output(): NodeMaterialConnectionPoint;
  140434. protected _buildBlock(state: NodeMaterialBuildState): this;
  140435. }
  140436. }
  140437. declare module BABYLON {
  140438. /**
  140439. * Block used to smooth step a value
  140440. */
  140441. export class SmoothStepBlock extends NodeMaterialBlock {
  140442. /**
  140443. * Creates a new SmoothStepBlock
  140444. * @param name defines the block name
  140445. */
  140446. constructor(name: string);
  140447. /**
  140448. * Gets the current class name
  140449. * @returns the class name
  140450. */
  140451. getClassName(): string;
  140452. /**
  140453. * Gets the value operand input component
  140454. */
  140455. get value(): NodeMaterialConnectionPoint;
  140456. /**
  140457. * Gets the first edge operand input component
  140458. */
  140459. get edge0(): NodeMaterialConnectionPoint;
  140460. /**
  140461. * Gets the second edge operand input component
  140462. */
  140463. get edge1(): NodeMaterialConnectionPoint;
  140464. /**
  140465. * Gets the output component
  140466. */
  140467. get output(): NodeMaterialConnectionPoint;
  140468. protected _buildBlock(state: NodeMaterialBuildState): this;
  140469. }
  140470. }
  140471. declare module BABYLON {
  140472. /**
  140473. * Block used to get the reciprocal (1 / x) of a value
  140474. */
  140475. export class ReciprocalBlock extends NodeMaterialBlock {
  140476. /**
  140477. * Creates a new ReciprocalBlock
  140478. * @param name defines the block name
  140479. */
  140480. constructor(name: string);
  140481. /**
  140482. * Gets the current class name
  140483. * @returns the class name
  140484. */
  140485. getClassName(): string;
  140486. /**
  140487. * Gets the input component
  140488. */
  140489. get input(): NodeMaterialConnectionPoint;
  140490. /**
  140491. * Gets the output component
  140492. */
  140493. get output(): NodeMaterialConnectionPoint;
  140494. protected _buildBlock(state: NodeMaterialBuildState): this;
  140495. }
  140496. }
  140497. declare module BABYLON {
  140498. /**
  140499. * Block used to replace a color by another one
  140500. */
  140501. export class ReplaceColorBlock extends NodeMaterialBlock {
  140502. /**
  140503. * Creates a new ReplaceColorBlock
  140504. * @param name defines the block name
  140505. */
  140506. constructor(name: string);
  140507. /**
  140508. * Gets the current class name
  140509. * @returns the class name
  140510. */
  140511. getClassName(): string;
  140512. /**
  140513. * Gets the value input component
  140514. */
  140515. get value(): NodeMaterialConnectionPoint;
  140516. /**
  140517. * Gets the reference input component
  140518. */
  140519. get reference(): NodeMaterialConnectionPoint;
  140520. /**
  140521. * Gets the distance input component
  140522. */
  140523. get distance(): NodeMaterialConnectionPoint;
  140524. /**
  140525. * Gets the replacement input component
  140526. */
  140527. get replacement(): NodeMaterialConnectionPoint;
  140528. /**
  140529. * Gets the output component
  140530. */
  140531. get output(): NodeMaterialConnectionPoint;
  140532. protected _buildBlock(state: NodeMaterialBuildState): this;
  140533. }
  140534. }
  140535. declare module BABYLON {
  140536. /**
  140537. * Block used to posterize a value
  140538. * @see https://en.wikipedia.org/wiki/Posterization
  140539. */
  140540. export class PosterizeBlock extends NodeMaterialBlock {
  140541. /**
  140542. * Creates a new PosterizeBlock
  140543. * @param name defines the block name
  140544. */
  140545. constructor(name: string);
  140546. /**
  140547. * Gets the current class name
  140548. * @returns the class name
  140549. */
  140550. getClassName(): string;
  140551. /**
  140552. * Gets the value input component
  140553. */
  140554. get value(): NodeMaterialConnectionPoint;
  140555. /**
  140556. * Gets the steps input component
  140557. */
  140558. get steps(): NodeMaterialConnectionPoint;
  140559. /**
  140560. * Gets the output component
  140561. */
  140562. get output(): NodeMaterialConnectionPoint;
  140563. protected _buildBlock(state: NodeMaterialBuildState): this;
  140564. }
  140565. }
  140566. declare module BABYLON {
  140567. /**
  140568. * Operations supported by the Wave block
  140569. */
  140570. export enum WaveBlockKind {
  140571. /** SawTooth */
  140572. SawTooth = 0,
  140573. /** Square */
  140574. Square = 1,
  140575. /** Triangle */
  140576. Triangle = 2
  140577. }
  140578. /**
  140579. * Block used to apply wave operation to floats
  140580. */
  140581. export class WaveBlock extends NodeMaterialBlock {
  140582. /**
  140583. * Gets or sets the kibnd of wave to be applied by the block
  140584. */
  140585. kind: WaveBlockKind;
  140586. /**
  140587. * Creates a new WaveBlock
  140588. * @param name defines the block name
  140589. */
  140590. constructor(name: string);
  140591. /**
  140592. * Gets the current class name
  140593. * @returns the class name
  140594. */
  140595. getClassName(): string;
  140596. /**
  140597. * Gets the input component
  140598. */
  140599. get input(): NodeMaterialConnectionPoint;
  140600. /**
  140601. * Gets the output component
  140602. */
  140603. get output(): NodeMaterialConnectionPoint;
  140604. protected _buildBlock(state: NodeMaterialBuildState): this;
  140605. serialize(): any;
  140606. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  140607. }
  140608. }
  140609. declare module BABYLON {
  140610. /**
  140611. * Class used to store a color step for the GradientBlock
  140612. */
  140613. export class GradientBlockColorStep {
  140614. /**
  140615. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  140616. */
  140617. step: number;
  140618. /**
  140619. * Gets or sets the color associated with this step
  140620. */
  140621. color: Color3;
  140622. /**
  140623. * Creates a new GradientBlockColorStep
  140624. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  140625. * @param color defines the color associated with this step
  140626. */
  140627. constructor(
  140628. /**
  140629. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  140630. */
  140631. step: number,
  140632. /**
  140633. * Gets or sets the color associated with this step
  140634. */
  140635. color: Color3);
  140636. }
  140637. /**
  140638. * Block used to return a color from a gradient based on an input value between 0 and 1
  140639. */
  140640. export class GradientBlock extends NodeMaterialBlock {
  140641. /**
  140642. * Gets or sets the list of color steps
  140643. */
  140644. colorSteps: GradientBlockColorStep[];
  140645. /**
  140646. * Creates a new GradientBlock
  140647. * @param name defines the block name
  140648. */
  140649. constructor(name: string);
  140650. /**
  140651. * Gets the current class name
  140652. * @returns the class name
  140653. */
  140654. getClassName(): string;
  140655. /**
  140656. * Gets the gradient input component
  140657. */
  140658. get gradient(): NodeMaterialConnectionPoint;
  140659. /**
  140660. * Gets the output component
  140661. */
  140662. get output(): NodeMaterialConnectionPoint;
  140663. private _writeColorConstant;
  140664. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  140665. serialize(): any;
  140666. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  140667. protected _dumpPropertiesCode(): string;
  140668. }
  140669. }
  140670. declare module BABYLON {
  140671. /**
  140672. * Block used to normalize lerp between 2 values
  140673. */
  140674. export class NLerpBlock extends NodeMaterialBlock {
  140675. /**
  140676. * Creates a new NLerpBlock
  140677. * @param name defines the block name
  140678. */
  140679. constructor(name: string);
  140680. /**
  140681. * Gets the current class name
  140682. * @returns the class name
  140683. */
  140684. getClassName(): string;
  140685. /**
  140686. * Gets the left operand input component
  140687. */
  140688. get left(): NodeMaterialConnectionPoint;
  140689. /**
  140690. * Gets the right operand input component
  140691. */
  140692. get right(): NodeMaterialConnectionPoint;
  140693. /**
  140694. * Gets the gradient operand input component
  140695. */
  140696. get gradient(): NodeMaterialConnectionPoint;
  140697. /**
  140698. * Gets the output component
  140699. */
  140700. get output(): NodeMaterialConnectionPoint;
  140701. protected _buildBlock(state: NodeMaterialBuildState): this;
  140702. }
  140703. }
  140704. declare module BABYLON {
  140705. /**
  140706. * block used to Generate a Worley Noise 3D Noise Pattern
  140707. */
  140708. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  140709. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  140710. manhattanDistance: boolean;
  140711. /**
  140712. * Creates a new WorleyNoise3DBlock
  140713. * @param name defines the block name
  140714. */
  140715. constructor(name: string);
  140716. /**
  140717. * Gets the current class name
  140718. * @returns the class name
  140719. */
  140720. getClassName(): string;
  140721. /**
  140722. * Gets the seed input component
  140723. */
  140724. get seed(): NodeMaterialConnectionPoint;
  140725. /**
  140726. * Gets the jitter input component
  140727. */
  140728. get jitter(): NodeMaterialConnectionPoint;
  140729. /**
  140730. * Gets the output component
  140731. */
  140732. get output(): NodeMaterialConnectionPoint;
  140733. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  140734. /**
  140735. * Exposes the properties to the UI?
  140736. */
  140737. protected _dumpPropertiesCode(): string;
  140738. /**
  140739. * Exposes the properties to the Seralize?
  140740. */
  140741. serialize(): any;
  140742. /**
  140743. * Exposes the properties to the deseralize?
  140744. */
  140745. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  140746. }
  140747. }
  140748. declare module BABYLON {
  140749. /**
  140750. * block used to Generate a Simplex Perlin 3d Noise Pattern
  140751. */
  140752. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  140753. /**
  140754. * Creates a new SimplexPerlin3DBlock
  140755. * @param name defines the block name
  140756. */
  140757. constructor(name: string);
  140758. /**
  140759. * Gets the current class name
  140760. * @returns the class name
  140761. */
  140762. getClassName(): string;
  140763. /**
  140764. * Gets the seed operand input component
  140765. */
  140766. get seed(): NodeMaterialConnectionPoint;
  140767. /**
  140768. * Gets the output component
  140769. */
  140770. get output(): NodeMaterialConnectionPoint;
  140771. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  140772. }
  140773. }
  140774. declare module BABYLON {
  140775. /**
  140776. * Block used to blend normals
  140777. */
  140778. export class NormalBlendBlock extends NodeMaterialBlock {
  140779. /**
  140780. * Creates a new NormalBlendBlock
  140781. * @param name defines the block name
  140782. */
  140783. constructor(name: string);
  140784. /**
  140785. * Gets the current class name
  140786. * @returns the class name
  140787. */
  140788. getClassName(): string;
  140789. /**
  140790. * Gets the first input component
  140791. */
  140792. get normalMap0(): NodeMaterialConnectionPoint;
  140793. /**
  140794. * Gets the second input component
  140795. */
  140796. get normalMap1(): NodeMaterialConnectionPoint;
  140797. /**
  140798. * Gets the output component
  140799. */
  140800. get output(): NodeMaterialConnectionPoint;
  140801. protected _buildBlock(state: NodeMaterialBuildState): this;
  140802. }
  140803. }
  140804. declare module BABYLON {
  140805. /**
  140806. * Block used to rotate a 2d vector by a given angle
  140807. */
  140808. export class Rotate2dBlock extends NodeMaterialBlock {
  140809. /**
  140810. * Creates a new Rotate2dBlock
  140811. * @param name defines the block name
  140812. */
  140813. constructor(name: string);
  140814. /**
  140815. * Gets the current class name
  140816. * @returns the class name
  140817. */
  140818. getClassName(): string;
  140819. /**
  140820. * Gets the input vector
  140821. */
  140822. get input(): NodeMaterialConnectionPoint;
  140823. /**
  140824. * Gets the input angle
  140825. */
  140826. get angle(): NodeMaterialConnectionPoint;
  140827. /**
  140828. * Gets the output component
  140829. */
  140830. get output(): NodeMaterialConnectionPoint;
  140831. autoConfigure(material: NodeMaterial): void;
  140832. protected _buildBlock(state: NodeMaterialBuildState): this;
  140833. }
  140834. }
  140835. declare module BABYLON {
  140836. /**
  140837. * Block used to get the reflected vector from a direction and a normal
  140838. */
  140839. export class ReflectBlock extends NodeMaterialBlock {
  140840. /**
  140841. * Creates a new ReflectBlock
  140842. * @param name defines the block name
  140843. */
  140844. constructor(name: string);
  140845. /**
  140846. * Gets the current class name
  140847. * @returns the class name
  140848. */
  140849. getClassName(): string;
  140850. /**
  140851. * Gets the incident component
  140852. */
  140853. get incident(): NodeMaterialConnectionPoint;
  140854. /**
  140855. * Gets the normal component
  140856. */
  140857. get normal(): NodeMaterialConnectionPoint;
  140858. /**
  140859. * Gets the output component
  140860. */
  140861. get output(): NodeMaterialConnectionPoint;
  140862. protected _buildBlock(state: NodeMaterialBuildState): this;
  140863. }
  140864. }
  140865. declare module BABYLON {
  140866. /**
  140867. * Block used to get the refracted vector from a direction and a normal
  140868. */
  140869. export class RefractBlock extends NodeMaterialBlock {
  140870. /**
  140871. * Creates a new RefractBlock
  140872. * @param name defines the block name
  140873. */
  140874. constructor(name: string);
  140875. /**
  140876. * Gets the current class name
  140877. * @returns the class name
  140878. */
  140879. getClassName(): string;
  140880. /**
  140881. * Gets the incident component
  140882. */
  140883. get incident(): NodeMaterialConnectionPoint;
  140884. /**
  140885. * Gets the normal component
  140886. */
  140887. get normal(): NodeMaterialConnectionPoint;
  140888. /**
  140889. * Gets the index of refraction component
  140890. */
  140891. get ior(): NodeMaterialConnectionPoint;
  140892. /**
  140893. * Gets the output component
  140894. */
  140895. get output(): NodeMaterialConnectionPoint;
  140896. protected _buildBlock(state: NodeMaterialBuildState): this;
  140897. }
  140898. }
  140899. declare module BABYLON {
  140900. /**
  140901. * Block used to desaturate a color
  140902. */
  140903. export class DesaturateBlock extends NodeMaterialBlock {
  140904. /**
  140905. * Creates a new DesaturateBlock
  140906. * @param name defines the block name
  140907. */
  140908. constructor(name: string);
  140909. /**
  140910. * Gets the current class name
  140911. * @returns the class name
  140912. */
  140913. getClassName(): string;
  140914. /**
  140915. * Gets the color operand input component
  140916. */
  140917. get color(): NodeMaterialConnectionPoint;
  140918. /**
  140919. * Gets the level operand input component
  140920. */
  140921. get level(): NodeMaterialConnectionPoint;
  140922. /**
  140923. * Gets the output component
  140924. */
  140925. get output(): NodeMaterialConnectionPoint;
  140926. protected _buildBlock(state: NodeMaterialBuildState): this;
  140927. }
  140928. }
  140929. declare module BABYLON {
  140930. /**
  140931. * Block used to implement the ambient occlusion module of the PBR material
  140932. */
  140933. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  140934. /**
  140935. * Create a new AmbientOcclusionBlock
  140936. * @param name defines the block name
  140937. */
  140938. constructor(name: string);
  140939. /**
  140940. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  140941. */
  140942. useAmbientInGrayScale: boolean;
  140943. /**
  140944. * Initialize the block and prepare the context for build
  140945. * @param state defines the state that will be used for the build
  140946. */
  140947. initialize(state: NodeMaterialBuildState): void;
  140948. /**
  140949. * Gets the current class name
  140950. * @returns the class name
  140951. */
  140952. getClassName(): string;
  140953. /**
  140954. * Gets the texture input component
  140955. */
  140956. get texture(): NodeMaterialConnectionPoint;
  140957. /**
  140958. * Gets the texture intensity component
  140959. */
  140960. get intensity(): NodeMaterialConnectionPoint;
  140961. /**
  140962. * Gets the direct light intensity input component
  140963. */
  140964. get directLightIntensity(): NodeMaterialConnectionPoint;
  140965. /**
  140966. * Gets the ambient occlusion object output component
  140967. */
  140968. get ambientOcclusion(): NodeMaterialConnectionPoint;
  140969. /**
  140970. * Gets the main code of the block (fragment side)
  140971. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  140972. * @returns the shader code
  140973. */
  140974. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  140975. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140976. protected _buildBlock(state: NodeMaterialBuildState): this;
  140977. protected _dumpPropertiesCode(): string;
  140978. serialize(): any;
  140979. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  140980. }
  140981. }
  140982. declare module BABYLON {
  140983. /**
  140984. * Block used to implement the reflection module of the PBR material
  140985. */
  140986. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  140987. /** @hidden */
  140988. _defineLODReflectionAlpha: string;
  140989. /** @hidden */
  140990. _defineLinearSpecularReflection: string;
  140991. private _vEnvironmentIrradianceName;
  140992. /** @hidden */
  140993. _vReflectionMicrosurfaceInfosName: string;
  140994. /** @hidden */
  140995. _vReflectionInfosName: string;
  140996. /** @hidden */
  140997. _vReflectionFilteringInfoName: string;
  140998. private _scene;
  140999. /**
  141000. * The three properties below are set by the main PBR block prior to calling methods of this class.
  141001. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  141002. * It's less burden on the user side in the editor part.
  141003. */
  141004. /** @hidden */
  141005. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  141006. /** @hidden */
  141007. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  141008. /** @hidden */
  141009. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  141010. /**
  141011. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  141012. * diffuse part of the IBL.
  141013. */
  141014. useSphericalHarmonics: boolean;
  141015. /**
  141016. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  141017. */
  141018. forceIrradianceInFragment: boolean;
  141019. /**
  141020. * Create a new ReflectionBlock
  141021. * @param name defines the block name
  141022. */
  141023. constructor(name: string);
  141024. /**
  141025. * Gets the current class name
  141026. * @returns the class name
  141027. */
  141028. getClassName(): string;
  141029. /**
  141030. * Gets the position input component
  141031. */
  141032. get position(): NodeMaterialConnectionPoint;
  141033. /**
  141034. * Gets the world position input component
  141035. */
  141036. get worldPosition(): NodeMaterialConnectionPoint;
  141037. /**
  141038. * Gets the world normal input component
  141039. */
  141040. get worldNormal(): NodeMaterialConnectionPoint;
  141041. /**
  141042. * Gets the world input component
  141043. */
  141044. get world(): NodeMaterialConnectionPoint;
  141045. /**
  141046. * Gets the camera (or eye) position component
  141047. */
  141048. get cameraPosition(): NodeMaterialConnectionPoint;
  141049. /**
  141050. * Gets the view input component
  141051. */
  141052. get view(): NodeMaterialConnectionPoint;
  141053. /**
  141054. * Gets the color input component
  141055. */
  141056. get color(): NodeMaterialConnectionPoint;
  141057. /**
  141058. * Gets the reflection object output component
  141059. */
  141060. get reflection(): NodeMaterialConnectionPoint;
  141061. /**
  141062. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  141063. */
  141064. get hasTexture(): boolean;
  141065. /**
  141066. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  141067. */
  141068. get reflectionColor(): string;
  141069. protected _getTexture(): Nullable<BaseTexture>;
  141070. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141071. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  141072. /**
  141073. * Gets the code to inject in the vertex shader
  141074. * @param state current state of the node material building
  141075. * @returns the shader code
  141076. */
  141077. handleVertexSide(state: NodeMaterialBuildState): string;
  141078. /**
  141079. * Gets the main code of the block (fragment side)
  141080. * @param state current state of the node material building
  141081. * @param normalVarName name of the existing variable corresponding to the normal
  141082. * @returns the shader code
  141083. */
  141084. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  141085. protected _buildBlock(state: NodeMaterialBuildState): this;
  141086. protected _dumpPropertiesCode(): string;
  141087. serialize(): any;
  141088. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141089. }
  141090. }
  141091. declare module BABYLON {
  141092. /**
  141093. * Block used to implement the sheen module of the PBR material
  141094. */
  141095. export class SheenBlock extends NodeMaterialBlock {
  141096. /**
  141097. * Create a new SheenBlock
  141098. * @param name defines the block name
  141099. */
  141100. constructor(name: string);
  141101. /**
  141102. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  141103. * It allows the strength of the sheen effect to not depend on the base color of the material,
  141104. * making it easier to setup and tweak the effect
  141105. */
  141106. albedoScaling: boolean;
  141107. /**
  141108. * Defines if the sheen is linked to the sheen color.
  141109. */
  141110. linkSheenWithAlbedo: boolean;
  141111. /**
  141112. * Initialize the block and prepare the context for build
  141113. * @param state defines the state that will be used for the build
  141114. */
  141115. initialize(state: NodeMaterialBuildState): void;
  141116. /**
  141117. * Gets the current class name
  141118. * @returns the class name
  141119. */
  141120. getClassName(): string;
  141121. /**
  141122. * Gets the intensity input component
  141123. */
  141124. get intensity(): NodeMaterialConnectionPoint;
  141125. /**
  141126. * Gets the color input component
  141127. */
  141128. get color(): NodeMaterialConnectionPoint;
  141129. /**
  141130. * Gets the roughness input component
  141131. */
  141132. get roughness(): NodeMaterialConnectionPoint;
  141133. /**
  141134. * Gets the sheen object output component
  141135. */
  141136. get sheen(): NodeMaterialConnectionPoint;
  141137. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141138. /**
  141139. * Gets the main code of the block (fragment side)
  141140. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  141141. * @returns the shader code
  141142. */
  141143. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  141144. protected _buildBlock(state: NodeMaterialBuildState): this;
  141145. protected _dumpPropertiesCode(): string;
  141146. serialize(): any;
  141147. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141148. }
  141149. }
  141150. declare module BABYLON {
  141151. /**
  141152. * Block used to implement the reflectivity module of the PBR material
  141153. */
  141154. export class ReflectivityBlock extends NodeMaterialBlock {
  141155. private _metallicReflectanceColor;
  141156. private _metallicF0Factor;
  141157. /** @hidden */
  141158. _vMetallicReflectanceFactorsName: string;
  141159. /**
  141160. * The property below is set by the main PBR block prior to calling methods of this class.
  141161. */
  141162. /** @hidden */
  141163. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  141164. /**
  141165. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  141166. */
  141167. useAmbientOcclusionFromMetallicTextureRed: boolean;
  141168. /**
  141169. * Specifies if the metallic texture contains the metallness information in its blue channel.
  141170. */
  141171. useMetallnessFromMetallicTextureBlue: boolean;
  141172. /**
  141173. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  141174. */
  141175. useRoughnessFromMetallicTextureAlpha: boolean;
  141176. /**
  141177. * Specifies if the metallic texture contains the roughness information in its green channel.
  141178. */
  141179. useRoughnessFromMetallicTextureGreen: boolean;
  141180. /**
  141181. * Create a new ReflectivityBlock
  141182. * @param name defines the block name
  141183. */
  141184. constructor(name: string);
  141185. /**
  141186. * Initialize the block and prepare the context for build
  141187. * @param state defines the state that will be used for the build
  141188. */
  141189. initialize(state: NodeMaterialBuildState): void;
  141190. /**
  141191. * Gets the current class name
  141192. * @returns the class name
  141193. */
  141194. getClassName(): string;
  141195. /**
  141196. * Gets the metallic input component
  141197. */
  141198. get metallic(): NodeMaterialConnectionPoint;
  141199. /**
  141200. * Gets the roughness input component
  141201. */
  141202. get roughness(): NodeMaterialConnectionPoint;
  141203. /**
  141204. * Gets the texture input component
  141205. */
  141206. get texture(): NodeMaterialConnectionPoint;
  141207. /**
  141208. * Gets the reflectivity object output component
  141209. */
  141210. get reflectivity(): NodeMaterialConnectionPoint;
  141211. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  141212. /**
  141213. * Gets the main code of the block (fragment side)
  141214. * @param state current state of the node material building
  141215. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  141216. * @returns the shader code
  141217. */
  141218. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  141219. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141220. protected _buildBlock(state: NodeMaterialBuildState): this;
  141221. protected _dumpPropertiesCode(): string;
  141222. serialize(): any;
  141223. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141224. }
  141225. }
  141226. declare module BABYLON {
  141227. /**
  141228. * Block used to implement the anisotropy module of the PBR material
  141229. */
  141230. export class AnisotropyBlock extends NodeMaterialBlock {
  141231. /**
  141232. * The two properties below are set by the main PBR block prior to calling methods of this class.
  141233. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  141234. * It's less burden on the user side in the editor part.
  141235. */
  141236. /** @hidden */
  141237. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  141238. /** @hidden */
  141239. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  141240. /**
  141241. * Create a new AnisotropyBlock
  141242. * @param name defines the block name
  141243. */
  141244. constructor(name: string);
  141245. /**
  141246. * Initialize the block and prepare the context for build
  141247. * @param state defines the state that will be used for the build
  141248. */
  141249. initialize(state: NodeMaterialBuildState): void;
  141250. /**
  141251. * Gets the current class name
  141252. * @returns the class name
  141253. */
  141254. getClassName(): string;
  141255. /**
  141256. * Gets the intensity input component
  141257. */
  141258. get intensity(): NodeMaterialConnectionPoint;
  141259. /**
  141260. * Gets the direction input component
  141261. */
  141262. get direction(): NodeMaterialConnectionPoint;
  141263. /**
  141264. * Gets the texture input component
  141265. */
  141266. get texture(): NodeMaterialConnectionPoint;
  141267. /**
  141268. * Gets the uv input component
  141269. */
  141270. get uv(): NodeMaterialConnectionPoint;
  141271. /**
  141272. * Gets the worldTangent input component
  141273. */
  141274. get worldTangent(): NodeMaterialConnectionPoint;
  141275. /**
  141276. * Gets the anisotropy object output component
  141277. */
  141278. get anisotropy(): NodeMaterialConnectionPoint;
  141279. private _generateTBNSpace;
  141280. /**
  141281. * Gets the main code of the block (fragment side)
  141282. * @param state current state of the node material building
  141283. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  141284. * @returns the shader code
  141285. */
  141286. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  141287. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141288. protected _buildBlock(state: NodeMaterialBuildState): this;
  141289. }
  141290. }
  141291. declare module BABYLON {
  141292. /**
  141293. * Block used to implement the clear coat module of the PBR material
  141294. */
  141295. export class ClearCoatBlock extends NodeMaterialBlock {
  141296. private _scene;
  141297. /**
  141298. * Create a new ClearCoatBlock
  141299. * @param name defines the block name
  141300. */
  141301. constructor(name: string);
  141302. /**
  141303. * Initialize the block and prepare the context for build
  141304. * @param state defines the state that will be used for the build
  141305. */
  141306. initialize(state: NodeMaterialBuildState): void;
  141307. /**
  141308. * Gets the current class name
  141309. * @returns the class name
  141310. */
  141311. getClassName(): string;
  141312. /**
  141313. * Gets the intensity input component
  141314. */
  141315. get intensity(): NodeMaterialConnectionPoint;
  141316. /**
  141317. * Gets the roughness input component
  141318. */
  141319. get roughness(): NodeMaterialConnectionPoint;
  141320. /**
  141321. * Gets the ior input component
  141322. */
  141323. get ior(): NodeMaterialConnectionPoint;
  141324. /**
  141325. * Gets the texture input component
  141326. */
  141327. get texture(): NodeMaterialConnectionPoint;
  141328. /**
  141329. * Gets the bump texture input component
  141330. */
  141331. get bumpTexture(): NodeMaterialConnectionPoint;
  141332. /**
  141333. * Gets the uv input component
  141334. */
  141335. get uv(): NodeMaterialConnectionPoint;
  141336. /**
  141337. * Gets the tint color input component
  141338. */
  141339. get tintColor(): NodeMaterialConnectionPoint;
  141340. /**
  141341. * Gets the tint "at distance" input component
  141342. */
  141343. get tintAtDistance(): NodeMaterialConnectionPoint;
  141344. /**
  141345. * Gets the tint thickness input component
  141346. */
  141347. get tintThickness(): NodeMaterialConnectionPoint;
  141348. /**
  141349. * Gets the world tangent input component
  141350. */
  141351. get worldTangent(): NodeMaterialConnectionPoint;
  141352. /**
  141353. * Gets the clear coat object output component
  141354. */
  141355. get clearcoat(): NodeMaterialConnectionPoint;
  141356. autoConfigure(material: NodeMaterial): void;
  141357. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141358. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  141359. private _generateTBNSpace;
  141360. /**
  141361. * Gets the main code of the block (fragment side)
  141362. * @param state current state of the node material building
  141363. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  141364. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  141365. * @param worldPosVarName name of the variable holding the world position
  141366. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  141367. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  141368. * @param worldNormalVarName name of the variable holding the world normal
  141369. * @returns the shader code
  141370. */
  141371. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  141372. protected _buildBlock(state: NodeMaterialBuildState): this;
  141373. }
  141374. }
  141375. declare module BABYLON {
  141376. /**
  141377. * Block used to implement the sub surface module of the PBR material
  141378. */
  141379. export class SubSurfaceBlock extends NodeMaterialBlock {
  141380. /**
  141381. * Create a new SubSurfaceBlock
  141382. * @param name defines the block name
  141383. */
  141384. constructor(name: string);
  141385. /**
  141386. * Stores the intensity of the different subsurface effects in the thickness texture.
  141387. * * the green channel is the translucency intensity.
  141388. * * the blue channel is the scattering intensity.
  141389. * * the alpha channel is the refraction intensity.
  141390. */
  141391. useMaskFromThicknessTexture: boolean;
  141392. /**
  141393. * Initialize the block and prepare the context for build
  141394. * @param state defines the state that will be used for the build
  141395. */
  141396. initialize(state: NodeMaterialBuildState): void;
  141397. /**
  141398. * Gets the current class name
  141399. * @returns the class name
  141400. */
  141401. getClassName(): string;
  141402. /**
  141403. * Gets the min thickness input component
  141404. */
  141405. get minThickness(): NodeMaterialConnectionPoint;
  141406. /**
  141407. * Gets the max thickness input component
  141408. */
  141409. get maxThickness(): NodeMaterialConnectionPoint;
  141410. /**
  141411. * Gets the thickness texture component
  141412. */
  141413. get thicknessTexture(): NodeMaterialConnectionPoint;
  141414. /**
  141415. * Gets the tint color input component
  141416. */
  141417. get tintColor(): NodeMaterialConnectionPoint;
  141418. /**
  141419. * Gets the translucency intensity input component
  141420. */
  141421. get translucencyIntensity(): NodeMaterialConnectionPoint;
  141422. /**
  141423. * Gets the translucency diffusion distance input component
  141424. */
  141425. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  141426. /**
  141427. * Gets the refraction object parameters
  141428. */
  141429. get refraction(): NodeMaterialConnectionPoint;
  141430. /**
  141431. * Gets the sub surface object output component
  141432. */
  141433. get subsurface(): NodeMaterialConnectionPoint;
  141434. autoConfigure(material: NodeMaterial): void;
  141435. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141436. /**
  141437. * Gets the main code of the block (fragment side)
  141438. * @param state current state of the node material building
  141439. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  141440. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  141441. * @param worldPosVarName name of the variable holding the world position
  141442. * @returns the shader code
  141443. */
  141444. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  141445. protected _buildBlock(state: NodeMaterialBuildState): this;
  141446. }
  141447. }
  141448. declare module BABYLON {
  141449. /**
  141450. * Block used to implement the PBR metallic/roughness model
  141451. */
  141452. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  141453. /**
  141454. * Gets or sets the light associated with this block
  141455. */
  141456. light: Nullable<Light>;
  141457. private _lightId;
  141458. private _scene;
  141459. private _environmentBRDFTexture;
  141460. private _environmentBrdfSamplerName;
  141461. private _vNormalWName;
  141462. private _invertNormalName;
  141463. /**
  141464. * Create a new ReflectionBlock
  141465. * @param name defines the block name
  141466. */
  141467. constructor(name: string);
  141468. /**
  141469. * Intensity of the direct lights e.g. the four lights available in your scene.
  141470. * This impacts both the direct diffuse and specular highlights.
  141471. */
  141472. directIntensity: number;
  141473. /**
  141474. * Intensity of the environment e.g. how much the environment will light the object
  141475. * either through harmonics for rough material or through the refelction for shiny ones.
  141476. */
  141477. environmentIntensity: number;
  141478. /**
  141479. * This is a special control allowing the reduction of the specular highlights coming from the
  141480. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  141481. */
  141482. specularIntensity: number;
  141483. /**
  141484. * Defines the falloff type used in this material.
  141485. * It by default is Physical.
  141486. */
  141487. lightFalloff: number;
  141488. /**
  141489. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  141490. */
  141491. useAlphaFromAlbedoTexture: boolean;
  141492. /**
  141493. * Specifies that alpha test should be used
  141494. */
  141495. useAlphaTest: boolean;
  141496. /**
  141497. * Defines the alpha limits in alpha test mode.
  141498. */
  141499. alphaTestCutoff: number;
  141500. /**
  141501. * Specifies that alpha blending should be used
  141502. */
  141503. useAlphaBlending: boolean;
  141504. /**
  141505. * Defines if the alpha value should be determined via the rgb values.
  141506. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  141507. */
  141508. opacityRGB: boolean;
  141509. /**
  141510. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  141511. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  141512. */
  141513. useRadianceOverAlpha: boolean;
  141514. /**
  141515. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  141516. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  141517. */
  141518. useSpecularOverAlpha: boolean;
  141519. /**
  141520. * Enables specular anti aliasing in the PBR shader.
  141521. * It will both interacts on the Geometry for analytical and IBL lighting.
  141522. * It also prefilter the roughness map based on the bump values.
  141523. */
  141524. enableSpecularAntiAliasing: boolean;
  141525. /**
  141526. * Enables realtime filtering on the texture.
  141527. */
  141528. realTimeFiltering: boolean;
  141529. /**
  141530. * Quality switch for realtime filtering
  141531. */
  141532. realTimeFilteringQuality: number;
  141533. /**
  141534. * Defines if the material uses energy conservation.
  141535. */
  141536. useEnergyConservation: boolean;
  141537. /**
  141538. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  141539. * too much the area relying on ambient texture to define their ambient occlusion.
  141540. */
  141541. useRadianceOcclusion: boolean;
  141542. /**
  141543. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  141544. * makes the reflect vector face the model (under horizon).
  141545. */
  141546. useHorizonOcclusion: boolean;
  141547. /**
  141548. * If set to true, no lighting calculations will be applied.
  141549. */
  141550. unlit: boolean;
  141551. /**
  141552. * Force normal to face away from face.
  141553. */
  141554. forceNormalForward: boolean;
  141555. /**
  141556. * Defines the material debug mode.
  141557. * It helps seeing only some components of the material while troubleshooting.
  141558. */
  141559. debugMode: number;
  141560. /**
  141561. * Specify from where on screen the debug mode should start.
  141562. * The value goes from -1 (full screen) to 1 (not visible)
  141563. * It helps with side by side comparison against the final render
  141564. * This defaults to 0
  141565. */
  141566. debugLimit: number;
  141567. /**
  141568. * As the default viewing range might not be enough (if the ambient is really small for instance)
  141569. * You can use the factor to better multiply the final value.
  141570. */
  141571. debugFactor: number;
  141572. /**
  141573. * Initialize the block and prepare the context for build
  141574. * @param state defines the state that will be used for the build
  141575. */
  141576. initialize(state: NodeMaterialBuildState): void;
  141577. /**
  141578. * Gets the current class name
  141579. * @returns the class name
  141580. */
  141581. getClassName(): string;
  141582. /**
  141583. * Gets the world position input component
  141584. */
  141585. get worldPosition(): NodeMaterialConnectionPoint;
  141586. /**
  141587. * Gets the world normal input component
  141588. */
  141589. get worldNormal(): NodeMaterialConnectionPoint;
  141590. /**
  141591. * Gets the perturbed normal input component
  141592. */
  141593. get perturbedNormal(): NodeMaterialConnectionPoint;
  141594. /**
  141595. * Gets the camera position input component
  141596. */
  141597. get cameraPosition(): NodeMaterialConnectionPoint;
  141598. /**
  141599. * Gets the base color input component
  141600. */
  141601. get baseColor(): NodeMaterialConnectionPoint;
  141602. /**
  141603. * Gets the opacity texture input component
  141604. */
  141605. get opacityTexture(): NodeMaterialConnectionPoint;
  141606. /**
  141607. * Gets the ambient color input component
  141608. */
  141609. get ambientColor(): NodeMaterialConnectionPoint;
  141610. /**
  141611. * Gets the reflectivity object parameters
  141612. */
  141613. get reflectivity(): NodeMaterialConnectionPoint;
  141614. /**
  141615. * Gets the ambient occlusion object parameters
  141616. */
  141617. get ambientOcclusion(): NodeMaterialConnectionPoint;
  141618. /**
  141619. * Gets the reflection object parameters
  141620. */
  141621. get reflection(): NodeMaterialConnectionPoint;
  141622. /**
  141623. * Gets the sheen object parameters
  141624. */
  141625. get sheen(): NodeMaterialConnectionPoint;
  141626. /**
  141627. * Gets the clear coat object parameters
  141628. */
  141629. get clearcoat(): NodeMaterialConnectionPoint;
  141630. /**
  141631. * Gets the sub surface object parameters
  141632. */
  141633. get subsurface(): NodeMaterialConnectionPoint;
  141634. /**
  141635. * Gets the anisotropy object parameters
  141636. */
  141637. get anisotropy(): NodeMaterialConnectionPoint;
  141638. /**
  141639. * Gets the ambient output component
  141640. */
  141641. get ambient(): NodeMaterialConnectionPoint;
  141642. /**
  141643. * Gets the diffuse output component
  141644. */
  141645. get diffuse(): NodeMaterialConnectionPoint;
  141646. /**
  141647. * Gets the specular output component
  141648. */
  141649. get specular(): NodeMaterialConnectionPoint;
  141650. /**
  141651. * Gets the sheen output component
  141652. */
  141653. get sheenDir(): NodeMaterialConnectionPoint;
  141654. /**
  141655. * Gets the clear coat output component
  141656. */
  141657. get clearcoatDir(): NodeMaterialConnectionPoint;
  141658. /**
  141659. * Gets the indirect diffuse output component
  141660. */
  141661. get diffuseIndirect(): NodeMaterialConnectionPoint;
  141662. /**
  141663. * Gets the indirect specular output component
  141664. */
  141665. get specularIndirect(): NodeMaterialConnectionPoint;
  141666. /**
  141667. * Gets the indirect sheen output component
  141668. */
  141669. get sheenIndirect(): NodeMaterialConnectionPoint;
  141670. /**
  141671. * Gets the indirect clear coat output component
  141672. */
  141673. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  141674. /**
  141675. * Gets the refraction output component
  141676. */
  141677. get refraction(): NodeMaterialConnectionPoint;
  141678. /**
  141679. * Gets the global lighting output component
  141680. */
  141681. get lighting(): NodeMaterialConnectionPoint;
  141682. /**
  141683. * Gets the shadow output component
  141684. */
  141685. get shadow(): NodeMaterialConnectionPoint;
  141686. /**
  141687. * Gets the alpha output component
  141688. */
  141689. get alpha(): NodeMaterialConnectionPoint;
  141690. autoConfigure(material: NodeMaterial): void;
  141691. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141692. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  141693. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141694. private _injectVertexCode;
  141695. /**
  141696. * Gets the code corresponding to the albedo/opacity module
  141697. * @returns the shader code
  141698. */
  141699. getAlbedoOpacityCode(): string;
  141700. protected _buildBlock(state: NodeMaterialBuildState): this;
  141701. protected _dumpPropertiesCode(): string;
  141702. serialize(): any;
  141703. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141704. }
  141705. }
  141706. declare module BABYLON {
  141707. /**
  141708. * Block used to compute value of one parameter modulo another
  141709. */
  141710. export class ModBlock extends NodeMaterialBlock {
  141711. /**
  141712. * Creates a new ModBlock
  141713. * @param name defines the block name
  141714. */
  141715. constructor(name: string);
  141716. /**
  141717. * Gets the current class name
  141718. * @returns the class name
  141719. */
  141720. getClassName(): string;
  141721. /**
  141722. * Gets the left operand input component
  141723. */
  141724. get left(): NodeMaterialConnectionPoint;
  141725. /**
  141726. * Gets the right operand input component
  141727. */
  141728. get right(): NodeMaterialConnectionPoint;
  141729. /**
  141730. * Gets the output component
  141731. */
  141732. get output(): NodeMaterialConnectionPoint;
  141733. protected _buildBlock(state: NodeMaterialBuildState): this;
  141734. }
  141735. }
  141736. declare module BABYLON {
  141737. /**
  141738. * Helper class to push actions to a pool of workers.
  141739. */
  141740. export class WorkerPool implements IDisposable {
  141741. private _workerInfos;
  141742. private _pendingActions;
  141743. /**
  141744. * Constructor
  141745. * @param workers Array of workers to use for actions
  141746. */
  141747. constructor(workers: Array<Worker>);
  141748. /**
  141749. * Terminates all workers and clears any pending actions.
  141750. */
  141751. dispose(): void;
  141752. /**
  141753. * Pushes an action to the worker pool. If all the workers are active, the action will be
  141754. * pended until a worker has completed its action.
  141755. * @param action The action to perform. Call onComplete when the action is complete.
  141756. */
  141757. push(action: (worker: Worker, onComplete: () => void) => void): void;
  141758. private _execute;
  141759. }
  141760. }
  141761. declare module BABYLON {
  141762. /**
  141763. * Configuration for Draco compression
  141764. */
  141765. export interface IDracoCompressionConfiguration {
  141766. /**
  141767. * Configuration for the decoder.
  141768. */
  141769. decoder: {
  141770. /**
  141771. * The url to the WebAssembly module.
  141772. */
  141773. wasmUrl?: string;
  141774. /**
  141775. * The url to the WebAssembly binary.
  141776. */
  141777. wasmBinaryUrl?: string;
  141778. /**
  141779. * The url to the fallback JavaScript module.
  141780. */
  141781. fallbackUrl?: string;
  141782. };
  141783. }
  141784. /**
  141785. * Draco compression (https://google.github.io/draco/)
  141786. *
  141787. * This class wraps the Draco module.
  141788. *
  141789. * **Encoder**
  141790. *
  141791. * The encoder is not currently implemented.
  141792. *
  141793. * **Decoder**
  141794. *
  141795. * 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.
  141796. *
  141797. * To update the configuration, use the following code:
  141798. * ```javascript
  141799. * DracoCompression.Configuration = {
  141800. * decoder: {
  141801. * wasmUrl: "<url to the WebAssembly library>",
  141802. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  141803. * fallbackUrl: "<url to the fallback JavaScript library>",
  141804. * }
  141805. * };
  141806. * ```
  141807. *
  141808. * 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.
  141809. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  141810. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  141811. *
  141812. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  141813. * ```javascript
  141814. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  141815. * ```
  141816. *
  141817. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  141818. */
  141819. export class DracoCompression implements IDisposable {
  141820. private _workerPoolPromise?;
  141821. private _decoderModulePromise?;
  141822. /**
  141823. * The configuration. Defaults to the following urls:
  141824. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  141825. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  141826. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  141827. */
  141828. static Configuration: IDracoCompressionConfiguration;
  141829. /**
  141830. * Returns true if the decoder configuration is available.
  141831. */
  141832. static get DecoderAvailable(): boolean;
  141833. /**
  141834. * Default number of workers to create when creating the draco compression object.
  141835. */
  141836. static DefaultNumWorkers: number;
  141837. private static GetDefaultNumWorkers;
  141838. private static _Default;
  141839. /**
  141840. * Default instance for the draco compression object.
  141841. */
  141842. static get Default(): DracoCompression;
  141843. /**
  141844. * Constructor
  141845. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  141846. */
  141847. constructor(numWorkers?: number);
  141848. /**
  141849. * Stop all async operations and release resources.
  141850. */
  141851. dispose(): void;
  141852. /**
  141853. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  141854. * @returns a promise that resolves when ready
  141855. */
  141856. whenReadyAsync(): Promise<void>;
  141857. /**
  141858. * Decode Draco compressed mesh data to vertex data.
  141859. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  141860. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  141861. * @returns A promise that resolves with the decoded vertex data
  141862. */
  141863. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  141864. [kind: string]: number;
  141865. }): Promise<VertexData>;
  141866. }
  141867. }
  141868. declare module BABYLON {
  141869. /**
  141870. * Class for building Constructive Solid Geometry
  141871. */
  141872. export class CSG {
  141873. private polygons;
  141874. /**
  141875. * The world matrix
  141876. */
  141877. matrix: Matrix;
  141878. /**
  141879. * Stores the position
  141880. */
  141881. position: Vector3;
  141882. /**
  141883. * Stores the rotation
  141884. */
  141885. rotation: Vector3;
  141886. /**
  141887. * Stores the rotation quaternion
  141888. */
  141889. rotationQuaternion: Nullable<Quaternion>;
  141890. /**
  141891. * Stores the scaling vector
  141892. */
  141893. scaling: Vector3;
  141894. /**
  141895. * Convert the Mesh to CSG
  141896. * @param mesh The Mesh to convert to CSG
  141897. * @returns A new CSG from the Mesh
  141898. */
  141899. static FromMesh(mesh: Mesh): CSG;
  141900. /**
  141901. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  141902. * @param polygons Polygons used to construct a CSG solid
  141903. */
  141904. private static FromPolygons;
  141905. /**
  141906. * Clones, or makes a deep copy, of the CSG
  141907. * @returns A new CSG
  141908. */
  141909. clone(): CSG;
  141910. /**
  141911. * Unions this CSG with another CSG
  141912. * @param csg The CSG to union against this CSG
  141913. * @returns The unioned CSG
  141914. */
  141915. union(csg: CSG): CSG;
  141916. /**
  141917. * Unions this CSG with another CSG in place
  141918. * @param csg The CSG to union against this CSG
  141919. */
  141920. unionInPlace(csg: CSG): void;
  141921. /**
  141922. * Subtracts this CSG with another CSG
  141923. * @param csg The CSG to subtract against this CSG
  141924. * @returns A new CSG
  141925. */
  141926. subtract(csg: CSG): CSG;
  141927. /**
  141928. * Subtracts this CSG with another CSG in place
  141929. * @param csg The CSG to subtact against this CSG
  141930. */
  141931. subtractInPlace(csg: CSG): void;
  141932. /**
  141933. * Intersect this CSG with another CSG
  141934. * @param csg The CSG to intersect against this CSG
  141935. * @returns A new CSG
  141936. */
  141937. intersect(csg: CSG): CSG;
  141938. /**
  141939. * Intersects this CSG with another CSG in place
  141940. * @param csg The CSG to intersect against this CSG
  141941. */
  141942. intersectInPlace(csg: CSG): void;
  141943. /**
  141944. * Return a new CSG solid with solid and empty space switched. This solid is
  141945. * not modified.
  141946. * @returns A new CSG solid with solid and empty space switched
  141947. */
  141948. inverse(): CSG;
  141949. /**
  141950. * Inverses the CSG in place
  141951. */
  141952. inverseInPlace(): void;
  141953. /**
  141954. * This is used to keep meshes transformations so they can be restored
  141955. * when we build back a Babylon Mesh
  141956. * NB : All CSG operations are performed in world coordinates
  141957. * @param csg The CSG to copy the transform attributes from
  141958. * @returns This CSG
  141959. */
  141960. copyTransformAttributes(csg: CSG): CSG;
  141961. /**
  141962. * Build Raw mesh from CSG
  141963. * Coordinates here are in world space
  141964. * @param name The name of the mesh geometry
  141965. * @param scene The Scene
  141966. * @param keepSubMeshes Specifies if the submeshes should be kept
  141967. * @returns A new Mesh
  141968. */
  141969. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  141970. /**
  141971. * Build Mesh from CSG taking material and transforms into account
  141972. * @param name The name of the Mesh
  141973. * @param material The material of the Mesh
  141974. * @param scene The Scene
  141975. * @param keepSubMeshes Specifies if submeshes should be kept
  141976. * @returns The new Mesh
  141977. */
  141978. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  141979. }
  141980. }
  141981. declare module BABYLON {
  141982. /**
  141983. * Class used to create a trail following a mesh
  141984. */
  141985. export class TrailMesh extends Mesh {
  141986. private _generator;
  141987. private _autoStart;
  141988. private _running;
  141989. private _diameter;
  141990. private _length;
  141991. private _sectionPolygonPointsCount;
  141992. private _sectionVectors;
  141993. private _sectionNormalVectors;
  141994. private _beforeRenderObserver;
  141995. /**
  141996. * @constructor
  141997. * @param name The value used by scene.getMeshByName() to do a lookup.
  141998. * @param generator The mesh or transform node to generate a trail.
  141999. * @param scene The scene to add this mesh to.
  142000. * @param diameter Diameter of trailing mesh. Default is 1.
  142001. * @param length Length of trailing mesh. Default is 60.
  142002. * @param autoStart Automatically start trailing mesh. Default true.
  142003. */
  142004. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  142005. /**
  142006. * "TrailMesh"
  142007. * @returns "TrailMesh"
  142008. */
  142009. getClassName(): string;
  142010. private _createMesh;
  142011. /**
  142012. * Start trailing mesh.
  142013. */
  142014. start(): void;
  142015. /**
  142016. * Stop trailing mesh.
  142017. */
  142018. stop(): void;
  142019. /**
  142020. * Update trailing mesh geometry.
  142021. */
  142022. update(): void;
  142023. /**
  142024. * Returns a new TrailMesh object.
  142025. * @param name is a string, the name given to the new mesh
  142026. * @param newGenerator use new generator object for cloned trail mesh
  142027. * @returns a new mesh
  142028. */
  142029. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  142030. /**
  142031. * Serializes this trail mesh
  142032. * @param serializationObject object to write serialization to
  142033. */
  142034. serialize(serializationObject: any): void;
  142035. /**
  142036. * Parses a serialized trail mesh
  142037. * @param parsedMesh the serialized mesh
  142038. * @param scene the scene to create the trail mesh in
  142039. * @returns the created trail mesh
  142040. */
  142041. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  142042. }
  142043. }
  142044. declare module BABYLON {
  142045. /**
  142046. * Class containing static functions to help procedurally build meshes
  142047. */
  142048. export class TiledBoxBuilder {
  142049. /**
  142050. * Creates a box mesh
  142051. * 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)
  142052. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  142053. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142054. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142055. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142056. * @param name defines the name of the mesh
  142057. * @param options defines the options used to create the mesh
  142058. * @param scene defines the hosting scene
  142059. * @returns the box mesh
  142060. */
  142061. static CreateTiledBox(name: string, options: {
  142062. pattern?: number;
  142063. width?: number;
  142064. height?: number;
  142065. depth?: number;
  142066. tileSize?: number;
  142067. tileWidth?: number;
  142068. tileHeight?: number;
  142069. alignHorizontal?: number;
  142070. alignVertical?: number;
  142071. faceUV?: Vector4[];
  142072. faceColors?: Color4[];
  142073. sideOrientation?: number;
  142074. updatable?: boolean;
  142075. }, scene?: Nullable<Scene>): Mesh;
  142076. }
  142077. }
  142078. declare module BABYLON {
  142079. /**
  142080. * Class containing static functions to help procedurally build meshes
  142081. */
  142082. export class TorusKnotBuilder {
  142083. /**
  142084. * Creates a torus knot mesh
  142085. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  142086. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  142087. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  142088. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  142089. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142090. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142091. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  142092. * @param name defines the name of the mesh
  142093. * @param options defines the options used to create the mesh
  142094. * @param scene defines the hosting scene
  142095. * @returns the torus knot mesh
  142096. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  142097. */
  142098. static CreateTorusKnot(name: string, options: {
  142099. radius?: number;
  142100. tube?: number;
  142101. radialSegments?: number;
  142102. tubularSegments?: number;
  142103. p?: number;
  142104. q?: number;
  142105. updatable?: boolean;
  142106. sideOrientation?: number;
  142107. frontUVs?: Vector4;
  142108. backUVs?: Vector4;
  142109. }, scene: any): Mesh;
  142110. }
  142111. }
  142112. declare module BABYLON {
  142113. /**
  142114. * Polygon
  142115. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  142116. */
  142117. export class Polygon {
  142118. /**
  142119. * Creates a rectangle
  142120. * @param xmin bottom X coord
  142121. * @param ymin bottom Y coord
  142122. * @param xmax top X coord
  142123. * @param ymax top Y coord
  142124. * @returns points that make the resulting rectation
  142125. */
  142126. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  142127. /**
  142128. * Creates a circle
  142129. * @param radius radius of circle
  142130. * @param cx scale in x
  142131. * @param cy scale in y
  142132. * @param numberOfSides number of sides that make up the circle
  142133. * @returns points that make the resulting circle
  142134. */
  142135. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  142136. /**
  142137. * Creates a polygon from input string
  142138. * @param input Input polygon data
  142139. * @returns the parsed points
  142140. */
  142141. static Parse(input: string): Vector2[];
  142142. /**
  142143. * Starts building a polygon from x and y coordinates
  142144. * @param x x coordinate
  142145. * @param y y coordinate
  142146. * @returns the started path2
  142147. */
  142148. static StartingAt(x: number, y: number): Path2;
  142149. }
  142150. /**
  142151. * Builds a polygon
  142152. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  142153. */
  142154. export class PolygonMeshBuilder {
  142155. private _points;
  142156. private _outlinepoints;
  142157. private _holes;
  142158. private _name;
  142159. private _scene;
  142160. private _epoints;
  142161. private _eholes;
  142162. private _addToepoint;
  142163. /**
  142164. * Babylon reference to the earcut plugin.
  142165. */
  142166. bjsEarcut: any;
  142167. /**
  142168. * Creates a PolygonMeshBuilder
  142169. * @param name name of the builder
  142170. * @param contours Path of the polygon
  142171. * @param scene scene to add to when creating the mesh
  142172. * @param earcutInjection can be used to inject your own earcut reference
  142173. */
  142174. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  142175. /**
  142176. * Adds a whole within the polygon
  142177. * @param hole Array of points defining the hole
  142178. * @returns this
  142179. */
  142180. addHole(hole: Vector2[]): PolygonMeshBuilder;
  142181. /**
  142182. * Creates the polygon
  142183. * @param updatable If the mesh should be updatable
  142184. * @param depth The depth of the mesh created
  142185. * @returns the created mesh
  142186. */
  142187. build(updatable?: boolean, depth?: number): Mesh;
  142188. /**
  142189. * Creates the polygon
  142190. * @param depth The depth of the mesh created
  142191. * @returns the created VertexData
  142192. */
  142193. buildVertexData(depth?: number): VertexData;
  142194. /**
  142195. * Adds a side to the polygon
  142196. * @param positions points that make the polygon
  142197. * @param normals normals of the polygon
  142198. * @param uvs uvs of the polygon
  142199. * @param indices indices of the polygon
  142200. * @param bounds bounds of the polygon
  142201. * @param points points of the polygon
  142202. * @param depth depth of the polygon
  142203. * @param flip flip of the polygon
  142204. */
  142205. private addSide;
  142206. }
  142207. }
  142208. declare module BABYLON {
  142209. /**
  142210. * Class containing static functions to help procedurally build meshes
  142211. */
  142212. export class PolygonBuilder {
  142213. /**
  142214. * Creates a polygon mesh
  142215. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  142216. * * 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
  142217. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  142218. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142219. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  142220. * * Remember you can only change the shape positions, not their number when updating a polygon
  142221. * @param name defines the name of the mesh
  142222. * @param options defines the options used to create the mesh
  142223. * @param scene defines the hosting scene
  142224. * @param earcutInjection can be used to inject your own earcut reference
  142225. * @returns the polygon mesh
  142226. */
  142227. static CreatePolygon(name: string, options: {
  142228. shape: Vector3[];
  142229. holes?: Vector3[][];
  142230. depth?: number;
  142231. faceUV?: Vector4[];
  142232. faceColors?: Color4[];
  142233. updatable?: boolean;
  142234. sideOrientation?: number;
  142235. frontUVs?: Vector4;
  142236. backUVs?: Vector4;
  142237. wrap?: boolean;
  142238. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  142239. /**
  142240. * Creates an extruded polygon mesh, with depth in the Y direction.
  142241. * * 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)
  142242. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  142243. * @param name defines the name of the mesh
  142244. * @param options defines the options used to create the mesh
  142245. * @param scene defines the hosting scene
  142246. * @param earcutInjection can be used to inject your own earcut reference
  142247. * @returns the polygon mesh
  142248. */
  142249. static ExtrudePolygon(name: string, options: {
  142250. shape: Vector3[];
  142251. holes?: Vector3[][];
  142252. depth?: number;
  142253. faceUV?: Vector4[];
  142254. faceColors?: Color4[];
  142255. updatable?: boolean;
  142256. sideOrientation?: number;
  142257. frontUVs?: Vector4;
  142258. backUVs?: Vector4;
  142259. wrap?: boolean;
  142260. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  142261. }
  142262. }
  142263. declare module BABYLON {
  142264. /**
  142265. * Class containing static functions to help procedurally build meshes
  142266. */
  142267. export class LatheBuilder {
  142268. /**
  142269. * Creates lathe mesh.
  142270. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  142271. * * 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
  142272. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  142273. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  142274. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  142275. * * 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
  142276. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  142277. * * 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
  142278. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142279. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142280. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  142281. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142282. * @param name defines the name of the mesh
  142283. * @param options defines the options used to create the mesh
  142284. * @param scene defines the hosting scene
  142285. * @returns the lathe mesh
  142286. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  142287. */
  142288. static CreateLathe(name: string, options: {
  142289. shape: Vector3[];
  142290. radius?: number;
  142291. tessellation?: number;
  142292. clip?: number;
  142293. arc?: number;
  142294. closed?: boolean;
  142295. updatable?: boolean;
  142296. sideOrientation?: number;
  142297. frontUVs?: Vector4;
  142298. backUVs?: Vector4;
  142299. cap?: number;
  142300. invertUV?: boolean;
  142301. }, scene?: Nullable<Scene>): Mesh;
  142302. }
  142303. }
  142304. declare module BABYLON {
  142305. /**
  142306. * Class containing static functions to help procedurally build meshes
  142307. */
  142308. export class TiledPlaneBuilder {
  142309. /**
  142310. * Creates a tiled plane mesh
  142311. * * The parameter `pattern` will, depending on value, do nothing or
  142312. * * * flip (reflect about central vertical) alternate tiles across and up
  142313. * * * flip every tile on alternate rows
  142314. * * * rotate (180 degs) alternate tiles across and up
  142315. * * * rotate every tile on alternate rows
  142316. * * * flip and rotate alternate tiles across and up
  142317. * * * flip and rotate every tile on alternate rows
  142318. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  142319. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  142320. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142321. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  142322. * * 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)
  142323. * * 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)
  142324. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  142325. * @param name defines the name of the mesh
  142326. * @param options defines the options used to create the mesh
  142327. * @param scene defines the hosting scene
  142328. * @returns the box mesh
  142329. */
  142330. static CreateTiledPlane(name: string, options: {
  142331. pattern?: number;
  142332. tileSize?: number;
  142333. tileWidth?: number;
  142334. tileHeight?: number;
  142335. size?: number;
  142336. width?: number;
  142337. height?: number;
  142338. alignHorizontal?: number;
  142339. alignVertical?: number;
  142340. sideOrientation?: number;
  142341. frontUVs?: Vector4;
  142342. backUVs?: Vector4;
  142343. updatable?: boolean;
  142344. }, scene?: Nullable<Scene>): Mesh;
  142345. }
  142346. }
  142347. declare module BABYLON {
  142348. /**
  142349. * Class containing static functions to help procedurally build meshes
  142350. */
  142351. export class TubeBuilder {
  142352. /**
  142353. * Creates a tube mesh.
  142354. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  142355. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  142356. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  142357. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  142358. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  142359. * * 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)
  142360. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  142361. * * 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
  142362. * * 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
  142363. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142364. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142365. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  142366. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142367. * @param name defines the name of the mesh
  142368. * @param options defines the options used to create the mesh
  142369. * @param scene defines the hosting scene
  142370. * @returns the tube mesh
  142371. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  142372. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  142373. */
  142374. static CreateTube(name: string, options: {
  142375. path: Vector3[];
  142376. radius?: number;
  142377. tessellation?: number;
  142378. radiusFunction?: {
  142379. (i: number, distance: number): number;
  142380. };
  142381. cap?: number;
  142382. arc?: number;
  142383. updatable?: boolean;
  142384. sideOrientation?: number;
  142385. frontUVs?: Vector4;
  142386. backUVs?: Vector4;
  142387. instance?: Mesh;
  142388. invertUV?: boolean;
  142389. }, scene?: Nullable<Scene>): Mesh;
  142390. }
  142391. }
  142392. declare module BABYLON {
  142393. /**
  142394. * Class containing static functions to help procedurally build meshes
  142395. */
  142396. export class IcoSphereBuilder {
  142397. /**
  142398. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  142399. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  142400. * * 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`)
  142401. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  142402. * * 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
  142403. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142404. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142405. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142406. * @param name defines the name of the mesh
  142407. * @param options defines the options used to create the mesh
  142408. * @param scene defines the hosting scene
  142409. * @returns the icosahedron mesh
  142410. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  142411. */
  142412. static CreateIcoSphere(name: string, options: {
  142413. radius?: number;
  142414. radiusX?: number;
  142415. radiusY?: number;
  142416. radiusZ?: number;
  142417. flat?: boolean;
  142418. subdivisions?: number;
  142419. sideOrientation?: number;
  142420. frontUVs?: Vector4;
  142421. backUVs?: Vector4;
  142422. updatable?: boolean;
  142423. }, scene?: Nullable<Scene>): Mesh;
  142424. }
  142425. }
  142426. declare module BABYLON {
  142427. /**
  142428. * Class containing static functions to help procedurally build meshes
  142429. */
  142430. export class DecalBuilder {
  142431. /**
  142432. * Creates a decal mesh.
  142433. * 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
  142434. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  142435. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  142436. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  142437. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  142438. * @param name defines the name of the mesh
  142439. * @param sourceMesh defines the mesh where the decal must be applied
  142440. * @param options defines the options used to create the mesh
  142441. * @param scene defines the hosting scene
  142442. * @returns the decal mesh
  142443. * @see https://doc.babylonjs.com/how_to/decals
  142444. */
  142445. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  142446. position?: Vector3;
  142447. normal?: Vector3;
  142448. size?: Vector3;
  142449. angle?: number;
  142450. }): Mesh;
  142451. }
  142452. }
  142453. declare module BABYLON {
  142454. /**
  142455. * Class containing static functions to help procedurally build meshes
  142456. */
  142457. export class MeshBuilder {
  142458. /**
  142459. * Creates a box mesh
  142460. * * The parameter `size` sets the size (float) of each box side (default 1)
  142461. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  142462. * * 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)
  142463. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  142464. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142465. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142466. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142467. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  142468. * @param name defines the name of the mesh
  142469. * @param options defines the options used to create the mesh
  142470. * @param scene defines the hosting scene
  142471. * @returns the box mesh
  142472. */
  142473. static CreateBox(name: string, options: {
  142474. size?: number;
  142475. width?: number;
  142476. height?: number;
  142477. depth?: number;
  142478. faceUV?: Vector4[];
  142479. faceColors?: Color4[];
  142480. sideOrientation?: number;
  142481. frontUVs?: Vector4;
  142482. backUVs?: Vector4;
  142483. wrap?: boolean;
  142484. topBaseAt?: number;
  142485. bottomBaseAt?: number;
  142486. updatable?: boolean;
  142487. }, scene?: Nullable<Scene>): Mesh;
  142488. /**
  142489. * Creates a tiled box mesh
  142490. * * faceTiles sets the pattern, tile size and number of tiles for a face
  142491. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142492. * @param name defines the name of the mesh
  142493. * @param options defines the options used to create the mesh
  142494. * @param scene defines the hosting scene
  142495. * @returns the tiled box mesh
  142496. */
  142497. static CreateTiledBox(name: string, options: {
  142498. pattern?: number;
  142499. size?: number;
  142500. width?: number;
  142501. height?: number;
  142502. depth: number;
  142503. tileSize?: number;
  142504. tileWidth?: number;
  142505. tileHeight?: number;
  142506. faceUV?: Vector4[];
  142507. faceColors?: Color4[];
  142508. alignHorizontal?: number;
  142509. alignVertical?: number;
  142510. sideOrientation?: number;
  142511. updatable?: boolean;
  142512. }, scene?: Nullable<Scene>): Mesh;
  142513. /**
  142514. * Creates a sphere mesh
  142515. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  142516. * * 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`)
  142517. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  142518. * * 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
  142519. * * 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)
  142520. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142521. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142522. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142523. * @param name defines the name of the mesh
  142524. * @param options defines the options used to create the mesh
  142525. * @param scene defines the hosting scene
  142526. * @returns the sphere mesh
  142527. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  142528. */
  142529. static CreateSphere(name: string, options: {
  142530. segments?: number;
  142531. diameter?: number;
  142532. diameterX?: number;
  142533. diameterY?: number;
  142534. diameterZ?: number;
  142535. arc?: number;
  142536. slice?: number;
  142537. sideOrientation?: number;
  142538. frontUVs?: Vector4;
  142539. backUVs?: Vector4;
  142540. updatable?: boolean;
  142541. }, scene?: Nullable<Scene>): Mesh;
  142542. /**
  142543. * Creates a plane polygonal mesh. By default, this is a disc
  142544. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  142545. * * 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
  142546. * * 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
  142547. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142548. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142549. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142550. * @param name defines the name of the mesh
  142551. * @param options defines the options used to create the mesh
  142552. * @param scene defines the hosting scene
  142553. * @returns the plane polygonal mesh
  142554. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  142555. */
  142556. static CreateDisc(name: string, options: {
  142557. radius?: number;
  142558. tessellation?: number;
  142559. arc?: number;
  142560. updatable?: boolean;
  142561. sideOrientation?: number;
  142562. frontUVs?: Vector4;
  142563. backUVs?: Vector4;
  142564. }, scene?: Nullable<Scene>): Mesh;
  142565. /**
  142566. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  142567. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  142568. * * 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`)
  142569. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  142570. * * 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
  142571. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142572. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142573. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142574. * @param name defines the name of the mesh
  142575. * @param options defines the options used to create the mesh
  142576. * @param scene defines the hosting scene
  142577. * @returns the icosahedron mesh
  142578. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  142579. */
  142580. static CreateIcoSphere(name: string, options: {
  142581. radius?: number;
  142582. radiusX?: number;
  142583. radiusY?: number;
  142584. radiusZ?: number;
  142585. flat?: boolean;
  142586. subdivisions?: number;
  142587. sideOrientation?: number;
  142588. frontUVs?: Vector4;
  142589. backUVs?: Vector4;
  142590. updatable?: boolean;
  142591. }, scene?: Nullable<Scene>): Mesh;
  142592. /**
  142593. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  142594. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  142595. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  142596. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  142597. * * 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
  142598. * * 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
  142599. * * 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
  142600. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142601. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142602. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  142603. * * 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
  142604. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  142605. * * 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
  142606. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  142607. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142608. * @param name defines the name of the mesh
  142609. * @param options defines the options used to create the mesh
  142610. * @param scene defines the hosting scene
  142611. * @returns the ribbon mesh
  142612. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  142613. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  142614. */
  142615. static CreateRibbon(name: string, options: {
  142616. pathArray: Vector3[][];
  142617. closeArray?: boolean;
  142618. closePath?: boolean;
  142619. offset?: number;
  142620. updatable?: boolean;
  142621. sideOrientation?: number;
  142622. frontUVs?: Vector4;
  142623. backUVs?: Vector4;
  142624. instance?: Mesh;
  142625. invertUV?: boolean;
  142626. uvs?: Vector2[];
  142627. colors?: Color4[];
  142628. }, scene?: Nullable<Scene>): Mesh;
  142629. /**
  142630. * Creates a cylinder or a cone mesh
  142631. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  142632. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  142633. * * 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.
  142634. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  142635. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  142636. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  142637. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  142638. * * 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).
  142639. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  142640. * * 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).
  142641. * * 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
  142642. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  142643. * * 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
  142644. * * 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.
  142645. * * If `enclose` is false, a ring surface is one element.
  142646. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  142647. * * 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
  142648. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142649. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142650. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  142651. * @param name defines the name of the mesh
  142652. * @param options defines the options used to create the mesh
  142653. * @param scene defines the hosting scene
  142654. * @returns the cylinder mesh
  142655. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  142656. */
  142657. static CreateCylinder(name: string, options: {
  142658. height?: number;
  142659. diameterTop?: number;
  142660. diameterBottom?: number;
  142661. diameter?: number;
  142662. tessellation?: number;
  142663. subdivisions?: number;
  142664. arc?: number;
  142665. faceColors?: Color4[];
  142666. faceUV?: Vector4[];
  142667. updatable?: boolean;
  142668. hasRings?: boolean;
  142669. enclose?: boolean;
  142670. cap?: number;
  142671. sideOrientation?: number;
  142672. frontUVs?: Vector4;
  142673. backUVs?: Vector4;
  142674. }, scene?: Nullable<Scene>): Mesh;
  142675. /**
  142676. * Creates a torus mesh
  142677. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  142678. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  142679. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  142680. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142681. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142682. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  142683. * @param name defines the name of the mesh
  142684. * @param options defines the options used to create the mesh
  142685. * @param scene defines the hosting scene
  142686. * @returns the torus mesh
  142687. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  142688. */
  142689. static CreateTorus(name: string, options: {
  142690. diameter?: number;
  142691. thickness?: number;
  142692. tessellation?: number;
  142693. updatable?: boolean;
  142694. sideOrientation?: number;
  142695. frontUVs?: Vector4;
  142696. backUVs?: Vector4;
  142697. }, scene?: Nullable<Scene>): Mesh;
  142698. /**
  142699. * Creates a torus knot mesh
  142700. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  142701. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  142702. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  142703. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  142704. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142705. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142706. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  142707. * @param name defines the name of the mesh
  142708. * @param options defines the options used to create the mesh
  142709. * @param scene defines the hosting scene
  142710. * @returns the torus knot mesh
  142711. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  142712. */
  142713. static CreateTorusKnot(name: string, options: {
  142714. radius?: number;
  142715. tube?: number;
  142716. radialSegments?: number;
  142717. tubularSegments?: number;
  142718. p?: number;
  142719. q?: number;
  142720. updatable?: boolean;
  142721. sideOrientation?: number;
  142722. frontUVs?: Vector4;
  142723. backUVs?: Vector4;
  142724. }, scene?: Nullable<Scene>): Mesh;
  142725. /**
  142726. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  142727. * * 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
  142728. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  142729. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  142730. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  142731. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  142732. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  142733. * * 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
  142734. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  142735. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142736. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  142737. * @param name defines the name of the new line system
  142738. * @param options defines the options used to create the line system
  142739. * @param scene defines the hosting scene
  142740. * @returns a new line system mesh
  142741. */
  142742. static CreateLineSystem(name: string, options: {
  142743. lines: Vector3[][];
  142744. updatable?: boolean;
  142745. instance?: Nullable<LinesMesh>;
  142746. colors?: Nullable<Color4[][]>;
  142747. useVertexAlpha?: boolean;
  142748. }, scene: Nullable<Scene>): LinesMesh;
  142749. /**
  142750. * Creates a line mesh
  142751. * 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
  142752. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  142753. * * The parameter `points` is an array successive Vector3
  142754. * * 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
  142755. * * The optional parameter `colors` is an array of successive Color4, one per line point
  142756. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  142757. * * When updating an instance, remember that only point positions can change, not the number of points
  142758. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142759. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  142760. * @param name defines the name of the new line system
  142761. * @param options defines the options used to create the line system
  142762. * @param scene defines the hosting scene
  142763. * @returns a new line mesh
  142764. */
  142765. static CreateLines(name: string, options: {
  142766. points: Vector3[];
  142767. updatable?: boolean;
  142768. instance?: Nullable<LinesMesh>;
  142769. colors?: Color4[];
  142770. useVertexAlpha?: boolean;
  142771. }, scene?: Nullable<Scene>): LinesMesh;
  142772. /**
  142773. * Creates a dashed line mesh
  142774. * * 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
  142775. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  142776. * * The parameter `points` is an array successive Vector3
  142777. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  142778. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  142779. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  142780. * * 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
  142781. * * When updating an instance, remember that only point positions can change, not the number of points
  142782. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142783. * @param name defines the name of the mesh
  142784. * @param options defines the options used to create the mesh
  142785. * @param scene defines the hosting scene
  142786. * @returns the dashed line mesh
  142787. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  142788. */
  142789. static CreateDashedLines(name: string, options: {
  142790. points: Vector3[];
  142791. dashSize?: number;
  142792. gapSize?: number;
  142793. dashNb?: number;
  142794. updatable?: boolean;
  142795. instance?: LinesMesh;
  142796. }, scene?: Nullable<Scene>): LinesMesh;
  142797. /**
  142798. * 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.
  142799. * * 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.
  142800. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  142801. * * 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.
  142802. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  142803. * * 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
  142804. * * 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
  142805. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  142806. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142807. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142808. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  142809. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  142810. * @param name defines the name of the mesh
  142811. * @param options defines the options used to create the mesh
  142812. * @param scene defines the hosting scene
  142813. * @returns the extruded shape mesh
  142814. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  142815. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  142816. */
  142817. static ExtrudeShape(name: string, options: {
  142818. shape: Vector3[];
  142819. path: Vector3[];
  142820. scale?: number;
  142821. rotation?: number;
  142822. cap?: number;
  142823. updatable?: boolean;
  142824. sideOrientation?: number;
  142825. frontUVs?: Vector4;
  142826. backUVs?: Vector4;
  142827. instance?: Mesh;
  142828. invertUV?: boolean;
  142829. }, scene?: Nullable<Scene>): Mesh;
  142830. /**
  142831. * Creates an custom extruded shape mesh.
  142832. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  142833. * * 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.
  142834. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  142835. * * 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
  142836. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  142837. * * 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
  142838. * * It must returns a float value that will be the scale value applied to the shape on each path point
  142839. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  142840. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  142841. * * 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
  142842. * * 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
  142843. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  142844. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142845. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142846. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  142847. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142848. * @param name defines the name of the mesh
  142849. * @param options defines the options used to create the mesh
  142850. * @param scene defines the hosting scene
  142851. * @returns the custom extruded shape mesh
  142852. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  142853. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  142854. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  142855. */
  142856. static ExtrudeShapeCustom(name: string, options: {
  142857. shape: Vector3[];
  142858. path: Vector3[];
  142859. scaleFunction?: any;
  142860. rotationFunction?: any;
  142861. ribbonCloseArray?: boolean;
  142862. ribbonClosePath?: boolean;
  142863. cap?: number;
  142864. updatable?: boolean;
  142865. sideOrientation?: number;
  142866. frontUVs?: Vector4;
  142867. backUVs?: Vector4;
  142868. instance?: Mesh;
  142869. invertUV?: boolean;
  142870. }, scene?: Nullable<Scene>): Mesh;
  142871. /**
  142872. * Creates lathe mesh.
  142873. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  142874. * * 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
  142875. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  142876. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  142877. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  142878. * * 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
  142879. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  142880. * * 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
  142881. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142882. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142883. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  142884. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142885. * @param name defines the name of the mesh
  142886. * @param options defines the options used to create the mesh
  142887. * @param scene defines the hosting scene
  142888. * @returns the lathe mesh
  142889. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  142890. */
  142891. static CreateLathe(name: string, options: {
  142892. shape: Vector3[];
  142893. radius?: number;
  142894. tessellation?: number;
  142895. clip?: number;
  142896. arc?: number;
  142897. closed?: boolean;
  142898. updatable?: boolean;
  142899. sideOrientation?: number;
  142900. frontUVs?: Vector4;
  142901. backUVs?: Vector4;
  142902. cap?: number;
  142903. invertUV?: boolean;
  142904. }, scene?: Nullable<Scene>): Mesh;
  142905. /**
  142906. * Creates a tiled plane mesh
  142907. * * You can set a limited pattern arrangement with the tiles
  142908. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142909. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142910. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142911. * @param name defines the name of the mesh
  142912. * @param options defines the options used to create the mesh
  142913. * @param scene defines the hosting scene
  142914. * @returns the plane mesh
  142915. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  142916. */
  142917. static CreateTiledPlane(name: string, options: {
  142918. pattern?: number;
  142919. tileSize?: number;
  142920. tileWidth?: number;
  142921. tileHeight?: number;
  142922. size?: number;
  142923. width?: number;
  142924. height?: number;
  142925. alignHorizontal?: number;
  142926. alignVertical?: number;
  142927. sideOrientation?: number;
  142928. frontUVs?: Vector4;
  142929. backUVs?: Vector4;
  142930. updatable?: boolean;
  142931. }, scene?: Nullable<Scene>): Mesh;
  142932. /**
  142933. * Creates a plane mesh
  142934. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  142935. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  142936. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  142937. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  142938. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  142939. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142940. * @param name defines the name of the mesh
  142941. * @param options defines the options used to create the mesh
  142942. * @param scene defines the hosting scene
  142943. * @returns the plane mesh
  142944. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  142945. */
  142946. static CreatePlane(name: string, options: {
  142947. size?: number;
  142948. width?: number;
  142949. height?: number;
  142950. sideOrientation?: number;
  142951. frontUVs?: Vector4;
  142952. backUVs?: Vector4;
  142953. updatable?: boolean;
  142954. sourcePlane?: Plane;
  142955. }, scene?: Nullable<Scene>): Mesh;
  142956. /**
  142957. * Creates a ground mesh
  142958. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  142959. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  142960. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  142961. * @param name defines the name of the mesh
  142962. * @param options defines the options used to create the mesh
  142963. * @param scene defines the hosting scene
  142964. * @returns the ground mesh
  142965. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  142966. */
  142967. static CreateGround(name: string, options: {
  142968. width?: number;
  142969. height?: number;
  142970. subdivisions?: number;
  142971. subdivisionsX?: number;
  142972. subdivisionsY?: number;
  142973. updatable?: boolean;
  142974. }, scene?: Nullable<Scene>): Mesh;
  142975. /**
  142976. * Creates a tiled ground mesh
  142977. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  142978. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  142979. * * 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
  142980. * * 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
  142981. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  142982. * @param name defines the name of the mesh
  142983. * @param options defines the options used to create the mesh
  142984. * @param scene defines the hosting scene
  142985. * @returns the tiled ground mesh
  142986. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  142987. */
  142988. static CreateTiledGround(name: string, options: {
  142989. xmin: number;
  142990. zmin: number;
  142991. xmax: number;
  142992. zmax: number;
  142993. subdivisions?: {
  142994. w: number;
  142995. h: number;
  142996. };
  142997. precision?: {
  142998. w: number;
  142999. h: number;
  143000. };
  143001. updatable?: boolean;
  143002. }, scene?: Nullable<Scene>): Mesh;
  143003. /**
  143004. * Creates a ground mesh from a height map
  143005. * * The parameter `url` sets the URL of the height map image resource.
  143006. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  143007. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  143008. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  143009. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  143010. * * 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.
  143011. * * 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).
  143012. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  143013. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  143014. * @param name defines the name of the mesh
  143015. * @param url defines the url to the height map
  143016. * @param options defines the options used to create the mesh
  143017. * @param scene defines the hosting scene
  143018. * @returns the ground mesh
  143019. * @see https://doc.babylonjs.com/babylon101/height_map
  143020. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  143021. */
  143022. static CreateGroundFromHeightMap(name: string, url: string, options: {
  143023. width?: number;
  143024. height?: number;
  143025. subdivisions?: number;
  143026. minHeight?: number;
  143027. maxHeight?: number;
  143028. colorFilter?: Color3;
  143029. alphaFilter?: number;
  143030. updatable?: boolean;
  143031. onReady?: (mesh: GroundMesh) => void;
  143032. }, scene?: Nullable<Scene>): GroundMesh;
  143033. /**
  143034. * Creates a polygon mesh
  143035. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  143036. * * 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
  143037. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  143038. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143039. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  143040. * * Remember you can only change the shape positions, not their number when updating a polygon
  143041. * @param name defines the name of the mesh
  143042. * @param options defines the options used to create the mesh
  143043. * @param scene defines the hosting scene
  143044. * @param earcutInjection can be used to inject your own earcut reference
  143045. * @returns the polygon mesh
  143046. */
  143047. static CreatePolygon(name: string, options: {
  143048. shape: Vector3[];
  143049. holes?: Vector3[][];
  143050. depth?: number;
  143051. faceUV?: Vector4[];
  143052. faceColors?: Color4[];
  143053. updatable?: boolean;
  143054. sideOrientation?: number;
  143055. frontUVs?: Vector4;
  143056. backUVs?: Vector4;
  143057. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  143058. /**
  143059. * Creates an extruded polygon mesh, with depth in the Y direction.
  143060. * * 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)
  143061. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  143062. * @param name defines the name of the mesh
  143063. * @param options defines the options used to create the mesh
  143064. * @param scene defines the hosting scene
  143065. * @param earcutInjection can be used to inject your own earcut reference
  143066. * @returns the polygon mesh
  143067. */
  143068. static ExtrudePolygon(name: string, options: {
  143069. shape: Vector3[];
  143070. holes?: Vector3[][];
  143071. depth?: number;
  143072. faceUV?: Vector4[];
  143073. faceColors?: Color4[];
  143074. updatable?: boolean;
  143075. sideOrientation?: number;
  143076. frontUVs?: Vector4;
  143077. backUVs?: Vector4;
  143078. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  143079. /**
  143080. * Creates a tube mesh.
  143081. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  143082. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  143083. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  143084. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  143085. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  143086. * * 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)
  143087. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  143088. * * 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
  143089. * * 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
  143090. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143091. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143092. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  143093. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143094. * @param name defines the name of the mesh
  143095. * @param options defines the options used to create the mesh
  143096. * @param scene defines the hosting scene
  143097. * @returns the tube mesh
  143098. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  143099. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  143100. */
  143101. static CreateTube(name: string, options: {
  143102. path: Vector3[];
  143103. radius?: number;
  143104. tessellation?: number;
  143105. radiusFunction?: {
  143106. (i: number, distance: number): number;
  143107. };
  143108. cap?: number;
  143109. arc?: number;
  143110. updatable?: boolean;
  143111. sideOrientation?: number;
  143112. frontUVs?: Vector4;
  143113. backUVs?: Vector4;
  143114. instance?: Mesh;
  143115. invertUV?: boolean;
  143116. }, scene?: Nullable<Scene>): Mesh;
  143117. /**
  143118. * Creates a polyhedron mesh
  143119. * * 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
  143120. * * The parameter `size` (positive float, default 1) sets the polygon size
  143121. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  143122. * * 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`
  143123. * * 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
  143124. * * 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)`)
  143125. * * 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
  143126. * * 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
  143127. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143128. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143129. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143130. * @param name defines the name of the mesh
  143131. * @param options defines the options used to create the mesh
  143132. * @param scene defines the hosting scene
  143133. * @returns the polyhedron mesh
  143134. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  143135. */
  143136. static CreatePolyhedron(name: string, options: {
  143137. type?: number;
  143138. size?: number;
  143139. sizeX?: number;
  143140. sizeY?: number;
  143141. sizeZ?: number;
  143142. custom?: any;
  143143. faceUV?: Vector4[];
  143144. faceColors?: Color4[];
  143145. flat?: boolean;
  143146. updatable?: boolean;
  143147. sideOrientation?: number;
  143148. frontUVs?: Vector4;
  143149. backUVs?: Vector4;
  143150. }, scene?: Nullable<Scene>): Mesh;
  143151. /**
  143152. * Creates a decal mesh.
  143153. * 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
  143154. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  143155. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  143156. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  143157. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  143158. * @param name defines the name of the mesh
  143159. * @param sourceMesh defines the mesh where the decal must be applied
  143160. * @param options defines the options used to create the mesh
  143161. * @param scene defines the hosting scene
  143162. * @returns the decal mesh
  143163. * @see https://doc.babylonjs.com/how_to/decals
  143164. */
  143165. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  143166. position?: Vector3;
  143167. normal?: Vector3;
  143168. size?: Vector3;
  143169. angle?: number;
  143170. }): Mesh;
  143171. }
  143172. }
  143173. declare module BABYLON {
  143174. /**
  143175. * A simplifier interface for future simplification implementations
  143176. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  143177. */
  143178. export interface ISimplifier {
  143179. /**
  143180. * Simplification of a given mesh according to the given settings.
  143181. * Since this requires computation, it is assumed that the function runs async.
  143182. * @param settings The settings of the simplification, including quality and distance
  143183. * @param successCallback A callback that will be called after the mesh was simplified.
  143184. * @param errorCallback in case of an error, this callback will be called. optional.
  143185. */
  143186. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  143187. }
  143188. /**
  143189. * Expected simplification settings.
  143190. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  143191. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  143192. */
  143193. export interface ISimplificationSettings {
  143194. /**
  143195. * Gets or sets the expected quality
  143196. */
  143197. quality: number;
  143198. /**
  143199. * Gets or sets the distance when this optimized version should be used
  143200. */
  143201. distance: number;
  143202. /**
  143203. * Gets an already optimized mesh
  143204. */
  143205. optimizeMesh?: boolean;
  143206. }
  143207. /**
  143208. * Class used to specify simplification options
  143209. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  143210. */
  143211. export class SimplificationSettings implements ISimplificationSettings {
  143212. /** expected quality */
  143213. quality: number;
  143214. /** distance when this optimized version should be used */
  143215. distance: number;
  143216. /** already optimized mesh */
  143217. optimizeMesh?: boolean | undefined;
  143218. /**
  143219. * Creates a SimplificationSettings
  143220. * @param quality expected quality
  143221. * @param distance distance when this optimized version should be used
  143222. * @param optimizeMesh already optimized mesh
  143223. */
  143224. constructor(
  143225. /** expected quality */
  143226. quality: number,
  143227. /** distance when this optimized version should be used */
  143228. distance: number,
  143229. /** already optimized mesh */
  143230. optimizeMesh?: boolean | undefined);
  143231. }
  143232. /**
  143233. * Interface used to define a simplification task
  143234. */
  143235. export interface ISimplificationTask {
  143236. /**
  143237. * Array of settings
  143238. */
  143239. settings: Array<ISimplificationSettings>;
  143240. /**
  143241. * Simplification type
  143242. */
  143243. simplificationType: SimplificationType;
  143244. /**
  143245. * Mesh to simplify
  143246. */
  143247. mesh: Mesh;
  143248. /**
  143249. * Callback called on success
  143250. */
  143251. successCallback?: () => void;
  143252. /**
  143253. * Defines if parallel processing can be used
  143254. */
  143255. parallelProcessing: boolean;
  143256. }
  143257. /**
  143258. * Queue used to order the simplification tasks
  143259. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  143260. */
  143261. export class SimplificationQueue {
  143262. private _simplificationArray;
  143263. /**
  143264. * Gets a boolean indicating that the process is still running
  143265. */
  143266. running: boolean;
  143267. /**
  143268. * Creates a new queue
  143269. */
  143270. constructor();
  143271. /**
  143272. * Adds a new simplification task
  143273. * @param task defines a task to add
  143274. */
  143275. addTask(task: ISimplificationTask): void;
  143276. /**
  143277. * Execute next task
  143278. */
  143279. executeNext(): void;
  143280. /**
  143281. * Execute a simplification task
  143282. * @param task defines the task to run
  143283. */
  143284. runSimplification(task: ISimplificationTask): void;
  143285. private getSimplifier;
  143286. }
  143287. /**
  143288. * The implemented types of simplification
  143289. * At the moment only Quadratic Error Decimation is implemented
  143290. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  143291. */
  143292. export enum SimplificationType {
  143293. /** Quadratic error decimation */
  143294. QUADRATIC = 0
  143295. }
  143296. /**
  143297. * An implementation of the Quadratic Error simplification algorithm.
  143298. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  143299. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  143300. * @author RaananW
  143301. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  143302. */
  143303. export class QuadraticErrorSimplification implements ISimplifier {
  143304. private _mesh;
  143305. private triangles;
  143306. private vertices;
  143307. private references;
  143308. private _reconstructedMesh;
  143309. /** Gets or sets the number pf sync interations */
  143310. syncIterations: number;
  143311. /** Gets or sets the aggressiveness of the simplifier */
  143312. aggressiveness: number;
  143313. /** Gets or sets the number of allowed iterations for decimation */
  143314. decimationIterations: number;
  143315. /** Gets or sets the espilon to use for bounding box computation */
  143316. boundingBoxEpsilon: number;
  143317. /**
  143318. * Creates a new QuadraticErrorSimplification
  143319. * @param _mesh defines the target mesh
  143320. */
  143321. constructor(_mesh: Mesh);
  143322. /**
  143323. * Simplification of a given mesh according to the given settings.
  143324. * Since this requires computation, it is assumed that the function runs async.
  143325. * @param settings The settings of the simplification, including quality and distance
  143326. * @param successCallback A callback that will be called after the mesh was simplified.
  143327. */
  143328. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  143329. private runDecimation;
  143330. private initWithMesh;
  143331. private init;
  143332. private reconstructMesh;
  143333. private initDecimatedMesh;
  143334. private isFlipped;
  143335. private updateTriangles;
  143336. private identifyBorder;
  143337. private updateMesh;
  143338. private vertexError;
  143339. private calculateError;
  143340. }
  143341. }
  143342. declare module BABYLON {
  143343. interface Scene {
  143344. /** @hidden (Backing field) */
  143345. _simplificationQueue: SimplificationQueue;
  143346. /**
  143347. * Gets or sets the simplification queue attached to the scene
  143348. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  143349. */
  143350. simplificationQueue: SimplificationQueue;
  143351. }
  143352. interface Mesh {
  143353. /**
  143354. * Simplify the mesh according to the given array of settings.
  143355. * Function will return immediately and will simplify async
  143356. * @param settings a collection of simplification settings
  143357. * @param parallelProcessing should all levels calculate parallel or one after the other
  143358. * @param simplificationType the type of simplification to run
  143359. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  143360. * @returns the current mesh
  143361. */
  143362. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  143363. }
  143364. /**
  143365. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  143366. * created in a scene
  143367. */
  143368. export class SimplicationQueueSceneComponent implements ISceneComponent {
  143369. /**
  143370. * The component name helpfull to identify the component in the list of scene components.
  143371. */
  143372. readonly name: string;
  143373. /**
  143374. * The scene the component belongs to.
  143375. */
  143376. scene: Scene;
  143377. /**
  143378. * Creates a new instance of the component for the given scene
  143379. * @param scene Defines the scene to register the component in
  143380. */
  143381. constructor(scene: Scene);
  143382. /**
  143383. * Registers the component in a given scene
  143384. */
  143385. register(): void;
  143386. /**
  143387. * Rebuilds the elements related to this component in case of
  143388. * context lost for instance.
  143389. */
  143390. rebuild(): void;
  143391. /**
  143392. * Disposes the component and the associated ressources
  143393. */
  143394. dispose(): void;
  143395. private _beforeCameraUpdate;
  143396. }
  143397. }
  143398. declare module BABYLON {
  143399. interface Mesh {
  143400. /**
  143401. * Creates a new thin instance
  143402. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  143403. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  143404. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  143405. */
  143406. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  143407. /**
  143408. * Adds the transformation (matrix) of the current mesh as a thin instance
  143409. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  143410. * @returns the thin instance index number
  143411. */
  143412. thinInstanceAddSelf(refresh: boolean): number;
  143413. /**
  143414. * Registers a custom attribute to be used with thin instances
  143415. * @param kind name of the attribute
  143416. * @param stride size in floats of the attribute
  143417. */
  143418. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  143419. /**
  143420. * Sets the matrix of a thin instance
  143421. * @param index index of the thin instance
  143422. * @param matrix matrix to set
  143423. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  143424. */
  143425. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  143426. /**
  143427. * Sets the value of a custom attribute for a thin instance
  143428. * @param kind name of the attribute
  143429. * @param index index of the thin instance
  143430. * @param value value to set
  143431. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  143432. */
  143433. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  143434. /**
  143435. * Gets / sets the number of thin instances to display. Note that you can't set a number higher than what the underlying buffer can handle.
  143436. */
  143437. thinInstanceCount: number;
  143438. /**
  143439. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  143440. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  143441. * @param buffer buffer to set
  143442. * @param stride size in floats of each value of the buffer
  143443. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  143444. */
  143445. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  143446. /**
  143447. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  143448. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  143449. */
  143450. thinInstanceBufferUpdated(kind: string): void;
  143451. /**
  143452. * Refreshes the bounding info, taking into account all the thin instances defined
  143453. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  143454. */
  143455. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  143456. /** @hidden */
  143457. _thinInstanceInitializeUserStorage(): void;
  143458. /** @hidden */
  143459. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  143460. /** @hidden */
  143461. _userThinInstanceBuffersStorage: {
  143462. data: {
  143463. [key: string]: Float32Array;
  143464. };
  143465. sizes: {
  143466. [key: string]: number;
  143467. };
  143468. vertexBuffers: {
  143469. [key: string]: Nullable<VertexBuffer>;
  143470. };
  143471. strides: {
  143472. [key: string]: number;
  143473. };
  143474. };
  143475. }
  143476. }
  143477. declare module BABYLON {
  143478. /**
  143479. * Navigation plugin interface to add navigation constrained by a navigation mesh
  143480. */
  143481. export interface INavigationEnginePlugin {
  143482. /**
  143483. * plugin name
  143484. */
  143485. name: string;
  143486. /**
  143487. * Creates a navigation mesh
  143488. * @param meshes array of all the geometry used to compute the navigatio mesh
  143489. * @param parameters bunch of parameters used to filter geometry
  143490. */
  143491. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  143492. /**
  143493. * Create a navigation mesh debug mesh
  143494. * @param scene is where the mesh will be added
  143495. * @returns debug display mesh
  143496. */
  143497. createDebugNavMesh(scene: Scene): Mesh;
  143498. /**
  143499. * Get a navigation mesh constrained position, closest to the parameter position
  143500. * @param position world position
  143501. * @returns the closest point to position constrained by the navigation mesh
  143502. */
  143503. getClosestPoint(position: Vector3): Vector3;
  143504. /**
  143505. * Get a navigation mesh constrained position, closest to the parameter position
  143506. * @param position world position
  143507. * @param result output the closest point to position constrained by the navigation mesh
  143508. */
  143509. getClosestPointToRef(position: Vector3, result: Vector3): void;
  143510. /**
  143511. * Get a navigation mesh constrained position, within a particular radius
  143512. * @param position world position
  143513. * @param maxRadius the maximum distance to the constrained world position
  143514. * @returns the closest point to position constrained by the navigation mesh
  143515. */
  143516. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  143517. /**
  143518. * Get a navigation mesh constrained position, within a particular radius
  143519. * @param position world position
  143520. * @param maxRadius the maximum distance to the constrained world position
  143521. * @param result output the closest point to position constrained by the navigation mesh
  143522. */
  143523. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  143524. /**
  143525. * Compute the final position from a segment made of destination-position
  143526. * @param position world position
  143527. * @param destination world position
  143528. * @returns the resulting point along the navmesh
  143529. */
  143530. moveAlong(position: Vector3, destination: Vector3): Vector3;
  143531. /**
  143532. * Compute the final position from a segment made of destination-position
  143533. * @param position world position
  143534. * @param destination world position
  143535. * @param result output the resulting point along the navmesh
  143536. */
  143537. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  143538. /**
  143539. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  143540. * @param start world position
  143541. * @param end world position
  143542. * @returns array containing world position composing the path
  143543. */
  143544. computePath(start: Vector3, end: Vector3): Vector3[];
  143545. /**
  143546. * If this plugin is supported
  143547. * @returns true if plugin is supported
  143548. */
  143549. isSupported(): boolean;
  143550. /**
  143551. * Create a new Crowd so you can add agents
  143552. * @param maxAgents the maximum agent count in the crowd
  143553. * @param maxAgentRadius the maximum radius an agent can have
  143554. * @param scene to attach the crowd to
  143555. * @returns the crowd you can add agents to
  143556. */
  143557. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  143558. /**
  143559. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  143560. * The queries will try to find a solution within those bounds
  143561. * default is (1,1,1)
  143562. * @param extent x,y,z value that define the extent around the queries point of reference
  143563. */
  143564. setDefaultQueryExtent(extent: Vector3): void;
  143565. /**
  143566. * Get the Bounding box extent specified by setDefaultQueryExtent
  143567. * @returns the box extent values
  143568. */
  143569. getDefaultQueryExtent(): Vector3;
  143570. /**
  143571. * build the navmesh from a previously saved state using getNavmeshData
  143572. * @param data the Uint8Array returned by getNavmeshData
  143573. */
  143574. buildFromNavmeshData(data: Uint8Array): void;
  143575. /**
  143576. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  143577. * @returns data the Uint8Array that can be saved and reused
  143578. */
  143579. getNavmeshData(): Uint8Array;
  143580. /**
  143581. * Get the Bounding box extent result specified by setDefaultQueryExtent
  143582. * @param result output the box extent values
  143583. */
  143584. getDefaultQueryExtentToRef(result: Vector3): void;
  143585. /**
  143586. * Release all resources
  143587. */
  143588. dispose(): void;
  143589. }
  143590. /**
  143591. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  143592. */
  143593. export interface ICrowd {
  143594. /**
  143595. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  143596. * You can attach anything to that node. The node position is updated in the scene update tick.
  143597. * @param pos world position that will be constrained by the navigation mesh
  143598. * @param parameters agent parameters
  143599. * @param transform hooked to the agent that will be update by the scene
  143600. * @returns agent index
  143601. */
  143602. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  143603. /**
  143604. * Returns the agent position in world space
  143605. * @param index agent index returned by addAgent
  143606. * @returns world space position
  143607. */
  143608. getAgentPosition(index: number): Vector3;
  143609. /**
  143610. * Gets the agent position result in world space
  143611. * @param index agent index returned by addAgent
  143612. * @param result output world space position
  143613. */
  143614. getAgentPositionToRef(index: number, result: Vector3): void;
  143615. /**
  143616. * Gets the agent velocity in world space
  143617. * @param index agent index returned by addAgent
  143618. * @returns world space velocity
  143619. */
  143620. getAgentVelocity(index: number): Vector3;
  143621. /**
  143622. * Gets the agent velocity result in world space
  143623. * @param index agent index returned by addAgent
  143624. * @param result output world space velocity
  143625. */
  143626. getAgentVelocityToRef(index: number, result: Vector3): void;
  143627. /**
  143628. * remove a particular agent previously created
  143629. * @param index agent index returned by addAgent
  143630. */
  143631. removeAgent(index: number): void;
  143632. /**
  143633. * get the list of all agents attached to this crowd
  143634. * @returns list of agent indices
  143635. */
  143636. getAgents(): number[];
  143637. /**
  143638. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  143639. * @param deltaTime in seconds
  143640. */
  143641. update(deltaTime: number): void;
  143642. /**
  143643. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  143644. * @param index agent index returned by addAgent
  143645. * @param destination targeted world position
  143646. */
  143647. agentGoto(index: number, destination: Vector3): void;
  143648. /**
  143649. * Teleport the agent to a new position
  143650. * @param index agent index returned by addAgent
  143651. * @param destination targeted world position
  143652. */
  143653. agentTeleport(index: number, destination: Vector3): void;
  143654. /**
  143655. * Update agent parameters
  143656. * @param index agent index returned by addAgent
  143657. * @param parameters agent parameters
  143658. */
  143659. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  143660. /**
  143661. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  143662. * The queries will try to find a solution within those bounds
  143663. * default is (1,1,1)
  143664. * @param extent x,y,z value that define the extent around the queries point of reference
  143665. */
  143666. setDefaultQueryExtent(extent: Vector3): void;
  143667. /**
  143668. * Get the Bounding box extent specified by setDefaultQueryExtent
  143669. * @returns the box extent values
  143670. */
  143671. getDefaultQueryExtent(): Vector3;
  143672. /**
  143673. * Get the Bounding box extent result specified by setDefaultQueryExtent
  143674. * @param result output the box extent values
  143675. */
  143676. getDefaultQueryExtentToRef(result: Vector3): void;
  143677. /**
  143678. * Release all resources
  143679. */
  143680. dispose(): void;
  143681. }
  143682. /**
  143683. * Configures an agent
  143684. */
  143685. export interface IAgentParameters {
  143686. /**
  143687. * Agent radius. [Limit: >= 0]
  143688. */
  143689. radius: number;
  143690. /**
  143691. * Agent height. [Limit: > 0]
  143692. */
  143693. height: number;
  143694. /**
  143695. * Maximum allowed acceleration. [Limit: >= 0]
  143696. */
  143697. maxAcceleration: number;
  143698. /**
  143699. * Maximum allowed speed. [Limit: >= 0]
  143700. */
  143701. maxSpeed: number;
  143702. /**
  143703. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  143704. */
  143705. collisionQueryRange: number;
  143706. /**
  143707. * The path visibility optimization range. [Limit: > 0]
  143708. */
  143709. pathOptimizationRange: number;
  143710. /**
  143711. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  143712. */
  143713. separationWeight: number;
  143714. }
  143715. /**
  143716. * Configures the navigation mesh creation
  143717. */
  143718. export interface INavMeshParameters {
  143719. /**
  143720. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  143721. */
  143722. cs: number;
  143723. /**
  143724. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  143725. */
  143726. ch: number;
  143727. /**
  143728. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  143729. */
  143730. walkableSlopeAngle: number;
  143731. /**
  143732. * Minimum floor to 'ceiling' height that will still allow the floor area to
  143733. * be considered walkable. [Limit: >= 3] [Units: vx]
  143734. */
  143735. walkableHeight: number;
  143736. /**
  143737. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  143738. */
  143739. walkableClimb: number;
  143740. /**
  143741. * The distance to erode/shrink the walkable area of the heightfield away from
  143742. * obstructions. [Limit: >=0] [Units: vx]
  143743. */
  143744. walkableRadius: number;
  143745. /**
  143746. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  143747. */
  143748. maxEdgeLen: number;
  143749. /**
  143750. * The maximum distance a simplfied contour's border edges should deviate
  143751. * the original raw contour. [Limit: >=0] [Units: vx]
  143752. */
  143753. maxSimplificationError: number;
  143754. /**
  143755. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  143756. */
  143757. minRegionArea: number;
  143758. /**
  143759. * Any regions with a span count smaller than this value will, if possible,
  143760. * be merged with larger regions. [Limit: >=0] [Units: vx]
  143761. */
  143762. mergeRegionArea: number;
  143763. /**
  143764. * The maximum number of vertices allowed for polygons generated during the
  143765. * contour to polygon conversion process. [Limit: >= 3]
  143766. */
  143767. maxVertsPerPoly: number;
  143768. /**
  143769. * Sets the sampling distance to use when generating the detail mesh.
  143770. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  143771. */
  143772. detailSampleDist: number;
  143773. /**
  143774. * The maximum distance the detail mesh surface should deviate from heightfield
  143775. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  143776. */
  143777. detailSampleMaxError: number;
  143778. }
  143779. }
  143780. declare module BABYLON {
  143781. /**
  143782. * RecastJS navigation plugin
  143783. */
  143784. export class RecastJSPlugin implements INavigationEnginePlugin {
  143785. /**
  143786. * Reference to the Recast library
  143787. */
  143788. bjsRECAST: any;
  143789. /**
  143790. * plugin name
  143791. */
  143792. name: string;
  143793. /**
  143794. * the first navmesh created. We might extend this to support multiple navmeshes
  143795. */
  143796. navMesh: any;
  143797. /**
  143798. * Initializes the recastJS plugin
  143799. * @param recastInjection can be used to inject your own recast reference
  143800. */
  143801. constructor(recastInjection?: any);
  143802. /**
  143803. * Creates a navigation mesh
  143804. * @param meshes array of all the geometry used to compute the navigatio mesh
  143805. * @param parameters bunch of parameters used to filter geometry
  143806. */
  143807. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  143808. /**
  143809. * Create a navigation mesh debug mesh
  143810. * @param scene is where the mesh will be added
  143811. * @returns debug display mesh
  143812. */
  143813. createDebugNavMesh(scene: Scene): Mesh;
  143814. /**
  143815. * Get a navigation mesh constrained position, closest to the parameter position
  143816. * @param position world position
  143817. * @returns the closest point to position constrained by the navigation mesh
  143818. */
  143819. getClosestPoint(position: Vector3): Vector3;
  143820. /**
  143821. * Get a navigation mesh constrained position, closest to the parameter position
  143822. * @param position world position
  143823. * @param result output the closest point to position constrained by the navigation mesh
  143824. */
  143825. getClosestPointToRef(position: Vector3, result: Vector3): void;
  143826. /**
  143827. * Get a navigation mesh constrained position, within a particular radius
  143828. * @param position world position
  143829. * @param maxRadius the maximum distance to the constrained world position
  143830. * @returns the closest point to position constrained by the navigation mesh
  143831. */
  143832. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  143833. /**
  143834. * Get a navigation mesh constrained position, within a particular radius
  143835. * @param position world position
  143836. * @param maxRadius the maximum distance to the constrained world position
  143837. * @param result output the closest point to position constrained by the navigation mesh
  143838. */
  143839. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  143840. /**
  143841. * Compute the final position from a segment made of destination-position
  143842. * @param position world position
  143843. * @param destination world position
  143844. * @returns the resulting point along the navmesh
  143845. */
  143846. moveAlong(position: Vector3, destination: Vector3): Vector3;
  143847. /**
  143848. * Compute the final position from a segment made of destination-position
  143849. * @param position world position
  143850. * @param destination world position
  143851. * @param result output the resulting point along the navmesh
  143852. */
  143853. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  143854. /**
  143855. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  143856. * @param start world position
  143857. * @param end world position
  143858. * @returns array containing world position composing the path
  143859. */
  143860. computePath(start: Vector3, end: Vector3): Vector3[];
  143861. /**
  143862. * Create a new Crowd so you can add agents
  143863. * @param maxAgents the maximum agent count in the crowd
  143864. * @param maxAgentRadius the maximum radius an agent can have
  143865. * @param scene to attach the crowd to
  143866. * @returns the crowd you can add agents to
  143867. */
  143868. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  143869. /**
  143870. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  143871. * The queries will try to find a solution within those bounds
  143872. * default is (1,1,1)
  143873. * @param extent x,y,z value that define the extent around the queries point of reference
  143874. */
  143875. setDefaultQueryExtent(extent: Vector3): void;
  143876. /**
  143877. * Get the Bounding box extent specified by setDefaultQueryExtent
  143878. * @returns the box extent values
  143879. */
  143880. getDefaultQueryExtent(): Vector3;
  143881. /**
  143882. * build the navmesh from a previously saved state using getNavmeshData
  143883. * @param data the Uint8Array returned by getNavmeshData
  143884. */
  143885. buildFromNavmeshData(data: Uint8Array): void;
  143886. /**
  143887. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  143888. * @returns data the Uint8Array that can be saved and reused
  143889. */
  143890. getNavmeshData(): Uint8Array;
  143891. /**
  143892. * Get the Bounding box extent result specified by setDefaultQueryExtent
  143893. * @param result output the box extent values
  143894. */
  143895. getDefaultQueryExtentToRef(result: Vector3): void;
  143896. /**
  143897. * Disposes
  143898. */
  143899. dispose(): void;
  143900. /**
  143901. * If this plugin is supported
  143902. * @returns true if plugin is supported
  143903. */
  143904. isSupported(): boolean;
  143905. }
  143906. /**
  143907. * Recast detour crowd implementation
  143908. */
  143909. export class RecastJSCrowd implements ICrowd {
  143910. /**
  143911. * Recast/detour plugin
  143912. */
  143913. bjsRECASTPlugin: RecastJSPlugin;
  143914. /**
  143915. * Link to the detour crowd
  143916. */
  143917. recastCrowd: any;
  143918. /**
  143919. * One transform per agent
  143920. */
  143921. transforms: TransformNode[];
  143922. /**
  143923. * All agents created
  143924. */
  143925. agents: number[];
  143926. /**
  143927. * Link to the scene is kept to unregister the crowd from the scene
  143928. */
  143929. private _scene;
  143930. /**
  143931. * Observer for crowd updates
  143932. */
  143933. private _onBeforeAnimationsObserver;
  143934. /**
  143935. * Constructor
  143936. * @param plugin recastJS plugin
  143937. * @param maxAgents the maximum agent count in the crowd
  143938. * @param maxAgentRadius the maximum radius an agent can have
  143939. * @param scene to attach the crowd to
  143940. * @returns the crowd you can add agents to
  143941. */
  143942. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  143943. /**
  143944. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  143945. * You can attach anything to that node. The node position is updated in the scene update tick.
  143946. * @param pos world position that will be constrained by the navigation mesh
  143947. * @param parameters agent parameters
  143948. * @param transform hooked to the agent that will be update by the scene
  143949. * @returns agent index
  143950. */
  143951. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  143952. /**
  143953. * Returns the agent position in world space
  143954. * @param index agent index returned by addAgent
  143955. * @returns world space position
  143956. */
  143957. getAgentPosition(index: number): Vector3;
  143958. /**
  143959. * Returns the agent position result in world space
  143960. * @param index agent index returned by addAgent
  143961. * @param result output world space position
  143962. */
  143963. getAgentPositionToRef(index: number, result: Vector3): void;
  143964. /**
  143965. * Returns the agent velocity in world space
  143966. * @param index agent index returned by addAgent
  143967. * @returns world space velocity
  143968. */
  143969. getAgentVelocity(index: number): Vector3;
  143970. /**
  143971. * Returns the agent velocity result in world space
  143972. * @param index agent index returned by addAgent
  143973. * @param result output world space velocity
  143974. */
  143975. getAgentVelocityToRef(index: number, result: Vector3): void;
  143976. /**
  143977. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  143978. * @param index agent index returned by addAgent
  143979. * @param destination targeted world position
  143980. */
  143981. agentGoto(index: number, destination: Vector3): void;
  143982. /**
  143983. * Teleport the agent to a new position
  143984. * @param index agent index returned by addAgent
  143985. * @param destination targeted world position
  143986. */
  143987. agentTeleport(index: number, destination: Vector3): void;
  143988. /**
  143989. * Update agent parameters
  143990. * @param index agent index returned by addAgent
  143991. * @param parameters agent parameters
  143992. */
  143993. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  143994. /**
  143995. * remove a particular agent previously created
  143996. * @param index agent index returned by addAgent
  143997. */
  143998. removeAgent(index: number): void;
  143999. /**
  144000. * get the list of all agents attached to this crowd
  144001. * @returns list of agent indices
  144002. */
  144003. getAgents(): number[];
  144004. /**
  144005. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  144006. * @param deltaTime in seconds
  144007. */
  144008. update(deltaTime: number): void;
  144009. /**
  144010. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  144011. * The queries will try to find a solution within those bounds
  144012. * default is (1,1,1)
  144013. * @param extent x,y,z value that define the extent around the queries point of reference
  144014. */
  144015. setDefaultQueryExtent(extent: Vector3): void;
  144016. /**
  144017. * Get the Bounding box extent specified by setDefaultQueryExtent
  144018. * @returns the box extent values
  144019. */
  144020. getDefaultQueryExtent(): Vector3;
  144021. /**
  144022. * Get the Bounding box extent result specified by setDefaultQueryExtent
  144023. * @param result output the box extent values
  144024. */
  144025. getDefaultQueryExtentToRef(result: Vector3): void;
  144026. /**
  144027. * Release all resources
  144028. */
  144029. dispose(): void;
  144030. }
  144031. }
  144032. declare module BABYLON {
  144033. /**
  144034. * Class used to enable access to IndexedDB
  144035. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  144036. */
  144037. export class Database implements IOfflineProvider {
  144038. private _callbackManifestChecked;
  144039. private _currentSceneUrl;
  144040. private _db;
  144041. private _enableSceneOffline;
  144042. private _enableTexturesOffline;
  144043. private _manifestVersionFound;
  144044. private _mustUpdateRessources;
  144045. private _hasReachedQuota;
  144046. private _isSupported;
  144047. private _idbFactory;
  144048. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  144049. private static IsUASupportingBlobStorage;
  144050. /**
  144051. * Gets a boolean indicating if Database storate is enabled (off by default)
  144052. */
  144053. static IDBStorageEnabled: boolean;
  144054. /**
  144055. * Gets a boolean indicating if scene must be saved in the database
  144056. */
  144057. get enableSceneOffline(): boolean;
  144058. /**
  144059. * Gets a boolean indicating if textures must be saved in the database
  144060. */
  144061. get enableTexturesOffline(): boolean;
  144062. /**
  144063. * Creates a new Database
  144064. * @param urlToScene defines the url to load the scene
  144065. * @param callbackManifestChecked defines the callback to use when manifest is checked
  144066. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  144067. */
  144068. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  144069. private static _ParseURL;
  144070. private static _ReturnFullUrlLocation;
  144071. private _checkManifestFile;
  144072. /**
  144073. * Open the database and make it available
  144074. * @param successCallback defines the callback to call on success
  144075. * @param errorCallback defines the callback to call on error
  144076. */
  144077. open(successCallback: () => void, errorCallback: () => void): void;
  144078. /**
  144079. * Loads an image from the database
  144080. * @param url defines the url to load from
  144081. * @param image defines the target DOM image
  144082. */
  144083. loadImage(url: string, image: HTMLImageElement): void;
  144084. private _loadImageFromDBAsync;
  144085. private _saveImageIntoDBAsync;
  144086. private _checkVersionFromDB;
  144087. private _loadVersionFromDBAsync;
  144088. private _saveVersionIntoDBAsync;
  144089. /**
  144090. * Loads a file from database
  144091. * @param url defines the URL to load from
  144092. * @param sceneLoaded defines a callback to call on success
  144093. * @param progressCallBack defines a callback to call when progress changed
  144094. * @param errorCallback defines a callback to call on error
  144095. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  144096. */
  144097. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  144098. private _loadFileAsync;
  144099. private _saveFileAsync;
  144100. /**
  144101. * Validates if xhr data is correct
  144102. * @param xhr defines the request to validate
  144103. * @param dataType defines the expected data type
  144104. * @returns true if data is correct
  144105. */
  144106. private static _ValidateXHRData;
  144107. }
  144108. }
  144109. declare module BABYLON {
  144110. /** @hidden */
  144111. export var gpuUpdateParticlesPixelShader: {
  144112. name: string;
  144113. shader: string;
  144114. };
  144115. }
  144116. declare module BABYLON {
  144117. /** @hidden */
  144118. export var gpuUpdateParticlesVertexShader: {
  144119. name: string;
  144120. shader: string;
  144121. };
  144122. }
  144123. declare module BABYLON {
  144124. /** @hidden */
  144125. export var clipPlaneFragmentDeclaration2: {
  144126. name: string;
  144127. shader: string;
  144128. };
  144129. }
  144130. declare module BABYLON {
  144131. /** @hidden */
  144132. export var gpuRenderParticlesPixelShader: {
  144133. name: string;
  144134. shader: string;
  144135. };
  144136. }
  144137. declare module BABYLON {
  144138. /** @hidden */
  144139. export var clipPlaneVertexDeclaration2: {
  144140. name: string;
  144141. shader: string;
  144142. };
  144143. }
  144144. declare module BABYLON {
  144145. /** @hidden */
  144146. export var gpuRenderParticlesVertexShader: {
  144147. name: string;
  144148. shader: string;
  144149. };
  144150. }
  144151. declare module BABYLON {
  144152. /**
  144153. * This represents a GPU particle system in Babylon
  144154. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  144155. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  144156. */
  144157. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  144158. /**
  144159. * The layer mask we are rendering the particles through.
  144160. */
  144161. layerMask: number;
  144162. private _capacity;
  144163. private _activeCount;
  144164. private _currentActiveCount;
  144165. private _accumulatedCount;
  144166. private _renderEffect;
  144167. private _updateEffect;
  144168. private _buffer0;
  144169. private _buffer1;
  144170. private _spriteBuffer;
  144171. private _updateVAO;
  144172. private _renderVAO;
  144173. private _targetIndex;
  144174. private _sourceBuffer;
  144175. private _targetBuffer;
  144176. private _engine;
  144177. private _currentRenderId;
  144178. private _started;
  144179. private _stopped;
  144180. private _timeDelta;
  144181. private _randomTexture;
  144182. private _randomTexture2;
  144183. private _attributesStrideSize;
  144184. private _updateEffectOptions;
  144185. private _randomTextureSize;
  144186. private _actualFrame;
  144187. private _customEffect;
  144188. private readonly _rawTextureWidth;
  144189. /**
  144190. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  144191. */
  144192. static get IsSupported(): boolean;
  144193. /**
  144194. * An event triggered when the system is disposed.
  144195. */
  144196. onDisposeObservable: Observable<IParticleSystem>;
  144197. /**
  144198. * Gets the maximum number of particles active at the same time.
  144199. * @returns The max number of active particles.
  144200. */
  144201. getCapacity(): number;
  144202. /**
  144203. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  144204. * to override the particles.
  144205. */
  144206. forceDepthWrite: boolean;
  144207. /**
  144208. * Gets or set the number of active particles
  144209. */
  144210. get activeParticleCount(): number;
  144211. set activeParticleCount(value: number);
  144212. private _preWarmDone;
  144213. /**
  144214. * Specifies if the particles are updated in emitter local space or world space.
  144215. */
  144216. isLocal: boolean;
  144217. /**
  144218. * Is this system ready to be used/rendered
  144219. * @return true if the system is ready
  144220. */
  144221. isReady(): boolean;
  144222. /**
  144223. * Gets if the system has been started. (Note: this will still be true after stop is called)
  144224. * @returns True if it has been started, otherwise false.
  144225. */
  144226. isStarted(): boolean;
  144227. /**
  144228. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  144229. * @returns True if it has been stopped, otherwise false.
  144230. */
  144231. isStopped(): boolean;
  144232. /**
  144233. * Gets a boolean indicating that the system is stopping
  144234. * @returns true if the system is currently stopping
  144235. */
  144236. isStopping(): boolean;
  144237. /**
  144238. * Gets the number of particles active at the same time.
  144239. * @returns The number of active particles.
  144240. */
  144241. getActiveCount(): number;
  144242. /**
  144243. * Starts the particle system and begins to emit
  144244. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  144245. */
  144246. start(delay?: number): void;
  144247. /**
  144248. * Stops the particle system.
  144249. */
  144250. stop(): void;
  144251. /**
  144252. * Remove all active particles
  144253. */
  144254. reset(): void;
  144255. /**
  144256. * Returns the string "GPUParticleSystem"
  144257. * @returns a string containing the class name
  144258. */
  144259. getClassName(): string;
  144260. /**
  144261. * Gets the custom effect used to render the particles
  144262. * @param blendMode Blend mode for which the effect should be retrieved
  144263. * @returns The effect
  144264. */
  144265. getCustomEffect(blendMode?: number): Nullable<Effect>;
  144266. /**
  144267. * Sets the custom effect used to render the particles
  144268. * @param effect The effect to set
  144269. * @param blendMode Blend mode for which the effect should be set
  144270. */
  144271. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  144272. /** @hidden */
  144273. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  144274. /**
  144275. * Observable that will be called just before the particles are drawn
  144276. */
  144277. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  144278. /**
  144279. * Gets the name of the particle vertex shader
  144280. */
  144281. get vertexShaderName(): string;
  144282. private _colorGradientsTexture;
  144283. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  144284. /**
  144285. * Adds a new color gradient
  144286. * @param gradient defines the gradient to use (between 0 and 1)
  144287. * @param color1 defines the color to affect to the specified gradient
  144288. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  144289. * @returns the current particle system
  144290. */
  144291. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  144292. private _refreshColorGradient;
  144293. /** Force the system to rebuild all gradients that need to be resync */
  144294. forceRefreshGradients(): void;
  144295. /**
  144296. * Remove a specific color gradient
  144297. * @param gradient defines the gradient to remove
  144298. * @returns the current particle system
  144299. */
  144300. removeColorGradient(gradient: number): GPUParticleSystem;
  144301. private _angularSpeedGradientsTexture;
  144302. private _sizeGradientsTexture;
  144303. private _velocityGradientsTexture;
  144304. private _limitVelocityGradientsTexture;
  144305. private _dragGradientsTexture;
  144306. private _addFactorGradient;
  144307. /**
  144308. * Adds a new size gradient
  144309. * @param gradient defines the gradient to use (between 0 and 1)
  144310. * @param factor defines the size factor to affect to the specified gradient
  144311. * @returns the current particle system
  144312. */
  144313. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  144314. /**
  144315. * Remove a specific size gradient
  144316. * @param gradient defines the gradient to remove
  144317. * @returns the current particle system
  144318. */
  144319. removeSizeGradient(gradient: number): GPUParticleSystem;
  144320. private _refreshFactorGradient;
  144321. /**
  144322. * Adds a new angular speed gradient
  144323. * @param gradient defines the gradient to use (between 0 and 1)
  144324. * @param factor defines the angular speed to affect to the specified gradient
  144325. * @returns the current particle system
  144326. */
  144327. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  144328. /**
  144329. * Remove a specific angular speed gradient
  144330. * @param gradient defines the gradient to remove
  144331. * @returns the current particle system
  144332. */
  144333. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  144334. /**
  144335. * Adds a new velocity gradient
  144336. * @param gradient defines the gradient to use (between 0 and 1)
  144337. * @param factor defines the velocity to affect to the specified gradient
  144338. * @returns the current particle system
  144339. */
  144340. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  144341. /**
  144342. * Remove a specific velocity gradient
  144343. * @param gradient defines the gradient to remove
  144344. * @returns the current particle system
  144345. */
  144346. removeVelocityGradient(gradient: number): GPUParticleSystem;
  144347. /**
  144348. * Adds a new limit velocity gradient
  144349. * @param gradient defines the gradient to use (between 0 and 1)
  144350. * @param factor defines the limit velocity value to affect to the specified gradient
  144351. * @returns the current particle system
  144352. */
  144353. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  144354. /**
  144355. * Remove a specific limit velocity gradient
  144356. * @param gradient defines the gradient to remove
  144357. * @returns the current particle system
  144358. */
  144359. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  144360. /**
  144361. * Adds a new drag gradient
  144362. * @param gradient defines the gradient to use (between 0 and 1)
  144363. * @param factor defines the drag value to affect to the specified gradient
  144364. * @returns the current particle system
  144365. */
  144366. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  144367. /**
  144368. * Remove a specific drag gradient
  144369. * @param gradient defines the gradient to remove
  144370. * @returns the current particle system
  144371. */
  144372. removeDragGradient(gradient: number): GPUParticleSystem;
  144373. /**
  144374. * Not supported by GPUParticleSystem
  144375. * @param gradient defines the gradient to use (between 0 and 1)
  144376. * @param factor defines the emit rate value to affect to the specified gradient
  144377. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  144378. * @returns the current particle system
  144379. */
  144380. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  144381. /**
  144382. * Not supported by GPUParticleSystem
  144383. * @param gradient defines the gradient to remove
  144384. * @returns the current particle system
  144385. */
  144386. removeEmitRateGradient(gradient: number): IParticleSystem;
  144387. /**
  144388. * Not supported by GPUParticleSystem
  144389. * @param gradient defines the gradient to use (between 0 and 1)
  144390. * @param factor defines the start size value to affect to the specified gradient
  144391. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  144392. * @returns the current particle system
  144393. */
  144394. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  144395. /**
  144396. * Not supported by GPUParticleSystem
  144397. * @param gradient defines the gradient to remove
  144398. * @returns the current particle system
  144399. */
  144400. removeStartSizeGradient(gradient: number): IParticleSystem;
  144401. /**
  144402. * Not supported by GPUParticleSystem
  144403. * @param gradient defines the gradient to use (between 0 and 1)
  144404. * @param min defines the color remap minimal range
  144405. * @param max defines the color remap maximal range
  144406. * @returns the current particle system
  144407. */
  144408. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  144409. /**
  144410. * Not supported by GPUParticleSystem
  144411. * @param gradient defines the gradient to remove
  144412. * @returns the current particle system
  144413. */
  144414. removeColorRemapGradient(): IParticleSystem;
  144415. /**
  144416. * Not supported by GPUParticleSystem
  144417. * @param gradient defines the gradient to use (between 0 and 1)
  144418. * @param min defines the alpha remap minimal range
  144419. * @param max defines the alpha remap maximal range
  144420. * @returns the current particle system
  144421. */
  144422. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  144423. /**
  144424. * Not supported by GPUParticleSystem
  144425. * @param gradient defines the gradient to remove
  144426. * @returns the current particle system
  144427. */
  144428. removeAlphaRemapGradient(): IParticleSystem;
  144429. /**
  144430. * Not supported by GPUParticleSystem
  144431. * @param gradient defines the gradient to use (between 0 and 1)
  144432. * @param color defines the color to affect to the specified gradient
  144433. * @returns the current particle system
  144434. */
  144435. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  144436. /**
  144437. * Not supported by GPUParticleSystem
  144438. * @param gradient defines the gradient to remove
  144439. * @returns the current particle system
  144440. */
  144441. removeRampGradient(): IParticleSystem;
  144442. /**
  144443. * Not supported by GPUParticleSystem
  144444. * @returns the list of ramp gradients
  144445. */
  144446. getRampGradients(): Nullable<Array<Color3Gradient>>;
  144447. /**
  144448. * Not supported by GPUParticleSystem
  144449. * Gets or sets a boolean indicating that ramp gradients must be used
  144450. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  144451. */
  144452. get useRampGradients(): boolean;
  144453. set useRampGradients(value: boolean);
  144454. /**
  144455. * Not supported by GPUParticleSystem
  144456. * @param gradient defines the gradient to use (between 0 and 1)
  144457. * @param factor defines the life time factor to affect to the specified gradient
  144458. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  144459. * @returns the current particle system
  144460. */
  144461. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  144462. /**
  144463. * Not supported by GPUParticleSystem
  144464. * @param gradient defines the gradient to remove
  144465. * @returns the current particle system
  144466. */
  144467. removeLifeTimeGradient(gradient: number): IParticleSystem;
  144468. /**
  144469. * Instantiates a GPU particle system.
  144470. * 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.
  144471. * @param name The name of the particle system
  144472. * @param options The options used to create the system
  144473. * @param scene The scene the particle system belongs to
  144474. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  144475. * @param customEffect a custom effect used to change the way particles are rendered by default
  144476. */
  144477. constructor(name: string, options: Partial<{
  144478. capacity: number;
  144479. randomTextureSize: number;
  144480. }>, scene: Scene, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  144481. protected _reset(): void;
  144482. private _createUpdateVAO;
  144483. private _createRenderVAO;
  144484. private _initialize;
  144485. /** @hidden */
  144486. _recreateUpdateEffect(): void;
  144487. private _getEffect;
  144488. /**
  144489. * Fill the defines array according to the current settings of the particle system
  144490. * @param defines Array to be updated
  144491. * @param blendMode blend mode to take into account when updating the array
  144492. */
  144493. fillDefines(defines: Array<string>, blendMode?: number): void;
  144494. /**
  144495. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  144496. * @param uniforms Uniforms array to fill
  144497. * @param attributes Attributes array to fill
  144498. * @param samplers Samplers array to fill
  144499. */
  144500. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  144501. /** @hidden */
  144502. _recreateRenderEffect(): Effect;
  144503. /**
  144504. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  144505. * @param preWarm defines if we are in the pre-warmimg phase
  144506. */
  144507. animate(preWarm?: boolean): void;
  144508. private _createFactorGradientTexture;
  144509. private _createSizeGradientTexture;
  144510. private _createAngularSpeedGradientTexture;
  144511. private _createVelocityGradientTexture;
  144512. private _createLimitVelocityGradientTexture;
  144513. private _createDragGradientTexture;
  144514. private _createColorGradientTexture;
  144515. /**
  144516. * Renders the particle system in its current state
  144517. * @param preWarm defines if the system should only update the particles but not render them
  144518. * @returns the current number of particles
  144519. */
  144520. render(preWarm?: boolean): number;
  144521. /**
  144522. * Rebuilds the particle system
  144523. */
  144524. rebuild(): void;
  144525. private _releaseBuffers;
  144526. private _releaseVAOs;
  144527. /**
  144528. * Disposes the particle system and free the associated resources
  144529. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  144530. */
  144531. dispose(disposeTexture?: boolean): void;
  144532. /**
  144533. * Clones the particle system.
  144534. * @param name The name of the cloned object
  144535. * @param newEmitter The new emitter to use
  144536. * @returns the cloned particle system
  144537. */
  144538. clone(name: string, newEmitter: any): GPUParticleSystem;
  144539. /**
  144540. * Serializes the particle system to a JSON object
  144541. * @param serializeTexture defines if the texture must be serialized as well
  144542. * @returns the JSON object
  144543. */
  144544. serialize(serializeTexture?: boolean): any;
  144545. /**
  144546. * Parses a JSON object to create a GPU particle system.
  144547. * @param parsedParticleSystem The JSON object to parse
  144548. * @param scene The scene to create the particle system in
  144549. * @param rootUrl The root url to use to load external dependencies like texture
  144550. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  144551. * @returns the parsed GPU particle system
  144552. */
  144553. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  144554. }
  144555. }
  144556. declare module BABYLON {
  144557. /**
  144558. * Represents a set of particle systems working together to create a specific effect
  144559. */
  144560. export class ParticleSystemSet implements IDisposable {
  144561. /**
  144562. * Gets or sets base Assets URL
  144563. */
  144564. static BaseAssetsUrl: string;
  144565. private _emitterCreationOptions;
  144566. private _emitterNode;
  144567. /**
  144568. * Gets the particle system list
  144569. */
  144570. systems: IParticleSystem[];
  144571. /**
  144572. * Gets the emitter node used with this set
  144573. */
  144574. get emitterNode(): Nullable<TransformNode>;
  144575. /**
  144576. * Creates a new emitter mesh as a sphere
  144577. * @param options defines the options used to create the sphere
  144578. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  144579. * @param scene defines the hosting scene
  144580. */
  144581. setEmitterAsSphere(options: {
  144582. diameter: number;
  144583. segments: number;
  144584. color: Color3;
  144585. }, renderingGroupId: number, scene: Scene): void;
  144586. /**
  144587. * Starts all particle systems of the set
  144588. * @param emitter defines an optional mesh to use as emitter for the particle systems
  144589. */
  144590. start(emitter?: AbstractMesh): void;
  144591. /**
  144592. * Release all associated resources
  144593. */
  144594. dispose(): void;
  144595. /**
  144596. * Serialize the set into a JSON compatible object
  144597. * @param serializeTexture defines if the texture must be serialized as well
  144598. * @returns a JSON compatible representation of the set
  144599. */
  144600. serialize(serializeTexture?: boolean): any;
  144601. /**
  144602. * Parse a new ParticleSystemSet from a serialized source
  144603. * @param data defines a JSON compatible representation of the set
  144604. * @param scene defines the hosting scene
  144605. * @param gpu defines if we want GPU particles or CPU particles
  144606. * @returns a new ParticleSystemSet
  144607. */
  144608. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  144609. }
  144610. }
  144611. declare module BABYLON {
  144612. /**
  144613. * This class is made for on one-liner static method to help creating particle system set.
  144614. */
  144615. export class ParticleHelper {
  144616. /**
  144617. * Gets or sets base Assets URL
  144618. */
  144619. static BaseAssetsUrl: string;
  144620. /** Define the Url to load snippets */
  144621. static SnippetUrl: string;
  144622. /**
  144623. * Create a default particle system that you can tweak
  144624. * @param emitter defines the emitter to use
  144625. * @param capacity defines the system capacity (default is 500 particles)
  144626. * @param scene defines the hosting scene
  144627. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  144628. * @returns the new Particle system
  144629. */
  144630. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  144631. /**
  144632. * This is the main static method (one-liner) of this helper to create different particle systems
  144633. * @param type This string represents the type to the particle system to create
  144634. * @param scene The scene where the particle system should live
  144635. * @param gpu If the system will use gpu
  144636. * @returns the ParticleSystemSet created
  144637. */
  144638. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  144639. /**
  144640. * Static function used to export a particle system to a ParticleSystemSet variable.
  144641. * Please note that the emitter shape is not exported
  144642. * @param systems defines the particle systems to export
  144643. * @returns the created particle system set
  144644. */
  144645. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  144646. /**
  144647. * Creates a particle system from a snippet saved in a remote file
  144648. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  144649. * @param url defines the url to load from
  144650. * @param scene defines the hosting scene
  144651. * @param gpu If the system will use gpu
  144652. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  144653. * @returns a promise that will resolve to the new particle system
  144654. */
  144655. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  144656. /**
  144657. * Creates a particle system from a snippet saved by the particle system editor
  144658. * @param snippetId defines the snippet to load
  144659. * @param scene defines the hosting scene
  144660. * @param gpu If the system will use gpu
  144661. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  144662. * @returns a promise that will resolve to the new particle system
  144663. */
  144664. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  144665. }
  144666. }
  144667. declare module BABYLON {
  144668. interface Engine {
  144669. /**
  144670. * Create an effect to use with particle systems.
  144671. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  144672. * the particle system for which you want to create a custom effect in the last parameter
  144673. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  144674. * @param uniformsNames defines a list of attribute names
  144675. * @param samplers defines an array of string used to represent textures
  144676. * @param defines defines the string containing the defines to use to compile the shaders
  144677. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  144678. * @param onCompiled defines a function to call when the effect creation is successful
  144679. * @param onError defines a function to call when the effect creation has failed
  144680. * @param particleSystem the particle system you want to create the effect for
  144681. * @returns the new Effect
  144682. */
  144683. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  144684. }
  144685. interface Mesh {
  144686. /**
  144687. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  144688. * @returns an array of IParticleSystem
  144689. */
  144690. getEmittedParticleSystems(): IParticleSystem[];
  144691. /**
  144692. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  144693. * @returns an array of IParticleSystem
  144694. */
  144695. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  144696. }
  144697. }
  144698. declare module BABYLON {
  144699. /** Defines the 4 color options */
  144700. export enum PointColor {
  144701. /** color value */
  144702. Color = 2,
  144703. /** uv value */
  144704. UV = 1,
  144705. /** random value */
  144706. Random = 0,
  144707. /** stated value */
  144708. Stated = 3
  144709. }
  144710. /**
  144711. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  144712. * 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.
  144713. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  144714. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  144715. *
  144716. * Full documentation here : TO BE ENTERED
  144717. */
  144718. export class PointsCloudSystem implements IDisposable {
  144719. /**
  144720. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  144721. * Example : var p = SPS.particles[i];
  144722. */
  144723. particles: CloudPoint[];
  144724. /**
  144725. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  144726. */
  144727. nbParticles: number;
  144728. /**
  144729. * This a counter for your own usage. It's not set by any SPS functions.
  144730. */
  144731. counter: number;
  144732. /**
  144733. * The PCS name. This name is also given to the underlying mesh.
  144734. */
  144735. name: string;
  144736. /**
  144737. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  144738. */
  144739. mesh: Mesh;
  144740. /**
  144741. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  144742. * Please read :
  144743. */
  144744. vars: any;
  144745. /**
  144746. * @hidden
  144747. */
  144748. _size: number;
  144749. private _scene;
  144750. private _promises;
  144751. private _positions;
  144752. private _indices;
  144753. private _normals;
  144754. private _colors;
  144755. private _uvs;
  144756. private _indices32;
  144757. private _positions32;
  144758. private _colors32;
  144759. private _uvs32;
  144760. private _updatable;
  144761. private _isVisibilityBoxLocked;
  144762. private _alwaysVisible;
  144763. private _groups;
  144764. private _groupCounter;
  144765. private _computeParticleColor;
  144766. private _computeParticleTexture;
  144767. private _computeParticleRotation;
  144768. private _computeBoundingBox;
  144769. private _isReady;
  144770. /**
  144771. * Creates a PCS (Points Cloud System) object
  144772. * @param name (String) is the PCS name, this will be the underlying mesh name
  144773. * @param pointSize (number) is the size for each point
  144774. * @param scene (Scene) is the scene in which the PCS is added
  144775. * @param options defines the options of the PCS e.g.
  144776. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  144777. */
  144778. constructor(name: string, pointSize: number, scene: Scene, options?: {
  144779. updatable?: boolean;
  144780. });
  144781. /**
  144782. * Builds the PCS underlying mesh. Returns a standard Mesh.
  144783. * If no points were added to the PCS, the returned mesh is just a single point.
  144784. * @returns a promise for the created mesh
  144785. */
  144786. buildMeshAsync(): Promise<Mesh>;
  144787. /**
  144788. * @hidden
  144789. */
  144790. private _buildMesh;
  144791. private _addParticle;
  144792. private _randomUnitVector;
  144793. private _getColorIndicesForCoord;
  144794. private _setPointsColorOrUV;
  144795. private _colorFromTexture;
  144796. private _calculateDensity;
  144797. /**
  144798. * Adds points to the PCS in random positions within a unit sphere
  144799. * @param nb (positive integer) the number of particles to be created from this model
  144800. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  144801. * @returns the number of groups in the system
  144802. */
  144803. addPoints(nb: number, pointFunction?: any): number;
  144804. /**
  144805. * Adds points to the PCS from the surface of the model shape
  144806. * @param mesh is any Mesh object that will be used as a surface model for the points
  144807. * @param nb (positive integer) the number of particles to be created from this model
  144808. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  144809. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  144810. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  144811. * @returns the number of groups in the system
  144812. */
  144813. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  144814. /**
  144815. * Adds points to the PCS inside the model shape
  144816. * @param mesh is any Mesh object that will be used as a surface model for the points
  144817. * @param nb (positive integer) the number of particles to be created from this model
  144818. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  144819. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  144820. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  144821. * @returns the number of groups in the system
  144822. */
  144823. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  144824. /**
  144825. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  144826. * This method calls `updateParticle()` for each particle of the SPS.
  144827. * For an animated SPS, it is usually called within the render loop.
  144828. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  144829. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  144830. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  144831. * @returns the PCS.
  144832. */
  144833. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  144834. /**
  144835. * Disposes the PCS.
  144836. */
  144837. dispose(): void;
  144838. /**
  144839. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  144840. * doc :
  144841. * @returns the PCS.
  144842. */
  144843. refreshVisibleSize(): PointsCloudSystem;
  144844. /**
  144845. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  144846. * @param size the size (float) of the visibility box
  144847. * note : this doesn't lock the PCS mesh bounding box.
  144848. * doc :
  144849. */
  144850. setVisibilityBox(size: number): void;
  144851. /**
  144852. * Gets whether the PCS is always visible or not
  144853. * doc :
  144854. */
  144855. get isAlwaysVisible(): boolean;
  144856. /**
  144857. * Sets the PCS as always visible or not
  144858. * doc :
  144859. */
  144860. set isAlwaysVisible(val: boolean);
  144861. /**
  144862. * Tells to `setParticles()` to compute the particle rotations or not
  144863. * Default value : false. The PCS is faster when it's set to false
  144864. * Note : particle rotations are only applied to parent particles
  144865. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  144866. */
  144867. set computeParticleRotation(val: boolean);
  144868. /**
  144869. * Tells to `setParticles()` to compute the particle colors or not.
  144870. * Default value : true. The PCS is faster when it's set to false.
  144871. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  144872. */
  144873. set computeParticleColor(val: boolean);
  144874. set computeParticleTexture(val: boolean);
  144875. /**
  144876. * Gets if `setParticles()` computes the particle colors or not.
  144877. * Default value : false. The PCS is faster when it's set to false.
  144878. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  144879. */
  144880. get computeParticleColor(): boolean;
  144881. /**
  144882. * Gets if `setParticles()` computes the particle textures or not.
  144883. * Default value : false. The PCS is faster when it's set to false.
  144884. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  144885. */
  144886. get computeParticleTexture(): boolean;
  144887. /**
  144888. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  144889. */
  144890. set computeBoundingBox(val: boolean);
  144891. /**
  144892. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  144893. */
  144894. get computeBoundingBox(): boolean;
  144895. /**
  144896. * This function does nothing. It may be overwritten to set all the particle first values.
  144897. * The PCS doesn't call this function, you may have to call it by your own.
  144898. * doc :
  144899. */
  144900. initParticles(): void;
  144901. /**
  144902. * This function does nothing. It may be overwritten to recycle a particle
  144903. * The PCS doesn't call this function, you can to call it
  144904. * doc :
  144905. * @param particle The particle to recycle
  144906. * @returns the recycled particle
  144907. */
  144908. recycleParticle(particle: CloudPoint): CloudPoint;
  144909. /**
  144910. * Updates a particle : this function should be overwritten by the user.
  144911. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  144912. * doc :
  144913. * @example : just set a particle position or velocity and recycle conditions
  144914. * @param particle The particle to update
  144915. * @returns the updated particle
  144916. */
  144917. updateParticle(particle: CloudPoint): CloudPoint;
  144918. /**
  144919. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  144920. * This does nothing and may be overwritten by the user.
  144921. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  144922. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  144923. * @param update the boolean update value actually passed to setParticles()
  144924. */
  144925. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  144926. /**
  144927. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  144928. * This will be passed three parameters.
  144929. * This does nothing and may be overwritten by the user.
  144930. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  144931. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  144932. * @param update the boolean update value actually passed to setParticles()
  144933. */
  144934. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  144935. }
  144936. }
  144937. declare module BABYLON {
  144938. /**
  144939. * Represents one particle of a points cloud system.
  144940. */
  144941. export class CloudPoint {
  144942. /**
  144943. * particle global index
  144944. */
  144945. idx: number;
  144946. /**
  144947. * The color of the particle
  144948. */
  144949. color: Nullable<Color4>;
  144950. /**
  144951. * The world space position of the particle.
  144952. */
  144953. position: Vector3;
  144954. /**
  144955. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  144956. */
  144957. rotation: Vector3;
  144958. /**
  144959. * The world space rotation quaternion of the particle.
  144960. */
  144961. rotationQuaternion: Nullable<Quaternion>;
  144962. /**
  144963. * The uv of the particle.
  144964. */
  144965. uv: Nullable<Vector2>;
  144966. /**
  144967. * The current speed of the particle.
  144968. */
  144969. velocity: Vector3;
  144970. /**
  144971. * The pivot point in the particle local space.
  144972. */
  144973. pivot: Vector3;
  144974. /**
  144975. * Must the particle be translated from its pivot point in its local space ?
  144976. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  144977. * Default : false
  144978. */
  144979. translateFromPivot: boolean;
  144980. /**
  144981. * Index of this particle in the global "positions" array (Internal use)
  144982. * @hidden
  144983. */
  144984. _pos: number;
  144985. /**
  144986. * @hidden Index of this particle in the global "indices" array (Internal use)
  144987. */
  144988. _ind: number;
  144989. /**
  144990. * Group this particle belongs to
  144991. */
  144992. _group: PointsGroup;
  144993. /**
  144994. * Group id of this particle
  144995. */
  144996. groupId: number;
  144997. /**
  144998. * Index of the particle in its group id (Internal use)
  144999. */
  145000. idxInGroup: number;
  145001. /**
  145002. * @hidden Particle BoundingInfo object (Internal use)
  145003. */
  145004. _boundingInfo: BoundingInfo;
  145005. /**
  145006. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  145007. */
  145008. _pcs: PointsCloudSystem;
  145009. /**
  145010. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  145011. */
  145012. _stillInvisible: boolean;
  145013. /**
  145014. * @hidden Last computed particle rotation matrix
  145015. */
  145016. _rotationMatrix: number[];
  145017. /**
  145018. * Parent particle Id, if any.
  145019. * Default null.
  145020. */
  145021. parentId: Nullable<number>;
  145022. /**
  145023. * @hidden Internal global position in the PCS.
  145024. */
  145025. _globalPosition: Vector3;
  145026. /**
  145027. * Creates a Point Cloud object.
  145028. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  145029. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  145030. * @param group (PointsGroup) is the group the particle belongs to
  145031. * @param groupId (integer) is the group identifier in the PCS.
  145032. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  145033. * @param pcs defines the PCS it is associated to
  145034. */
  145035. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  145036. /**
  145037. * get point size
  145038. */
  145039. get size(): Vector3;
  145040. /**
  145041. * Set point size
  145042. */
  145043. set size(scale: Vector3);
  145044. /**
  145045. * Legacy support, changed quaternion to rotationQuaternion
  145046. */
  145047. get quaternion(): Nullable<Quaternion>;
  145048. /**
  145049. * Legacy support, changed quaternion to rotationQuaternion
  145050. */
  145051. set quaternion(q: Nullable<Quaternion>);
  145052. /**
  145053. * Returns a boolean. True if the particle intersects a mesh, else false
  145054. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  145055. * @param target is the object (point or mesh) what the intersection is computed against
  145056. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  145057. * @returns true if it intersects
  145058. */
  145059. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  145060. /**
  145061. * get the rotation matrix of the particle
  145062. * @hidden
  145063. */
  145064. getRotationMatrix(m: Matrix): void;
  145065. }
  145066. /**
  145067. * Represents a group of points in a points cloud system
  145068. * * PCS internal tool, don't use it manually.
  145069. */
  145070. export class PointsGroup {
  145071. /**
  145072. * The group id
  145073. * @hidden
  145074. */
  145075. groupID: number;
  145076. /**
  145077. * image data for group (internal use)
  145078. * @hidden
  145079. */
  145080. _groupImageData: Nullable<ArrayBufferView>;
  145081. /**
  145082. * Image Width (internal use)
  145083. * @hidden
  145084. */
  145085. _groupImgWidth: number;
  145086. /**
  145087. * Image Height (internal use)
  145088. * @hidden
  145089. */
  145090. _groupImgHeight: number;
  145091. /**
  145092. * Custom position function (internal use)
  145093. * @hidden
  145094. */
  145095. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  145096. /**
  145097. * density per facet for surface points
  145098. * @hidden
  145099. */
  145100. _groupDensity: number[];
  145101. /**
  145102. * Only when points are colored by texture carries pointer to texture list array
  145103. * @hidden
  145104. */
  145105. _textureNb: number;
  145106. /**
  145107. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  145108. * PCS internal tool, don't use it manually.
  145109. * @hidden
  145110. */
  145111. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  145112. }
  145113. }
  145114. declare module BABYLON {
  145115. interface Scene {
  145116. /** @hidden (Backing field) */
  145117. _physicsEngine: Nullable<IPhysicsEngine>;
  145118. /** @hidden */
  145119. _physicsTimeAccumulator: number;
  145120. /**
  145121. * Gets the current physics engine
  145122. * @returns a IPhysicsEngine or null if none attached
  145123. */
  145124. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  145125. /**
  145126. * Enables physics to the current scene
  145127. * @param gravity defines the scene's gravity for the physics engine
  145128. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  145129. * @return a boolean indicating if the physics engine was initialized
  145130. */
  145131. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  145132. /**
  145133. * Disables and disposes the physics engine associated with the scene
  145134. */
  145135. disablePhysicsEngine(): void;
  145136. /**
  145137. * Gets a boolean indicating if there is an active physics engine
  145138. * @returns a boolean indicating if there is an active physics engine
  145139. */
  145140. isPhysicsEnabled(): boolean;
  145141. /**
  145142. * Deletes a physics compound impostor
  145143. * @param compound defines the compound to delete
  145144. */
  145145. deleteCompoundImpostor(compound: any): void;
  145146. /**
  145147. * An event triggered when physic simulation is about to be run
  145148. */
  145149. onBeforePhysicsObservable: Observable<Scene>;
  145150. /**
  145151. * An event triggered when physic simulation has been done
  145152. */
  145153. onAfterPhysicsObservable: Observable<Scene>;
  145154. }
  145155. interface AbstractMesh {
  145156. /** @hidden */
  145157. _physicsImpostor: Nullable<PhysicsImpostor>;
  145158. /**
  145159. * Gets or sets impostor used for physic simulation
  145160. * @see http://doc.babylonjs.com/features/physics_engine
  145161. */
  145162. physicsImpostor: Nullable<PhysicsImpostor>;
  145163. /**
  145164. * Gets the current physics impostor
  145165. * @see http://doc.babylonjs.com/features/physics_engine
  145166. * @returns a physics impostor or null
  145167. */
  145168. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  145169. /** Apply a physic impulse to the mesh
  145170. * @param force defines the force to apply
  145171. * @param contactPoint defines where to apply the force
  145172. * @returns the current mesh
  145173. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  145174. */
  145175. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  145176. /**
  145177. * Creates a physic joint between two meshes
  145178. * @param otherMesh defines the other mesh to use
  145179. * @param pivot1 defines the pivot to use on this mesh
  145180. * @param pivot2 defines the pivot to use on the other mesh
  145181. * @param options defines additional options (can be plugin dependent)
  145182. * @returns the current mesh
  145183. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  145184. */
  145185. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  145186. /** @hidden */
  145187. _disposePhysicsObserver: Nullable<Observer<Node>>;
  145188. }
  145189. /**
  145190. * Defines the physics engine scene component responsible to manage a physics engine
  145191. */
  145192. export class PhysicsEngineSceneComponent implements ISceneComponent {
  145193. /**
  145194. * The component name helpful to identify the component in the list of scene components.
  145195. */
  145196. readonly name: string;
  145197. /**
  145198. * The scene the component belongs to.
  145199. */
  145200. scene: Scene;
  145201. /**
  145202. * Creates a new instance of the component for the given scene
  145203. * @param scene Defines the scene to register the component in
  145204. */
  145205. constructor(scene: Scene);
  145206. /**
  145207. * Registers the component in a given scene
  145208. */
  145209. register(): void;
  145210. /**
  145211. * Rebuilds the elements related to this component in case of
  145212. * context lost for instance.
  145213. */
  145214. rebuild(): void;
  145215. /**
  145216. * Disposes the component and the associated ressources
  145217. */
  145218. dispose(): void;
  145219. }
  145220. }
  145221. declare module BABYLON {
  145222. /**
  145223. * A helper for physics simulations
  145224. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145225. */
  145226. export class PhysicsHelper {
  145227. private _scene;
  145228. private _physicsEngine;
  145229. /**
  145230. * Initializes the Physics helper
  145231. * @param scene Babylon.js scene
  145232. */
  145233. constructor(scene: Scene);
  145234. /**
  145235. * Applies a radial explosion impulse
  145236. * @param origin the origin of the explosion
  145237. * @param radiusOrEventOptions the radius or the options of radial explosion
  145238. * @param strength the explosion strength
  145239. * @param falloff possible options: Constant & Linear. Defaults to Constant
  145240. * @returns A physics radial explosion event, or null
  145241. */
  145242. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  145243. /**
  145244. * Applies a radial explosion force
  145245. * @param origin the origin of the explosion
  145246. * @param radiusOrEventOptions the radius or the options of radial explosion
  145247. * @param strength the explosion strength
  145248. * @param falloff possible options: Constant & Linear. Defaults to Constant
  145249. * @returns A physics radial explosion event, or null
  145250. */
  145251. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  145252. /**
  145253. * Creates a gravitational field
  145254. * @param origin the origin of the explosion
  145255. * @param radiusOrEventOptions the radius or the options of radial explosion
  145256. * @param strength the explosion strength
  145257. * @param falloff possible options: Constant & Linear. Defaults to Constant
  145258. * @returns A physics gravitational field event, or null
  145259. */
  145260. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  145261. /**
  145262. * Creates a physics updraft event
  145263. * @param origin the origin of the updraft
  145264. * @param radiusOrEventOptions the radius or the options of the updraft
  145265. * @param strength the strength of the updraft
  145266. * @param height the height of the updraft
  145267. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  145268. * @returns A physics updraft event, or null
  145269. */
  145270. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  145271. /**
  145272. * Creates a physics vortex event
  145273. * @param origin the of the vortex
  145274. * @param radiusOrEventOptions the radius or the options of the vortex
  145275. * @param strength the strength of the vortex
  145276. * @param height the height of the vortex
  145277. * @returns a Physics vortex event, or null
  145278. * A physics vortex event or null
  145279. */
  145280. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  145281. }
  145282. /**
  145283. * Represents a physics radial explosion event
  145284. */
  145285. class PhysicsRadialExplosionEvent {
  145286. private _scene;
  145287. private _options;
  145288. private _sphere;
  145289. private _dataFetched;
  145290. /**
  145291. * Initializes a radial explosioin event
  145292. * @param _scene BabylonJS scene
  145293. * @param _options The options for the vortex event
  145294. */
  145295. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  145296. /**
  145297. * Returns the data related to the radial explosion event (sphere).
  145298. * @returns The radial explosion event data
  145299. */
  145300. getData(): PhysicsRadialExplosionEventData;
  145301. /**
  145302. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  145303. * @param impostor A physics imposter
  145304. * @param origin the origin of the explosion
  145305. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  145306. */
  145307. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  145308. /**
  145309. * Triggers affecterd impostors callbacks
  145310. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  145311. */
  145312. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  145313. /**
  145314. * Disposes the sphere.
  145315. * @param force Specifies if the sphere should be disposed by force
  145316. */
  145317. dispose(force?: boolean): void;
  145318. /*** Helpers ***/
  145319. private _prepareSphere;
  145320. private _intersectsWithSphere;
  145321. }
  145322. /**
  145323. * Represents a gravitational field event
  145324. */
  145325. class PhysicsGravitationalFieldEvent {
  145326. private _physicsHelper;
  145327. private _scene;
  145328. private _origin;
  145329. private _options;
  145330. private _tickCallback;
  145331. private _sphere;
  145332. private _dataFetched;
  145333. /**
  145334. * Initializes the physics gravitational field event
  145335. * @param _physicsHelper A physics helper
  145336. * @param _scene BabylonJS scene
  145337. * @param _origin The origin position of the gravitational field event
  145338. * @param _options The options for the vortex event
  145339. */
  145340. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  145341. /**
  145342. * Returns the data related to the gravitational field event (sphere).
  145343. * @returns A gravitational field event
  145344. */
  145345. getData(): PhysicsGravitationalFieldEventData;
  145346. /**
  145347. * Enables the gravitational field.
  145348. */
  145349. enable(): void;
  145350. /**
  145351. * Disables the gravitational field.
  145352. */
  145353. disable(): void;
  145354. /**
  145355. * Disposes the sphere.
  145356. * @param force The force to dispose from the gravitational field event
  145357. */
  145358. dispose(force?: boolean): void;
  145359. private _tick;
  145360. }
  145361. /**
  145362. * Represents a physics updraft event
  145363. */
  145364. class PhysicsUpdraftEvent {
  145365. private _scene;
  145366. private _origin;
  145367. private _options;
  145368. private _physicsEngine;
  145369. private _originTop;
  145370. private _originDirection;
  145371. private _tickCallback;
  145372. private _cylinder;
  145373. private _cylinderPosition;
  145374. private _dataFetched;
  145375. /**
  145376. * Initializes the physics updraft event
  145377. * @param _scene BabylonJS scene
  145378. * @param _origin The origin position of the updraft
  145379. * @param _options The options for the updraft event
  145380. */
  145381. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  145382. /**
  145383. * Returns the data related to the updraft event (cylinder).
  145384. * @returns A physics updraft event
  145385. */
  145386. getData(): PhysicsUpdraftEventData;
  145387. /**
  145388. * Enables the updraft.
  145389. */
  145390. enable(): void;
  145391. /**
  145392. * Disables the updraft.
  145393. */
  145394. disable(): void;
  145395. /**
  145396. * Disposes the cylinder.
  145397. * @param force Specifies if the updraft should be disposed by force
  145398. */
  145399. dispose(force?: boolean): void;
  145400. private getImpostorHitData;
  145401. private _tick;
  145402. /*** Helpers ***/
  145403. private _prepareCylinder;
  145404. private _intersectsWithCylinder;
  145405. }
  145406. /**
  145407. * Represents a physics vortex event
  145408. */
  145409. class PhysicsVortexEvent {
  145410. private _scene;
  145411. private _origin;
  145412. private _options;
  145413. private _physicsEngine;
  145414. private _originTop;
  145415. private _tickCallback;
  145416. private _cylinder;
  145417. private _cylinderPosition;
  145418. private _dataFetched;
  145419. /**
  145420. * Initializes the physics vortex event
  145421. * @param _scene The BabylonJS scene
  145422. * @param _origin The origin position of the vortex
  145423. * @param _options The options for the vortex event
  145424. */
  145425. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  145426. /**
  145427. * Returns the data related to the vortex event (cylinder).
  145428. * @returns The physics vortex event data
  145429. */
  145430. getData(): PhysicsVortexEventData;
  145431. /**
  145432. * Enables the vortex.
  145433. */
  145434. enable(): void;
  145435. /**
  145436. * Disables the cortex.
  145437. */
  145438. disable(): void;
  145439. /**
  145440. * Disposes the sphere.
  145441. * @param force
  145442. */
  145443. dispose(force?: boolean): void;
  145444. private getImpostorHitData;
  145445. private _tick;
  145446. /*** Helpers ***/
  145447. private _prepareCylinder;
  145448. private _intersectsWithCylinder;
  145449. }
  145450. /**
  145451. * Options fot the radial explosion event
  145452. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145453. */
  145454. export class PhysicsRadialExplosionEventOptions {
  145455. /**
  145456. * The radius of the sphere for the radial explosion.
  145457. */
  145458. radius: number;
  145459. /**
  145460. * The strenth of the explosion.
  145461. */
  145462. strength: number;
  145463. /**
  145464. * The strenght of the force in correspondence to the distance of the affected object
  145465. */
  145466. falloff: PhysicsRadialImpulseFalloff;
  145467. /**
  145468. * Sphere options for the radial explosion.
  145469. */
  145470. sphere: {
  145471. segments: number;
  145472. diameter: number;
  145473. };
  145474. /**
  145475. * Sphere options for the radial explosion.
  145476. */
  145477. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  145478. }
  145479. /**
  145480. * Options fot the updraft event
  145481. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145482. */
  145483. export class PhysicsUpdraftEventOptions {
  145484. /**
  145485. * The radius of the cylinder for the vortex
  145486. */
  145487. radius: number;
  145488. /**
  145489. * The strenth of the updraft.
  145490. */
  145491. strength: number;
  145492. /**
  145493. * The height of the cylinder for the updraft.
  145494. */
  145495. height: number;
  145496. /**
  145497. * The mode for the the updraft.
  145498. */
  145499. updraftMode: PhysicsUpdraftMode;
  145500. }
  145501. /**
  145502. * Options fot the vortex event
  145503. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145504. */
  145505. export class PhysicsVortexEventOptions {
  145506. /**
  145507. * The radius of the cylinder for the vortex
  145508. */
  145509. radius: number;
  145510. /**
  145511. * The strenth of the vortex.
  145512. */
  145513. strength: number;
  145514. /**
  145515. * The height of the cylinder for the vortex.
  145516. */
  145517. height: number;
  145518. /**
  145519. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  145520. */
  145521. centripetalForceThreshold: number;
  145522. /**
  145523. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  145524. */
  145525. centripetalForceMultiplier: number;
  145526. /**
  145527. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  145528. */
  145529. centrifugalForceMultiplier: number;
  145530. /**
  145531. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  145532. */
  145533. updraftForceMultiplier: number;
  145534. }
  145535. /**
  145536. * The strenght of the force in correspondence to the distance of the affected object
  145537. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145538. */
  145539. export enum PhysicsRadialImpulseFalloff {
  145540. /** Defines that impulse is constant in strength across it's whole radius */
  145541. Constant = 0,
  145542. /** Defines that impulse gets weaker if it's further from the origin */
  145543. Linear = 1
  145544. }
  145545. /**
  145546. * The strength of the force in correspondence to the distance of the affected object
  145547. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145548. */
  145549. export enum PhysicsUpdraftMode {
  145550. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  145551. Center = 0,
  145552. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  145553. Perpendicular = 1
  145554. }
  145555. /**
  145556. * Interface for a physics hit data
  145557. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145558. */
  145559. export interface PhysicsHitData {
  145560. /**
  145561. * The force applied at the contact point
  145562. */
  145563. force: Vector3;
  145564. /**
  145565. * The contact point
  145566. */
  145567. contactPoint: Vector3;
  145568. /**
  145569. * The distance from the origin to the contact point
  145570. */
  145571. distanceFromOrigin: number;
  145572. }
  145573. /**
  145574. * Interface for radial explosion event data
  145575. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145576. */
  145577. export interface PhysicsRadialExplosionEventData {
  145578. /**
  145579. * A sphere used for the radial explosion event
  145580. */
  145581. sphere: Mesh;
  145582. }
  145583. /**
  145584. * Interface for gravitational field event data
  145585. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145586. */
  145587. export interface PhysicsGravitationalFieldEventData {
  145588. /**
  145589. * A sphere mesh used for the gravitational field event
  145590. */
  145591. sphere: Mesh;
  145592. }
  145593. /**
  145594. * Interface for updraft event data
  145595. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145596. */
  145597. export interface PhysicsUpdraftEventData {
  145598. /**
  145599. * A cylinder used for the updraft event
  145600. */
  145601. cylinder: Mesh;
  145602. }
  145603. /**
  145604. * Interface for vortex event data
  145605. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145606. */
  145607. export interface PhysicsVortexEventData {
  145608. /**
  145609. * A cylinder used for the vortex event
  145610. */
  145611. cylinder: Mesh;
  145612. }
  145613. /**
  145614. * Interface for an affected physics impostor
  145615. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  145616. */
  145617. export interface PhysicsAffectedImpostorWithData {
  145618. /**
  145619. * The impostor affected by the effect
  145620. */
  145621. impostor: PhysicsImpostor;
  145622. /**
  145623. * The data about the hit/horce from the explosion
  145624. */
  145625. hitData: PhysicsHitData;
  145626. }
  145627. }
  145628. declare module BABYLON {
  145629. /** @hidden */
  145630. export var blackAndWhitePixelShader: {
  145631. name: string;
  145632. shader: string;
  145633. };
  145634. }
  145635. declare module BABYLON {
  145636. /**
  145637. * Post process used to render in black and white
  145638. */
  145639. export class BlackAndWhitePostProcess extends PostProcess {
  145640. /**
  145641. * Linear about to convert he result to black and white (default: 1)
  145642. */
  145643. degree: number;
  145644. /**
  145645. * Creates a black and white post process
  145646. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  145647. * @param name The name of the effect.
  145648. * @param options The required width/height ratio to downsize to before computing the render pass.
  145649. * @param camera The camera to apply the render pass to.
  145650. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  145651. * @param engine The engine which the post process will be applied. (default: current engine)
  145652. * @param reusable If the post process can be reused on the same frame. (default: false)
  145653. */
  145654. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  145655. }
  145656. }
  145657. declare module BABYLON {
  145658. /**
  145659. * This represents a set of one or more post processes in Babylon.
  145660. * A post process can be used to apply a shader to a texture after it is rendered.
  145661. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  145662. */
  145663. export class PostProcessRenderEffect {
  145664. private _postProcesses;
  145665. private _getPostProcesses;
  145666. private _singleInstance;
  145667. private _cameras;
  145668. private _indicesForCamera;
  145669. /**
  145670. * Name of the effect
  145671. * @hidden
  145672. */
  145673. _name: string;
  145674. /**
  145675. * Instantiates a post process render effect.
  145676. * A post process can be used to apply a shader to a texture after it is rendered.
  145677. * @param engine The engine the effect is tied to
  145678. * @param name The name of the effect
  145679. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  145680. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  145681. */
  145682. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  145683. /**
  145684. * Checks if all the post processes in the effect are supported.
  145685. */
  145686. get isSupported(): boolean;
  145687. /**
  145688. * Updates the current state of the effect
  145689. * @hidden
  145690. */
  145691. _update(): void;
  145692. /**
  145693. * Attaches the effect on cameras
  145694. * @param cameras The camera to attach to.
  145695. * @hidden
  145696. */
  145697. _attachCameras(cameras: Camera): void;
  145698. /**
  145699. * Attaches the effect on cameras
  145700. * @param cameras The camera to attach to.
  145701. * @hidden
  145702. */
  145703. _attachCameras(cameras: Camera[]): void;
  145704. /**
  145705. * Detaches the effect on cameras
  145706. * @param cameras The camera to detatch from.
  145707. * @hidden
  145708. */
  145709. _detachCameras(cameras: Camera): void;
  145710. /**
  145711. * Detatches the effect on cameras
  145712. * @param cameras The camera to detatch from.
  145713. * @hidden
  145714. */
  145715. _detachCameras(cameras: Camera[]): void;
  145716. /**
  145717. * Enables the effect on given cameras
  145718. * @param cameras The camera to enable.
  145719. * @hidden
  145720. */
  145721. _enable(cameras: Camera): void;
  145722. /**
  145723. * Enables the effect on given cameras
  145724. * @param cameras The camera to enable.
  145725. * @hidden
  145726. */
  145727. _enable(cameras: Nullable<Camera[]>): void;
  145728. /**
  145729. * Disables the effect on the given cameras
  145730. * @param cameras The camera to disable.
  145731. * @hidden
  145732. */
  145733. _disable(cameras: Camera): void;
  145734. /**
  145735. * Disables the effect on the given cameras
  145736. * @param cameras The camera to disable.
  145737. * @hidden
  145738. */
  145739. _disable(cameras: Nullable<Camera[]>): void;
  145740. /**
  145741. * Gets a list of the post processes contained in the effect.
  145742. * @param camera The camera to get the post processes on.
  145743. * @returns The list of the post processes in the effect.
  145744. */
  145745. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  145746. }
  145747. }
  145748. declare module BABYLON {
  145749. /** @hidden */
  145750. export var extractHighlightsPixelShader: {
  145751. name: string;
  145752. shader: string;
  145753. };
  145754. }
  145755. declare module BABYLON {
  145756. /**
  145757. * 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.
  145758. */
  145759. export class ExtractHighlightsPostProcess extends PostProcess {
  145760. /**
  145761. * The luminance threshold, pixels below this value will be set to black.
  145762. */
  145763. threshold: number;
  145764. /** @hidden */
  145765. _exposure: number;
  145766. /**
  145767. * Post process which has the input texture to be used when performing highlight extraction
  145768. * @hidden
  145769. */
  145770. _inputPostProcess: Nullable<PostProcess>;
  145771. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  145772. }
  145773. }
  145774. declare module BABYLON {
  145775. /** @hidden */
  145776. export var bloomMergePixelShader: {
  145777. name: string;
  145778. shader: string;
  145779. };
  145780. }
  145781. declare module BABYLON {
  145782. /**
  145783. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  145784. */
  145785. export class BloomMergePostProcess extends PostProcess {
  145786. /** Weight of the bloom to be added to the original input. */
  145787. weight: number;
  145788. /**
  145789. * Creates a new instance of @see BloomMergePostProcess
  145790. * @param name The name of the effect.
  145791. * @param originalFromInput Post process which's input will be used for the merge.
  145792. * @param blurred Blurred highlights post process which's output will be used.
  145793. * @param weight Weight of the bloom to be added to the original input.
  145794. * @param options The required width/height ratio to downsize to before computing the render pass.
  145795. * @param camera The camera to apply the render pass to.
  145796. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  145797. * @param engine The engine which the post process will be applied. (default: current engine)
  145798. * @param reusable If the post process can be reused on the same frame. (default: false)
  145799. * @param textureType Type of textures used when performing the post process. (default: 0)
  145800. * @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)
  145801. */
  145802. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  145803. /** Weight of the bloom to be added to the original input. */
  145804. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  145805. }
  145806. }
  145807. declare module BABYLON {
  145808. /**
  145809. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  145810. */
  145811. export class BloomEffect extends PostProcessRenderEffect {
  145812. private bloomScale;
  145813. /**
  145814. * @hidden Internal
  145815. */
  145816. _effects: Array<PostProcess>;
  145817. /**
  145818. * @hidden Internal
  145819. */
  145820. _downscale: ExtractHighlightsPostProcess;
  145821. private _blurX;
  145822. private _blurY;
  145823. private _merge;
  145824. /**
  145825. * The luminance threshold to find bright areas of the image to bloom.
  145826. */
  145827. get threshold(): number;
  145828. set threshold(value: number);
  145829. /**
  145830. * The strength of the bloom.
  145831. */
  145832. get weight(): number;
  145833. set weight(value: number);
  145834. /**
  145835. * Specifies the size of the bloom blur kernel, relative to the final output size
  145836. */
  145837. get kernel(): number;
  145838. set kernel(value: number);
  145839. /**
  145840. * Creates a new instance of @see BloomEffect
  145841. * @param scene The scene the effect belongs to.
  145842. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  145843. * @param bloomKernel The size of the kernel to be used when applying the blur.
  145844. * @param bloomWeight The the strength of bloom.
  145845. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  145846. * @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)
  145847. */
  145848. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  145849. /**
  145850. * Disposes each of the internal effects for a given camera.
  145851. * @param camera The camera to dispose the effect on.
  145852. */
  145853. disposeEffects(camera: Camera): void;
  145854. /**
  145855. * @hidden Internal
  145856. */
  145857. _updateEffects(): void;
  145858. /**
  145859. * Internal
  145860. * @returns if all the contained post processes are ready.
  145861. * @hidden
  145862. */
  145863. _isReady(): boolean;
  145864. }
  145865. }
  145866. declare module BABYLON {
  145867. /** @hidden */
  145868. export var chromaticAberrationPixelShader: {
  145869. name: string;
  145870. shader: string;
  145871. };
  145872. }
  145873. declare module BABYLON {
  145874. /**
  145875. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  145876. */
  145877. export class ChromaticAberrationPostProcess extends PostProcess {
  145878. /**
  145879. * The amount of seperation of rgb channels (default: 30)
  145880. */
  145881. aberrationAmount: number;
  145882. /**
  145883. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  145884. */
  145885. radialIntensity: number;
  145886. /**
  145887. * 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))
  145888. */
  145889. direction: Vector2;
  145890. /**
  145891. * 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))
  145892. */
  145893. centerPosition: Vector2;
  145894. /**
  145895. * Creates a new instance ChromaticAberrationPostProcess
  145896. * @param name The name of the effect.
  145897. * @param screenWidth The width of the screen to apply the effect on.
  145898. * @param screenHeight The height of the screen to apply the effect on.
  145899. * @param options The required width/height ratio to downsize to before computing the render pass.
  145900. * @param camera The camera to apply the render pass to.
  145901. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  145902. * @param engine The engine which the post process will be applied. (default: current engine)
  145903. * @param reusable If the post process can be reused on the same frame. (default: false)
  145904. * @param textureType Type of textures used when performing the post process. (default: 0)
  145905. * @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)
  145906. */
  145907. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  145908. }
  145909. }
  145910. declare module BABYLON {
  145911. /** @hidden */
  145912. export var circleOfConfusionPixelShader: {
  145913. name: string;
  145914. shader: string;
  145915. };
  145916. }
  145917. declare module BABYLON {
  145918. /**
  145919. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  145920. */
  145921. export class CircleOfConfusionPostProcess extends PostProcess {
  145922. /**
  145923. * 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.
  145924. */
  145925. lensSize: number;
  145926. /**
  145927. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  145928. */
  145929. fStop: number;
  145930. /**
  145931. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  145932. */
  145933. focusDistance: number;
  145934. /**
  145935. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  145936. */
  145937. focalLength: number;
  145938. private _depthTexture;
  145939. /**
  145940. * Creates a new instance CircleOfConfusionPostProcess
  145941. * @param name The name of the effect.
  145942. * @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.
  145943. * @param options The required width/height ratio to downsize to before computing the render pass.
  145944. * @param camera The camera to apply the render pass to.
  145945. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  145946. * @param engine The engine which the post process will be applied. (default: current engine)
  145947. * @param reusable If the post process can be reused on the same frame. (default: false)
  145948. * @param textureType Type of textures used when performing the post process. (default: 0)
  145949. * @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)
  145950. */
  145951. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  145952. /**
  145953. * 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.
  145954. */
  145955. set depthTexture(value: RenderTargetTexture);
  145956. }
  145957. }
  145958. declare module BABYLON {
  145959. /** @hidden */
  145960. export var colorCorrectionPixelShader: {
  145961. name: string;
  145962. shader: string;
  145963. };
  145964. }
  145965. declare module BABYLON {
  145966. /**
  145967. *
  145968. * This post-process allows the modification of rendered colors by using
  145969. * a 'look-up table' (LUT). This effect is also called Color Grading.
  145970. *
  145971. * The object needs to be provided an url to a texture containing the color
  145972. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  145973. * Use an image editing software to tweak the LUT to match your needs.
  145974. *
  145975. * For an example of a color LUT, see here:
  145976. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  145977. * For explanations on color grading, see here:
  145978. * @see http://udn.epicgames.com/Three/ColorGrading.html
  145979. *
  145980. */
  145981. export class ColorCorrectionPostProcess extends PostProcess {
  145982. private _colorTableTexture;
  145983. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  145984. }
  145985. }
  145986. declare module BABYLON {
  145987. /** @hidden */
  145988. export var convolutionPixelShader: {
  145989. name: string;
  145990. shader: string;
  145991. };
  145992. }
  145993. declare module BABYLON {
  145994. /**
  145995. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  145996. * input texture to perform effects such as edge detection or sharpening
  145997. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  145998. */
  145999. export class ConvolutionPostProcess extends PostProcess {
  146000. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  146001. kernel: number[];
  146002. /**
  146003. * Creates a new instance ConvolutionPostProcess
  146004. * @param name The name of the effect.
  146005. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  146006. * @param options The required width/height ratio to downsize to before computing the render pass.
  146007. * @param camera The camera to apply the render pass to.
  146008. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146009. * @param engine The engine which the post process will be applied. (default: current engine)
  146010. * @param reusable If the post process can be reused on the same frame. (default: false)
  146011. * @param textureType Type of textures used when performing the post process. (default: 0)
  146012. */
  146013. constructor(name: string,
  146014. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  146015. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  146016. /**
  146017. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  146018. */
  146019. static EdgeDetect0Kernel: number[];
  146020. /**
  146021. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  146022. */
  146023. static EdgeDetect1Kernel: number[];
  146024. /**
  146025. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  146026. */
  146027. static EdgeDetect2Kernel: number[];
  146028. /**
  146029. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  146030. */
  146031. static SharpenKernel: number[];
  146032. /**
  146033. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  146034. */
  146035. static EmbossKernel: number[];
  146036. /**
  146037. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  146038. */
  146039. static GaussianKernel: number[];
  146040. }
  146041. }
  146042. declare module BABYLON {
  146043. /**
  146044. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  146045. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  146046. * based on samples that have a large difference in distance than the center pixel.
  146047. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  146048. */
  146049. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  146050. direction: Vector2;
  146051. /**
  146052. * Creates a new instance CircleOfConfusionPostProcess
  146053. * @param name The name of the effect.
  146054. * @param scene The scene the effect belongs to.
  146055. * @param direction The direction the blur should be applied.
  146056. * @param kernel The size of the kernel used to blur.
  146057. * @param options The required width/height ratio to downsize to before computing the render pass.
  146058. * @param camera The camera to apply the render pass to.
  146059. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  146060. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  146061. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146062. * @param engine The engine which the post process will be applied. (default: current engine)
  146063. * @param reusable If the post process can be reused on the same frame. (default: false)
  146064. * @param textureType Type of textures used when performing the post process. (default: 0)
  146065. * @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)
  146066. */
  146067. 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);
  146068. }
  146069. }
  146070. declare module BABYLON {
  146071. /** @hidden */
  146072. export var depthOfFieldMergePixelShader: {
  146073. name: string;
  146074. shader: string;
  146075. };
  146076. }
  146077. declare module BABYLON {
  146078. /**
  146079. * Options to be set when merging outputs from the default pipeline.
  146080. */
  146081. export class DepthOfFieldMergePostProcessOptions {
  146082. /**
  146083. * The original image to merge on top of
  146084. */
  146085. originalFromInput: PostProcess;
  146086. /**
  146087. * Parameters to perform the merge of the depth of field effect
  146088. */
  146089. depthOfField?: {
  146090. circleOfConfusion: PostProcess;
  146091. blurSteps: Array<PostProcess>;
  146092. };
  146093. /**
  146094. * Parameters to perform the merge of bloom effect
  146095. */
  146096. bloom?: {
  146097. blurred: PostProcess;
  146098. weight: number;
  146099. };
  146100. }
  146101. /**
  146102. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  146103. */
  146104. export class DepthOfFieldMergePostProcess extends PostProcess {
  146105. private blurSteps;
  146106. /**
  146107. * Creates a new instance of DepthOfFieldMergePostProcess
  146108. * @param name The name of the effect.
  146109. * @param originalFromInput Post process which's input will be used for the merge.
  146110. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  146111. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  146112. * @param options The required width/height ratio to downsize to before computing the render pass.
  146113. * @param camera The camera to apply the render pass to.
  146114. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146115. * @param engine The engine which the post process will be applied. (default: current engine)
  146116. * @param reusable If the post process can be reused on the same frame. (default: false)
  146117. * @param textureType Type of textures used when performing the post process. (default: 0)
  146118. * @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)
  146119. */
  146120. 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);
  146121. /**
  146122. * Updates the effect with the current post process compile time values and recompiles the shader.
  146123. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  146124. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  146125. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  146126. * @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
  146127. * @param onCompiled Called when the shader has been compiled.
  146128. * @param onError Called if there is an error when compiling a shader.
  146129. */
  146130. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  146131. }
  146132. }
  146133. declare module BABYLON {
  146134. /**
  146135. * Specifies the level of max blur that should be applied when using the depth of field effect
  146136. */
  146137. export enum DepthOfFieldEffectBlurLevel {
  146138. /**
  146139. * Subtle blur
  146140. */
  146141. Low = 0,
  146142. /**
  146143. * Medium blur
  146144. */
  146145. Medium = 1,
  146146. /**
  146147. * Large blur
  146148. */
  146149. High = 2
  146150. }
  146151. /**
  146152. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  146153. */
  146154. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  146155. private _circleOfConfusion;
  146156. /**
  146157. * @hidden Internal, blurs from high to low
  146158. */
  146159. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  146160. private _depthOfFieldBlurY;
  146161. private _dofMerge;
  146162. /**
  146163. * @hidden Internal post processes in depth of field effect
  146164. */
  146165. _effects: Array<PostProcess>;
  146166. /**
  146167. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  146168. */
  146169. set focalLength(value: number);
  146170. get focalLength(): number;
  146171. /**
  146172. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  146173. */
  146174. set fStop(value: number);
  146175. get fStop(): number;
  146176. /**
  146177. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  146178. */
  146179. set focusDistance(value: number);
  146180. get focusDistance(): number;
  146181. /**
  146182. * 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.
  146183. */
  146184. set lensSize(value: number);
  146185. get lensSize(): number;
  146186. /**
  146187. * Creates a new instance DepthOfFieldEffect
  146188. * @param scene The scene the effect belongs to.
  146189. * @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.
  146190. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  146191. * @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)
  146192. */
  146193. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  146194. /**
  146195. * Get the current class name of the current effet
  146196. * @returns "DepthOfFieldEffect"
  146197. */
  146198. getClassName(): string;
  146199. /**
  146200. * 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.
  146201. */
  146202. set depthTexture(value: RenderTargetTexture);
  146203. /**
  146204. * Disposes each of the internal effects for a given camera.
  146205. * @param camera The camera to dispose the effect on.
  146206. */
  146207. disposeEffects(camera: Camera): void;
  146208. /**
  146209. * @hidden Internal
  146210. */
  146211. _updateEffects(): void;
  146212. /**
  146213. * Internal
  146214. * @returns if all the contained post processes are ready.
  146215. * @hidden
  146216. */
  146217. _isReady(): boolean;
  146218. }
  146219. }
  146220. declare module BABYLON {
  146221. /** @hidden */
  146222. export var displayPassPixelShader: {
  146223. name: string;
  146224. shader: string;
  146225. };
  146226. }
  146227. declare module BABYLON {
  146228. /**
  146229. * DisplayPassPostProcess which produces an output the same as it's input
  146230. */
  146231. export class DisplayPassPostProcess extends PostProcess {
  146232. /**
  146233. * Creates the DisplayPassPostProcess
  146234. * @param name The name of the effect.
  146235. * @param options The required width/height ratio to downsize to before computing the render pass.
  146236. * @param camera The camera to apply the render pass to.
  146237. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146238. * @param engine The engine which the post process will be applied. (default: current engine)
  146239. * @param reusable If the post process can be reused on the same frame. (default: false)
  146240. */
  146241. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  146242. }
  146243. }
  146244. declare module BABYLON {
  146245. /** @hidden */
  146246. export var filterPixelShader: {
  146247. name: string;
  146248. shader: string;
  146249. };
  146250. }
  146251. declare module BABYLON {
  146252. /**
  146253. * Applies a kernel filter to the image
  146254. */
  146255. export class FilterPostProcess extends PostProcess {
  146256. /** The matrix to be applied to the image */
  146257. kernelMatrix: Matrix;
  146258. /**
  146259. *
  146260. * @param name The name of the effect.
  146261. * @param kernelMatrix The matrix to be applied to the image
  146262. * @param options The required width/height ratio to downsize to before computing the render pass.
  146263. * @param camera The camera to apply the render pass to.
  146264. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146265. * @param engine The engine which the post process will be applied. (default: current engine)
  146266. * @param reusable If the post process can be reused on the same frame. (default: false)
  146267. */
  146268. constructor(name: string,
  146269. /** The matrix to be applied to the image */
  146270. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  146271. }
  146272. }
  146273. declare module BABYLON {
  146274. /** @hidden */
  146275. export var fxaaPixelShader: {
  146276. name: string;
  146277. shader: string;
  146278. };
  146279. }
  146280. declare module BABYLON {
  146281. /** @hidden */
  146282. export var fxaaVertexShader: {
  146283. name: string;
  146284. shader: string;
  146285. };
  146286. }
  146287. declare module BABYLON {
  146288. /**
  146289. * Fxaa post process
  146290. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  146291. */
  146292. export class FxaaPostProcess extends PostProcess {
  146293. /** @hidden */
  146294. texelWidth: number;
  146295. /** @hidden */
  146296. texelHeight: number;
  146297. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  146298. private _getDefines;
  146299. }
  146300. }
  146301. declare module BABYLON {
  146302. /** @hidden */
  146303. export var grainPixelShader: {
  146304. name: string;
  146305. shader: string;
  146306. };
  146307. }
  146308. declare module BABYLON {
  146309. /**
  146310. * The GrainPostProcess adds noise to the image at mid luminance levels
  146311. */
  146312. export class GrainPostProcess extends PostProcess {
  146313. /**
  146314. * The intensity of the grain added (default: 30)
  146315. */
  146316. intensity: number;
  146317. /**
  146318. * If the grain should be randomized on every frame
  146319. */
  146320. animated: boolean;
  146321. /**
  146322. * Creates a new instance of @see GrainPostProcess
  146323. * @param name The name of the effect.
  146324. * @param options The required width/height ratio to downsize to before computing the render pass.
  146325. * @param camera The camera to apply the render pass to.
  146326. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146327. * @param engine The engine which the post process will be applied. (default: current engine)
  146328. * @param reusable If the post process can be reused on the same frame. (default: false)
  146329. * @param textureType Type of textures used when performing the post process. (default: 0)
  146330. * @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)
  146331. */
  146332. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  146333. }
  146334. }
  146335. declare module BABYLON {
  146336. /** @hidden */
  146337. export var highlightsPixelShader: {
  146338. name: string;
  146339. shader: string;
  146340. };
  146341. }
  146342. declare module BABYLON {
  146343. /**
  146344. * Extracts highlights from the image
  146345. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  146346. */
  146347. export class HighlightsPostProcess extends PostProcess {
  146348. /**
  146349. * Extracts highlights from the image
  146350. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  146351. * @param name The name of the effect.
  146352. * @param options The required width/height ratio to downsize to before computing the render pass.
  146353. * @param camera The camera to apply the render pass to.
  146354. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146355. * @param engine The engine which the post process will be applied. (default: current engine)
  146356. * @param reusable If the post process can be reused on the same frame. (default: false)
  146357. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  146358. */
  146359. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  146360. }
  146361. }
  146362. declare module BABYLON {
  146363. /** @hidden */
  146364. export var mrtFragmentDeclaration: {
  146365. name: string;
  146366. shader: string;
  146367. };
  146368. }
  146369. declare module BABYLON {
  146370. /** @hidden */
  146371. export var geometryPixelShader: {
  146372. name: string;
  146373. shader: string;
  146374. };
  146375. }
  146376. declare module BABYLON {
  146377. /** @hidden */
  146378. export var geometryVertexShader: {
  146379. name: string;
  146380. shader: string;
  146381. };
  146382. }
  146383. declare module BABYLON {
  146384. /** @hidden */
  146385. interface ISavedTransformationMatrix {
  146386. world: Matrix;
  146387. viewProjection: Matrix;
  146388. }
  146389. /**
  146390. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  146391. */
  146392. export class GeometryBufferRenderer {
  146393. /**
  146394. * Constant used to retrieve the position texture index in the G-Buffer textures array
  146395. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  146396. */
  146397. static readonly POSITION_TEXTURE_TYPE: number;
  146398. /**
  146399. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  146400. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  146401. */
  146402. static readonly VELOCITY_TEXTURE_TYPE: number;
  146403. /**
  146404. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  146405. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  146406. */
  146407. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  146408. /**
  146409. * Dictionary used to store the previous transformation matrices of each rendered mesh
  146410. * in order to compute objects velocities when enableVelocity is set to "true"
  146411. * @hidden
  146412. */
  146413. _previousTransformationMatrices: {
  146414. [index: number]: ISavedTransformationMatrix;
  146415. };
  146416. /**
  146417. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  146418. * in order to compute objects velocities when enableVelocity is set to "true"
  146419. * @hidden
  146420. */
  146421. _previousBonesTransformationMatrices: {
  146422. [index: number]: Float32Array;
  146423. };
  146424. /**
  146425. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  146426. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  146427. */
  146428. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  146429. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  146430. renderTransparentMeshes: boolean;
  146431. private _scene;
  146432. private _multiRenderTarget;
  146433. private _ratio;
  146434. private _enablePosition;
  146435. private _enableVelocity;
  146436. private _enableReflectivity;
  146437. private _positionIndex;
  146438. private _velocityIndex;
  146439. private _reflectivityIndex;
  146440. protected _effect: Effect;
  146441. protected _cachedDefines: string;
  146442. /**
  146443. * Set the render list (meshes to be rendered) used in the G buffer.
  146444. */
  146445. set renderList(meshes: Mesh[]);
  146446. /**
  146447. * Gets wether or not G buffer are supported by the running hardware.
  146448. * This requires draw buffer supports
  146449. */
  146450. get isSupported(): boolean;
  146451. /**
  146452. * Returns the index of the given texture type in the G-Buffer textures array
  146453. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  146454. * @returns the index of the given texture type in the G-Buffer textures array
  146455. */
  146456. getTextureIndex(textureType: number): number;
  146457. /**
  146458. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  146459. */
  146460. get enablePosition(): boolean;
  146461. /**
  146462. * Sets whether or not objects positions are enabled for the G buffer.
  146463. */
  146464. set enablePosition(enable: boolean);
  146465. /**
  146466. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  146467. */
  146468. get enableVelocity(): boolean;
  146469. /**
  146470. * Sets wether or not objects velocities are enabled for the G buffer.
  146471. */
  146472. set enableVelocity(enable: boolean);
  146473. /**
  146474. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  146475. */
  146476. get enableReflectivity(): boolean;
  146477. /**
  146478. * Sets wether or not objects roughness are enabled for the G buffer.
  146479. */
  146480. set enableReflectivity(enable: boolean);
  146481. /**
  146482. * Gets the scene associated with the buffer.
  146483. */
  146484. get scene(): Scene;
  146485. /**
  146486. * Gets the ratio used by the buffer during its creation.
  146487. * How big is the buffer related to the main canvas.
  146488. */
  146489. get ratio(): number;
  146490. /** @hidden */
  146491. static _SceneComponentInitialization: (scene: Scene) => void;
  146492. /**
  146493. * Creates a new G Buffer for the scene
  146494. * @param scene The scene the buffer belongs to
  146495. * @param ratio How big is the buffer related to the main canvas.
  146496. */
  146497. constructor(scene: Scene, ratio?: number);
  146498. /**
  146499. * Checks wether everything is ready to render a submesh to the G buffer.
  146500. * @param subMesh the submesh to check readiness for
  146501. * @param useInstances is the mesh drawn using instance or not
  146502. * @returns true if ready otherwise false
  146503. */
  146504. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  146505. /**
  146506. * Gets the current underlying G Buffer.
  146507. * @returns the buffer
  146508. */
  146509. getGBuffer(): MultiRenderTarget;
  146510. /**
  146511. * Gets the number of samples used to render the buffer (anti aliasing).
  146512. */
  146513. get samples(): number;
  146514. /**
  146515. * Sets the number of samples used to render the buffer (anti aliasing).
  146516. */
  146517. set samples(value: number);
  146518. /**
  146519. * Disposes the renderer and frees up associated resources.
  146520. */
  146521. dispose(): void;
  146522. protected _createRenderTargets(): void;
  146523. private _copyBonesTransformationMatrices;
  146524. }
  146525. }
  146526. declare module BABYLON {
  146527. interface Scene {
  146528. /** @hidden (Backing field) */
  146529. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  146530. /**
  146531. * Gets or Sets the current geometry buffer associated to the scene.
  146532. */
  146533. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  146534. /**
  146535. * Enables a GeometryBufferRender and associates it with the scene
  146536. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  146537. * @returns the GeometryBufferRenderer
  146538. */
  146539. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  146540. /**
  146541. * Disables the GeometryBufferRender associated with the scene
  146542. */
  146543. disableGeometryBufferRenderer(): void;
  146544. }
  146545. /**
  146546. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  146547. * in several rendering techniques.
  146548. */
  146549. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  146550. /**
  146551. * The component name helpful to identify the component in the list of scene components.
  146552. */
  146553. readonly name: string;
  146554. /**
  146555. * The scene the component belongs to.
  146556. */
  146557. scene: Scene;
  146558. /**
  146559. * Creates a new instance of the component for the given scene
  146560. * @param scene Defines the scene to register the component in
  146561. */
  146562. constructor(scene: Scene);
  146563. /**
  146564. * Registers the component in a given scene
  146565. */
  146566. register(): void;
  146567. /**
  146568. * Rebuilds the elements related to this component in case of
  146569. * context lost for instance.
  146570. */
  146571. rebuild(): void;
  146572. /**
  146573. * Disposes the component and the associated ressources
  146574. */
  146575. dispose(): void;
  146576. private _gatherRenderTargets;
  146577. }
  146578. }
  146579. declare module BABYLON {
  146580. /** @hidden */
  146581. export var motionBlurPixelShader: {
  146582. name: string;
  146583. shader: string;
  146584. };
  146585. }
  146586. declare module BABYLON {
  146587. /**
  146588. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  146589. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  146590. * As an example, all you have to do is to create the post-process:
  146591. * var mb = new BABYLON.MotionBlurPostProcess(
  146592. * 'mb', // The name of the effect.
  146593. * scene, // The scene containing the objects to blur according to their velocity.
  146594. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  146595. * camera // The camera to apply the render pass to.
  146596. * );
  146597. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  146598. */
  146599. export class MotionBlurPostProcess extends PostProcess {
  146600. /**
  146601. * Defines how much the image is blurred by the movement. Default value is equal to 1
  146602. */
  146603. motionStrength: number;
  146604. /**
  146605. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  146606. */
  146607. get motionBlurSamples(): number;
  146608. /**
  146609. * Sets the number of iterations to be used for motion blur quality
  146610. */
  146611. set motionBlurSamples(samples: number);
  146612. private _motionBlurSamples;
  146613. private _geometryBufferRenderer;
  146614. /**
  146615. * Creates a new instance MotionBlurPostProcess
  146616. * @param name The name of the effect.
  146617. * @param scene The scene containing the objects to blur according to their velocity.
  146618. * @param options The required width/height ratio to downsize to before computing the render pass.
  146619. * @param camera The camera to apply the render pass to.
  146620. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146621. * @param engine The engine which the post process will be applied. (default: current engine)
  146622. * @param reusable If the post process can be reused on the same frame. (default: false)
  146623. * @param textureType Type of textures used when performing the post process. (default: 0)
  146624. * @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)
  146625. */
  146626. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  146627. /**
  146628. * Excludes the given skinned mesh from computing bones velocities.
  146629. * 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.
  146630. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  146631. */
  146632. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  146633. /**
  146634. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  146635. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  146636. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  146637. */
  146638. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  146639. /**
  146640. * Disposes the post process.
  146641. * @param camera The camera to dispose the post process on.
  146642. */
  146643. dispose(camera?: Camera): void;
  146644. }
  146645. }
  146646. declare module BABYLON {
  146647. /** @hidden */
  146648. export var refractionPixelShader: {
  146649. name: string;
  146650. shader: string;
  146651. };
  146652. }
  146653. declare module BABYLON {
  146654. /**
  146655. * Post process which applies a refractin texture
  146656. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  146657. */
  146658. export class RefractionPostProcess extends PostProcess {
  146659. /** the base color of the refraction (used to taint the rendering) */
  146660. color: Color3;
  146661. /** simulated refraction depth */
  146662. depth: number;
  146663. /** the coefficient of the base color (0 to remove base color tainting) */
  146664. colorLevel: number;
  146665. private _refTexture;
  146666. private _ownRefractionTexture;
  146667. /**
  146668. * Gets or sets the refraction texture
  146669. * Please note that you are responsible for disposing the texture if you set it manually
  146670. */
  146671. get refractionTexture(): Texture;
  146672. set refractionTexture(value: Texture);
  146673. /**
  146674. * Initializes the RefractionPostProcess
  146675. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  146676. * @param name The name of the effect.
  146677. * @param refractionTextureUrl Url of the refraction texture to use
  146678. * @param color the base color of the refraction (used to taint the rendering)
  146679. * @param depth simulated refraction depth
  146680. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  146681. * @param camera The camera to apply the render pass to.
  146682. * @param options The required width/height ratio to downsize to before computing the render pass.
  146683. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146684. * @param engine The engine which the post process will be applied. (default: current engine)
  146685. * @param reusable If the post process can be reused on the same frame. (default: false)
  146686. */
  146687. constructor(name: string, refractionTextureUrl: string,
  146688. /** the base color of the refraction (used to taint the rendering) */
  146689. color: Color3,
  146690. /** simulated refraction depth */
  146691. depth: number,
  146692. /** the coefficient of the base color (0 to remove base color tainting) */
  146693. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  146694. /**
  146695. * Disposes of the post process
  146696. * @param camera Camera to dispose post process on
  146697. */
  146698. dispose(camera: Camera): void;
  146699. }
  146700. }
  146701. declare module BABYLON {
  146702. /** @hidden */
  146703. export var sharpenPixelShader: {
  146704. name: string;
  146705. shader: string;
  146706. };
  146707. }
  146708. declare module BABYLON {
  146709. /**
  146710. * The SharpenPostProcess applies a sharpen kernel to every pixel
  146711. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  146712. */
  146713. export class SharpenPostProcess extends PostProcess {
  146714. /**
  146715. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  146716. */
  146717. colorAmount: number;
  146718. /**
  146719. * How much sharpness should be applied (default: 0.3)
  146720. */
  146721. edgeAmount: number;
  146722. /**
  146723. * Creates a new instance ConvolutionPostProcess
  146724. * @param name The name of the effect.
  146725. * @param options The required width/height ratio to downsize to before computing the render pass.
  146726. * @param camera The camera to apply the render pass to.
  146727. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146728. * @param engine The engine which the post process will be applied. (default: current engine)
  146729. * @param reusable If the post process can be reused on the same frame. (default: false)
  146730. * @param textureType Type of textures used when performing the post process. (default: 0)
  146731. * @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)
  146732. */
  146733. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  146734. }
  146735. }
  146736. declare module BABYLON {
  146737. /**
  146738. * PostProcessRenderPipeline
  146739. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  146740. */
  146741. export class PostProcessRenderPipeline {
  146742. private engine;
  146743. private _renderEffects;
  146744. private _renderEffectsForIsolatedPass;
  146745. /**
  146746. * List of inspectable custom properties (used by the Inspector)
  146747. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  146748. */
  146749. inspectableCustomProperties: IInspectable[];
  146750. /**
  146751. * @hidden
  146752. */
  146753. protected _cameras: Camera[];
  146754. /** @hidden */
  146755. _name: string;
  146756. /**
  146757. * Gets pipeline name
  146758. */
  146759. get name(): string;
  146760. /** Gets the list of attached cameras */
  146761. get cameras(): Camera[];
  146762. /**
  146763. * Initializes a PostProcessRenderPipeline
  146764. * @param engine engine to add the pipeline to
  146765. * @param name name of the pipeline
  146766. */
  146767. constructor(engine: Engine, name: string);
  146768. /**
  146769. * Gets the class name
  146770. * @returns "PostProcessRenderPipeline"
  146771. */
  146772. getClassName(): string;
  146773. /**
  146774. * If all the render effects in the pipeline are supported
  146775. */
  146776. get isSupported(): boolean;
  146777. /**
  146778. * Adds an effect to the pipeline
  146779. * @param renderEffect the effect to add
  146780. */
  146781. addEffect(renderEffect: PostProcessRenderEffect): void;
  146782. /** @hidden */
  146783. _rebuild(): void;
  146784. /** @hidden */
  146785. _enableEffect(renderEffectName: string, cameras: Camera): void;
  146786. /** @hidden */
  146787. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  146788. /** @hidden */
  146789. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  146790. /** @hidden */
  146791. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  146792. /** @hidden */
  146793. _attachCameras(cameras: Camera, unique: boolean): void;
  146794. /** @hidden */
  146795. _attachCameras(cameras: Camera[], unique: boolean): void;
  146796. /** @hidden */
  146797. _detachCameras(cameras: Camera): void;
  146798. /** @hidden */
  146799. _detachCameras(cameras: Nullable<Camera[]>): void;
  146800. /** @hidden */
  146801. _update(): void;
  146802. /** @hidden */
  146803. _reset(): void;
  146804. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  146805. /**
  146806. * Disposes of the pipeline
  146807. */
  146808. dispose(): void;
  146809. }
  146810. }
  146811. declare module BABYLON {
  146812. /**
  146813. * PostProcessRenderPipelineManager class
  146814. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  146815. */
  146816. export class PostProcessRenderPipelineManager {
  146817. private _renderPipelines;
  146818. /**
  146819. * Initializes a PostProcessRenderPipelineManager
  146820. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  146821. */
  146822. constructor();
  146823. /**
  146824. * Gets the list of supported render pipelines
  146825. */
  146826. get supportedPipelines(): PostProcessRenderPipeline[];
  146827. /**
  146828. * Adds a pipeline to the manager
  146829. * @param renderPipeline The pipeline to add
  146830. */
  146831. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  146832. /**
  146833. * Attaches a camera to the pipeline
  146834. * @param renderPipelineName The name of the pipeline to attach to
  146835. * @param cameras the camera to attach
  146836. * @param unique if the camera can be attached multiple times to the pipeline
  146837. */
  146838. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  146839. /**
  146840. * Detaches a camera from the pipeline
  146841. * @param renderPipelineName The name of the pipeline to detach from
  146842. * @param cameras the camera to detach
  146843. */
  146844. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  146845. /**
  146846. * Enables an effect by name on a pipeline
  146847. * @param renderPipelineName the name of the pipeline to enable the effect in
  146848. * @param renderEffectName the name of the effect to enable
  146849. * @param cameras the cameras that the effect should be enabled on
  146850. */
  146851. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  146852. /**
  146853. * Disables an effect by name on a pipeline
  146854. * @param renderPipelineName the name of the pipeline to disable the effect in
  146855. * @param renderEffectName the name of the effect to disable
  146856. * @param cameras the cameras that the effect should be disabled on
  146857. */
  146858. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  146859. /**
  146860. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  146861. */
  146862. update(): void;
  146863. /** @hidden */
  146864. _rebuild(): void;
  146865. /**
  146866. * Disposes of the manager and pipelines
  146867. */
  146868. dispose(): void;
  146869. }
  146870. }
  146871. declare module BABYLON {
  146872. interface Scene {
  146873. /** @hidden (Backing field) */
  146874. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  146875. /**
  146876. * Gets the postprocess render pipeline manager
  146877. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  146878. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  146879. */
  146880. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  146881. }
  146882. /**
  146883. * Defines the Render Pipeline scene component responsible to rendering pipelines
  146884. */
  146885. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  146886. /**
  146887. * The component name helpfull to identify the component in the list of scene components.
  146888. */
  146889. readonly name: string;
  146890. /**
  146891. * The scene the component belongs to.
  146892. */
  146893. scene: Scene;
  146894. /**
  146895. * Creates a new instance of the component for the given scene
  146896. * @param scene Defines the scene to register the component in
  146897. */
  146898. constructor(scene: Scene);
  146899. /**
  146900. * Registers the component in a given scene
  146901. */
  146902. register(): void;
  146903. /**
  146904. * Rebuilds the elements related to this component in case of
  146905. * context lost for instance.
  146906. */
  146907. rebuild(): void;
  146908. /**
  146909. * Disposes the component and the associated ressources
  146910. */
  146911. dispose(): void;
  146912. private _gatherRenderTargets;
  146913. }
  146914. }
  146915. declare module BABYLON {
  146916. /**
  146917. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  146918. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  146919. */
  146920. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  146921. private _scene;
  146922. private _camerasToBeAttached;
  146923. /**
  146924. * ID of the sharpen post process,
  146925. */
  146926. private readonly SharpenPostProcessId;
  146927. /**
  146928. * @ignore
  146929. * ID of the image processing post process;
  146930. */
  146931. readonly ImageProcessingPostProcessId: string;
  146932. /**
  146933. * @ignore
  146934. * ID of the Fast Approximate Anti-Aliasing post process;
  146935. */
  146936. readonly FxaaPostProcessId: string;
  146937. /**
  146938. * ID of the chromatic aberration post process,
  146939. */
  146940. private readonly ChromaticAberrationPostProcessId;
  146941. /**
  146942. * ID of the grain post process
  146943. */
  146944. private readonly GrainPostProcessId;
  146945. /**
  146946. * Sharpen post process which will apply a sharpen convolution to enhance edges
  146947. */
  146948. sharpen: SharpenPostProcess;
  146949. private _sharpenEffect;
  146950. private bloom;
  146951. /**
  146952. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  146953. */
  146954. depthOfField: DepthOfFieldEffect;
  146955. /**
  146956. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  146957. */
  146958. fxaa: FxaaPostProcess;
  146959. /**
  146960. * Image post processing pass used to perform operations such as tone mapping or color grading.
  146961. */
  146962. imageProcessing: ImageProcessingPostProcess;
  146963. /**
  146964. * Chromatic aberration post process which will shift rgb colors in the image
  146965. */
  146966. chromaticAberration: ChromaticAberrationPostProcess;
  146967. private _chromaticAberrationEffect;
  146968. /**
  146969. * Grain post process which add noise to the image
  146970. */
  146971. grain: GrainPostProcess;
  146972. private _grainEffect;
  146973. /**
  146974. * Glow post process which adds a glow to emissive areas of the image
  146975. */
  146976. private _glowLayer;
  146977. /**
  146978. * Animations which can be used to tweak settings over a period of time
  146979. */
  146980. animations: Animation[];
  146981. private _imageProcessingConfigurationObserver;
  146982. private _sharpenEnabled;
  146983. private _bloomEnabled;
  146984. private _depthOfFieldEnabled;
  146985. private _depthOfFieldBlurLevel;
  146986. private _fxaaEnabled;
  146987. private _imageProcessingEnabled;
  146988. private _defaultPipelineTextureType;
  146989. private _bloomScale;
  146990. private _chromaticAberrationEnabled;
  146991. private _grainEnabled;
  146992. private _buildAllowed;
  146993. /**
  146994. * Gets active scene
  146995. */
  146996. get scene(): Scene;
  146997. /**
  146998. * Enable or disable the sharpen process from the pipeline
  146999. */
  147000. set sharpenEnabled(enabled: boolean);
  147001. get sharpenEnabled(): boolean;
  147002. private _resizeObserver;
  147003. private _hardwareScaleLevel;
  147004. private _bloomKernel;
  147005. /**
  147006. * Specifies the size of the bloom blur kernel, relative to the final output size
  147007. */
  147008. get bloomKernel(): number;
  147009. set bloomKernel(value: number);
  147010. /**
  147011. * Specifies the weight of the bloom in the final rendering
  147012. */
  147013. private _bloomWeight;
  147014. /**
  147015. * Specifies the luma threshold for the area that will be blurred by the bloom
  147016. */
  147017. private _bloomThreshold;
  147018. private _hdr;
  147019. /**
  147020. * The strength of the bloom.
  147021. */
  147022. set bloomWeight(value: number);
  147023. get bloomWeight(): number;
  147024. /**
  147025. * The strength of the bloom.
  147026. */
  147027. set bloomThreshold(value: number);
  147028. get bloomThreshold(): number;
  147029. /**
  147030. * The scale of the bloom, lower value will provide better performance.
  147031. */
  147032. set bloomScale(value: number);
  147033. get bloomScale(): number;
  147034. /**
  147035. * Enable or disable the bloom from the pipeline
  147036. */
  147037. set bloomEnabled(enabled: boolean);
  147038. get bloomEnabled(): boolean;
  147039. private _rebuildBloom;
  147040. /**
  147041. * If the depth of field is enabled.
  147042. */
  147043. get depthOfFieldEnabled(): boolean;
  147044. set depthOfFieldEnabled(enabled: boolean);
  147045. /**
  147046. * Blur level of the depth of field effect. (Higher blur will effect performance)
  147047. */
  147048. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  147049. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  147050. /**
  147051. * If the anti aliasing is enabled.
  147052. */
  147053. set fxaaEnabled(enabled: boolean);
  147054. get fxaaEnabled(): boolean;
  147055. private _samples;
  147056. /**
  147057. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  147058. */
  147059. set samples(sampleCount: number);
  147060. get samples(): number;
  147061. /**
  147062. * If image processing is enabled.
  147063. */
  147064. set imageProcessingEnabled(enabled: boolean);
  147065. get imageProcessingEnabled(): boolean;
  147066. /**
  147067. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  147068. */
  147069. set glowLayerEnabled(enabled: boolean);
  147070. get glowLayerEnabled(): boolean;
  147071. /**
  147072. * Gets the glow layer (or null if not defined)
  147073. */
  147074. get glowLayer(): Nullable<GlowLayer>;
  147075. /**
  147076. * Enable or disable the chromaticAberration process from the pipeline
  147077. */
  147078. set chromaticAberrationEnabled(enabled: boolean);
  147079. get chromaticAberrationEnabled(): boolean;
  147080. /**
  147081. * Enable or disable the grain process from the pipeline
  147082. */
  147083. set grainEnabled(enabled: boolean);
  147084. get grainEnabled(): boolean;
  147085. /**
  147086. * @constructor
  147087. * @param name - The rendering pipeline name (default: "")
  147088. * @param hdr - If high dynamic range textures should be used (default: true)
  147089. * @param scene - The scene linked to this pipeline (default: the last created scene)
  147090. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  147091. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  147092. */
  147093. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  147094. /**
  147095. * Get the class name
  147096. * @returns "DefaultRenderingPipeline"
  147097. */
  147098. getClassName(): string;
  147099. /**
  147100. * Force the compilation of the entire pipeline.
  147101. */
  147102. prepare(): void;
  147103. private _hasCleared;
  147104. private _prevPostProcess;
  147105. private _prevPrevPostProcess;
  147106. private _setAutoClearAndTextureSharing;
  147107. private _depthOfFieldSceneObserver;
  147108. private _buildPipeline;
  147109. private _disposePostProcesses;
  147110. /**
  147111. * Adds a camera to the pipeline
  147112. * @param camera the camera to be added
  147113. */
  147114. addCamera(camera: Camera): void;
  147115. /**
  147116. * Removes a camera from the pipeline
  147117. * @param camera the camera to remove
  147118. */
  147119. removeCamera(camera: Camera): void;
  147120. /**
  147121. * Dispose of the pipeline and stop all post processes
  147122. */
  147123. dispose(): void;
  147124. /**
  147125. * Serialize the rendering pipeline (Used when exporting)
  147126. * @returns the serialized object
  147127. */
  147128. serialize(): any;
  147129. /**
  147130. * Parse the serialized pipeline
  147131. * @param source Source pipeline.
  147132. * @param scene The scene to load the pipeline to.
  147133. * @param rootUrl The URL of the serialized pipeline.
  147134. * @returns An instantiated pipeline from the serialized object.
  147135. */
  147136. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  147137. }
  147138. }
  147139. declare module BABYLON {
  147140. /** @hidden */
  147141. export var lensHighlightsPixelShader: {
  147142. name: string;
  147143. shader: string;
  147144. };
  147145. }
  147146. declare module BABYLON {
  147147. /** @hidden */
  147148. export var depthOfFieldPixelShader: {
  147149. name: string;
  147150. shader: string;
  147151. };
  147152. }
  147153. declare module BABYLON {
  147154. /**
  147155. * BABYLON.JS Chromatic Aberration GLSL Shader
  147156. * Author: Olivier Guyot
  147157. * Separates very slightly R, G and B colors on the edges of the screen
  147158. * Inspired by Francois Tarlier & Martins Upitis
  147159. */
  147160. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  147161. /**
  147162. * @ignore
  147163. * The chromatic aberration PostProcess id in the pipeline
  147164. */
  147165. LensChromaticAberrationEffect: string;
  147166. /**
  147167. * @ignore
  147168. * The highlights enhancing PostProcess id in the pipeline
  147169. */
  147170. HighlightsEnhancingEffect: string;
  147171. /**
  147172. * @ignore
  147173. * The depth-of-field PostProcess id in the pipeline
  147174. */
  147175. LensDepthOfFieldEffect: string;
  147176. private _scene;
  147177. private _depthTexture;
  147178. private _grainTexture;
  147179. private _chromaticAberrationPostProcess;
  147180. private _highlightsPostProcess;
  147181. private _depthOfFieldPostProcess;
  147182. private _edgeBlur;
  147183. private _grainAmount;
  147184. private _chromaticAberration;
  147185. private _distortion;
  147186. private _highlightsGain;
  147187. private _highlightsThreshold;
  147188. private _dofDistance;
  147189. private _dofAperture;
  147190. private _dofDarken;
  147191. private _dofPentagon;
  147192. private _blurNoise;
  147193. /**
  147194. * @constructor
  147195. *
  147196. * Effect parameters are as follow:
  147197. * {
  147198. * chromatic_aberration: number; // from 0 to x (1 for realism)
  147199. * edge_blur: number; // from 0 to x (1 for realism)
  147200. * distortion: number; // from 0 to x (1 for realism)
  147201. * grain_amount: number; // from 0 to 1
  147202. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  147203. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  147204. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  147205. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  147206. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  147207. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  147208. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  147209. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  147210. * }
  147211. * Note: if an effect parameter is unset, effect is disabled
  147212. *
  147213. * @param name The rendering pipeline name
  147214. * @param parameters - An object containing all parameters (see above)
  147215. * @param scene The scene linked to this pipeline
  147216. * @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)
  147217. * @param cameras The array of cameras that the rendering pipeline will be attached to
  147218. */
  147219. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  147220. /**
  147221. * Get the class name
  147222. * @returns "LensRenderingPipeline"
  147223. */
  147224. getClassName(): string;
  147225. /**
  147226. * Gets associated scene
  147227. */
  147228. get scene(): Scene;
  147229. /**
  147230. * Gets or sets the edge blur
  147231. */
  147232. get edgeBlur(): number;
  147233. set edgeBlur(value: number);
  147234. /**
  147235. * Gets or sets the grain amount
  147236. */
  147237. get grainAmount(): number;
  147238. set grainAmount(value: number);
  147239. /**
  147240. * Gets or sets the chromatic aberration amount
  147241. */
  147242. get chromaticAberration(): number;
  147243. set chromaticAberration(value: number);
  147244. /**
  147245. * Gets or sets the depth of field aperture
  147246. */
  147247. get dofAperture(): number;
  147248. set dofAperture(value: number);
  147249. /**
  147250. * Gets or sets the edge distortion
  147251. */
  147252. get edgeDistortion(): number;
  147253. set edgeDistortion(value: number);
  147254. /**
  147255. * Gets or sets the depth of field distortion
  147256. */
  147257. get dofDistortion(): number;
  147258. set dofDistortion(value: number);
  147259. /**
  147260. * Gets or sets the darken out of focus amount
  147261. */
  147262. get darkenOutOfFocus(): number;
  147263. set darkenOutOfFocus(value: number);
  147264. /**
  147265. * Gets or sets a boolean indicating if blur noise is enabled
  147266. */
  147267. get blurNoise(): boolean;
  147268. set blurNoise(value: boolean);
  147269. /**
  147270. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  147271. */
  147272. get pentagonBokeh(): boolean;
  147273. set pentagonBokeh(value: boolean);
  147274. /**
  147275. * Gets or sets the highlight grain amount
  147276. */
  147277. get highlightsGain(): number;
  147278. set highlightsGain(value: number);
  147279. /**
  147280. * Gets or sets the highlight threshold
  147281. */
  147282. get highlightsThreshold(): number;
  147283. set highlightsThreshold(value: number);
  147284. /**
  147285. * Sets the amount of blur at the edges
  147286. * @param amount blur amount
  147287. */
  147288. setEdgeBlur(amount: number): void;
  147289. /**
  147290. * Sets edge blur to 0
  147291. */
  147292. disableEdgeBlur(): void;
  147293. /**
  147294. * Sets the amout of grain
  147295. * @param amount Amount of grain
  147296. */
  147297. setGrainAmount(amount: number): void;
  147298. /**
  147299. * Set grain amount to 0
  147300. */
  147301. disableGrain(): void;
  147302. /**
  147303. * Sets the chromatic aberration amount
  147304. * @param amount amount of chromatic aberration
  147305. */
  147306. setChromaticAberration(amount: number): void;
  147307. /**
  147308. * Sets chromatic aberration amount to 0
  147309. */
  147310. disableChromaticAberration(): void;
  147311. /**
  147312. * Sets the EdgeDistortion amount
  147313. * @param amount amount of EdgeDistortion
  147314. */
  147315. setEdgeDistortion(amount: number): void;
  147316. /**
  147317. * Sets edge distortion to 0
  147318. */
  147319. disableEdgeDistortion(): void;
  147320. /**
  147321. * Sets the FocusDistance amount
  147322. * @param amount amount of FocusDistance
  147323. */
  147324. setFocusDistance(amount: number): void;
  147325. /**
  147326. * Disables depth of field
  147327. */
  147328. disableDepthOfField(): void;
  147329. /**
  147330. * Sets the Aperture amount
  147331. * @param amount amount of Aperture
  147332. */
  147333. setAperture(amount: number): void;
  147334. /**
  147335. * Sets the DarkenOutOfFocus amount
  147336. * @param amount amount of DarkenOutOfFocus
  147337. */
  147338. setDarkenOutOfFocus(amount: number): void;
  147339. private _pentagonBokehIsEnabled;
  147340. /**
  147341. * Creates a pentagon bokeh effect
  147342. */
  147343. enablePentagonBokeh(): void;
  147344. /**
  147345. * Disables the pentagon bokeh effect
  147346. */
  147347. disablePentagonBokeh(): void;
  147348. /**
  147349. * Enables noise blur
  147350. */
  147351. enableNoiseBlur(): void;
  147352. /**
  147353. * Disables noise blur
  147354. */
  147355. disableNoiseBlur(): void;
  147356. /**
  147357. * Sets the HighlightsGain amount
  147358. * @param amount amount of HighlightsGain
  147359. */
  147360. setHighlightsGain(amount: number): void;
  147361. /**
  147362. * Sets the HighlightsThreshold amount
  147363. * @param amount amount of HighlightsThreshold
  147364. */
  147365. setHighlightsThreshold(amount: number): void;
  147366. /**
  147367. * Disables highlights
  147368. */
  147369. disableHighlights(): void;
  147370. /**
  147371. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  147372. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  147373. */
  147374. dispose(disableDepthRender?: boolean): void;
  147375. private _createChromaticAberrationPostProcess;
  147376. private _createHighlightsPostProcess;
  147377. private _createDepthOfFieldPostProcess;
  147378. private _createGrainTexture;
  147379. }
  147380. }
  147381. declare module BABYLON {
  147382. /** @hidden */
  147383. export var ssao2PixelShader: {
  147384. name: string;
  147385. shader: string;
  147386. };
  147387. }
  147388. declare module BABYLON {
  147389. /** @hidden */
  147390. export var ssaoCombinePixelShader: {
  147391. name: string;
  147392. shader: string;
  147393. };
  147394. }
  147395. declare module BABYLON {
  147396. /**
  147397. * Render pipeline to produce ssao effect
  147398. */
  147399. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  147400. /**
  147401. * @ignore
  147402. * The PassPostProcess id in the pipeline that contains the original scene color
  147403. */
  147404. SSAOOriginalSceneColorEffect: string;
  147405. /**
  147406. * @ignore
  147407. * The SSAO PostProcess id in the pipeline
  147408. */
  147409. SSAORenderEffect: string;
  147410. /**
  147411. * @ignore
  147412. * The horizontal blur PostProcess id in the pipeline
  147413. */
  147414. SSAOBlurHRenderEffect: string;
  147415. /**
  147416. * @ignore
  147417. * The vertical blur PostProcess id in the pipeline
  147418. */
  147419. SSAOBlurVRenderEffect: string;
  147420. /**
  147421. * @ignore
  147422. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  147423. */
  147424. SSAOCombineRenderEffect: string;
  147425. /**
  147426. * The output strength of the SSAO post-process. Default value is 1.0.
  147427. */
  147428. totalStrength: number;
  147429. /**
  147430. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  147431. */
  147432. maxZ: number;
  147433. /**
  147434. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  147435. */
  147436. minZAspect: number;
  147437. private _samples;
  147438. /**
  147439. * Number of samples used for the SSAO calculations. Default value is 8
  147440. */
  147441. set samples(n: number);
  147442. get samples(): number;
  147443. private _textureSamples;
  147444. /**
  147445. * Number of samples to use for antialiasing
  147446. */
  147447. set textureSamples(n: number);
  147448. get textureSamples(): number;
  147449. /**
  147450. * Ratio object used for SSAO ratio and blur ratio
  147451. */
  147452. private _ratio;
  147453. /**
  147454. * Dynamically generated sphere sampler.
  147455. */
  147456. private _sampleSphere;
  147457. /**
  147458. * Blur filter offsets
  147459. */
  147460. private _samplerOffsets;
  147461. private _expensiveBlur;
  147462. /**
  147463. * If bilateral blur should be used
  147464. */
  147465. set expensiveBlur(b: boolean);
  147466. get expensiveBlur(): boolean;
  147467. /**
  147468. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  147469. */
  147470. radius: number;
  147471. /**
  147472. * The base color of the SSAO post-process
  147473. * The final result is "base + ssao" between [0, 1]
  147474. */
  147475. base: number;
  147476. /**
  147477. * Support test.
  147478. */
  147479. static get IsSupported(): boolean;
  147480. private _scene;
  147481. private _depthTexture;
  147482. private _normalTexture;
  147483. private _randomTexture;
  147484. private _originalColorPostProcess;
  147485. private _ssaoPostProcess;
  147486. private _blurHPostProcess;
  147487. private _blurVPostProcess;
  147488. private _ssaoCombinePostProcess;
  147489. /**
  147490. * Gets active scene
  147491. */
  147492. get scene(): Scene;
  147493. /**
  147494. * @constructor
  147495. * @param name The rendering pipeline name
  147496. * @param scene The scene linked to this pipeline
  147497. * @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 }
  147498. * @param cameras The array of cameras that the rendering pipeline will be attached to
  147499. */
  147500. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  147501. /**
  147502. * Get the class name
  147503. * @returns "SSAO2RenderingPipeline"
  147504. */
  147505. getClassName(): string;
  147506. /**
  147507. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  147508. */
  147509. dispose(disableGeometryBufferRenderer?: boolean): void;
  147510. private _createBlurPostProcess;
  147511. /** @hidden */
  147512. _rebuild(): void;
  147513. private _bits;
  147514. private _radicalInverse_VdC;
  147515. private _hammersley;
  147516. private _hemisphereSample_uniform;
  147517. private _generateHemisphere;
  147518. private _createSSAOPostProcess;
  147519. private _createSSAOCombinePostProcess;
  147520. private _createRandomTexture;
  147521. /**
  147522. * Serialize the rendering pipeline (Used when exporting)
  147523. * @returns the serialized object
  147524. */
  147525. serialize(): any;
  147526. /**
  147527. * Parse the serialized pipeline
  147528. * @param source Source pipeline.
  147529. * @param scene The scene to load the pipeline to.
  147530. * @param rootUrl The URL of the serialized pipeline.
  147531. * @returns An instantiated pipeline from the serialized object.
  147532. */
  147533. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  147534. }
  147535. }
  147536. declare module BABYLON {
  147537. /** @hidden */
  147538. export var ssaoPixelShader: {
  147539. name: string;
  147540. shader: string;
  147541. };
  147542. }
  147543. declare module BABYLON {
  147544. /**
  147545. * Render pipeline to produce ssao effect
  147546. */
  147547. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  147548. /**
  147549. * @ignore
  147550. * The PassPostProcess id in the pipeline that contains the original scene color
  147551. */
  147552. SSAOOriginalSceneColorEffect: string;
  147553. /**
  147554. * @ignore
  147555. * The SSAO PostProcess id in the pipeline
  147556. */
  147557. SSAORenderEffect: string;
  147558. /**
  147559. * @ignore
  147560. * The horizontal blur PostProcess id in the pipeline
  147561. */
  147562. SSAOBlurHRenderEffect: string;
  147563. /**
  147564. * @ignore
  147565. * The vertical blur PostProcess id in the pipeline
  147566. */
  147567. SSAOBlurVRenderEffect: string;
  147568. /**
  147569. * @ignore
  147570. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  147571. */
  147572. SSAOCombineRenderEffect: string;
  147573. /**
  147574. * The output strength of the SSAO post-process. Default value is 1.0.
  147575. */
  147576. totalStrength: number;
  147577. /**
  147578. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  147579. */
  147580. radius: number;
  147581. /**
  147582. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  147583. * Must not be equal to fallOff and superior to fallOff.
  147584. * Default value is 0.0075
  147585. */
  147586. area: number;
  147587. /**
  147588. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  147589. * Must not be equal to area and inferior to area.
  147590. * Default value is 0.000001
  147591. */
  147592. fallOff: number;
  147593. /**
  147594. * The base color of the SSAO post-process
  147595. * The final result is "base + ssao" between [0, 1]
  147596. */
  147597. base: number;
  147598. private _scene;
  147599. private _depthTexture;
  147600. private _randomTexture;
  147601. private _originalColorPostProcess;
  147602. private _ssaoPostProcess;
  147603. private _blurHPostProcess;
  147604. private _blurVPostProcess;
  147605. private _ssaoCombinePostProcess;
  147606. private _firstUpdate;
  147607. /**
  147608. * Gets active scene
  147609. */
  147610. get scene(): Scene;
  147611. /**
  147612. * @constructor
  147613. * @param name - The rendering pipeline name
  147614. * @param scene - The scene linked to this pipeline
  147615. * @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 }
  147616. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  147617. */
  147618. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  147619. /**
  147620. * Get the class name
  147621. * @returns "SSAORenderingPipeline"
  147622. */
  147623. getClassName(): string;
  147624. /**
  147625. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  147626. */
  147627. dispose(disableDepthRender?: boolean): void;
  147628. private _createBlurPostProcess;
  147629. /** @hidden */
  147630. _rebuild(): void;
  147631. private _createSSAOPostProcess;
  147632. private _createSSAOCombinePostProcess;
  147633. private _createRandomTexture;
  147634. }
  147635. }
  147636. declare module BABYLON {
  147637. /** @hidden */
  147638. export var screenSpaceReflectionPixelShader: {
  147639. name: string;
  147640. shader: string;
  147641. };
  147642. }
  147643. declare module BABYLON {
  147644. /**
  147645. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  147646. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  147647. */
  147648. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  147649. /**
  147650. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  147651. */
  147652. threshold: number;
  147653. /**
  147654. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  147655. */
  147656. strength: number;
  147657. /**
  147658. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  147659. */
  147660. reflectionSpecularFalloffExponent: number;
  147661. /**
  147662. * Gets or sets the step size used to iterate until the effect finds the color of the reflection's pixel. Typically in interval [0.1, 1.0]
  147663. */
  147664. step: number;
  147665. /**
  147666. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  147667. */
  147668. roughnessFactor: number;
  147669. private _geometryBufferRenderer;
  147670. private _enableSmoothReflections;
  147671. private _reflectionSamples;
  147672. private _smoothSteps;
  147673. /**
  147674. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  147675. * @param name The name of the effect.
  147676. * @param scene The scene containing the objects to calculate reflections.
  147677. * @param options The required width/height ratio to downsize to before computing the render pass.
  147678. * @param camera The camera to apply the render pass to.
  147679. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147680. * @param engine The engine which the post process will be applied. (default: current engine)
  147681. * @param reusable If the post process can be reused on the same frame. (default: false)
  147682. * @param textureType Type of textures used when performing the post process. (default: 0)
  147683. * @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)
  147684. */
  147685. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147686. /**
  147687. * Gets wether or not smoothing reflections is enabled.
  147688. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  147689. */
  147690. get enableSmoothReflections(): boolean;
  147691. /**
  147692. * Sets wether or not smoothing reflections is enabled.
  147693. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  147694. */
  147695. set enableSmoothReflections(enabled: boolean);
  147696. /**
  147697. * Gets the number of samples taken while computing reflections. More samples count is high,
  147698. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  147699. */
  147700. get reflectionSamples(): number;
  147701. /**
  147702. * Sets the number of samples taken while computing reflections. More samples count is high,
  147703. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  147704. */
  147705. set reflectionSamples(samples: number);
  147706. /**
  147707. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  147708. * more the post-process will require GPU power and can generate a drop in FPS.
  147709. * Default value (5.0) work pretty well in all cases but can be adjusted.
  147710. */
  147711. get smoothSteps(): number;
  147712. set smoothSteps(steps: number);
  147713. private _updateEffectDefines;
  147714. }
  147715. }
  147716. declare module BABYLON {
  147717. /** @hidden */
  147718. export var standardPixelShader: {
  147719. name: string;
  147720. shader: string;
  147721. };
  147722. }
  147723. declare module BABYLON {
  147724. /**
  147725. * Standard rendering pipeline
  147726. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  147727. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  147728. */
  147729. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  147730. /**
  147731. * Public members
  147732. */
  147733. /**
  147734. * Post-process which contains the original scene color before the pipeline applies all the effects
  147735. */
  147736. originalPostProcess: Nullable<PostProcess>;
  147737. /**
  147738. * Post-process used to down scale an image x4
  147739. */
  147740. downSampleX4PostProcess: Nullable<PostProcess>;
  147741. /**
  147742. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  147743. */
  147744. brightPassPostProcess: Nullable<PostProcess>;
  147745. /**
  147746. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  147747. */
  147748. blurHPostProcesses: PostProcess[];
  147749. /**
  147750. * Post-process array storing all the vertical blur post-processes used by the pipeline
  147751. */
  147752. blurVPostProcesses: PostProcess[];
  147753. /**
  147754. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  147755. */
  147756. textureAdderPostProcess: Nullable<PostProcess>;
  147757. /**
  147758. * Post-process used to create volumetric lighting effect
  147759. */
  147760. volumetricLightPostProcess: Nullable<PostProcess>;
  147761. /**
  147762. * Post-process used to smooth the previous volumetric light post-process on the X axis
  147763. */
  147764. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  147765. /**
  147766. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  147767. */
  147768. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  147769. /**
  147770. * Post-process used to merge the volumetric light effect and the real scene color
  147771. */
  147772. volumetricLightMergePostProces: Nullable<PostProcess>;
  147773. /**
  147774. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  147775. */
  147776. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  147777. /**
  147778. * Base post-process used to calculate the average luminance of the final image for HDR
  147779. */
  147780. luminancePostProcess: Nullable<PostProcess>;
  147781. /**
  147782. * Post-processes used to create down sample post-processes in order to get
  147783. * the average luminance of the final image for HDR
  147784. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  147785. */
  147786. luminanceDownSamplePostProcesses: PostProcess[];
  147787. /**
  147788. * Post-process used to create a HDR effect (light adaptation)
  147789. */
  147790. hdrPostProcess: Nullable<PostProcess>;
  147791. /**
  147792. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  147793. */
  147794. textureAdderFinalPostProcess: Nullable<PostProcess>;
  147795. /**
  147796. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  147797. */
  147798. lensFlareFinalPostProcess: Nullable<PostProcess>;
  147799. /**
  147800. * Post-process used to merge the final HDR post-process and the real scene color
  147801. */
  147802. hdrFinalPostProcess: Nullable<PostProcess>;
  147803. /**
  147804. * Post-process used to create a lens flare effect
  147805. */
  147806. lensFlarePostProcess: Nullable<PostProcess>;
  147807. /**
  147808. * Post-process that merges the result of the lens flare post-process and the real scene color
  147809. */
  147810. lensFlareComposePostProcess: Nullable<PostProcess>;
  147811. /**
  147812. * Post-process used to create a motion blur effect
  147813. */
  147814. motionBlurPostProcess: Nullable<PostProcess>;
  147815. /**
  147816. * Post-process used to create a depth of field effect
  147817. */
  147818. depthOfFieldPostProcess: Nullable<PostProcess>;
  147819. /**
  147820. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  147821. */
  147822. fxaaPostProcess: Nullable<FxaaPostProcess>;
  147823. /**
  147824. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  147825. */
  147826. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  147827. /**
  147828. * Represents the brightness threshold in order to configure the illuminated surfaces
  147829. */
  147830. brightThreshold: number;
  147831. /**
  147832. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  147833. */
  147834. blurWidth: number;
  147835. /**
  147836. * Sets if the blur for highlighted surfaces must be only horizontal
  147837. */
  147838. horizontalBlur: boolean;
  147839. /**
  147840. * Gets the overall exposure used by the pipeline
  147841. */
  147842. get exposure(): number;
  147843. /**
  147844. * Sets the overall exposure used by the pipeline
  147845. */
  147846. set exposure(value: number);
  147847. /**
  147848. * Texture used typically to simulate "dirty" on camera lens
  147849. */
  147850. lensTexture: Nullable<Texture>;
  147851. /**
  147852. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  147853. */
  147854. volumetricLightCoefficient: number;
  147855. /**
  147856. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  147857. */
  147858. volumetricLightPower: number;
  147859. /**
  147860. * Used the set the blur intensity to smooth the volumetric lights
  147861. */
  147862. volumetricLightBlurScale: number;
  147863. /**
  147864. * Light (spot or directional) used to generate the volumetric lights rays
  147865. * The source light must have a shadow generate so the pipeline can get its
  147866. * depth map
  147867. */
  147868. sourceLight: Nullable<SpotLight | DirectionalLight>;
  147869. /**
  147870. * For eye adaptation, represents the minimum luminance the eye can see
  147871. */
  147872. hdrMinimumLuminance: number;
  147873. /**
  147874. * For eye adaptation, represents the decrease luminance speed
  147875. */
  147876. hdrDecreaseRate: number;
  147877. /**
  147878. * For eye adaptation, represents the increase luminance speed
  147879. */
  147880. hdrIncreaseRate: number;
  147881. /**
  147882. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  147883. */
  147884. get hdrAutoExposure(): boolean;
  147885. /**
  147886. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  147887. */
  147888. set hdrAutoExposure(value: boolean);
  147889. /**
  147890. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  147891. */
  147892. lensColorTexture: Nullable<Texture>;
  147893. /**
  147894. * The overall strengh for the lens flare effect
  147895. */
  147896. lensFlareStrength: number;
  147897. /**
  147898. * Dispersion coefficient for lens flare ghosts
  147899. */
  147900. lensFlareGhostDispersal: number;
  147901. /**
  147902. * Main lens flare halo width
  147903. */
  147904. lensFlareHaloWidth: number;
  147905. /**
  147906. * Based on the lens distortion effect, defines how much the lens flare result
  147907. * is distorted
  147908. */
  147909. lensFlareDistortionStrength: number;
  147910. /**
  147911. * Configures the blur intensity used for for lens flare (halo)
  147912. */
  147913. lensFlareBlurWidth: number;
  147914. /**
  147915. * Lens star texture must be used to simulate rays on the flares and is available
  147916. * in the documentation
  147917. */
  147918. lensStarTexture: Nullable<Texture>;
  147919. /**
  147920. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  147921. * flare effect by taking account of the dirt texture
  147922. */
  147923. lensFlareDirtTexture: Nullable<Texture>;
  147924. /**
  147925. * Represents the focal length for the depth of field effect
  147926. */
  147927. depthOfFieldDistance: number;
  147928. /**
  147929. * Represents the blur intensity for the blurred part of the depth of field effect
  147930. */
  147931. depthOfFieldBlurWidth: number;
  147932. /**
  147933. * Gets how much the image is blurred by the movement while using the motion blur post-process
  147934. */
  147935. get motionStrength(): number;
  147936. /**
  147937. * Sets how much the image is blurred by the movement while using the motion blur post-process
  147938. */
  147939. set motionStrength(strength: number);
  147940. /**
  147941. * Gets wether or not the motion blur post-process is object based or screen based.
  147942. */
  147943. get objectBasedMotionBlur(): boolean;
  147944. /**
  147945. * Sets wether or not the motion blur post-process should be object based or screen based
  147946. */
  147947. set objectBasedMotionBlur(value: boolean);
  147948. /**
  147949. * List of animations for the pipeline (IAnimatable implementation)
  147950. */
  147951. animations: Animation[];
  147952. /**
  147953. * Private members
  147954. */
  147955. private _scene;
  147956. private _currentDepthOfFieldSource;
  147957. private _basePostProcess;
  147958. private _fixedExposure;
  147959. private _currentExposure;
  147960. private _hdrAutoExposure;
  147961. private _hdrCurrentLuminance;
  147962. private _motionStrength;
  147963. private _isObjectBasedMotionBlur;
  147964. private _floatTextureType;
  147965. private _camerasToBeAttached;
  147966. private _ratio;
  147967. private _bloomEnabled;
  147968. private _depthOfFieldEnabled;
  147969. private _vlsEnabled;
  147970. private _lensFlareEnabled;
  147971. private _hdrEnabled;
  147972. private _motionBlurEnabled;
  147973. private _fxaaEnabled;
  147974. private _screenSpaceReflectionsEnabled;
  147975. private _motionBlurSamples;
  147976. private _volumetricLightStepsCount;
  147977. private _samples;
  147978. /**
  147979. * @ignore
  147980. * Specifies if the bloom pipeline is enabled
  147981. */
  147982. get BloomEnabled(): boolean;
  147983. set BloomEnabled(enabled: boolean);
  147984. /**
  147985. * @ignore
  147986. * Specifies if the depth of field pipeline is enabed
  147987. */
  147988. get DepthOfFieldEnabled(): boolean;
  147989. set DepthOfFieldEnabled(enabled: boolean);
  147990. /**
  147991. * @ignore
  147992. * Specifies if the lens flare pipeline is enabed
  147993. */
  147994. get LensFlareEnabled(): boolean;
  147995. set LensFlareEnabled(enabled: boolean);
  147996. /**
  147997. * @ignore
  147998. * Specifies if the HDR pipeline is enabled
  147999. */
  148000. get HDREnabled(): boolean;
  148001. set HDREnabled(enabled: boolean);
  148002. /**
  148003. * @ignore
  148004. * Specifies if the volumetric lights scattering effect is enabled
  148005. */
  148006. get VLSEnabled(): boolean;
  148007. set VLSEnabled(enabled: boolean);
  148008. /**
  148009. * @ignore
  148010. * Specifies if the motion blur effect is enabled
  148011. */
  148012. get MotionBlurEnabled(): boolean;
  148013. set MotionBlurEnabled(enabled: boolean);
  148014. /**
  148015. * Specifies if anti-aliasing is enabled
  148016. */
  148017. get fxaaEnabled(): boolean;
  148018. set fxaaEnabled(enabled: boolean);
  148019. /**
  148020. * Specifies if screen space reflections are enabled.
  148021. */
  148022. get screenSpaceReflectionsEnabled(): boolean;
  148023. set screenSpaceReflectionsEnabled(enabled: boolean);
  148024. /**
  148025. * Specifies the number of steps used to calculate the volumetric lights
  148026. * Typically in interval [50, 200]
  148027. */
  148028. get volumetricLightStepsCount(): number;
  148029. set volumetricLightStepsCount(count: number);
  148030. /**
  148031. * Specifies the number of samples used for the motion blur effect
  148032. * Typically in interval [16, 64]
  148033. */
  148034. get motionBlurSamples(): number;
  148035. set motionBlurSamples(samples: number);
  148036. /**
  148037. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  148038. */
  148039. get samples(): number;
  148040. set samples(sampleCount: number);
  148041. /**
  148042. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  148043. * @constructor
  148044. * @param name The rendering pipeline name
  148045. * @param scene The scene linked to this pipeline
  148046. * @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)
  148047. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  148048. * @param cameras The array of cameras that the rendering pipeline will be attached to
  148049. */
  148050. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  148051. private _buildPipeline;
  148052. private _createDownSampleX4PostProcess;
  148053. private _createBrightPassPostProcess;
  148054. private _createBlurPostProcesses;
  148055. private _createTextureAdderPostProcess;
  148056. private _createVolumetricLightPostProcess;
  148057. private _createLuminancePostProcesses;
  148058. private _createHdrPostProcess;
  148059. private _createLensFlarePostProcess;
  148060. private _createDepthOfFieldPostProcess;
  148061. private _createMotionBlurPostProcess;
  148062. private _getDepthTexture;
  148063. private _disposePostProcesses;
  148064. /**
  148065. * Dispose of the pipeline and stop all post processes
  148066. */
  148067. dispose(): void;
  148068. /**
  148069. * Serialize the rendering pipeline (Used when exporting)
  148070. * @returns the serialized object
  148071. */
  148072. serialize(): any;
  148073. /**
  148074. * Parse the serialized pipeline
  148075. * @param source Source pipeline.
  148076. * @param scene The scene to load the pipeline to.
  148077. * @param rootUrl The URL of the serialized pipeline.
  148078. * @returns An instantiated pipeline from the serialized object.
  148079. */
  148080. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  148081. /**
  148082. * Luminance steps
  148083. */
  148084. static LuminanceSteps: number;
  148085. }
  148086. }
  148087. declare module BABYLON {
  148088. /** @hidden */
  148089. export var stereoscopicInterlacePixelShader: {
  148090. name: string;
  148091. shader: string;
  148092. };
  148093. }
  148094. declare module BABYLON {
  148095. /**
  148096. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  148097. */
  148098. export class StereoscopicInterlacePostProcessI extends PostProcess {
  148099. private _stepSize;
  148100. private _passedProcess;
  148101. /**
  148102. * Initializes a StereoscopicInterlacePostProcessI
  148103. * @param name The name of the effect.
  148104. * @param rigCameras The rig cameras to be appled to the post process
  148105. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  148106. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  148107. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148108. * @param engine The engine which the post process will be applied. (default: current engine)
  148109. * @param reusable If the post process can be reused on the same frame. (default: false)
  148110. */
  148111. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148112. }
  148113. /**
  148114. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  148115. */
  148116. export class StereoscopicInterlacePostProcess extends PostProcess {
  148117. private _stepSize;
  148118. private _passedProcess;
  148119. /**
  148120. * Initializes a StereoscopicInterlacePostProcess
  148121. * @param name The name of the effect.
  148122. * @param rigCameras The rig cameras to be appled to the post process
  148123. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  148124. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148125. * @param engine The engine which the post process will be applied. (default: current engine)
  148126. * @param reusable If the post process can be reused on the same frame. (default: false)
  148127. */
  148128. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148129. }
  148130. }
  148131. declare module BABYLON {
  148132. /** @hidden */
  148133. export var tonemapPixelShader: {
  148134. name: string;
  148135. shader: string;
  148136. };
  148137. }
  148138. declare module BABYLON {
  148139. /** Defines operator used for tonemapping */
  148140. export enum TonemappingOperator {
  148141. /** Hable */
  148142. Hable = 0,
  148143. /** Reinhard */
  148144. Reinhard = 1,
  148145. /** HejiDawson */
  148146. HejiDawson = 2,
  148147. /** Photographic */
  148148. Photographic = 3
  148149. }
  148150. /**
  148151. * Defines a post process to apply tone mapping
  148152. */
  148153. export class TonemapPostProcess extends PostProcess {
  148154. private _operator;
  148155. /** Defines the required exposure adjustement */
  148156. exposureAdjustment: number;
  148157. /**
  148158. * Creates a new TonemapPostProcess
  148159. * @param name defines the name of the postprocess
  148160. * @param _operator defines the operator to use
  148161. * @param exposureAdjustment defines the required exposure adjustement
  148162. * @param camera defines the camera to use (can be null)
  148163. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  148164. * @param engine defines the hosting engine (can be ignore if camera is set)
  148165. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  148166. */
  148167. constructor(name: string, _operator: TonemappingOperator,
  148168. /** Defines the required exposure adjustement */
  148169. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  148170. }
  148171. }
  148172. declare module BABYLON {
  148173. /** @hidden */
  148174. export var volumetricLightScatteringPixelShader: {
  148175. name: string;
  148176. shader: string;
  148177. };
  148178. }
  148179. declare module BABYLON {
  148180. /** @hidden */
  148181. export var volumetricLightScatteringPassVertexShader: {
  148182. name: string;
  148183. shader: string;
  148184. };
  148185. }
  148186. declare module BABYLON {
  148187. /** @hidden */
  148188. export var volumetricLightScatteringPassPixelShader: {
  148189. name: string;
  148190. shader: string;
  148191. };
  148192. }
  148193. declare module BABYLON {
  148194. /**
  148195. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  148196. */
  148197. export class VolumetricLightScatteringPostProcess extends PostProcess {
  148198. private _volumetricLightScatteringPass;
  148199. private _volumetricLightScatteringRTT;
  148200. private _viewPort;
  148201. private _screenCoordinates;
  148202. private _cachedDefines;
  148203. /**
  148204. * If not undefined, the mesh position is computed from the attached node position
  148205. */
  148206. attachedNode: {
  148207. position: Vector3;
  148208. };
  148209. /**
  148210. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  148211. */
  148212. customMeshPosition: Vector3;
  148213. /**
  148214. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  148215. */
  148216. useCustomMeshPosition: boolean;
  148217. /**
  148218. * If the post-process should inverse the light scattering direction
  148219. */
  148220. invert: boolean;
  148221. /**
  148222. * The internal mesh used by the post-process
  148223. */
  148224. mesh: Mesh;
  148225. /**
  148226. * @hidden
  148227. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  148228. */
  148229. get useDiffuseColor(): boolean;
  148230. set useDiffuseColor(useDiffuseColor: boolean);
  148231. /**
  148232. * Array containing the excluded meshes not rendered in the internal pass
  148233. */
  148234. excludedMeshes: AbstractMesh[];
  148235. /**
  148236. * Controls the overall intensity of the post-process
  148237. */
  148238. exposure: number;
  148239. /**
  148240. * Dissipates each sample's contribution in range [0, 1]
  148241. */
  148242. decay: number;
  148243. /**
  148244. * Controls the overall intensity of each sample
  148245. */
  148246. weight: number;
  148247. /**
  148248. * Controls the density of each sample
  148249. */
  148250. density: number;
  148251. /**
  148252. * @constructor
  148253. * @param name The post-process name
  148254. * @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)
  148255. * @param camera The camera that the post-process will be attached to
  148256. * @param mesh The mesh used to create the light scattering
  148257. * @param samples The post-process quality, default 100
  148258. * @param samplingModeThe post-process filtering mode
  148259. * @param engine The babylon engine
  148260. * @param reusable If the post-process is reusable
  148261. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  148262. */
  148263. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  148264. /**
  148265. * Returns the string "VolumetricLightScatteringPostProcess"
  148266. * @returns "VolumetricLightScatteringPostProcess"
  148267. */
  148268. getClassName(): string;
  148269. private _isReady;
  148270. /**
  148271. * Sets the new light position for light scattering effect
  148272. * @param position The new custom light position
  148273. */
  148274. setCustomMeshPosition(position: Vector3): void;
  148275. /**
  148276. * Returns the light position for light scattering effect
  148277. * @return Vector3 The custom light position
  148278. */
  148279. getCustomMeshPosition(): Vector3;
  148280. /**
  148281. * Disposes the internal assets and detaches the post-process from the camera
  148282. */
  148283. dispose(camera: Camera): void;
  148284. /**
  148285. * Returns the render target texture used by the post-process
  148286. * @return the render target texture used by the post-process
  148287. */
  148288. getPass(): RenderTargetTexture;
  148289. private _meshExcluded;
  148290. private _createPass;
  148291. private _updateMeshScreenCoordinates;
  148292. /**
  148293. * Creates a default mesh for the Volumeric Light Scattering post-process
  148294. * @param name The mesh name
  148295. * @param scene The scene where to create the mesh
  148296. * @return the default mesh
  148297. */
  148298. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  148299. }
  148300. }
  148301. declare module BABYLON {
  148302. interface Scene {
  148303. /** @hidden (Backing field) */
  148304. _boundingBoxRenderer: BoundingBoxRenderer;
  148305. /** @hidden (Backing field) */
  148306. _forceShowBoundingBoxes: boolean;
  148307. /**
  148308. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  148309. */
  148310. forceShowBoundingBoxes: boolean;
  148311. /**
  148312. * Gets the bounding box renderer associated with the scene
  148313. * @returns a BoundingBoxRenderer
  148314. */
  148315. getBoundingBoxRenderer(): BoundingBoxRenderer;
  148316. }
  148317. interface AbstractMesh {
  148318. /** @hidden (Backing field) */
  148319. _showBoundingBox: boolean;
  148320. /**
  148321. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  148322. */
  148323. showBoundingBox: boolean;
  148324. }
  148325. /**
  148326. * Component responsible of rendering the bounding box of the meshes in a scene.
  148327. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  148328. */
  148329. export class BoundingBoxRenderer implements ISceneComponent {
  148330. /**
  148331. * The component name helpfull to identify the component in the list of scene components.
  148332. */
  148333. readonly name: string;
  148334. /**
  148335. * The scene the component belongs to.
  148336. */
  148337. scene: Scene;
  148338. /**
  148339. * Color of the bounding box lines placed in front of an object
  148340. */
  148341. frontColor: Color3;
  148342. /**
  148343. * Color of the bounding box lines placed behind an object
  148344. */
  148345. backColor: Color3;
  148346. /**
  148347. * Defines if the renderer should show the back lines or not
  148348. */
  148349. showBackLines: boolean;
  148350. /**
  148351. * Observable raised before rendering a bounding box
  148352. */
  148353. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  148354. /**
  148355. * Observable raised after rendering a bounding box
  148356. */
  148357. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  148358. /**
  148359. * @hidden
  148360. */
  148361. renderList: SmartArray<BoundingBox>;
  148362. private _colorShader;
  148363. private _vertexBuffers;
  148364. private _indexBuffer;
  148365. private _fillIndexBuffer;
  148366. private _fillIndexData;
  148367. /**
  148368. * Instantiates a new bounding box renderer in a scene.
  148369. * @param scene the scene the renderer renders in
  148370. */
  148371. constructor(scene: Scene);
  148372. /**
  148373. * Registers the component in a given scene
  148374. */
  148375. register(): void;
  148376. private _evaluateSubMesh;
  148377. private _activeMesh;
  148378. private _prepareRessources;
  148379. private _createIndexBuffer;
  148380. /**
  148381. * Rebuilds the elements related to this component in case of
  148382. * context lost for instance.
  148383. */
  148384. rebuild(): void;
  148385. /**
  148386. * @hidden
  148387. */
  148388. reset(): void;
  148389. /**
  148390. * Render the bounding boxes of a specific rendering group
  148391. * @param renderingGroupId defines the rendering group to render
  148392. */
  148393. render(renderingGroupId: number): void;
  148394. /**
  148395. * In case of occlusion queries, we can render the occlusion bounding box through this method
  148396. * @param mesh Define the mesh to render the occlusion bounding box for
  148397. */
  148398. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  148399. /**
  148400. * Dispose and release the resources attached to this renderer.
  148401. */
  148402. dispose(): void;
  148403. }
  148404. }
  148405. declare module BABYLON {
  148406. interface Scene {
  148407. /** @hidden (Backing field) */
  148408. _depthRenderer: {
  148409. [id: string]: DepthRenderer;
  148410. };
  148411. /**
  148412. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  148413. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  148414. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  148415. * @returns the created depth renderer
  148416. */
  148417. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  148418. /**
  148419. * Disables a depth renderer for a given camera
  148420. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  148421. */
  148422. disableDepthRenderer(camera?: Nullable<Camera>): void;
  148423. }
  148424. /**
  148425. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  148426. * in several rendering techniques.
  148427. */
  148428. export class DepthRendererSceneComponent implements ISceneComponent {
  148429. /**
  148430. * The component name helpfull to identify the component in the list of scene components.
  148431. */
  148432. readonly name: string;
  148433. /**
  148434. * The scene the component belongs to.
  148435. */
  148436. scene: Scene;
  148437. /**
  148438. * Creates a new instance of the component for the given scene
  148439. * @param scene Defines the scene to register the component in
  148440. */
  148441. constructor(scene: Scene);
  148442. /**
  148443. * Registers the component in a given scene
  148444. */
  148445. register(): void;
  148446. /**
  148447. * Rebuilds the elements related to this component in case of
  148448. * context lost for instance.
  148449. */
  148450. rebuild(): void;
  148451. /**
  148452. * Disposes the component and the associated ressources
  148453. */
  148454. dispose(): void;
  148455. private _gatherRenderTargets;
  148456. private _gatherActiveCameraRenderTargets;
  148457. }
  148458. }
  148459. declare module BABYLON {
  148460. /** @hidden */
  148461. export var outlinePixelShader: {
  148462. name: string;
  148463. shader: string;
  148464. };
  148465. }
  148466. declare module BABYLON {
  148467. /** @hidden */
  148468. export var outlineVertexShader: {
  148469. name: string;
  148470. shader: string;
  148471. };
  148472. }
  148473. declare module BABYLON {
  148474. interface Scene {
  148475. /** @hidden */
  148476. _outlineRenderer: OutlineRenderer;
  148477. /**
  148478. * Gets the outline renderer associated with the scene
  148479. * @returns a OutlineRenderer
  148480. */
  148481. getOutlineRenderer(): OutlineRenderer;
  148482. }
  148483. interface AbstractMesh {
  148484. /** @hidden (Backing field) */
  148485. _renderOutline: boolean;
  148486. /**
  148487. * Gets or sets a boolean indicating if the outline must be rendered as well
  148488. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  148489. */
  148490. renderOutline: boolean;
  148491. /** @hidden (Backing field) */
  148492. _renderOverlay: boolean;
  148493. /**
  148494. * Gets or sets a boolean indicating if the overlay must be rendered as well
  148495. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  148496. */
  148497. renderOverlay: boolean;
  148498. }
  148499. /**
  148500. * This class is responsible to draw bothe outline/overlay of meshes.
  148501. * It should not be used directly but through the available method on mesh.
  148502. */
  148503. export class OutlineRenderer implements ISceneComponent {
  148504. /**
  148505. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  148506. */
  148507. private static _StencilReference;
  148508. /**
  148509. * The name of the component. Each component must have a unique name.
  148510. */
  148511. name: string;
  148512. /**
  148513. * The scene the component belongs to.
  148514. */
  148515. scene: Scene;
  148516. /**
  148517. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  148518. */
  148519. zOffset: number;
  148520. private _engine;
  148521. private _effect;
  148522. private _cachedDefines;
  148523. private _savedDepthWrite;
  148524. /**
  148525. * Instantiates a new outline renderer. (There could be only one per scene).
  148526. * @param scene Defines the scene it belongs to
  148527. */
  148528. constructor(scene: Scene);
  148529. /**
  148530. * Register the component to one instance of a scene.
  148531. */
  148532. register(): void;
  148533. /**
  148534. * Rebuilds the elements related to this component in case of
  148535. * context lost for instance.
  148536. */
  148537. rebuild(): void;
  148538. /**
  148539. * Disposes the component and the associated ressources.
  148540. */
  148541. dispose(): void;
  148542. /**
  148543. * Renders the outline in the canvas.
  148544. * @param subMesh Defines the sumesh to render
  148545. * @param batch Defines the batch of meshes in case of instances
  148546. * @param useOverlay Defines if the rendering is for the overlay or the outline
  148547. */
  148548. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  148549. /**
  148550. * Returns whether or not the outline renderer is ready for a given submesh.
  148551. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  148552. * @param subMesh Defines the submesh to check readyness for
  148553. * @param useInstances Defines wheter wee are trying to render instances or not
  148554. * @returns true if ready otherwise false
  148555. */
  148556. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  148557. private _beforeRenderingMesh;
  148558. private _afterRenderingMesh;
  148559. }
  148560. }
  148561. declare module BABYLON {
  148562. /**
  148563. * Defines the basic options interface of a Sprite Frame Source Size.
  148564. */
  148565. export interface ISpriteJSONSpriteSourceSize {
  148566. /**
  148567. * number of the original width of the Frame
  148568. */
  148569. w: number;
  148570. /**
  148571. * number of the original height of the Frame
  148572. */
  148573. h: number;
  148574. }
  148575. /**
  148576. * Defines the basic options interface of a Sprite Frame Data.
  148577. */
  148578. export interface ISpriteJSONSpriteFrameData {
  148579. /**
  148580. * number of the x offset of the Frame
  148581. */
  148582. x: number;
  148583. /**
  148584. * number of the y offset of the Frame
  148585. */
  148586. y: number;
  148587. /**
  148588. * number of the width of the Frame
  148589. */
  148590. w: number;
  148591. /**
  148592. * number of the height of the Frame
  148593. */
  148594. h: number;
  148595. }
  148596. /**
  148597. * Defines the basic options interface of a JSON Sprite.
  148598. */
  148599. export interface ISpriteJSONSprite {
  148600. /**
  148601. * string name of the Frame
  148602. */
  148603. filename: string;
  148604. /**
  148605. * ISpriteJSONSpriteFrame basic object of the frame data
  148606. */
  148607. frame: ISpriteJSONSpriteFrameData;
  148608. /**
  148609. * boolean to flag is the frame was rotated.
  148610. */
  148611. rotated: boolean;
  148612. /**
  148613. * boolean to flag is the frame was trimmed.
  148614. */
  148615. trimmed: boolean;
  148616. /**
  148617. * ISpriteJSONSpriteFrame basic object of the source data
  148618. */
  148619. spriteSourceSize: ISpriteJSONSpriteFrameData;
  148620. /**
  148621. * ISpriteJSONSpriteFrame basic object of the source data
  148622. */
  148623. sourceSize: ISpriteJSONSpriteSourceSize;
  148624. }
  148625. /**
  148626. * Defines the basic options interface of a JSON atlas.
  148627. */
  148628. export interface ISpriteJSONAtlas {
  148629. /**
  148630. * Array of objects that contain the frame data.
  148631. */
  148632. frames: Array<ISpriteJSONSprite>;
  148633. /**
  148634. * object basic object containing the sprite meta data.
  148635. */
  148636. meta?: object;
  148637. }
  148638. }
  148639. declare module BABYLON {
  148640. /** @hidden */
  148641. export var spriteMapPixelShader: {
  148642. name: string;
  148643. shader: string;
  148644. };
  148645. }
  148646. declare module BABYLON {
  148647. /** @hidden */
  148648. export var spriteMapVertexShader: {
  148649. name: string;
  148650. shader: string;
  148651. };
  148652. }
  148653. declare module BABYLON {
  148654. /**
  148655. * Defines the basic options interface of a SpriteMap
  148656. */
  148657. export interface ISpriteMapOptions {
  148658. /**
  148659. * Vector2 of the number of cells in the grid.
  148660. */
  148661. stageSize?: Vector2;
  148662. /**
  148663. * Vector2 of the size of the output plane in World Units.
  148664. */
  148665. outputSize?: Vector2;
  148666. /**
  148667. * Vector3 of the position of the output plane in World Units.
  148668. */
  148669. outputPosition?: Vector3;
  148670. /**
  148671. * Vector3 of the rotation of the output plane.
  148672. */
  148673. outputRotation?: Vector3;
  148674. /**
  148675. * number of layers that the system will reserve in resources.
  148676. */
  148677. layerCount?: number;
  148678. /**
  148679. * number of max animation frames a single cell will reserve in resources.
  148680. */
  148681. maxAnimationFrames?: number;
  148682. /**
  148683. * number cell index of the base tile when the system compiles.
  148684. */
  148685. baseTile?: number;
  148686. /**
  148687. * boolean flip the sprite after its been repositioned by the framing data.
  148688. */
  148689. flipU?: boolean;
  148690. /**
  148691. * Vector3 scalar of the global RGB values of the SpriteMap.
  148692. */
  148693. colorMultiply?: Vector3;
  148694. }
  148695. /**
  148696. * Defines the IDisposable interface in order to be cleanable from resources.
  148697. */
  148698. export interface ISpriteMap extends IDisposable {
  148699. /**
  148700. * String name of the SpriteMap.
  148701. */
  148702. name: string;
  148703. /**
  148704. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  148705. */
  148706. atlasJSON: ISpriteJSONAtlas;
  148707. /**
  148708. * Texture of the SpriteMap.
  148709. */
  148710. spriteSheet: Texture;
  148711. /**
  148712. * The parameters to initialize the SpriteMap with.
  148713. */
  148714. options: ISpriteMapOptions;
  148715. }
  148716. /**
  148717. * Class used to manage a grid restricted sprite deployment on an Output plane.
  148718. */
  148719. export class SpriteMap implements ISpriteMap {
  148720. /** The Name of the spriteMap */
  148721. name: string;
  148722. /** The JSON file with the frame and meta data */
  148723. atlasJSON: ISpriteJSONAtlas;
  148724. /** The systems Sprite Sheet Texture */
  148725. spriteSheet: Texture;
  148726. /** Arguments passed with the Constructor */
  148727. options: ISpriteMapOptions;
  148728. /** Public Sprite Storage array, parsed from atlasJSON */
  148729. sprites: Array<ISpriteJSONSprite>;
  148730. /** Returns the Number of Sprites in the System */
  148731. get spriteCount(): number;
  148732. /** Returns the Position of Output Plane*/
  148733. get position(): Vector3;
  148734. /** Returns the Position of Output Plane*/
  148735. set position(v: Vector3);
  148736. /** Returns the Rotation of Output Plane*/
  148737. get rotation(): Vector3;
  148738. /** Returns the Rotation of Output Plane*/
  148739. set rotation(v: Vector3);
  148740. /** Sets the AnimationMap*/
  148741. get animationMap(): RawTexture;
  148742. /** Sets the AnimationMap*/
  148743. set animationMap(v: RawTexture);
  148744. /** Scene that the SpriteMap was created in */
  148745. private _scene;
  148746. /** Texture Buffer of Float32 that holds tile frame data*/
  148747. private _frameMap;
  148748. /** Texture Buffers of Float32 that holds tileMap data*/
  148749. private _tileMaps;
  148750. /** Texture Buffer of Float32 that holds Animation Data*/
  148751. private _animationMap;
  148752. /** Custom ShaderMaterial Central to the System*/
  148753. private _material;
  148754. /** Custom ShaderMaterial Central to the System*/
  148755. private _output;
  148756. /** Systems Time Ticker*/
  148757. private _time;
  148758. /**
  148759. * Creates a new SpriteMap
  148760. * @param name defines the SpriteMaps Name
  148761. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  148762. * @param spriteSheet is the Texture that the Sprites are on.
  148763. * @param options a basic deployment configuration
  148764. * @param scene The Scene that the map is deployed on
  148765. */
  148766. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  148767. /**
  148768. * Returns tileID location
  148769. * @returns Vector2 the cell position ID
  148770. */
  148771. getTileID(): Vector2;
  148772. /**
  148773. * Gets the UV location of the mouse over the SpriteMap.
  148774. * @returns Vector2 the UV position of the mouse interaction
  148775. */
  148776. getMousePosition(): Vector2;
  148777. /**
  148778. * Creates the "frame" texture Buffer
  148779. * -------------------------------------
  148780. * Structure of frames
  148781. * "filename": "Falling-Water-2.png",
  148782. * "frame": {"x":69,"y":103,"w":24,"h":32},
  148783. * "rotated": true,
  148784. * "trimmed": true,
  148785. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  148786. * "sourceSize": {"w":32,"h":32}
  148787. * @returns RawTexture of the frameMap
  148788. */
  148789. private _createFrameBuffer;
  148790. /**
  148791. * Creates the tileMap texture Buffer
  148792. * @param buffer normally and array of numbers, or a false to generate from scratch
  148793. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  148794. * @returns RawTexture of the tileMap
  148795. */
  148796. private _createTileBuffer;
  148797. /**
  148798. * Modifies the data of the tileMaps
  148799. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  148800. * @param pos is the iVector2 Coordinates of the Tile
  148801. * @param tile The SpriteIndex of the new Tile
  148802. */
  148803. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  148804. /**
  148805. * Creates the animationMap texture Buffer
  148806. * @param buffer normally and array of numbers, or a false to generate from scratch
  148807. * @returns RawTexture of the animationMap
  148808. */
  148809. private _createTileAnimationBuffer;
  148810. /**
  148811. * Modifies the data of the animationMap
  148812. * @param cellID is the Index of the Sprite
  148813. * @param _frame is the target Animation frame
  148814. * @param toCell is the Target Index of the next frame of the animation
  148815. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  148816. * @param speed is a global scalar of the time variable on the map.
  148817. */
  148818. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  148819. /**
  148820. * Exports the .tilemaps file
  148821. */
  148822. saveTileMaps(): void;
  148823. /**
  148824. * Imports the .tilemaps file
  148825. * @param url of the .tilemaps file
  148826. */
  148827. loadTileMaps(url: string): void;
  148828. /**
  148829. * Release associated resources
  148830. */
  148831. dispose(): void;
  148832. }
  148833. }
  148834. declare module BABYLON {
  148835. /**
  148836. * Class used to manage multiple sprites of different sizes on the same spritesheet
  148837. * @see http://doc.babylonjs.com/babylon101/sprites
  148838. */
  148839. export class SpritePackedManager extends SpriteManager {
  148840. /** defines the packed manager's name */
  148841. name: string;
  148842. /**
  148843. * Creates a new sprite manager from a packed sprite sheet
  148844. * @param name defines the manager's name
  148845. * @param imgUrl defines the sprite sheet url
  148846. * @param capacity defines the maximum allowed number of sprites
  148847. * @param scene defines the hosting scene
  148848. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  148849. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  148850. * @param samplingMode defines the smapling mode to use with spritesheet
  148851. * @param fromPacked set to true; do not alter
  148852. */
  148853. constructor(
  148854. /** defines the packed manager's name */
  148855. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  148856. }
  148857. }
  148858. declare module BABYLON {
  148859. /**
  148860. * Defines the list of states available for a task inside a AssetsManager
  148861. */
  148862. export enum AssetTaskState {
  148863. /**
  148864. * Initialization
  148865. */
  148866. INIT = 0,
  148867. /**
  148868. * Running
  148869. */
  148870. RUNNING = 1,
  148871. /**
  148872. * Done
  148873. */
  148874. DONE = 2,
  148875. /**
  148876. * Error
  148877. */
  148878. ERROR = 3
  148879. }
  148880. /**
  148881. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  148882. */
  148883. export abstract class AbstractAssetTask {
  148884. /**
  148885. * Task name
  148886. */ name: string;
  148887. /**
  148888. * Callback called when the task is successful
  148889. */
  148890. onSuccess: (task: any) => void;
  148891. /**
  148892. * Callback called when the task is not successful
  148893. */
  148894. onError: (task: any, message?: string, exception?: any) => void;
  148895. /**
  148896. * Creates a new AssetsManager
  148897. * @param name defines the name of the task
  148898. */
  148899. constructor(
  148900. /**
  148901. * Task name
  148902. */ name: string);
  148903. private _isCompleted;
  148904. private _taskState;
  148905. private _errorObject;
  148906. /**
  148907. * Get if the task is completed
  148908. */
  148909. get isCompleted(): boolean;
  148910. /**
  148911. * Gets the current state of the task
  148912. */
  148913. get taskState(): AssetTaskState;
  148914. /**
  148915. * Gets the current error object (if task is in error)
  148916. */
  148917. get errorObject(): {
  148918. message?: string;
  148919. exception?: any;
  148920. };
  148921. /**
  148922. * Internal only
  148923. * @hidden
  148924. */
  148925. _setErrorObject(message?: string, exception?: any): void;
  148926. /**
  148927. * Execute the current task
  148928. * @param scene defines the scene where you want your assets to be loaded
  148929. * @param onSuccess is a callback called when the task is successfully executed
  148930. * @param onError is a callback called if an error occurs
  148931. */
  148932. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  148933. /**
  148934. * Execute the current task
  148935. * @param scene defines the scene where you want your assets to be loaded
  148936. * @param onSuccess is a callback called when the task is successfully executed
  148937. * @param onError is a callback called if an error occurs
  148938. */
  148939. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  148940. /**
  148941. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  148942. * This can be used with failed tasks that have the reason for failure fixed.
  148943. */
  148944. reset(): void;
  148945. private onErrorCallback;
  148946. private onDoneCallback;
  148947. }
  148948. /**
  148949. * Define the interface used by progress events raised during assets loading
  148950. */
  148951. export interface IAssetsProgressEvent {
  148952. /**
  148953. * Defines the number of remaining tasks to process
  148954. */
  148955. remainingCount: number;
  148956. /**
  148957. * Defines the total number of tasks
  148958. */
  148959. totalCount: number;
  148960. /**
  148961. * Defines the task that was just processed
  148962. */
  148963. task: AbstractAssetTask;
  148964. }
  148965. /**
  148966. * Class used to share progress information about assets loading
  148967. */
  148968. export class AssetsProgressEvent implements IAssetsProgressEvent {
  148969. /**
  148970. * Defines the number of remaining tasks to process
  148971. */
  148972. remainingCount: number;
  148973. /**
  148974. * Defines the total number of tasks
  148975. */
  148976. totalCount: number;
  148977. /**
  148978. * Defines the task that was just processed
  148979. */
  148980. task: AbstractAssetTask;
  148981. /**
  148982. * Creates a AssetsProgressEvent
  148983. * @param remainingCount defines the number of remaining tasks to process
  148984. * @param totalCount defines the total number of tasks
  148985. * @param task defines the task that was just processed
  148986. */
  148987. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  148988. }
  148989. /**
  148990. * Define a task used by AssetsManager to load meshes
  148991. */
  148992. export class MeshAssetTask extends AbstractAssetTask {
  148993. /**
  148994. * Defines the name of the task
  148995. */
  148996. name: string;
  148997. /**
  148998. * Defines the list of mesh's names you want to load
  148999. */
  149000. meshesNames: any;
  149001. /**
  149002. * Defines the root url to use as a base to load your meshes and associated resources
  149003. */
  149004. rootUrl: string;
  149005. /**
  149006. * Defines the filename or File of the scene to load from
  149007. */
  149008. sceneFilename: string | File;
  149009. /**
  149010. * Gets the list of loaded meshes
  149011. */
  149012. loadedMeshes: Array<AbstractMesh>;
  149013. /**
  149014. * Gets the list of loaded particle systems
  149015. */
  149016. loadedParticleSystems: Array<IParticleSystem>;
  149017. /**
  149018. * Gets the list of loaded skeletons
  149019. */
  149020. loadedSkeletons: Array<Skeleton>;
  149021. /**
  149022. * Gets the list of loaded animation groups
  149023. */
  149024. loadedAnimationGroups: Array<AnimationGroup>;
  149025. /**
  149026. * Callback called when the task is successful
  149027. */
  149028. onSuccess: (task: MeshAssetTask) => void;
  149029. /**
  149030. * Callback called when the task is successful
  149031. */
  149032. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  149033. /**
  149034. * Creates a new MeshAssetTask
  149035. * @param name defines the name of the task
  149036. * @param meshesNames defines the list of mesh's names you want to load
  149037. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  149038. * @param sceneFilename defines the filename or File of the scene to load from
  149039. */
  149040. constructor(
  149041. /**
  149042. * Defines the name of the task
  149043. */
  149044. name: string,
  149045. /**
  149046. * Defines the list of mesh's names you want to load
  149047. */
  149048. meshesNames: any,
  149049. /**
  149050. * Defines the root url to use as a base to load your meshes and associated resources
  149051. */
  149052. rootUrl: string,
  149053. /**
  149054. * Defines the filename or File of the scene to load from
  149055. */
  149056. sceneFilename: string | File);
  149057. /**
  149058. * Execute the current task
  149059. * @param scene defines the scene where you want your assets to be loaded
  149060. * @param onSuccess is a callback called when the task is successfully executed
  149061. * @param onError is a callback called if an error occurs
  149062. */
  149063. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  149064. }
  149065. /**
  149066. * Define a task used by AssetsManager to load text content
  149067. */
  149068. export class TextFileAssetTask extends AbstractAssetTask {
  149069. /**
  149070. * Defines the name of the task
  149071. */
  149072. name: string;
  149073. /**
  149074. * Defines the location of the file to load
  149075. */
  149076. url: string;
  149077. /**
  149078. * Gets the loaded text string
  149079. */
  149080. text: string;
  149081. /**
  149082. * Callback called when the task is successful
  149083. */
  149084. onSuccess: (task: TextFileAssetTask) => void;
  149085. /**
  149086. * Callback called when the task is successful
  149087. */
  149088. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  149089. /**
  149090. * Creates a new TextFileAssetTask object
  149091. * @param name defines the name of the task
  149092. * @param url defines the location of the file to load
  149093. */
  149094. constructor(
  149095. /**
  149096. * Defines the name of the task
  149097. */
  149098. name: string,
  149099. /**
  149100. * Defines the location of the file to load
  149101. */
  149102. url: string);
  149103. /**
  149104. * Execute the current task
  149105. * @param scene defines the scene where you want your assets to be loaded
  149106. * @param onSuccess is a callback called when the task is successfully executed
  149107. * @param onError is a callback called if an error occurs
  149108. */
  149109. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  149110. }
  149111. /**
  149112. * Define a task used by AssetsManager to load binary data
  149113. */
  149114. export class BinaryFileAssetTask extends AbstractAssetTask {
  149115. /**
  149116. * Defines the name of the task
  149117. */
  149118. name: string;
  149119. /**
  149120. * Defines the location of the file to load
  149121. */
  149122. url: string;
  149123. /**
  149124. * Gets the lodaded data (as an array buffer)
  149125. */
  149126. data: ArrayBuffer;
  149127. /**
  149128. * Callback called when the task is successful
  149129. */
  149130. onSuccess: (task: BinaryFileAssetTask) => void;
  149131. /**
  149132. * Callback called when the task is successful
  149133. */
  149134. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  149135. /**
  149136. * Creates a new BinaryFileAssetTask object
  149137. * @param name defines the name of the new task
  149138. * @param url defines the location of the file to load
  149139. */
  149140. constructor(
  149141. /**
  149142. * Defines the name of the task
  149143. */
  149144. name: string,
  149145. /**
  149146. * Defines the location of the file to load
  149147. */
  149148. url: string);
  149149. /**
  149150. * Execute the current task
  149151. * @param scene defines the scene where you want your assets to be loaded
  149152. * @param onSuccess is a callback called when the task is successfully executed
  149153. * @param onError is a callback called if an error occurs
  149154. */
  149155. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  149156. }
  149157. /**
  149158. * Define a task used by AssetsManager to load images
  149159. */
  149160. export class ImageAssetTask extends AbstractAssetTask {
  149161. /**
  149162. * Defines the name of the task
  149163. */
  149164. name: string;
  149165. /**
  149166. * Defines the location of the image to load
  149167. */
  149168. url: string;
  149169. /**
  149170. * Gets the loaded images
  149171. */
  149172. image: HTMLImageElement;
  149173. /**
  149174. * Callback called when the task is successful
  149175. */
  149176. onSuccess: (task: ImageAssetTask) => void;
  149177. /**
  149178. * Callback called when the task is successful
  149179. */
  149180. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  149181. /**
  149182. * Creates a new ImageAssetTask
  149183. * @param name defines the name of the task
  149184. * @param url defines the location of the image to load
  149185. */
  149186. constructor(
  149187. /**
  149188. * Defines the name of the task
  149189. */
  149190. name: string,
  149191. /**
  149192. * Defines the location of the image to load
  149193. */
  149194. url: string);
  149195. /**
  149196. * Execute the current task
  149197. * @param scene defines the scene where you want your assets to be loaded
  149198. * @param onSuccess is a callback called when the task is successfully executed
  149199. * @param onError is a callback called if an error occurs
  149200. */
  149201. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  149202. }
  149203. /**
  149204. * Defines the interface used by texture loading tasks
  149205. */
  149206. export interface ITextureAssetTask<TEX extends BaseTexture> {
  149207. /**
  149208. * Gets the loaded texture
  149209. */
  149210. texture: TEX;
  149211. }
  149212. /**
  149213. * Define a task used by AssetsManager to load 2D textures
  149214. */
  149215. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  149216. /**
  149217. * Defines the name of the task
  149218. */
  149219. name: string;
  149220. /**
  149221. * Defines the location of the file to load
  149222. */
  149223. url: string;
  149224. /**
  149225. * Defines if mipmap should not be generated (default is false)
  149226. */
  149227. noMipmap?: boolean | undefined;
  149228. /**
  149229. * Defines if texture must be inverted on Y axis (default is true)
  149230. */
  149231. invertY: boolean;
  149232. /**
  149233. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  149234. */
  149235. samplingMode: number;
  149236. /**
  149237. * Gets the loaded texture
  149238. */
  149239. texture: Texture;
  149240. /**
  149241. * Callback called when the task is successful
  149242. */
  149243. onSuccess: (task: TextureAssetTask) => void;
  149244. /**
  149245. * Callback called when the task is successful
  149246. */
  149247. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  149248. /**
  149249. * Creates a new TextureAssetTask object
  149250. * @param name defines the name of the task
  149251. * @param url defines the location of the file to load
  149252. * @param noMipmap defines if mipmap should not be generated (default is false)
  149253. * @param invertY defines if texture must be inverted on Y axis (default is true)
  149254. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  149255. */
  149256. constructor(
  149257. /**
  149258. * Defines the name of the task
  149259. */
  149260. name: string,
  149261. /**
  149262. * Defines the location of the file to load
  149263. */
  149264. url: string,
  149265. /**
  149266. * Defines if mipmap should not be generated (default is false)
  149267. */
  149268. noMipmap?: boolean | undefined,
  149269. /**
  149270. * Defines if texture must be inverted on Y axis (default is true)
  149271. */
  149272. invertY?: boolean,
  149273. /**
  149274. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  149275. */
  149276. samplingMode?: number);
  149277. /**
  149278. * Execute the current task
  149279. * @param scene defines the scene where you want your assets to be loaded
  149280. * @param onSuccess is a callback called when the task is successfully executed
  149281. * @param onError is a callback called if an error occurs
  149282. */
  149283. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  149284. }
  149285. /**
  149286. * Define a task used by AssetsManager to load cube textures
  149287. */
  149288. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  149289. /**
  149290. * Defines the name of the task
  149291. */
  149292. name: string;
  149293. /**
  149294. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  149295. */
  149296. url: string;
  149297. /**
  149298. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  149299. */
  149300. extensions?: string[] | undefined;
  149301. /**
  149302. * Defines if mipmaps should not be generated (default is false)
  149303. */
  149304. noMipmap?: boolean | undefined;
  149305. /**
  149306. * Defines the explicit list of files (undefined by default)
  149307. */
  149308. files?: string[] | undefined;
  149309. /**
  149310. * Gets the loaded texture
  149311. */
  149312. texture: CubeTexture;
  149313. /**
  149314. * Callback called when the task is successful
  149315. */
  149316. onSuccess: (task: CubeTextureAssetTask) => void;
  149317. /**
  149318. * Callback called when the task is successful
  149319. */
  149320. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  149321. /**
  149322. * Creates a new CubeTextureAssetTask
  149323. * @param name defines the name of the task
  149324. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  149325. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  149326. * @param noMipmap defines if mipmaps should not be generated (default is false)
  149327. * @param files defines the explicit list of files (undefined by default)
  149328. */
  149329. constructor(
  149330. /**
  149331. * Defines the name of the task
  149332. */
  149333. name: string,
  149334. /**
  149335. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  149336. */
  149337. url: string,
  149338. /**
  149339. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  149340. */
  149341. extensions?: string[] | undefined,
  149342. /**
  149343. * Defines if mipmaps should not be generated (default is false)
  149344. */
  149345. noMipmap?: boolean | undefined,
  149346. /**
  149347. * Defines the explicit list of files (undefined by default)
  149348. */
  149349. files?: string[] | undefined);
  149350. /**
  149351. * Execute the current task
  149352. * @param scene defines the scene where you want your assets to be loaded
  149353. * @param onSuccess is a callback called when the task is successfully executed
  149354. * @param onError is a callback called if an error occurs
  149355. */
  149356. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  149357. }
  149358. /**
  149359. * Define a task used by AssetsManager to load HDR cube textures
  149360. */
  149361. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  149362. /**
  149363. * Defines the name of the task
  149364. */
  149365. name: string;
  149366. /**
  149367. * Defines the location of the file to load
  149368. */
  149369. url: string;
  149370. /**
  149371. * Defines the desired size (the more it increases the longer the generation will be)
  149372. */
  149373. size: number;
  149374. /**
  149375. * Defines if mipmaps should not be generated (default is false)
  149376. */
  149377. noMipmap: boolean;
  149378. /**
  149379. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  149380. */
  149381. generateHarmonics: boolean;
  149382. /**
  149383. * 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)
  149384. */
  149385. gammaSpace: boolean;
  149386. /**
  149387. * Internal Use Only
  149388. */
  149389. reserved: boolean;
  149390. /**
  149391. * Gets the loaded texture
  149392. */
  149393. texture: HDRCubeTexture;
  149394. /**
  149395. * Callback called when the task is successful
  149396. */
  149397. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  149398. /**
  149399. * Callback called when the task is successful
  149400. */
  149401. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  149402. /**
  149403. * Creates a new HDRCubeTextureAssetTask object
  149404. * @param name defines the name of the task
  149405. * @param url defines the location of the file to load
  149406. * @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.
  149407. * @param noMipmap defines if mipmaps should not be generated (default is false)
  149408. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  149409. * @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)
  149410. * @param reserved Internal use only
  149411. */
  149412. constructor(
  149413. /**
  149414. * Defines the name of the task
  149415. */
  149416. name: string,
  149417. /**
  149418. * Defines the location of the file to load
  149419. */
  149420. url: string,
  149421. /**
  149422. * Defines the desired size (the more it increases the longer the generation will be)
  149423. */
  149424. size: number,
  149425. /**
  149426. * Defines if mipmaps should not be generated (default is false)
  149427. */
  149428. noMipmap?: boolean,
  149429. /**
  149430. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  149431. */
  149432. generateHarmonics?: boolean,
  149433. /**
  149434. * 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)
  149435. */
  149436. gammaSpace?: boolean,
  149437. /**
  149438. * Internal Use Only
  149439. */
  149440. reserved?: boolean);
  149441. /**
  149442. * Execute the current task
  149443. * @param scene defines the scene where you want your assets to be loaded
  149444. * @param onSuccess is a callback called when the task is successfully executed
  149445. * @param onError is a callback called if an error occurs
  149446. */
  149447. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  149448. }
  149449. /**
  149450. * Define a task used by AssetsManager to load Equirectangular cube textures
  149451. */
  149452. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  149453. /**
  149454. * Defines the name of the task
  149455. */
  149456. name: string;
  149457. /**
  149458. * Defines the location of the file to load
  149459. */
  149460. url: string;
  149461. /**
  149462. * Defines the desired size (the more it increases the longer the generation will be)
  149463. */
  149464. size: number;
  149465. /**
  149466. * Defines if mipmaps should not be generated (default is false)
  149467. */
  149468. noMipmap: boolean;
  149469. /**
  149470. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  149471. * but the standard material would require them in Gamma space) (default is true)
  149472. */
  149473. gammaSpace: boolean;
  149474. /**
  149475. * Gets the loaded texture
  149476. */
  149477. texture: EquiRectangularCubeTexture;
  149478. /**
  149479. * Callback called when the task is successful
  149480. */
  149481. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  149482. /**
  149483. * Callback called when the task is successful
  149484. */
  149485. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  149486. /**
  149487. * Creates a new EquiRectangularCubeTextureAssetTask object
  149488. * @param name defines the name of the task
  149489. * @param url defines the location of the file to load
  149490. * @param size defines the desired size (the more it increases the longer the generation will be)
  149491. * If the size is omitted this implies you are using a preprocessed cubemap.
  149492. * @param noMipmap defines if mipmaps should not be generated (default is false)
  149493. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  149494. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  149495. * (default is true)
  149496. */
  149497. constructor(
  149498. /**
  149499. * Defines the name of the task
  149500. */
  149501. name: string,
  149502. /**
  149503. * Defines the location of the file to load
  149504. */
  149505. url: string,
  149506. /**
  149507. * Defines the desired size (the more it increases the longer the generation will be)
  149508. */
  149509. size: number,
  149510. /**
  149511. * Defines if mipmaps should not be generated (default is false)
  149512. */
  149513. noMipmap?: boolean,
  149514. /**
  149515. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  149516. * but the standard material would require them in Gamma space) (default is true)
  149517. */
  149518. gammaSpace?: boolean);
  149519. /**
  149520. * Execute the current task
  149521. * @param scene defines the scene where you want your assets to be loaded
  149522. * @param onSuccess is a callback called when the task is successfully executed
  149523. * @param onError is a callback called if an error occurs
  149524. */
  149525. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  149526. }
  149527. /**
  149528. * This class can be used to easily import assets into a scene
  149529. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  149530. */
  149531. export class AssetsManager {
  149532. private _scene;
  149533. private _isLoading;
  149534. protected _tasks: AbstractAssetTask[];
  149535. protected _waitingTasksCount: number;
  149536. protected _totalTasksCount: number;
  149537. /**
  149538. * Callback called when all tasks are processed
  149539. */
  149540. onFinish: (tasks: AbstractAssetTask[]) => void;
  149541. /**
  149542. * Callback called when a task is successful
  149543. */
  149544. onTaskSuccess: (task: AbstractAssetTask) => void;
  149545. /**
  149546. * Callback called when a task had an error
  149547. */
  149548. onTaskError: (task: AbstractAssetTask) => void;
  149549. /**
  149550. * Callback called when a task is done (whatever the result is)
  149551. */
  149552. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  149553. /**
  149554. * Observable called when all tasks are processed
  149555. */
  149556. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  149557. /**
  149558. * Observable called when a task had an error
  149559. */
  149560. onTaskErrorObservable: Observable<AbstractAssetTask>;
  149561. /**
  149562. * Observable called when all tasks were executed
  149563. */
  149564. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  149565. /**
  149566. * Observable called when a task is done (whatever the result is)
  149567. */
  149568. onProgressObservable: Observable<IAssetsProgressEvent>;
  149569. /**
  149570. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  149571. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  149572. */
  149573. useDefaultLoadingScreen: boolean;
  149574. /**
  149575. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  149576. * when all assets have been downloaded.
  149577. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  149578. */
  149579. autoHideLoadingUI: boolean;
  149580. /**
  149581. * Creates a new AssetsManager
  149582. * @param scene defines the scene to work on
  149583. */
  149584. constructor(scene: Scene);
  149585. /**
  149586. * Add a MeshAssetTask to the list of active tasks
  149587. * @param taskName defines the name of the new task
  149588. * @param meshesNames defines the name of meshes to load
  149589. * @param rootUrl defines the root url to use to locate files
  149590. * @param sceneFilename defines the filename of the scene file
  149591. * @returns a new MeshAssetTask object
  149592. */
  149593. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  149594. /**
  149595. * Add a TextFileAssetTask to the list of active tasks
  149596. * @param taskName defines the name of the new task
  149597. * @param url defines the url of the file to load
  149598. * @returns a new TextFileAssetTask object
  149599. */
  149600. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  149601. /**
  149602. * Add a BinaryFileAssetTask to the list of active tasks
  149603. * @param taskName defines the name of the new task
  149604. * @param url defines the url of the file to load
  149605. * @returns a new BinaryFileAssetTask object
  149606. */
  149607. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  149608. /**
  149609. * Add a ImageAssetTask to the list of active tasks
  149610. * @param taskName defines the name of the new task
  149611. * @param url defines the url of the file to load
  149612. * @returns a new ImageAssetTask object
  149613. */
  149614. addImageTask(taskName: string, url: string): ImageAssetTask;
  149615. /**
  149616. * Add a TextureAssetTask to the list of active tasks
  149617. * @param taskName defines the name of the new task
  149618. * @param url defines the url of the file to load
  149619. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  149620. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  149621. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  149622. * @returns a new TextureAssetTask object
  149623. */
  149624. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  149625. /**
  149626. * Add a CubeTextureAssetTask to the list of active tasks
  149627. * @param taskName defines the name of the new task
  149628. * @param url defines the url of the file to load
  149629. * @param extensions defines the extension to use to load the cube map (can be null)
  149630. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  149631. * @param files defines the list of files to load (can be null)
  149632. * @returns a new CubeTextureAssetTask object
  149633. */
  149634. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  149635. /**
  149636. *
  149637. * Add a HDRCubeTextureAssetTask to the list of active tasks
  149638. * @param taskName defines the name of the new task
  149639. * @param url defines the url of the file to load
  149640. * @param size defines the size you want for the cubemap (can be null)
  149641. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  149642. * @param generateHarmonics defines if you want to automatically generate (true by default)
  149643. * @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)
  149644. * @param reserved Internal use only
  149645. * @returns a new HDRCubeTextureAssetTask object
  149646. */
  149647. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  149648. /**
  149649. *
  149650. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  149651. * @param taskName defines the name of the new task
  149652. * @param url defines the url of the file to load
  149653. * @param size defines the size you want for the cubemap (can be null)
  149654. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  149655. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  149656. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  149657. * @returns a new EquiRectangularCubeTextureAssetTask object
  149658. */
  149659. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  149660. /**
  149661. * Remove a task from the assets manager.
  149662. * @param task the task to remove
  149663. */
  149664. removeTask(task: AbstractAssetTask): void;
  149665. private _decreaseWaitingTasksCount;
  149666. private _runTask;
  149667. /**
  149668. * Reset the AssetsManager and remove all tasks
  149669. * @return the current instance of the AssetsManager
  149670. */
  149671. reset(): AssetsManager;
  149672. /**
  149673. * Start the loading process
  149674. * @return the current instance of the AssetsManager
  149675. */
  149676. load(): AssetsManager;
  149677. /**
  149678. * Start the loading process as an async operation
  149679. * @return a promise returning the list of failed tasks
  149680. */
  149681. loadAsync(): Promise<void>;
  149682. }
  149683. }
  149684. declare module BABYLON {
  149685. /**
  149686. * Wrapper class for promise with external resolve and reject.
  149687. */
  149688. export class Deferred<T> {
  149689. /**
  149690. * The promise associated with this deferred object.
  149691. */
  149692. readonly promise: Promise<T>;
  149693. private _resolve;
  149694. private _reject;
  149695. /**
  149696. * The resolve method of the promise associated with this deferred object.
  149697. */
  149698. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  149699. /**
  149700. * The reject method of the promise associated with this deferred object.
  149701. */
  149702. get reject(): (reason?: any) => void;
  149703. /**
  149704. * Constructor for this deferred object.
  149705. */
  149706. constructor();
  149707. }
  149708. }
  149709. declare module BABYLON {
  149710. /**
  149711. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  149712. */
  149713. export class MeshExploder {
  149714. private _centerMesh;
  149715. private _meshes;
  149716. private _meshesOrigins;
  149717. private _toCenterVectors;
  149718. private _scaledDirection;
  149719. private _newPosition;
  149720. private _centerPosition;
  149721. /**
  149722. * Explodes meshes from a center mesh.
  149723. * @param meshes The meshes to explode.
  149724. * @param centerMesh The mesh to be center of explosion.
  149725. */
  149726. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  149727. private _setCenterMesh;
  149728. /**
  149729. * Get class name
  149730. * @returns "MeshExploder"
  149731. */
  149732. getClassName(): string;
  149733. /**
  149734. * "Exploded meshes"
  149735. * @returns Array of meshes with the centerMesh at index 0.
  149736. */
  149737. getMeshes(): Array<Mesh>;
  149738. /**
  149739. * Explodes meshes giving a specific direction
  149740. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  149741. */
  149742. explode(direction?: number): void;
  149743. }
  149744. }
  149745. declare module BABYLON {
  149746. /**
  149747. * Class used to help managing file picking and drag'n'drop
  149748. */
  149749. export class FilesInput {
  149750. /**
  149751. * List of files ready to be loaded
  149752. */
  149753. static get FilesToLoad(): {
  149754. [key: string]: File;
  149755. };
  149756. /**
  149757. * Callback called when a file is processed
  149758. */
  149759. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  149760. private _engine;
  149761. private _currentScene;
  149762. private _sceneLoadedCallback;
  149763. private _progressCallback;
  149764. private _additionalRenderLoopLogicCallback;
  149765. private _textureLoadingCallback;
  149766. private _startingProcessingFilesCallback;
  149767. private _onReloadCallback;
  149768. private _errorCallback;
  149769. private _elementToMonitor;
  149770. private _sceneFileToLoad;
  149771. private _filesToLoad;
  149772. /**
  149773. * Creates a new FilesInput
  149774. * @param engine defines the rendering engine
  149775. * @param scene defines the hosting scene
  149776. * @param sceneLoadedCallback callback called when scene is loaded
  149777. * @param progressCallback callback called to track progress
  149778. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  149779. * @param textureLoadingCallback callback called when a texture is loading
  149780. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  149781. * @param onReloadCallback callback called when a reload is requested
  149782. * @param errorCallback callback call if an error occurs
  149783. */
  149784. constructor(engine: Engine, scene: Scene, sceneLoadedCallback: (sceneFile: File, scene: Scene) => void, progressCallback: (progress: ISceneLoaderProgressEvent) => void, additionalRenderLoopLogicCallback: () => void, textureLoadingCallback: (remaining: number) => void, startingProcessingFilesCallback: (files?: File[]) => void, onReloadCallback: (sceneFile: File) => void, errorCallback: (sceneFile: File, scene: Scene, message: string) => void);
  149785. private _dragEnterHandler;
  149786. private _dragOverHandler;
  149787. private _dropHandler;
  149788. /**
  149789. * Calls this function to listen to drag'n'drop events on a specific DOM element
  149790. * @param elementToMonitor defines the DOM element to track
  149791. */
  149792. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  149793. /**
  149794. * Release all associated resources
  149795. */
  149796. dispose(): void;
  149797. private renderFunction;
  149798. private drag;
  149799. private drop;
  149800. private _traverseFolder;
  149801. private _processFiles;
  149802. /**
  149803. * Load files from a drop event
  149804. * @param event defines the drop event to use as source
  149805. */
  149806. loadFiles(event: any): void;
  149807. private _processReload;
  149808. /**
  149809. * Reload the current scene from the loaded files
  149810. */
  149811. reload(): void;
  149812. }
  149813. }
  149814. declare module BABYLON {
  149815. /**
  149816. * Defines the root class used to create scene optimization to use with SceneOptimizer
  149817. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  149818. */
  149819. export class SceneOptimization {
  149820. /**
  149821. * Defines the priority of this optimization (0 by default which means first in the list)
  149822. */
  149823. priority: number;
  149824. /**
  149825. * Gets a string describing the action executed by the current optimization
  149826. * @returns description string
  149827. */
  149828. getDescription(): string;
  149829. /**
  149830. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  149831. * @param scene defines the current scene where to apply this optimization
  149832. * @param optimizer defines the current optimizer
  149833. * @returns true if everything that can be done was applied
  149834. */
  149835. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  149836. /**
  149837. * Creates the SceneOptimization object
  149838. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  149839. * @param desc defines the description associated with the optimization
  149840. */
  149841. constructor(
  149842. /**
  149843. * Defines the priority of this optimization (0 by default which means first in the list)
  149844. */
  149845. priority?: number);
  149846. }
  149847. /**
  149848. * Defines an optimization used to reduce the size of render target textures
  149849. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  149850. */
  149851. export class TextureOptimization extends SceneOptimization {
  149852. /**
  149853. * Defines the priority of this optimization (0 by default which means first in the list)
  149854. */
  149855. priority: number;
  149856. /**
  149857. * 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
  149858. */
  149859. maximumSize: number;
  149860. /**
  149861. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  149862. */
  149863. step: number;
  149864. /**
  149865. * Gets a string describing the action executed by the current optimization
  149866. * @returns description string
  149867. */
  149868. getDescription(): string;
  149869. /**
  149870. * Creates the TextureOptimization object
  149871. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  149872. * @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
  149873. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  149874. */
  149875. constructor(
  149876. /**
  149877. * Defines the priority of this optimization (0 by default which means first in the list)
  149878. */
  149879. priority?: number,
  149880. /**
  149881. * 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
  149882. */
  149883. maximumSize?: number,
  149884. /**
  149885. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  149886. */
  149887. step?: number);
  149888. /**
  149889. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  149890. * @param scene defines the current scene where to apply this optimization
  149891. * @param optimizer defines the current optimizer
  149892. * @returns true if everything that can be done was applied
  149893. */
  149894. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  149895. }
  149896. /**
  149897. * Defines an optimization used to increase or decrease the rendering resolution
  149898. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  149899. */
  149900. export class HardwareScalingOptimization extends SceneOptimization {
  149901. /**
  149902. * Defines the priority of this optimization (0 by default which means first in the list)
  149903. */
  149904. priority: number;
  149905. /**
  149906. * Defines the maximum scale to use (2 by default)
  149907. */
  149908. maximumScale: number;
  149909. /**
  149910. * Defines the step to use between two passes (0.5 by default)
  149911. */
  149912. step: number;
  149913. private _currentScale;
  149914. private _directionOffset;
  149915. /**
  149916. * Gets a string describing the action executed by the current optimization
  149917. * @return description string
  149918. */
  149919. getDescription(): string;
  149920. /**
  149921. * Creates the HardwareScalingOptimization object
  149922. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  149923. * @param maximumScale defines the maximum scale to use (2 by default)
  149924. * @param step defines the step to use between two passes (0.5 by default)
  149925. */
  149926. constructor(
  149927. /**
  149928. * Defines the priority of this optimization (0 by default which means first in the list)
  149929. */
  149930. priority?: number,
  149931. /**
  149932. * Defines the maximum scale to use (2 by default)
  149933. */
  149934. maximumScale?: number,
  149935. /**
  149936. * Defines the step to use between two passes (0.5 by default)
  149937. */
  149938. step?: number);
  149939. /**
  149940. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  149941. * @param scene defines the current scene where to apply this optimization
  149942. * @param optimizer defines the current optimizer
  149943. * @returns true if everything that can be done was applied
  149944. */
  149945. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  149946. }
  149947. /**
  149948. * Defines an optimization used to remove shadows
  149949. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  149950. */
  149951. export class ShadowsOptimization extends SceneOptimization {
  149952. /**
  149953. * Gets a string describing the action executed by the current optimization
  149954. * @return description string
  149955. */
  149956. getDescription(): string;
  149957. /**
  149958. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  149959. * @param scene defines the current scene where to apply this optimization
  149960. * @param optimizer defines the current optimizer
  149961. * @returns true if everything that can be done was applied
  149962. */
  149963. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  149964. }
  149965. /**
  149966. * Defines an optimization used to turn post-processes off
  149967. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  149968. */
  149969. export class PostProcessesOptimization extends SceneOptimization {
  149970. /**
  149971. * Gets a string describing the action executed by the current optimization
  149972. * @return description string
  149973. */
  149974. getDescription(): string;
  149975. /**
  149976. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  149977. * @param scene defines the current scene where to apply this optimization
  149978. * @param optimizer defines the current optimizer
  149979. * @returns true if everything that can be done was applied
  149980. */
  149981. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  149982. }
  149983. /**
  149984. * Defines an optimization used to turn lens flares off
  149985. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  149986. */
  149987. export class LensFlaresOptimization extends SceneOptimization {
  149988. /**
  149989. * Gets a string describing the action executed by the current optimization
  149990. * @return description string
  149991. */
  149992. getDescription(): string;
  149993. /**
  149994. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  149995. * @param scene defines the current scene where to apply this optimization
  149996. * @param optimizer defines the current optimizer
  149997. * @returns true if everything that can be done was applied
  149998. */
  149999. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  150000. }
  150001. /**
  150002. * Defines an optimization based on user defined callback.
  150003. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  150004. */
  150005. export class CustomOptimization extends SceneOptimization {
  150006. /**
  150007. * Callback called to apply the custom optimization.
  150008. */
  150009. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  150010. /**
  150011. * Callback called to get custom description
  150012. */
  150013. onGetDescription: () => string;
  150014. /**
  150015. * Gets a string describing the action executed by the current optimization
  150016. * @returns description string
  150017. */
  150018. getDescription(): string;
  150019. /**
  150020. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  150021. * @param scene defines the current scene where to apply this optimization
  150022. * @param optimizer defines the current optimizer
  150023. * @returns true if everything that can be done was applied
  150024. */
  150025. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  150026. }
  150027. /**
  150028. * Defines an optimization used to turn particles off
  150029. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  150030. */
  150031. export class ParticlesOptimization extends SceneOptimization {
  150032. /**
  150033. * Gets a string describing the action executed by the current optimization
  150034. * @return description string
  150035. */
  150036. getDescription(): string;
  150037. /**
  150038. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  150039. * @param scene defines the current scene where to apply this optimization
  150040. * @param optimizer defines the current optimizer
  150041. * @returns true if everything that can be done was applied
  150042. */
  150043. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  150044. }
  150045. /**
  150046. * Defines an optimization used to turn render targets off
  150047. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  150048. */
  150049. export class RenderTargetsOptimization extends SceneOptimization {
  150050. /**
  150051. * Gets a string describing the action executed by the current optimization
  150052. * @return description string
  150053. */
  150054. getDescription(): string;
  150055. /**
  150056. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  150057. * @param scene defines the current scene where to apply this optimization
  150058. * @param optimizer defines the current optimizer
  150059. * @returns true if everything that can be done was applied
  150060. */
  150061. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  150062. }
  150063. /**
  150064. * Defines an optimization used to merge meshes with compatible materials
  150065. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  150066. */
  150067. export class MergeMeshesOptimization extends SceneOptimization {
  150068. private static _UpdateSelectionTree;
  150069. /**
  150070. * Gets or sets a boolean which defines if optimization octree has to be updated
  150071. */
  150072. static get UpdateSelectionTree(): boolean;
  150073. /**
  150074. * Gets or sets a boolean which defines if optimization octree has to be updated
  150075. */
  150076. static set UpdateSelectionTree(value: boolean);
  150077. /**
  150078. * Gets a string describing the action executed by the current optimization
  150079. * @return description string
  150080. */
  150081. getDescription(): string;
  150082. private _canBeMerged;
  150083. /**
  150084. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  150085. * @param scene defines the current scene where to apply this optimization
  150086. * @param optimizer defines the current optimizer
  150087. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  150088. * @returns true if everything that can be done was applied
  150089. */
  150090. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  150091. }
  150092. /**
  150093. * Defines a list of options used by SceneOptimizer
  150094. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  150095. */
  150096. export class SceneOptimizerOptions {
  150097. /**
  150098. * Defines the target frame rate to reach (60 by default)
  150099. */
  150100. targetFrameRate: number;
  150101. /**
  150102. * Defines the interval between two checkes (2000ms by default)
  150103. */
  150104. trackerDuration: number;
  150105. /**
  150106. * Gets the list of optimizations to apply
  150107. */
  150108. optimizations: SceneOptimization[];
  150109. /**
  150110. * Creates a new list of options used by SceneOptimizer
  150111. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  150112. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  150113. */
  150114. constructor(
  150115. /**
  150116. * Defines the target frame rate to reach (60 by default)
  150117. */
  150118. targetFrameRate?: number,
  150119. /**
  150120. * Defines the interval between two checkes (2000ms by default)
  150121. */
  150122. trackerDuration?: number);
  150123. /**
  150124. * Add a new optimization
  150125. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  150126. * @returns the current SceneOptimizerOptions
  150127. */
  150128. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  150129. /**
  150130. * Add a new custom optimization
  150131. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  150132. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  150133. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  150134. * @returns the current SceneOptimizerOptions
  150135. */
  150136. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  150137. /**
  150138. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  150139. * @param targetFrameRate defines the target frame rate (60 by default)
  150140. * @returns a SceneOptimizerOptions object
  150141. */
  150142. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  150143. /**
  150144. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  150145. * @param targetFrameRate defines the target frame rate (60 by default)
  150146. * @returns a SceneOptimizerOptions object
  150147. */
  150148. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  150149. /**
  150150. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  150151. * @param targetFrameRate defines the target frame rate (60 by default)
  150152. * @returns a SceneOptimizerOptions object
  150153. */
  150154. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  150155. }
  150156. /**
  150157. * Class used to run optimizations in order to reach a target frame rate
  150158. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  150159. */
  150160. export class SceneOptimizer implements IDisposable {
  150161. private _isRunning;
  150162. private _options;
  150163. private _scene;
  150164. private _currentPriorityLevel;
  150165. private _targetFrameRate;
  150166. private _trackerDuration;
  150167. private _currentFrameRate;
  150168. private _sceneDisposeObserver;
  150169. private _improvementMode;
  150170. /**
  150171. * Defines an observable called when the optimizer reaches the target frame rate
  150172. */
  150173. onSuccessObservable: Observable<SceneOptimizer>;
  150174. /**
  150175. * Defines an observable called when the optimizer enables an optimization
  150176. */
  150177. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  150178. /**
  150179. * Defines an observable called when the optimizer is not able to reach the target frame rate
  150180. */
  150181. onFailureObservable: Observable<SceneOptimizer>;
  150182. /**
  150183. * Gets a boolean indicating if the optimizer is in improvement mode
  150184. */
  150185. get isInImprovementMode(): boolean;
  150186. /**
  150187. * Gets the current priority level (0 at start)
  150188. */
  150189. get currentPriorityLevel(): number;
  150190. /**
  150191. * Gets the current frame rate checked by the SceneOptimizer
  150192. */
  150193. get currentFrameRate(): number;
  150194. /**
  150195. * Gets or sets the current target frame rate (60 by default)
  150196. */
  150197. get targetFrameRate(): number;
  150198. /**
  150199. * Gets or sets the current target frame rate (60 by default)
  150200. */
  150201. set targetFrameRate(value: number);
  150202. /**
  150203. * Gets or sets the current interval between two checks (every 2000ms by default)
  150204. */
  150205. get trackerDuration(): number;
  150206. /**
  150207. * Gets or sets the current interval between two checks (every 2000ms by default)
  150208. */
  150209. set trackerDuration(value: number);
  150210. /**
  150211. * Gets the list of active optimizations
  150212. */
  150213. get optimizations(): SceneOptimization[];
  150214. /**
  150215. * Creates a new SceneOptimizer
  150216. * @param scene defines the scene to work on
  150217. * @param options defines the options to use with the SceneOptimizer
  150218. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  150219. * @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)
  150220. */
  150221. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  150222. /**
  150223. * Stops the current optimizer
  150224. */
  150225. stop(): void;
  150226. /**
  150227. * Reset the optimizer to initial step (current priority level = 0)
  150228. */
  150229. reset(): void;
  150230. /**
  150231. * Start the optimizer. By default it will try to reach a specific framerate
  150232. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  150233. */
  150234. start(): void;
  150235. private _checkCurrentState;
  150236. /**
  150237. * Release all resources
  150238. */
  150239. dispose(): void;
  150240. /**
  150241. * Helper function to create a SceneOptimizer with one single line of code
  150242. * @param scene defines the scene to work on
  150243. * @param options defines the options to use with the SceneOptimizer
  150244. * @param onSuccess defines a callback to call on success
  150245. * @param onFailure defines a callback to call on failure
  150246. * @returns the new SceneOptimizer object
  150247. */
  150248. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  150249. }
  150250. }
  150251. declare module BABYLON {
  150252. /**
  150253. * Class used to serialize a scene into a string
  150254. */
  150255. export class SceneSerializer {
  150256. /**
  150257. * Clear cache used by a previous serialization
  150258. */
  150259. static ClearCache(): void;
  150260. /**
  150261. * Serialize a scene into a JSON compatible object
  150262. * @param scene defines the scene to serialize
  150263. * @returns a JSON compatible object
  150264. */
  150265. static Serialize(scene: Scene): any;
  150266. /**
  150267. * Serialize a mesh into a JSON compatible object
  150268. * @param toSerialize defines the mesh to serialize
  150269. * @param withParents defines if parents must be serialized as well
  150270. * @param withChildren defines if children must be serialized as well
  150271. * @returns a JSON compatible object
  150272. */
  150273. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  150274. }
  150275. }
  150276. declare module BABYLON {
  150277. /**
  150278. * Class used to host texture specific utilities
  150279. */
  150280. export class TextureTools {
  150281. /**
  150282. * Uses the GPU to create a copy texture rescaled at a given size
  150283. * @param texture Texture to copy from
  150284. * @param width defines the desired width
  150285. * @param height defines the desired height
  150286. * @param useBilinearMode defines if bilinear mode has to be used
  150287. * @return the generated texture
  150288. */
  150289. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  150290. }
  150291. }
  150292. declare module BABYLON {
  150293. /**
  150294. * This represents the different options available for the video capture.
  150295. */
  150296. export interface VideoRecorderOptions {
  150297. /** Defines the mime type of the video. */
  150298. mimeType: string;
  150299. /** Defines the FPS the video should be recorded at. */
  150300. fps: number;
  150301. /** Defines the chunk size for the recording data. */
  150302. recordChunckSize: number;
  150303. /** The audio tracks to attach to the recording. */
  150304. audioTracks?: MediaStreamTrack[];
  150305. }
  150306. /**
  150307. * This can help with recording videos from BabylonJS.
  150308. * This is based on the available WebRTC functionalities of the browser.
  150309. *
  150310. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  150311. */
  150312. export class VideoRecorder {
  150313. private static readonly _defaultOptions;
  150314. /**
  150315. * Returns whether or not the VideoRecorder is available in your browser.
  150316. * @param engine Defines the Babylon Engine.
  150317. * @returns true if supported otherwise false.
  150318. */
  150319. static IsSupported(engine: Engine): boolean;
  150320. private readonly _options;
  150321. private _canvas;
  150322. private _mediaRecorder;
  150323. private _recordedChunks;
  150324. private _fileName;
  150325. private _resolve;
  150326. private _reject;
  150327. /**
  150328. * True when a recording is already in progress.
  150329. */
  150330. get isRecording(): boolean;
  150331. /**
  150332. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  150333. * @param engine Defines the BabylonJS Engine you wish to record.
  150334. * @param options Defines options that can be used to customize the capture.
  150335. */
  150336. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  150337. /**
  150338. * Stops the current recording before the default capture timeout passed in the startRecording function.
  150339. */
  150340. stopRecording(): void;
  150341. /**
  150342. * Starts recording the canvas for a max duration specified in parameters.
  150343. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  150344. * If null no automatic download will start and you can rely on the promise to get the data back.
  150345. * @param maxDuration Defines the maximum recording time in seconds.
  150346. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  150347. * @return A promise callback at the end of the recording with the video data in Blob.
  150348. */
  150349. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  150350. /**
  150351. * Releases internal resources used during the recording.
  150352. */
  150353. dispose(): void;
  150354. private _handleDataAvailable;
  150355. private _handleError;
  150356. private _handleStop;
  150357. }
  150358. }
  150359. declare module BABYLON {
  150360. /**
  150361. * Class containing a set of static utilities functions for screenshots
  150362. */
  150363. export class ScreenshotTools {
  150364. /**
  150365. * Captures a screenshot of the current rendering
  150366. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  150367. * @param engine defines the rendering engine
  150368. * @param camera defines the source camera
  150369. * @param size This parameter can be set to a single number or to an object with the
  150370. * following (optional) properties: precision, width, height. If a single number is passed,
  150371. * it will be used for both width and height. If an object is passed, the screenshot size
  150372. * will be derived from the parameters. The precision property is a multiplier allowing
  150373. * rendering at a higher or lower resolution
  150374. * @param successCallback defines the callback receives a single parameter which contains the
  150375. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  150376. * src parameter of an <img> to display it
  150377. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  150378. * Check your browser for supported MIME types
  150379. */
  150380. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  150381. /**
  150382. * Captures a screenshot of the current rendering
  150383. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  150384. * @param engine defines the rendering engine
  150385. * @param camera defines the source camera
  150386. * @param size This parameter can be set to a single number or to an object with the
  150387. * following (optional) properties: precision, width, height. If a single number is passed,
  150388. * it will be used for both width and height. If an object is passed, the screenshot size
  150389. * will be derived from the parameters. The precision property is a multiplier allowing
  150390. * rendering at a higher or lower resolution
  150391. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  150392. * Check your browser for supported MIME types
  150393. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  150394. * to the src parameter of an <img> to display it
  150395. */
  150396. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  150397. /**
  150398. * Generates an image screenshot from the specified camera.
  150399. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  150400. * @param engine The engine to use for rendering
  150401. * @param camera The camera to use for rendering
  150402. * @param size This parameter can be set to a single number or to an object with the
  150403. * following (optional) properties: precision, width, height. If a single number is passed,
  150404. * it will be used for both width and height. If an object is passed, the screenshot size
  150405. * will be derived from the parameters. The precision property is a multiplier allowing
  150406. * rendering at a higher or lower resolution
  150407. * @param successCallback The callback receives a single parameter which contains the
  150408. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  150409. * src parameter of an <img> to display it
  150410. * @param mimeType The MIME type of the screenshot image (default: image/png).
  150411. * Check your browser for supported MIME types
  150412. * @param samples Texture samples (default: 1)
  150413. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  150414. * @param fileName A name for for the downloaded file.
  150415. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  150416. */
  150417. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): void;
  150418. /**
  150419. * Generates an image screenshot from the specified camera.
  150420. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  150421. * @param engine The engine to use for rendering
  150422. * @param camera The camera to use for rendering
  150423. * @param size This parameter can be set to a single number or to an object with the
  150424. * following (optional) properties: precision, width, height. If a single number is passed,
  150425. * it will be used for both width and height. If an object is passed, the screenshot size
  150426. * will be derived from the parameters. The precision property is a multiplier allowing
  150427. * rendering at a higher or lower resolution
  150428. * @param mimeType The MIME type of the screenshot image (default: image/png).
  150429. * Check your browser for supported MIME types
  150430. * @param samples Texture samples (default: 1)
  150431. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  150432. * @param fileName A name for for the downloaded file.
  150433. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  150434. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  150435. * to the src parameter of an <img> to display it
  150436. */
  150437. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  150438. /**
  150439. * Gets height and width for screenshot size
  150440. * @private
  150441. */
  150442. private static _getScreenshotSize;
  150443. }
  150444. }
  150445. declare module BABYLON {
  150446. /**
  150447. * Interface for a data buffer
  150448. */
  150449. export interface IDataBuffer {
  150450. /**
  150451. * Reads bytes from the data buffer.
  150452. * @param byteOffset The byte offset to read
  150453. * @param byteLength The byte length to read
  150454. * @returns A promise that resolves when the bytes are read
  150455. */
  150456. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  150457. /**
  150458. * The byte length of the buffer.
  150459. */
  150460. readonly byteLength: number;
  150461. }
  150462. /**
  150463. * Utility class for reading from a data buffer
  150464. */
  150465. export class DataReader {
  150466. /**
  150467. * The data buffer associated with this data reader.
  150468. */
  150469. readonly buffer: IDataBuffer;
  150470. /**
  150471. * The current byte offset from the beginning of the data buffer.
  150472. */
  150473. byteOffset: number;
  150474. private _dataView;
  150475. private _dataByteOffset;
  150476. /**
  150477. * Constructor
  150478. * @param buffer The buffer to read
  150479. */
  150480. constructor(buffer: IDataBuffer);
  150481. /**
  150482. * Loads the given byte length.
  150483. * @param byteLength The byte length to load
  150484. * @returns A promise that resolves when the load is complete
  150485. */
  150486. loadAsync(byteLength: number): Promise<void>;
  150487. /**
  150488. * Read a unsigned 32-bit integer from the currently loaded data range.
  150489. * @returns The 32-bit integer read
  150490. */
  150491. readUint32(): number;
  150492. /**
  150493. * Read a byte array from the currently loaded data range.
  150494. * @param byteLength The byte length to read
  150495. * @returns The byte array read
  150496. */
  150497. readUint8Array(byteLength: number): Uint8Array;
  150498. /**
  150499. * Read a string from the currently loaded data range.
  150500. * @param byteLength The byte length to read
  150501. * @returns The string read
  150502. */
  150503. readString(byteLength: number): string;
  150504. /**
  150505. * Skips the given byte length the currently loaded data range.
  150506. * @param byteLength The byte length to skip
  150507. */
  150508. skipBytes(byteLength: number): void;
  150509. }
  150510. }
  150511. declare module BABYLON {
  150512. /**
  150513. * Class for storing data to local storage if available or in-memory storage otherwise
  150514. */
  150515. export class DataStorage {
  150516. private static _Storage;
  150517. private static _GetStorage;
  150518. /**
  150519. * Reads a string from the data storage
  150520. * @param key The key to read
  150521. * @param defaultValue The value if the key doesn't exist
  150522. * @returns The string value
  150523. */
  150524. static ReadString(key: string, defaultValue: string): string;
  150525. /**
  150526. * Writes a string to the data storage
  150527. * @param key The key to write
  150528. * @param value The value to write
  150529. */
  150530. static WriteString(key: string, value: string): void;
  150531. /**
  150532. * Reads a boolean from the data storage
  150533. * @param key The key to read
  150534. * @param defaultValue The value if the key doesn't exist
  150535. * @returns The boolean value
  150536. */
  150537. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  150538. /**
  150539. * Writes a boolean to the data storage
  150540. * @param key The key to write
  150541. * @param value The value to write
  150542. */
  150543. static WriteBoolean(key: string, value: boolean): void;
  150544. /**
  150545. * Reads a number from the data storage
  150546. * @param key The key to read
  150547. * @param defaultValue The value if the key doesn't exist
  150548. * @returns The number value
  150549. */
  150550. static ReadNumber(key: string, defaultValue: number): number;
  150551. /**
  150552. * Writes a number to the data storage
  150553. * @param key The key to write
  150554. * @param value The value to write
  150555. */
  150556. static WriteNumber(key: string, value: number): void;
  150557. }
  150558. }
  150559. declare module BABYLON {
  150560. /**
  150561. * An interface for all Hit test features
  150562. */
  150563. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  150564. /**
  150565. * Triggered when new babylon (transformed) hit test results are available
  150566. */
  150567. onHitTestResultObservable: Observable<T[]>;
  150568. }
  150569. /**
  150570. * Options used for hit testing
  150571. */
  150572. export interface IWebXRLegacyHitTestOptions {
  150573. /**
  150574. * Only test when user interacted with the scene. Default - hit test every frame
  150575. */
  150576. testOnPointerDownOnly?: boolean;
  150577. /**
  150578. * The node to use to transform the local results to world coordinates
  150579. */
  150580. worldParentNode?: TransformNode;
  150581. }
  150582. /**
  150583. * Interface defining the babylon result of raycasting/hit-test
  150584. */
  150585. export interface IWebXRLegacyHitResult {
  150586. /**
  150587. * Transformation matrix that can be applied to a node that will put it in the hit point location
  150588. */
  150589. transformationMatrix: Matrix;
  150590. /**
  150591. * The native hit test result
  150592. */
  150593. xrHitResult: XRHitResult | XRHitTestResult;
  150594. }
  150595. /**
  150596. * The currently-working hit-test module.
  150597. * Hit test (or Ray-casting) is used to interact with the real world.
  150598. * For further information read here - https://github.com/immersive-web/hit-test
  150599. */
  150600. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  150601. /**
  150602. * options to use when constructing this feature
  150603. */
  150604. readonly options: IWebXRLegacyHitTestOptions;
  150605. private _direction;
  150606. private _mat;
  150607. private _onSelectEnabled;
  150608. private _origin;
  150609. /**
  150610. * The module's name
  150611. */
  150612. static readonly Name: string;
  150613. /**
  150614. * The (Babylon) version of this module.
  150615. * This is an integer representing the implementation version.
  150616. * This number does not correspond to the WebXR specs version
  150617. */
  150618. static readonly Version: number;
  150619. /**
  150620. * Populated with the last native XR Hit Results
  150621. */
  150622. lastNativeXRHitResults: XRHitResult[];
  150623. /**
  150624. * Triggered when new babylon (transformed) hit test results are available
  150625. */
  150626. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  150627. /**
  150628. * Creates a new instance of the (legacy version) hit test feature
  150629. * @param _xrSessionManager an instance of WebXRSessionManager
  150630. * @param options options to use when constructing this feature
  150631. */
  150632. constructor(_xrSessionManager: WebXRSessionManager,
  150633. /**
  150634. * options to use when constructing this feature
  150635. */
  150636. options?: IWebXRLegacyHitTestOptions);
  150637. /**
  150638. * execute a hit test with an XR Ray
  150639. *
  150640. * @param xrSession a native xrSession that will execute this hit test
  150641. * @param xrRay the ray (position and direction) to use for ray-casting
  150642. * @param referenceSpace native XR reference space to use for the hit-test
  150643. * @param filter filter function that will filter the results
  150644. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  150645. */
  150646. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  150647. /**
  150648. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  150649. * @param event the (select) event to use to select with
  150650. * @param referenceSpace the reference space to use for this hit test
  150651. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  150652. */
  150653. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  150654. /**
  150655. * attach this feature
  150656. * Will usually be called by the features manager
  150657. *
  150658. * @returns true if successful.
  150659. */
  150660. attach(): boolean;
  150661. /**
  150662. * detach this feature.
  150663. * Will usually be called by the features manager
  150664. *
  150665. * @returns true if successful.
  150666. */
  150667. detach(): boolean;
  150668. /**
  150669. * Dispose this feature and all of the resources attached
  150670. */
  150671. dispose(): void;
  150672. protected _onXRFrame(frame: XRFrame): void;
  150673. private _onHitTestResults;
  150674. private _onSelect;
  150675. }
  150676. }
  150677. declare module BABYLON {
  150678. /**
  150679. * Options used for hit testing (version 2)
  150680. */
  150681. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  150682. /**
  150683. * Do not create a permanent hit test. Will usually be used when only
  150684. * transient inputs are needed.
  150685. */
  150686. disablePermanentHitTest?: boolean;
  150687. /**
  150688. * Enable transient (for example touch-based) hit test inspections
  150689. */
  150690. enableTransientHitTest?: boolean;
  150691. /**
  150692. * Offset ray for the permanent hit test
  150693. */
  150694. offsetRay?: Vector3;
  150695. /**
  150696. * Offset ray for the transient hit test
  150697. */
  150698. transientOffsetRay?: Vector3;
  150699. /**
  150700. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  150701. */
  150702. useReferenceSpace?: boolean;
  150703. }
  150704. /**
  150705. * Interface defining the babylon result of hit-test
  150706. */
  150707. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  150708. /**
  150709. * The input source that generated this hit test (if transient)
  150710. */
  150711. inputSource?: XRInputSource;
  150712. /**
  150713. * Is this a transient hit test
  150714. */
  150715. isTransient?: boolean;
  150716. /**
  150717. * Position of the hit test result
  150718. */
  150719. position: Vector3;
  150720. /**
  150721. * Rotation of the hit test result
  150722. */
  150723. rotationQuaternion: Quaternion;
  150724. /**
  150725. * The native hit test result
  150726. */
  150727. xrHitResult: XRHitTestResult;
  150728. }
  150729. /**
  150730. * The currently-working hit-test module.
  150731. * Hit test (or Ray-casting) is used to interact with the real world.
  150732. * For further information read here - https://github.com/immersive-web/hit-test
  150733. *
  150734. * Tested on chrome (mobile) 80.
  150735. */
  150736. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  150737. /**
  150738. * options to use when constructing this feature
  150739. */
  150740. readonly options: IWebXRHitTestOptions;
  150741. private _tmpMat;
  150742. private _tmpPos;
  150743. private _tmpQuat;
  150744. private _transientXrHitTestSource;
  150745. private _xrHitTestSource;
  150746. private initHitTestSource;
  150747. /**
  150748. * The module's name
  150749. */
  150750. static readonly Name: string;
  150751. /**
  150752. * The (Babylon) version of this module.
  150753. * This is an integer representing the implementation version.
  150754. * This number does not correspond to the WebXR specs version
  150755. */
  150756. static readonly Version: number;
  150757. /**
  150758. * When set to true, each hit test will have its own position/rotation objects
  150759. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  150760. * the developers will clone them or copy them as they see fit.
  150761. */
  150762. autoCloneTransformation: boolean;
  150763. /**
  150764. * Triggered when new babylon (transformed) hit test results are available
  150765. */
  150766. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  150767. /**
  150768. * Use this to temporarily pause hit test checks.
  150769. */
  150770. paused: boolean;
  150771. /**
  150772. * Creates a new instance of the hit test feature
  150773. * @param _xrSessionManager an instance of WebXRSessionManager
  150774. * @param options options to use when constructing this feature
  150775. */
  150776. constructor(_xrSessionManager: WebXRSessionManager,
  150777. /**
  150778. * options to use when constructing this feature
  150779. */
  150780. options?: IWebXRHitTestOptions);
  150781. /**
  150782. * attach this feature
  150783. * Will usually be called by the features manager
  150784. *
  150785. * @returns true if successful.
  150786. */
  150787. attach(): boolean;
  150788. /**
  150789. * detach this feature.
  150790. * Will usually be called by the features manager
  150791. *
  150792. * @returns true if successful.
  150793. */
  150794. detach(): boolean;
  150795. /**
  150796. * Dispose this feature and all of the resources attached
  150797. */
  150798. dispose(): void;
  150799. protected _onXRFrame(frame: XRFrame): void;
  150800. private _processWebXRHitTestResult;
  150801. }
  150802. }
  150803. declare module BABYLON {
  150804. /**
  150805. * Configuration options of the anchor system
  150806. */
  150807. export interface IWebXRAnchorSystemOptions {
  150808. /**
  150809. * a node that will be used to convert local to world coordinates
  150810. */
  150811. worldParentNode?: TransformNode;
  150812. /**
  150813. * If set to true a reference of the created anchors will be kept until the next session starts
  150814. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  150815. */
  150816. doNotRemoveAnchorsOnSessionEnded?: boolean;
  150817. }
  150818. /**
  150819. * A babylon container for an XR Anchor
  150820. */
  150821. export interface IWebXRAnchor {
  150822. /**
  150823. * A babylon-assigned ID for this anchor
  150824. */
  150825. id: number;
  150826. /**
  150827. * Transformation matrix to apply to an object attached to this anchor
  150828. */
  150829. transformationMatrix: Matrix;
  150830. /**
  150831. * The native anchor object
  150832. */
  150833. xrAnchor: XRAnchor;
  150834. /**
  150835. * if defined, this object will be constantly updated by the anchor's position and rotation
  150836. */
  150837. attachedNode?: TransformNode;
  150838. }
  150839. /**
  150840. * An implementation of the anchor system for WebXR.
  150841. * For further information see https://github.com/immersive-web/anchors/
  150842. */
  150843. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  150844. private _options;
  150845. private _lastFrameDetected;
  150846. private _trackedAnchors;
  150847. private _referenceSpaceForFrameAnchors;
  150848. private _futureAnchors;
  150849. /**
  150850. * The module's name
  150851. */
  150852. static readonly Name: string;
  150853. /**
  150854. * The (Babylon) version of this module.
  150855. * This is an integer representing the implementation version.
  150856. * This number does not correspond to the WebXR specs version
  150857. */
  150858. static readonly Version: number;
  150859. /**
  150860. * Observers registered here will be executed when a new anchor was added to the session
  150861. */
  150862. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  150863. /**
  150864. * Observers registered here will be executed when an anchor was removed from the session
  150865. */
  150866. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  150867. /**
  150868. * Observers registered here will be executed when an existing anchor updates
  150869. * This can execute N times every frame
  150870. */
  150871. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  150872. /**
  150873. * Set the reference space to use for anchor creation, when not using a hit test.
  150874. * Will default to the session's reference space if not defined
  150875. */
  150876. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  150877. /**
  150878. * constructs a new anchor system
  150879. * @param _xrSessionManager an instance of WebXRSessionManager
  150880. * @param _options configuration object for this feature
  150881. */
  150882. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  150883. private _tmpVector;
  150884. private _tmpQuaternion;
  150885. private _populateTmpTransformation;
  150886. /**
  150887. * Create a new anchor point using a hit test result at a specific point in the scene
  150888. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  150889. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  150890. *
  150891. * @param hitTestResult The hit test result to use for this anchor creation
  150892. * @param position an optional position offset for this anchor
  150893. * @param rotationQuaternion an optional rotation offset for this anchor
  150894. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  150895. */
  150896. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  150897. /**
  150898. * Add a new anchor at a specific position and rotation
  150899. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  150900. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  150901. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  150902. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  150903. *
  150904. * @param position the position in which to add an anchor
  150905. * @param rotationQuaternion an optional rotation for the anchor transformation
  150906. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  150907. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  150908. */
  150909. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  150910. /**
  150911. * detach this feature.
  150912. * Will usually be called by the features manager
  150913. *
  150914. * @returns true if successful.
  150915. */
  150916. detach(): boolean;
  150917. /**
  150918. * Dispose this feature and all of the resources attached
  150919. */
  150920. dispose(): void;
  150921. protected _onXRFrame(frame: XRFrame): void;
  150922. /**
  150923. * avoiding using Array.find for global support.
  150924. * @param xrAnchor the plane to find in the array
  150925. */
  150926. private _findIndexInAnchorArray;
  150927. private _updateAnchorWithXRFrame;
  150928. private _createAnchorAtTransformation;
  150929. }
  150930. }
  150931. declare module BABYLON {
  150932. /**
  150933. * Options used in the plane detector module
  150934. */
  150935. export interface IWebXRPlaneDetectorOptions {
  150936. /**
  150937. * The node to use to transform the local results to world coordinates
  150938. */
  150939. worldParentNode?: TransformNode;
  150940. /**
  150941. * If set to true a reference of the created planes will be kept until the next session starts
  150942. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  150943. */
  150944. doNotRemovePlanesOnSessionEnded?: boolean;
  150945. }
  150946. /**
  150947. * A babylon interface for a WebXR plane.
  150948. * A Plane is actually a polygon, built from N points in space
  150949. *
  150950. * Supported in chrome 79, not supported in canary 81 ATM
  150951. */
  150952. export interface IWebXRPlane {
  150953. /**
  150954. * a babylon-assigned ID for this polygon
  150955. */
  150956. id: number;
  150957. /**
  150958. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  150959. */
  150960. polygonDefinition: Array<Vector3>;
  150961. /**
  150962. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  150963. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  150964. */
  150965. transformationMatrix: Matrix;
  150966. /**
  150967. * the native xr-plane object
  150968. */
  150969. xrPlane: XRPlane;
  150970. }
  150971. /**
  150972. * The plane detector is used to detect planes in the real world when in AR
  150973. * For more information see https://github.com/immersive-web/real-world-geometry/
  150974. */
  150975. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  150976. private _options;
  150977. private _detectedPlanes;
  150978. private _enabled;
  150979. private _lastFrameDetected;
  150980. /**
  150981. * The module's name
  150982. */
  150983. static readonly Name: string;
  150984. /**
  150985. * The (Babylon) version of this module.
  150986. * This is an integer representing the implementation version.
  150987. * This number does not correspond to the WebXR specs version
  150988. */
  150989. static readonly Version: number;
  150990. /**
  150991. * Observers registered here will be executed when a new plane was added to the session
  150992. */
  150993. onPlaneAddedObservable: Observable<IWebXRPlane>;
  150994. /**
  150995. * Observers registered here will be executed when a plane is no longer detected in the session
  150996. */
  150997. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  150998. /**
  150999. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  151000. * This can execute N times every frame
  151001. */
  151002. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  151003. /**
  151004. * construct a new Plane Detector
  151005. * @param _xrSessionManager an instance of xr Session manager
  151006. * @param _options configuration to use when constructing this feature
  151007. */
  151008. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  151009. /**
  151010. * detach this feature.
  151011. * Will usually be called by the features manager
  151012. *
  151013. * @returns true if successful.
  151014. */
  151015. detach(): boolean;
  151016. /**
  151017. * Dispose this feature and all of the resources attached
  151018. */
  151019. dispose(): void;
  151020. protected _onXRFrame(frame: XRFrame): void;
  151021. private _init;
  151022. private _updatePlaneWithXRPlane;
  151023. /**
  151024. * avoiding using Array.find for global support.
  151025. * @param xrPlane the plane to find in the array
  151026. */
  151027. private findIndexInPlaneArray;
  151028. }
  151029. }
  151030. declare module BABYLON {
  151031. /**
  151032. * Options interface for the background remover plugin
  151033. */
  151034. export interface IWebXRBackgroundRemoverOptions {
  151035. /**
  151036. * Further background meshes to disable when entering AR
  151037. */
  151038. backgroundMeshes?: AbstractMesh[];
  151039. /**
  151040. * flags to configure the removal of the environment helper.
  151041. * If not set, the entire background will be removed. If set, flags should be set as well.
  151042. */
  151043. environmentHelperRemovalFlags?: {
  151044. /**
  151045. * Should the skybox be removed (default false)
  151046. */
  151047. skyBox?: boolean;
  151048. /**
  151049. * Should the ground be removed (default false)
  151050. */
  151051. ground?: boolean;
  151052. };
  151053. /**
  151054. * don't disable the environment helper
  151055. */
  151056. ignoreEnvironmentHelper?: boolean;
  151057. }
  151058. /**
  151059. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  151060. */
  151061. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  151062. /**
  151063. * read-only options to be used in this module
  151064. */
  151065. readonly options: IWebXRBackgroundRemoverOptions;
  151066. /**
  151067. * The module's name
  151068. */
  151069. static readonly Name: string;
  151070. /**
  151071. * The (Babylon) version of this module.
  151072. * This is an integer representing the implementation version.
  151073. * This number does not correspond to the WebXR specs version
  151074. */
  151075. static readonly Version: number;
  151076. /**
  151077. * registered observers will be triggered when the background state changes
  151078. */
  151079. onBackgroundStateChangedObservable: Observable<boolean>;
  151080. /**
  151081. * constructs a new background remover module
  151082. * @param _xrSessionManager the session manager for this module
  151083. * @param options read-only options to be used in this module
  151084. */
  151085. constructor(_xrSessionManager: WebXRSessionManager,
  151086. /**
  151087. * read-only options to be used in this module
  151088. */
  151089. options?: IWebXRBackgroundRemoverOptions);
  151090. /**
  151091. * attach this feature
  151092. * Will usually be called by the features manager
  151093. *
  151094. * @returns true if successful.
  151095. */
  151096. attach(): boolean;
  151097. /**
  151098. * detach this feature.
  151099. * Will usually be called by the features manager
  151100. *
  151101. * @returns true if successful.
  151102. */
  151103. detach(): boolean;
  151104. /**
  151105. * Dispose this feature and all of the resources attached
  151106. */
  151107. dispose(): void;
  151108. protected _onXRFrame(_xrFrame: XRFrame): void;
  151109. private _setBackgroundState;
  151110. }
  151111. }
  151112. declare module BABYLON {
  151113. /**
  151114. * Options for the controller physics feature
  151115. */
  151116. export class IWebXRControllerPhysicsOptions {
  151117. /**
  151118. * Should the headset get its own impostor
  151119. */
  151120. enableHeadsetImpostor?: boolean;
  151121. /**
  151122. * Optional parameters for the headset impostor
  151123. */
  151124. headsetImpostorParams?: {
  151125. /**
  151126. * The type of impostor to create. Default is sphere
  151127. */
  151128. impostorType: number;
  151129. /**
  151130. * the size of the impostor. Defaults to 10cm
  151131. */
  151132. impostorSize?: number | {
  151133. width: number;
  151134. height: number;
  151135. depth: number;
  151136. };
  151137. /**
  151138. * Friction definitions
  151139. */
  151140. friction?: number;
  151141. /**
  151142. * Restitution
  151143. */
  151144. restitution?: number;
  151145. };
  151146. /**
  151147. * The physics properties of the future impostors
  151148. */
  151149. physicsProperties?: {
  151150. /**
  151151. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  151152. * Note that this requires a physics engine that supports mesh impostors!
  151153. */
  151154. useControllerMesh?: boolean;
  151155. /**
  151156. * The type of impostor to create. Default is sphere
  151157. */
  151158. impostorType?: number;
  151159. /**
  151160. * the size of the impostor. Defaults to 10cm
  151161. */
  151162. impostorSize?: number | {
  151163. width: number;
  151164. height: number;
  151165. depth: number;
  151166. };
  151167. /**
  151168. * Friction definitions
  151169. */
  151170. friction?: number;
  151171. /**
  151172. * Restitution
  151173. */
  151174. restitution?: number;
  151175. };
  151176. /**
  151177. * the xr input to use with this pointer selection
  151178. */
  151179. xrInput: WebXRInput;
  151180. }
  151181. /**
  151182. * Add physics impostor to your webxr controllers,
  151183. * including naive calculation of their linear and angular velocity
  151184. */
  151185. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  151186. private readonly _options;
  151187. private _attachController;
  151188. private _controllers;
  151189. private _debugMode;
  151190. private _delta;
  151191. private _headsetImpostor?;
  151192. private _headsetMesh?;
  151193. private _lastTimestamp;
  151194. private _tmpQuaternion;
  151195. private _tmpVector;
  151196. /**
  151197. * The module's name
  151198. */
  151199. static readonly Name: string;
  151200. /**
  151201. * The (Babylon) version of this module.
  151202. * This is an integer representing the implementation version.
  151203. * This number does not correspond to the webxr specs version
  151204. */
  151205. static readonly Version: number;
  151206. /**
  151207. * Construct a new Controller Physics Feature
  151208. * @param _xrSessionManager the corresponding xr session manager
  151209. * @param _options options to create this feature with
  151210. */
  151211. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  151212. /**
  151213. * @hidden
  151214. * enable debugging - will show console outputs and the impostor mesh
  151215. */
  151216. _enablePhysicsDebug(): void;
  151217. /**
  151218. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  151219. * @param xrController the controller to add
  151220. */
  151221. addController(xrController: WebXRInputSource): void;
  151222. /**
  151223. * attach this feature
  151224. * Will usually be called by the features manager
  151225. *
  151226. * @returns true if successful.
  151227. */
  151228. attach(): boolean;
  151229. /**
  151230. * detach this feature.
  151231. * Will usually be called by the features manager
  151232. *
  151233. * @returns true if successful.
  151234. */
  151235. detach(): boolean;
  151236. /**
  151237. * Get the headset impostor, if enabled
  151238. * @returns the impostor
  151239. */
  151240. getHeadsetImpostor(): PhysicsImpostor | undefined;
  151241. /**
  151242. * Get the physics impostor of a specific controller.
  151243. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  151244. * @param controller the controller or the controller id of which to get the impostor
  151245. * @returns the impostor or null
  151246. */
  151247. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  151248. /**
  151249. * Update the physics properties provided in the constructor
  151250. * @param newProperties the new properties object
  151251. */
  151252. setPhysicsProperties(newProperties: {
  151253. impostorType?: number;
  151254. impostorSize?: number | {
  151255. width: number;
  151256. height: number;
  151257. depth: number;
  151258. };
  151259. friction?: number;
  151260. restitution?: number;
  151261. }): void;
  151262. protected _onXRFrame(_xrFrame: any): void;
  151263. private _detachController;
  151264. }
  151265. }
  151266. declare module BABYLON {
  151267. /**
  151268. * The motion controller class for all microsoft mixed reality controllers
  151269. */
  151270. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  151271. protected readonly _mapping: {
  151272. defaultButton: {
  151273. valueNodeName: string;
  151274. unpressedNodeName: string;
  151275. pressedNodeName: string;
  151276. };
  151277. defaultAxis: {
  151278. valueNodeName: string;
  151279. minNodeName: string;
  151280. maxNodeName: string;
  151281. };
  151282. buttons: {
  151283. "xr-standard-trigger": {
  151284. rootNodeName: string;
  151285. componentProperty: string;
  151286. states: string[];
  151287. };
  151288. "xr-standard-squeeze": {
  151289. rootNodeName: string;
  151290. componentProperty: string;
  151291. states: string[];
  151292. };
  151293. "xr-standard-touchpad": {
  151294. rootNodeName: string;
  151295. labelAnchorNodeName: string;
  151296. touchPointNodeName: string;
  151297. };
  151298. "xr-standard-thumbstick": {
  151299. rootNodeName: string;
  151300. componentProperty: string;
  151301. states: string[];
  151302. };
  151303. };
  151304. axes: {
  151305. "xr-standard-touchpad": {
  151306. "x-axis": {
  151307. rootNodeName: string;
  151308. };
  151309. "y-axis": {
  151310. rootNodeName: string;
  151311. };
  151312. };
  151313. "xr-standard-thumbstick": {
  151314. "x-axis": {
  151315. rootNodeName: string;
  151316. };
  151317. "y-axis": {
  151318. rootNodeName: string;
  151319. };
  151320. };
  151321. };
  151322. };
  151323. /**
  151324. * The base url used to load the left and right controller models
  151325. */
  151326. static MODEL_BASE_URL: string;
  151327. /**
  151328. * The name of the left controller model file
  151329. */
  151330. static MODEL_LEFT_FILENAME: string;
  151331. /**
  151332. * The name of the right controller model file
  151333. */
  151334. static MODEL_RIGHT_FILENAME: string;
  151335. profileId: string;
  151336. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  151337. protected _getFilenameAndPath(): {
  151338. filename: string;
  151339. path: string;
  151340. };
  151341. protected _getModelLoadingConstraints(): boolean;
  151342. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  151343. protected _setRootMesh(meshes: AbstractMesh[]): void;
  151344. protected _updateModel(): void;
  151345. }
  151346. }
  151347. declare module BABYLON {
  151348. /**
  151349. * The motion controller class for oculus touch (quest, rift).
  151350. * This class supports legacy mapping as well the standard xr mapping
  151351. */
  151352. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  151353. private _forceLegacyControllers;
  151354. private _modelRootNode;
  151355. /**
  151356. * The base url used to load the left and right controller models
  151357. */
  151358. static MODEL_BASE_URL: string;
  151359. /**
  151360. * The name of the left controller model file
  151361. */
  151362. static MODEL_LEFT_FILENAME: string;
  151363. /**
  151364. * The name of the right controller model file
  151365. */
  151366. static MODEL_RIGHT_FILENAME: string;
  151367. /**
  151368. * Base Url for the Quest controller model.
  151369. */
  151370. static QUEST_MODEL_BASE_URL: string;
  151371. profileId: string;
  151372. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  151373. protected _getFilenameAndPath(): {
  151374. filename: string;
  151375. path: string;
  151376. };
  151377. protected _getModelLoadingConstraints(): boolean;
  151378. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  151379. protected _setRootMesh(meshes: AbstractMesh[]): void;
  151380. protected _updateModel(): void;
  151381. /**
  151382. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  151383. * between the touch and touch 2.
  151384. */
  151385. private _isQuest;
  151386. }
  151387. }
  151388. declare module BABYLON {
  151389. /**
  151390. * The motion controller class for the standard HTC-Vive controllers
  151391. */
  151392. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  151393. private _modelRootNode;
  151394. /**
  151395. * The base url used to load the left and right controller models
  151396. */
  151397. static MODEL_BASE_URL: string;
  151398. /**
  151399. * File name for the controller model.
  151400. */
  151401. static MODEL_FILENAME: string;
  151402. profileId: string;
  151403. /**
  151404. * Create a new Vive motion controller object
  151405. * @param scene the scene to use to create this controller
  151406. * @param gamepadObject the corresponding gamepad object
  151407. * @param handedness the handedness of the controller
  151408. */
  151409. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  151410. protected _getFilenameAndPath(): {
  151411. filename: string;
  151412. path: string;
  151413. };
  151414. protected _getModelLoadingConstraints(): boolean;
  151415. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  151416. protected _setRootMesh(meshes: AbstractMesh[]): void;
  151417. protected _updateModel(): void;
  151418. }
  151419. }
  151420. declare module BABYLON {
  151421. /**
  151422. * A cursor which tracks a point on a path
  151423. */
  151424. export class PathCursor {
  151425. private path;
  151426. /**
  151427. * Stores path cursor callbacks for when an onchange event is triggered
  151428. */
  151429. private _onchange;
  151430. /**
  151431. * The value of the path cursor
  151432. */
  151433. value: number;
  151434. /**
  151435. * The animation array of the path cursor
  151436. */
  151437. animations: Animation[];
  151438. /**
  151439. * Initializes the path cursor
  151440. * @param path The path to track
  151441. */
  151442. constructor(path: Path2);
  151443. /**
  151444. * Gets the cursor point on the path
  151445. * @returns A point on the path cursor at the cursor location
  151446. */
  151447. getPoint(): Vector3;
  151448. /**
  151449. * Moves the cursor ahead by the step amount
  151450. * @param step The amount to move the cursor forward
  151451. * @returns This path cursor
  151452. */
  151453. moveAhead(step?: number): PathCursor;
  151454. /**
  151455. * Moves the cursor behind by the step amount
  151456. * @param step The amount to move the cursor back
  151457. * @returns This path cursor
  151458. */
  151459. moveBack(step?: number): PathCursor;
  151460. /**
  151461. * Moves the cursor by the step amount
  151462. * If the step amount is greater than one, an exception is thrown
  151463. * @param step The amount to move the cursor
  151464. * @returns This path cursor
  151465. */
  151466. move(step: number): PathCursor;
  151467. /**
  151468. * Ensures that the value is limited between zero and one
  151469. * @returns This path cursor
  151470. */
  151471. private ensureLimits;
  151472. /**
  151473. * Runs onchange callbacks on change (used by the animation engine)
  151474. * @returns This path cursor
  151475. */
  151476. private raiseOnChange;
  151477. /**
  151478. * Executes a function on change
  151479. * @param f A path cursor onchange callback
  151480. * @returns This path cursor
  151481. */
  151482. onchange(f: (cursor: PathCursor) => void): PathCursor;
  151483. }
  151484. }
  151485. declare module BABYLON {
  151486. /** @hidden */
  151487. export var blurPixelShader: {
  151488. name: string;
  151489. shader: string;
  151490. };
  151491. }
  151492. declare module BABYLON {
  151493. /** @hidden */
  151494. export var pointCloudVertexDeclaration: {
  151495. name: string;
  151496. shader: string;
  151497. };
  151498. }
  151499. // Mixins
  151500. interface Window {
  151501. mozIndexedDB: IDBFactory;
  151502. webkitIndexedDB: IDBFactory;
  151503. msIndexedDB: IDBFactory;
  151504. webkitURL: typeof URL;
  151505. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  151506. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  151507. WebGLRenderingContext: WebGLRenderingContext;
  151508. MSGesture: MSGesture;
  151509. CANNON: any;
  151510. AudioContext: AudioContext;
  151511. webkitAudioContext: AudioContext;
  151512. PointerEvent: any;
  151513. Math: Math;
  151514. Uint8Array: Uint8ArrayConstructor;
  151515. Float32Array: Float32ArrayConstructor;
  151516. mozURL: typeof URL;
  151517. msURL: typeof URL;
  151518. VRFrameData: any; // WebVR, from specs 1.1
  151519. DracoDecoderModule: any;
  151520. setImmediate(handler: (...args: any[]) => void): number;
  151521. }
  151522. interface HTMLCanvasElement {
  151523. requestPointerLock(): void;
  151524. msRequestPointerLock?(): void;
  151525. mozRequestPointerLock?(): void;
  151526. webkitRequestPointerLock?(): void;
  151527. /** Track wether a record is in progress */
  151528. isRecording: boolean;
  151529. /** Capture Stream method defined by some browsers */
  151530. captureStream(fps?: number): MediaStream;
  151531. }
  151532. interface CanvasRenderingContext2D {
  151533. msImageSmoothingEnabled: boolean;
  151534. }
  151535. interface MouseEvent {
  151536. mozMovementX: number;
  151537. mozMovementY: number;
  151538. webkitMovementX: number;
  151539. webkitMovementY: number;
  151540. msMovementX: number;
  151541. msMovementY: number;
  151542. }
  151543. interface Navigator {
  151544. mozGetVRDevices: (any: any) => any;
  151545. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  151546. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  151547. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  151548. webkitGetGamepads(): Gamepad[];
  151549. msGetGamepads(): Gamepad[];
  151550. webkitGamepads(): Gamepad[];
  151551. }
  151552. interface HTMLVideoElement {
  151553. mozSrcObject: any;
  151554. }
  151555. interface Math {
  151556. fround(x: number): number;
  151557. imul(a: number, b: number): number;
  151558. }
  151559. interface WebGLRenderingContext {
  151560. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  151561. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  151562. vertexAttribDivisor(index: number, divisor: number): void;
  151563. createVertexArray(): any;
  151564. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  151565. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  151566. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  151567. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  151568. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  151569. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  151570. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  151571. // Queries
  151572. createQuery(): WebGLQuery;
  151573. deleteQuery(query: WebGLQuery): void;
  151574. beginQuery(target: number, query: WebGLQuery): void;
  151575. endQuery(target: number): void;
  151576. getQueryParameter(query: WebGLQuery, pname: number): any;
  151577. getQuery(target: number, pname: number): any;
  151578. MAX_SAMPLES: number;
  151579. RGBA8: number;
  151580. READ_FRAMEBUFFER: number;
  151581. DRAW_FRAMEBUFFER: number;
  151582. UNIFORM_BUFFER: number;
  151583. HALF_FLOAT_OES: number;
  151584. RGBA16F: number;
  151585. RGBA32F: number;
  151586. R32F: number;
  151587. RG32F: number;
  151588. RGB32F: number;
  151589. R16F: number;
  151590. RG16F: number;
  151591. RGB16F: number;
  151592. RED: number;
  151593. RG: number;
  151594. R8: number;
  151595. RG8: number;
  151596. UNSIGNED_INT_24_8: number;
  151597. DEPTH24_STENCIL8: number;
  151598. MIN: number;
  151599. MAX: number;
  151600. /* Multiple Render Targets */
  151601. drawBuffers(buffers: number[]): void;
  151602. readBuffer(src: number): void;
  151603. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  151604. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  151605. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  151606. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  151607. // Occlusion Query
  151608. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  151609. ANY_SAMPLES_PASSED: number;
  151610. QUERY_RESULT_AVAILABLE: number;
  151611. QUERY_RESULT: number;
  151612. }
  151613. interface WebGLProgram {
  151614. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  151615. }
  151616. interface EXT_disjoint_timer_query {
  151617. QUERY_COUNTER_BITS_EXT: number;
  151618. TIME_ELAPSED_EXT: number;
  151619. TIMESTAMP_EXT: number;
  151620. GPU_DISJOINT_EXT: number;
  151621. QUERY_RESULT_EXT: number;
  151622. QUERY_RESULT_AVAILABLE_EXT: number;
  151623. queryCounterEXT(query: WebGLQuery, target: number): void;
  151624. createQueryEXT(): WebGLQuery;
  151625. beginQueryEXT(target: number, query: WebGLQuery): void;
  151626. endQueryEXT(target: number): void;
  151627. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  151628. deleteQueryEXT(query: WebGLQuery): void;
  151629. }
  151630. interface WebGLUniformLocation {
  151631. _currentState: any;
  151632. }
  151633. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  151634. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  151635. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  151636. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  151637. interface WebGLRenderingContext {
  151638. readonly RASTERIZER_DISCARD: number;
  151639. readonly DEPTH_COMPONENT24: number;
  151640. readonly TEXTURE_3D: number;
  151641. readonly TEXTURE_2D_ARRAY: number;
  151642. readonly TEXTURE_COMPARE_FUNC: number;
  151643. readonly TEXTURE_COMPARE_MODE: number;
  151644. readonly COMPARE_REF_TO_TEXTURE: number;
  151645. readonly TEXTURE_WRAP_R: number;
  151646. readonly HALF_FLOAT: number;
  151647. readonly RGB8: number;
  151648. readonly RED_INTEGER: number;
  151649. readonly RG_INTEGER: number;
  151650. readonly RGB_INTEGER: number;
  151651. readonly RGBA_INTEGER: number;
  151652. readonly R8_SNORM: number;
  151653. readonly RG8_SNORM: number;
  151654. readonly RGB8_SNORM: number;
  151655. readonly RGBA8_SNORM: number;
  151656. readonly R8I: number;
  151657. readonly RG8I: number;
  151658. readonly RGB8I: number;
  151659. readonly RGBA8I: number;
  151660. readonly R8UI: number;
  151661. readonly RG8UI: number;
  151662. readonly RGB8UI: number;
  151663. readonly RGBA8UI: number;
  151664. readonly R16I: number;
  151665. readonly RG16I: number;
  151666. readonly RGB16I: number;
  151667. readonly RGBA16I: number;
  151668. readonly R16UI: number;
  151669. readonly RG16UI: number;
  151670. readonly RGB16UI: number;
  151671. readonly RGBA16UI: number;
  151672. readonly R32I: number;
  151673. readonly RG32I: number;
  151674. readonly RGB32I: number;
  151675. readonly RGBA32I: number;
  151676. readonly R32UI: number;
  151677. readonly RG32UI: number;
  151678. readonly RGB32UI: number;
  151679. readonly RGBA32UI: number;
  151680. readonly RGB10_A2UI: number;
  151681. readonly R11F_G11F_B10F: number;
  151682. readonly RGB9_E5: number;
  151683. readonly RGB10_A2: number;
  151684. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  151685. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  151686. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  151687. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  151688. readonly DEPTH_COMPONENT32F: number;
  151689. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  151690. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  151691. 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;
  151692. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  151693. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  151694. readonly TRANSFORM_FEEDBACK: number;
  151695. readonly INTERLEAVED_ATTRIBS: number;
  151696. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  151697. createTransformFeedback(): WebGLTransformFeedback;
  151698. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  151699. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  151700. beginTransformFeedback(primitiveMode: number): void;
  151701. endTransformFeedback(): void;
  151702. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  151703. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  151704. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  151705. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  151706. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  151707. }
  151708. interface ImageBitmap {
  151709. readonly width: number;
  151710. readonly height: number;
  151711. close(): void;
  151712. }
  151713. interface WebGLQuery extends WebGLObject {
  151714. }
  151715. declare var WebGLQuery: {
  151716. prototype: WebGLQuery;
  151717. new(): WebGLQuery;
  151718. };
  151719. interface WebGLSampler extends WebGLObject {
  151720. }
  151721. declare var WebGLSampler: {
  151722. prototype: WebGLSampler;
  151723. new(): WebGLSampler;
  151724. };
  151725. interface WebGLSync extends WebGLObject {
  151726. }
  151727. declare var WebGLSync: {
  151728. prototype: WebGLSync;
  151729. new(): WebGLSync;
  151730. };
  151731. interface WebGLTransformFeedback extends WebGLObject {
  151732. }
  151733. declare var WebGLTransformFeedback: {
  151734. prototype: WebGLTransformFeedback;
  151735. new(): WebGLTransformFeedback;
  151736. };
  151737. interface WebGLVertexArrayObject extends WebGLObject {
  151738. }
  151739. declare var WebGLVertexArrayObject: {
  151740. prototype: WebGLVertexArrayObject;
  151741. new(): WebGLVertexArrayObject;
  151742. };
  151743. // Type definitions for WebVR API
  151744. // Project: https://w3c.github.io/webvr/
  151745. // Definitions by: six a <https://github.com/lostfictions>
  151746. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  151747. interface VRDisplay extends EventTarget {
  151748. /**
  151749. * Dictionary of capabilities describing the VRDisplay.
  151750. */
  151751. readonly capabilities: VRDisplayCapabilities;
  151752. /**
  151753. * z-depth defining the far plane of the eye view frustum
  151754. * enables mapping of values in the render target depth
  151755. * attachment to scene coordinates. Initially set to 10000.0.
  151756. */
  151757. depthFar: number;
  151758. /**
  151759. * z-depth defining the near plane of the eye view frustum
  151760. * enables mapping of values in the render target depth
  151761. * attachment to scene coordinates. Initially set to 0.01.
  151762. */
  151763. depthNear: number;
  151764. /**
  151765. * An identifier for this distinct VRDisplay. Used as an
  151766. * association point in the Gamepad API.
  151767. */
  151768. readonly displayId: number;
  151769. /**
  151770. * A display name, a user-readable name identifying it.
  151771. */
  151772. readonly displayName: string;
  151773. readonly isConnected: boolean;
  151774. readonly isPresenting: boolean;
  151775. /**
  151776. * If this VRDisplay supports room-scale experiences, the optional
  151777. * stage attribute contains details on the room-scale parameters.
  151778. */
  151779. readonly stageParameters: VRStageParameters | null;
  151780. /**
  151781. * Passing the value returned by `requestAnimationFrame` to
  151782. * `cancelAnimationFrame` will unregister the callback.
  151783. * @param handle Define the hanle of the request to cancel
  151784. */
  151785. cancelAnimationFrame(handle: number): void;
  151786. /**
  151787. * Stops presenting to the VRDisplay.
  151788. * @returns a promise to know when it stopped
  151789. */
  151790. exitPresent(): Promise<void>;
  151791. /**
  151792. * Return the current VREyeParameters for the given eye.
  151793. * @param whichEye Define the eye we want the parameter for
  151794. * @returns the eye parameters
  151795. */
  151796. getEyeParameters(whichEye: string): VREyeParameters;
  151797. /**
  151798. * Populates the passed VRFrameData with the information required to render
  151799. * the current frame.
  151800. * @param frameData Define the data structure to populate
  151801. * @returns true if ok otherwise false
  151802. */
  151803. getFrameData(frameData: VRFrameData): boolean;
  151804. /**
  151805. * Get the layers currently being presented.
  151806. * @returns the list of VR layers
  151807. */
  151808. getLayers(): VRLayer[];
  151809. /**
  151810. * Return a VRPose containing the future predicted pose of the VRDisplay
  151811. * when the current frame will be presented. The value returned will not
  151812. * change until JavaScript has returned control to the browser.
  151813. *
  151814. * The VRPose will contain the position, orientation, velocity,
  151815. * and acceleration of each of these properties.
  151816. * @returns the pose object
  151817. */
  151818. getPose(): VRPose;
  151819. /**
  151820. * Return the current instantaneous pose of the VRDisplay, with no
  151821. * prediction applied.
  151822. * @returns the current instantaneous pose
  151823. */
  151824. getImmediatePose(): VRPose;
  151825. /**
  151826. * The callback passed to `requestAnimationFrame` will be called
  151827. * any time a new frame should be rendered. When the VRDisplay is
  151828. * presenting the callback will be called at the native refresh
  151829. * rate of the HMD. When not presenting this function acts
  151830. * identically to how window.requestAnimationFrame acts. Content should
  151831. * make no assumptions of frame rate or vsync behavior as the HMD runs
  151832. * asynchronously from other displays and at differing refresh rates.
  151833. * @param callback Define the eaction to run next frame
  151834. * @returns the request handle it
  151835. */
  151836. requestAnimationFrame(callback: FrameRequestCallback): number;
  151837. /**
  151838. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  151839. * Repeat calls while already presenting will update the VRLayers being displayed.
  151840. * @param layers Define the list of layer to present
  151841. * @returns a promise to know when the request has been fulfilled
  151842. */
  151843. requestPresent(layers: VRLayer[]): Promise<void>;
  151844. /**
  151845. * Reset the pose for this display, treating its current position and
  151846. * orientation as the "origin/zero" values. VRPose.position,
  151847. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  151848. * updated when calling resetPose(). This should be called in only
  151849. * sitting-space experiences.
  151850. */
  151851. resetPose(): void;
  151852. /**
  151853. * The VRLayer provided to the VRDisplay will be captured and presented
  151854. * in the HMD. Calling this function has the same effect on the source
  151855. * canvas as any other operation that uses its source image, and canvases
  151856. * created without preserveDrawingBuffer set to true will be cleared.
  151857. * @param pose Define the pose to submit
  151858. */
  151859. submitFrame(pose?: VRPose): void;
  151860. }
  151861. declare var VRDisplay: {
  151862. prototype: VRDisplay;
  151863. new(): VRDisplay;
  151864. };
  151865. interface VRLayer {
  151866. leftBounds?: number[] | Float32Array | null;
  151867. rightBounds?: number[] | Float32Array | null;
  151868. source?: HTMLCanvasElement | null;
  151869. }
  151870. interface VRDisplayCapabilities {
  151871. readonly canPresent: boolean;
  151872. readonly hasExternalDisplay: boolean;
  151873. readonly hasOrientation: boolean;
  151874. readonly hasPosition: boolean;
  151875. readonly maxLayers: number;
  151876. }
  151877. interface VREyeParameters {
  151878. /** @deprecated */
  151879. readonly fieldOfView: VRFieldOfView;
  151880. readonly offset: Float32Array;
  151881. readonly renderHeight: number;
  151882. readonly renderWidth: number;
  151883. }
  151884. interface VRFieldOfView {
  151885. readonly downDegrees: number;
  151886. readonly leftDegrees: number;
  151887. readonly rightDegrees: number;
  151888. readonly upDegrees: number;
  151889. }
  151890. interface VRFrameData {
  151891. readonly leftProjectionMatrix: Float32Array;
  151892. readonly leftViewMatrix: Float32Array;
  151893. readonly pose: VRPose;
  151894. readonly rightProjectionMatrix: Float32Array;
  151895. readonly rightViewMatrix: Float32Array;
  151896. readonly timestamp: number;
  151897. }
  151898. interface VRPose {
  151899. readonly angularAcceleration: Float32Array | null;
  151900. readonly angularVelocity: Float32Array | null;
  151901. readonly linearAcceleration: Float32Array | null;
  151902. readonly linearVelocity: Float32Array | null;
  151903. readonly orientation: Float32Array | null;
  151904. readonly position: Float32Array | null;
  151905. readonly timestamp: number;
  151906. }
  151907. interface VRStageParameters {
  151908. sittingToStandingTransform?: Float32Array;
  151909. sizeX?: number;
  151910. sizeY?: number;
  151911. }
  151912. interface Navigator {
  151913. getVRDisplays(): Promise<VRDisplay[]>;
  151914. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  151915. }
  151916. interface Window {
  151917. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  151918. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  151919. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  151920. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  151921. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  151922. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  151923. }
  151924. interface Gamepad {
  151925. readonly displayId: number;
  151926. }
  151927. type XRSessionMode =
  151928. | "inline"
  151929. | "immersive-vr"
  151930. | "immersive-ar";
  151931. type XRReferenceSpaceType =
  151932. | "viewer"
  151933. | "local"
  151934. | "local-floor"
  151935. | "bounded-floor"
  151936. | "unbounded";
  151937. type XREnvironmentBlendMode =
  151938. | "opaque"
  151939. | "additive"
  151940. | "alpha-blend";
  151941. type XRVisibilityState =
  151942. | "visible"
  151943. | "visible-blurred"
  151944. | "hidden";
  151945. type XRHandedness =
  151946. | "none"
  151947. | "left"
  151948. | "right";
  151949. type XRTargetRayMode =
  151950. | "gaze"
  151951. | "tracked-pointer"
  151952. | "screen";
  151953. type XREye =
  151954. | "none"
  151955. | "left"
  151956. | "right";
  151957. type XREventType =
  151958. | "devicechange"
  151959. | "visibilitychange"
  151960. | "end"
  151961. | "inputsourceschange"
  151962. | "select"
  151963. | "selectstart"
  151964. | "selectend"
  151965. | "squeeze"
  151966. | "squeezestart"
  151967. | "squeezeend"
  151968. | "reset";
  151969. interface XRSpace extends EventTarget {
  151970. }
  151971. interface XRRenderState {
  151972. depthNear?: number;
  151973. depthFar?: number;
  151974. inlineVerticalFieldOfView?: number;
  151975. baseLayer?: XRWebGLLayer;
  151976. }
  151977. interface XRInputSource {
  151978. handedness: XRHandedness;
  151979. targetRayMode: XRTargetRayMode;
  151980. targetRaySpace: XRSpace;
  151981. gripSpace: XRSpace | undefined;
  151982. gamepad: Gamepad | undefined;
  151983. profiles: Array<string>;
  151984. }
  151985. interface XRSessionInit {
  151986. optionalFeatures?: string[];
  151987. requiredFeatures?: string[];
  151988. }
  151989. interface XRSession {
  151990. addEventListener: Function;
  151991. removeEventListener: Function;
  151992. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  151993. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  151994. requestAnimationFrame: Function;
  151995. end(): Promise<void>;
  151996. renderState: XRRenderState;
  151997. inputSources: Array<XRInputSource>;
  151998. // hit test
  151999. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  152000. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  152001. // legacy AR hit test
  152002. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  152003. // legacy plane detection
  152004. updateWorldTrackingState(options: {
  152005. planeDetectionState?: { enabled: boolean; }
  152006. }): void;
  152007. }
  152008. interface XRReferenceSpace extends XRSpace {
  152009. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  152010. onreset: any;
  152011. }
  152012. type XRPlaneSet = Set<XRPlane>;
  152013. type XRAnchorSet = Set<XRAnchor>;
  152014. interface XRFrame {
  152015. session: XRSession;
  152016. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  152017. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  152018. // AR
  152019. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult> ;
  152020. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  152021. // Anchors
  152022. trackedAnchors?: XRAnchorSet;
  152023. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  152024. // Planes
  152025. worldInformation: {
  152026. detectedPlanes?: XRPlaneSet;
  152027. };
  152028. }
  152029. interface XRViewerPose extends XRPose {
  152030. views: Array<XRView>;
  152031. }
  152032. interface XRPose {
  152033. transform: XRRigidTransform;
  152034. emulatedPosition: boolean;
  152035. }
  152036. interface XRWebGLLayerOptions {
  152037. antialias?: boolean;
  152038. depth?: boolean;
  152039. stencil?: boolean;
  152040. alpha?: boolean;
  152041. multiview?: boolean;
  152042. framebufferScaleFactor?: number;
  152043. }
  152044. declare var XRWebGLLayer: {
  152045. prototype: XRWebGLLayer;
  152046. new(session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  152047. };
  152048. interface XRWebGLLayer {
  152049. framebuffer: WebGLFramebuffer;
  152050. framebufferWidth: number;
  152051. framebufferHeight: number;
  152052. getViewport: Function;
  152053. }
  152054. declare class XRRigidTransform {
  152055. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  152056. position: DOMPointReadOnly;
  152057. orientation: DOMPointReadOnly;
  152058. matrix: Float32Array;
  152059. inverse: XRRigidTransform;
  152060. }
  152061. interface XRView {
  152062. eye: XREye;
  152063. projectionMatrix: Float32Array;
  152064. transform: XRRigidTransform;
  152065. }
  152066. interface XRInputSourceChangeEvent {
  152067. session: XRSession;
  152068. removed: Array<XRInputSource>;
  152069. added: Array<XRInputSource>;
  152070. }
  152071. interface XRInputSourceEvent extends Event {
  152072. readonly frame: XRFrame;
  152073. readonly inputSource: XRInputSource;
  152074. }
  152075. // Experimental(er) features
  152076. declare class XRRay {
  152077. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  152078. origin: DOMPointReadOnly;
  152079. direction: DOMPointReadOnly;
  152080. matrix: Float32Array;
  152081. }
  152082. declare enum XRHitTestTrackableType {
  152083. "point",
  152084. "plane"
  152085. }
  152086. interface XRHitResult {
  152087. hitMatrix: Float32Array;
  152088. }
  152089. interface XRTransientInputHitTestResult {
  152090. readonly inputSource: XRInputSource;
  152091. readonly results: Array<XRHitTestResult>;
  152092. }
  152093. interface XRHitTestResult {
  152094. getPose(baseSpace: XRSpace): XRPose | undefined;
  152095. // When anchor system is enabled
  152096. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  152097. }
  152098. interface XRHitTestSource {
  152099. cancel(): void;
  152100. }
  152101. interface XRTransientInputHitTestSource {
  152102. cancel(): void;
  152103. }
  152104. interface XRHitTestOptionsInit {
  152105. space: XRSpace;
  152106. entityTypes?: Array<XRHitTestTrackableType>;
  152107. offsetRay?: XRRay;
  152108. }
  152109. interface XRTransientInputHitTestOptionsInit {
  152110. profile: string;
  152111. entityTypes?: Array<XRHitTestTrackableType>;
  152112. offsetRay?: XRRay;
  152113. }
  152114. interface XRAnchor {
  152115. anchorSpace: XRSpace;
  152116. delete(): void;
  152117. }
  152118. interface XRPlane {
  152119. orientation: "Horizontal" | "Vertical";
  152120. planeSpace: XRSpace;
  152121. polygon: Array<DOMPointReadOnly>;
  152122. lastChangedTime: number;
  152123. }